2022年8月24日 实际开发中需要注意的规范总结

记录一下开发的时候自己认为需要注意的规范，数量不多，但是犯过几次错，记下来就是为了不在犯错。

开发规范：

1、使用的常量是否需要提出来，写进常量类

2、被复用的变量，可以考虑包装进复用类，例如抽象类被多个类继承，多个类使用了几个一样的变量，直接放在抽象类中，避免重复set或者定义

3、数据表设计的时候，考虑最大情况下的容量，选择合适的数据类型

4、功能实现时，优先考虑组件的复用，降低编码量

5、mybatis的实体类最好与数据库中的表字段相对应，提高可读性

6、部分配置直接写在properties中，利用配置中心实现动态的配置更新

7、考虑复杂情况，比如多个请求同时调用这个模块，分析极端情况代码是否会出现问题。

8、报错的日志里需要记录关键信息，如docNo，UUID，报错的堆栈信息，注意log.info提示的格式。报错日志需要记录报错的详细信息，能够辅助排错的信息

9、多条sql执行插入，需要考虑加入事务机制，保证全部插入完成

10、提示信息，如果与定义的变量挂钩，需要将提示信息也取变量，避免后续该变量调整，需要再去修改提示。如查询数据超过1w条不允许用户下载文件，那么提示的message则读定义1w的变量，避免修改1w的限制时，还要再去修改提示方法

11、录入接口平台，注意哪些参数不能为空（哪些是必要的参数），返回类型如何，前端需要如何处理

12、返回给前段的数据一般都会自定义一个Result去包装一下，返回给前端

13、前端传参，有一般用的是GET以及POST，GET请求的参数，一般跟随在地址的后面，但是不安全，数据长度受限，多数情况下采用POST方法传参，把参数放在ResponseBody中，并将ContentType 设置为 application/json 后端使用结构相同的参数类接受参数，用@RequestBody 修饰controller方法的形参，即可得到参数对应的对象。

 

写一点题外话：

在上了两个月的班，感觉自己的成长速度远远不够，虽然代码能写了，但是排错不够快，对整个项目的业务逻辑了解的都不够彻底，希望自己能够加快成长速度，一个小需求，也要写两个礼拜，别人不说，自己都会不好意思，有点高学历，低能的感觉。多学习，同进步！