项目心得--网约车

桃扇骨 2024-03-27 17:25 18阅读 0赞

## 一、RESTFUL ##

Post：新增

Put：全量修改

Patch：修改某个值

Delete: 删除

Get：查询

删除接口也可以用POST请求

url注意：

url中不要带有敏感词（用户id等）

url中的名词用复数形式

![60564dcb10cff3ce0a64677eba230546.png][]

url设计：

[api.xxx.com/courses][api.xxx.com_courses]

## 二、状态码和提示信息 ##

code：状态码

message：success等

消息：真正的消息体

这样做可以省去解析消息体拿到状态码

## 三、分页 ##

1.  /api/courses?page=1&size=10

1.  /api/courses?max\_id=100&min\_id=90

第一种缺点：不适合频繁有插入的情况（第一页的数据，可能在看第二页的时候被挤到第二页了，看到了重复数据）

第二种缺点：不合适看指定的页数（得要看了前一页之后，才能知道下一页的max\_id和min\_id）

## 四、接口设计工具 ##

APIFOX

## 五、dependencies和dependencyManager ##

dependencyManager在父项目中只声明依赖，并不实现引用；子项目需要显示声明依赖；有利于版本统一，父项目声明后，子项目中可以不写版本号

dependencies：在父项目中写了依赖后，子项目自动继承父项目的依赖，可以直接使用

创建项目：

groupId：公司名

artifactId：项目名

## 六、创建项目 ##

1.  ### 验证项目 ###

项目创建完成，可以通过package打包的方式，验证项目是否创建完成

1.  ### 父项目中packaging为pom ###

### 3.创建子项目 ###

new module

创建完子项目，父项目的pom文件中会多：

### 4. relativePath ###

relativePath用于找父项目的pom文件位置，默认就是../pom.xml

### 5. 子项目调用 ###

同一个父项目中的各个子项目，如果需要相互调用，可以在父项目中加对应的项目依赖，也可以在调用的项目中添加依赖

![9e7046b81c1356e5bc28fbc1aa7bbd23.png][]

## 七、nacos ##

nacos只是一个应用服务，下载了以后，直接启动运行

nacos启动时，路径带中文会报错

windows上可以使用启动脚本来启动nacos，把启动命令放在bat文件中，双击bat文件就可以启动了

### **把服务注册到nacos中** ###

1.  在服务中添加nacos依赖

![c1c685567df7e96b6607c686cc70cf03.png][]

1.  添加配置

![d0b90d4570e04dde1a05191df9b72f2d.png][]

1.  在启动类中添加注解

@EnableDiscoveryClient

## 八、链式调用@Accessors ##

实体类上可以加@Accessors(chain=true)注解

用于链式调用，set完一个属性后可以直接再设置另一个属性，会返回对象本身

user.setName("").setAge();

## 九、springboot、spring cloud、spring cloud alibaba版本统一问题 ##

spring cloud alibaba中有说明版本统一问题，可以通过dependcyManager在管理整个项目的版本

> [https://github.com/alibaba/spring-cloud-alibaba/wiki/%E7%89%88%E6%9C%AC%E8%AF%B4%E6%98%8E][https_github.com_alibaba_spring-cloud-alibaba_wiki_E7_89_88_E6_9C_AC_E8_AF_B4_E6_98_8E]

在父项目中注明spring cloud alibab的版本号

![10e08331684bb5d111f4b369af216b19.png][]

## 十、openFeign ##

### 子项目之间调用可以使用openFegin ###

1.  添加openFeign的依赖

<dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-openfeign</artifactId>
            </dependency>

1.  启动类需要添加注解

@EnableFeignClients

1.  使用openFegin需要引用loadBalance依赖

![abc3eec5614b38541f5b27e2e659d568.png][]

### **使用openFeign进行远程调用** ###

![ebee5022351f481ac236b213df95329f.png][]

### 使用feign进行服务调用会出现的问题： ###

GET请求中，如果参数放在body中，使用@RequestBody进行参数传递，GET请求会被转成POST请求。

解决方式一：需要修改成路径参数 @PathVariable

解决方式二：添加依赖

<dependency>
                <groupId>io.github.openfeign</groupId>
                <artifactId>feign-httpclient</artifactId>
            </dependency>

## 十一、mysql8的数据库连接 ##

需要写时区serverTimezone=GMT%2B8

## 十二、JWT ##

用于生成解析token

JWT：Json Web Token

官网：[https://jwt.io/][https_jwt.io]

![f3f0caf9292924424e537607f5ad7fc1.png][]

第一部分和第二部分都可以被解析出来，所以token里面不要放很重要的信息

第三部分中有一个256位的密码，可以增加密码的安全性

### 项目中引入JWT ###

1.  添加依赖

![f43689caf498b33d6c29c07420b6bce7.png][]

1.  生成token

// 生成token
        public static String generatorToken(String phone , String identity , String tokenType) {
            Map<String,String> map = new HashMap<>();
            map.put(JWT_KEY_PHONE,phone);
            map.put(JWT_KEY_IDENTITY, identity);
            map.put(JWT_TOKEN_TYPE, tokenType);
            // 防止每次生成的token一样。
            map.put(JWT_TOKEN_TIME, Calendar.getInstance().getTime().toString());
    
            JWTCreator.Builder builder = JWT.create();
            // 整合map
            map.forEach(
                (k,v) -> {
                    builder.withClaim(k,v);
                }
            );
            // 整合过期时间
    //        builder.withExpiresAt(date);
    
            // 生成 token
            String sign = builder.sign(Algorithm.HMAC256(SIGN));
    
            return sign;
        }

1.  解析token

// 解析token
        public static TokenResult parseToken(String token){
            DecodedJWT verify = JWT.require(Algorithm.HMAC256(SIGN)).build().verify(token);
            String phone = verify.getClaim(JWT_KEY_PHONE).asString();
            String identity = verify.getClaim(JWT_KEY_IDENTITY).asString();
    
            TokenResult tokenResult = new TokenResult();
            tokenResult.setPhone(phone);
            tokenResult.setIdentity(identity);
            return tokenResult;
    
        }

## 十三、添加拦截器 ##

1.  实现HandlerInterceptor

1.  重写preHandle方法

public class JwtInterceptor implements HandlerInterceptor {
    
        @Autowired
        private StringRedisTemplate stringRedisTemplate;
    
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    
            boolean result = true;
            String resutltString = "";
    
            String token = request.getHeader("Authorization");
            // 解析token
            TokenResult tokenResult = JwtUtils.checkToken(token);
    
            if (tokenResult == null){
                resutltString = "access token invalid";
                result = false;
            }else{
                // 拼接key
                String phone = tokenResult.getPhone();
                String identity = tokenResult.getIdentity();
    
                String tokenKey = RedisPrefixUtils.generatorTokenKey(phone,identity, TokenConstants.ACCESS_TOKEN_TYPE);
                // 从redis中取出token
                String tokenRedis = stringRedisTemplate.opsForValue().get(tokenKey);
                if ((StringUtils.isBlank(tokenRedis))  || (!token.trim().equals(tokenRedis.trim()))){
                    resutltString = "access token invalid";
                    result = false;
                }
            }
    
            if (!result){
                PrintWriter out = response.getWriter();
                out.print(JSONObject.fromObject(ResponseResult.fail(resutltString)).toString());
            }
    
            return result;
        }
    }

1.  把拦截器注入到spring容器中

@Configuration
    public class InterceptorConfig implements WebMvcConfigurer {
    
        @Bean
        public JwtInterceptor jwtInterceptor(){
            return new JwtInterceptor();
        }
    
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
            registry.addInterceptor(jwtInterceptor())
                    // 拦截的路径
                    .addPathPatterns("/**")
                    // 不拦截的路径
                    .excludePathPatterns("/noauth")
                    .excludePathPatterns("/verification-code")
                    .excludePathPatterns("/verification-code-check")
                    ;
        }
    }

拦截器是在bean实例化前初始化的，所以拦截器中使用bean需要在拦截器配置类中手动注入要使用的bean

![213b0a2ec299884fd495fd90babfdfd2.png][]

## 十四、token ##

### token失效 ###

1.  可以通过token本身设置过期时间

1.  也可以通过存储在redis中设置过期时间

### 双token ###

accessToken、refreshToken

accessToken是正常的访问token，refreshToken是刷新token，refreshToken的过期时间一般要比accessToken长。当accessToken快要过期了，但是用户正在访问，此时突然过期，对用户体验很不友好。此时，使用refreshToken访问，来更新accessToken和refreshToken。提高用户体验

可以在浏览器中安装**JSON-handle**插件，这样浏览器中的数据会展示成json格式

## 十五、读取yml中配置的参数 ##

1.  ### @Value ###

![d1d9a1d2e0b64881030e133fdc6e94a9.png][]

### 2. 配置文件 ###

@Data
    @Configuration
    @ConfigurationProperties(prefix = "xxx.xxx.xxx")
    public class ApiAuthProperties {
    
        private String url;
    
        private String checkToken;
    
    }

## 十六、Ribbon ##

### Ribbon用法： ###

1.  在启动类中添加RestTemplate

![6bdeb23a84aae170a193a12d11af736a.png][]

1.  通过RestTemplate进行远程调用

![98604e35eaab86bd926e333331cab805.png][]

### openFeign和Ribbon的区别 ###

openFeign内置了Ribbon，调用的是服务注册中心（Nacos）的服务

Ribbon可以调用第三方接口，需要手动调用

### url中的参数是复杂json，包含数组，对象 ###

需要对一些符号进行编码：\[ \] " : ,

使用ribbon进行接口调用时，url需要使用URI.create(url)

## 十七、根据数据库表生成对应实体类 ##

1.  引入jar包

![56c2b571d364eb80f711926edd18852a.png][]

1.  编写自动生成工具类

FastAutoGenerator.create("jdbc:mysql://localhost:3306/service-driver-user?characterEncoding=utf-8&serverTimezone=GMT%2B8",
                    "root","root")
                    .globalConfig(builder -> {
                        builder.author("作者名").fileOverride().outputDir("导出文件路径");
                    })
                    .packageConfig(builder -> {
                        builder.parent("com.mashibing.serviceDriverUser").pathInfo(Collections.singletonMap(OutputFile.mapperXml,
                                "xxx\\service-driver-user\\src\\main\\java\\com\\mashibing\\serviceDriverUser\\mapper"));
                    })
                    .strategyConfig(builder -> {
                        builder.addInclude("driver_user_work_status");
    
                    })
                    .templateEngine(new FreemarkerTemplateEngine())
                    .execute();

加sql相关的日志

logging:
      level:
        com:
          baomidou:
            mybatisplus: debug
    mybatis-plus:
      configuration:
        log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

## 十八、请求参数 ##

### **@RequestParam** ###

写在params中的参数，接收时使用**@RequestParam**

![93cebe43bcead3f4dcce92528153fa2f.png][]

### **@RequestBody** ###

在body中的，接收时使用**@RequestBody**

![39dfd2c6558a6a493e5e8d4b15104c3e.png][]

### **@PathVariable** ###

在路径中的，接收时使用**@PathVariable**

### **Header** ###

header中的参数，接收时使用HttpServletRequest，httpServletRequest.getHeader("xxx");

## 十九、日期 ##

实体类的中Date不推荐，推荐使用LocalDate

时间转成时间戳：

localDateTime.toInstant(ZoneOffset.*of*(**"+8"**)).toEpochMilli()

使用@JsonFormat注解，需要以下依赖

![7b0684dddb26fc76c95fbada7ce9af7f.png][]

![bf1fc625ffa940ec7beac1809f96b6ab.png][]

## 二十、请求错误码 ##

4开头的是客户端的错误

5开头的是服务端的错误

400：参数有误，比如说日期格式有误

401：权限有误

404：地址有误

## 二十一、idea运行xml中的sql注意事项 ##

勾选bulid project automatically

![62a84a4948df4a74db423e20e131cc26.png][]

按住clt+shift+A，选择Register，勾选compiler.xxx

![cb8c2482272db08e74e1a0eab866520d.png][]

## 二十二、把mapper文件放在resource下，需要配置 ##

![5a1ba28ec51a2474bace806a0df1865e.png][]

## 二十三、数字与字符串 ##

### json格式中的字符串使用getLong获取，可能会导致精度丢失 ###

![9c18b084fd1a0ab3769557aba51a43fb.png][]

可以getString后，通过Long.parseLong转换

### 小数用double存储，还是用字符串存储 ###

如果小数用于计算，用double

如果不用于计算，只用于展示，可以用字符串

## 二十四、设置提交忽略目录 ##

在项目的跟目录下找到.gitignore文件

写项目名/子项目名/target/，这样可以忽略target下所有文件

![5f27f461428ff59aaa20b0b1f7743130.png][]

## 二十五、并发测试 ##

工具：Jmeter

> [https://jmeter.apache.org/][https_jmeter.apache.org]

需要配置环境变量JMETER\_HOME

设置需要的参数

![68336cd5ec7ed93eef50985264379f16.png][]

## 二十六、并发问题 ##

1.  ### 单节点可以使用synchronized加锁 ###

synchronized锁long类型的数据，可以使用：

synchronized(( longNum + "").intern())

![23d59b19483274e1e7bf5e35646ac983.png][]

当调用intern()方法时，如果常量池中已经有这个字符串（根据equals判断），则直接返回

如果常量池中没有，把这个字符串添加进常量池并返回

但是synchronized是jvm级别的，解决不了集群之间的并发问题

### 2. 集群可以使用redisson ###

RLock lock = redissonClient.getLock(lockKey);
    lock.lock(); // 加锁
    lock.unlock(); // 解锁

#### 一个项目启动多次（测试集群部署） ####

1.  添加多个端口号

![c30bf2d9ba330053d2882ecb033a338f.png][]

1.  复制两个项目启动

![04c7bd4eca1c3f8cac0105d3e88fb686.png][]

## 二十七、修改项目名 ##

1.  rename

![f95ae1af6c39329ef66f00068151f2b3.png][]

1.  修改包名

![c2b8485a844ec3b1aa98f18abe65dc70.png][]

1.  修改pom文件

![0982e00142fa4f4c8e7291152dcf3f10.png][]

## 二十八、其他 ##

数据库名可以与服务名保持一致

JSONObject中是否有某个字段，可以用has

复制对象属性：

可以使用BeanUtils.copyProperties(src, dest);

微服务开发时，如果切换网络，可能会导致服务间调用不通了

前后端数据交互，可以使用：SseEmitter

路径中的下划线\_和中划线-的区别：

搜索引擎关于爬虫的优化，建议在路径中使用中划线-

计算机通过外网被访问，需要提供一个外网的ip地址，可以使用**花生壳**产生一个外网ip

接入支付宝支付参考：[https://opendocs.alipay.com/common/02ncur][https_opendocs.alipay.com_common_02ncur]

![b1e50315484733241203a7ebfdf26de1.png][]

[60564dcb10cff3ce0a64677eba230546.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/ea195eac306c490fa154447be4eeadf6.png
[api.xxx.com_courses]: https://api.xxx.com/courses
[9e7046b81c1356e5bc28fbc1aa7bbd23.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/3fbb7c7081934695843276bcc3bb5648.png
[c1c685567df7e96b6607c686cc70cf03.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/ff3af5237c7d4dc3ac494b8dd3af9b1a.png
[d0b90d4570e04dde1a05191df9b72f2d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/79cf6dd0c26c4675b7ab0586aa0859e4.png
[https_github.com_alibaba_spring-cloud-alibaba_wiki_E7_89_88_E6_9C_AC_E8_AF_B4_E6_98_8E]: https://github.com/alibaba/spring-cloud-alibaba/wiki/%E7%89%88%E6%9C%AC%E8%AF%B4%E6%98%8E
[10e08331684bb5d111f4b369af216b19.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/21e8ffdb103648c2879b16b8a74dffd9.png
[abc3eec5614b38541f5b27e2e659d568.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/862f4e17fc3044fdae3278f10f47eafa.png
[ebee5022351f481ac236b213df95329f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/eb27795666544e5f8a5874a18e846733.png
[https_jwt.io]: https://jwt.io/
[f3f0caf9292924424e537607f5ad7fc1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/3455f0e135fd4ba18395c79b6b168629.png
[f43689caf498b33d6c29c07420b6bce7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/c092a543d7374500a7c2256acabb38fe.png
[213b0a2ec299884fd495fd90babfdfd2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/cb6cac0e5a0e4a42878c39e737304d96.png
[d1d9a1d2e0b64881030e133fdc6e94a9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/45ead5519ece4c4cb56a07fbb7f3dac9.png
[6bdeb23a84aae170a193a12d11af736a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/af8c02b9b7a14bfd967f1005a33ef75a.png
[98604e35eaab86bd926e333331cab805.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/9e655c9dc0c9428aa864d8ef39080153.png
[56c2b571d364eb80f711926edd18852a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/41b144827c384905bc301dee28e0563a.png
[93cebe43bcead3f4dcce92528153fa2f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/d36df06bbb564f6fa65e0df9aa0f72b6.png
[39dfd2c6558a6a493e5e8d4b15104c3e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/fdca5800c8154b32b97342a6c4ff5f98.png
[7b0684dddb26fc76c95fbada7ce9af7f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/36232994ae04467a94ae8aa30f1ca7cf.png
[bf1fc625ffa940ec7beac1809f96b6ab.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/256e3fc06b7147f3aee2ddc736a141f7.png
[62a84a4948df4a74db423e20e131cc26.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/42cfcfde7c0940538b420fa1b4eae9c2.png
[cb8c2482272db08e74e1a0eab866520d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/aea7660f8cab405eb1ca21e119161f63.png
[5a1ba28ec51a2474bace806a0df1865e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/99d988b7c9f640f8ae6504d34f886828.png
[9c18b084fd1a0ab3769557aba51a43fb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/931bf4b1e614401cb86fe3335bea4bc9.png
[5f27f461428ff59aaa20b0b1f7743130.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/b40a841322fe4bb691dd8b70e6d85226.png
[https_jmeter.apache.org]: https://jmeter.apache.org/
[68336cd5ec7ed93eef50985264379f16.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/dc88b9e79c60432397646d4e688c042c.png
[23d59b19483274e1e7bf5e35646ac983.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/d0dd251a64a24307af6e1da087854c5f.png
[c30bf2d9ba330053d2882ecb033a338f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/d3c4225d3e2c454c9daa6c828b5d304d.png
[04c7bd4eca1c3f8cac0105d3e88fb686.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/d7168eb788504d1e8177188773561249.png
[f95ae1af6c39329ef66f00068151f2b3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/cc83e25bf8cc4928b308480b1bdf9623.png
[c2b8485a844ec3b1aa98f18abe65dc70.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/d6ab5604bf764af6bb2e4a5981b82cf6.png
[0982e00142fa4f4c8e7291152dcf3f10.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/b577c7b7822247798e1a1be3d0b15c52.png
[https_opendocs.alipay.com_common_02ncur]: https://opendocs.alipay.com/common/02ncur
[b1e50315484733241203a7ebfdf26de1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/2663272c28ad48ce8314cf3e97cdcd1e.png