项目开发规范 -- 自总结
1、url
不要使用驼峰形式,采用中划线
2、不要在service
层直接操作mapper
因为service
层的数据可能来自于关系型数据库MySQL
和非关系型数据库Redis
,将所有数据来源都写在repository
里,这样对service
层来说就进行数据存储解耦了。
3、commit
信息时,格式如下
[提交类型]:提交信息
提交类型有:add
、fix
、delete
、imp
imp用来表示修改配置文件
4、多表查询慎用left join
如果多表查询是为了关联查询,即查询条件包含其他表,就不能使用left join
。否则这个关联查询就失效。自己品味。
关联查询应该直接select * from a,b
5、抛异常信息格式
- 在
infra.constant
新建ErrorCodeConstants
类保存抛错的常量信息 HZERO
中可以在返回消息管理中配置,用于多语言环境;
6、定义不同表的关联关系时,尽量使用code
,有助于后期迁移
因为你用id
做关联的话,迁移数据地时候可能就没这些id
信息了,数据迁移就会非常麻烦
7、涉及头行结构时,只需要俩个controller
,不需要第三个来汇总头行信息,有head
和line
即可
8、所有命名尽量简短,但明意
9、新建表步骤
- 在
Excel
中建立表,生成groovy
文件 - 将
groovy
复制到指定项目的db.script
文件夹中 - 使用脚本在数据库初始化表
10、git merge
只比较俩个分支最新的commit
,不会完整的比较俩个分支的不同
假设服务器上有俩个分支,且这俩个分支的配置是不同的。只要保证最新commit
没有提交配置文件,就可以先把自己远程分支merge
到develop1
分支上,再将develop1
分支的代码merge
到develop2
上。
其中,develop1
分支merge
到develop2
分支上时,是不会改变develop2
分支上的配置文件的。
11、变量命名风格不要以首字母小写第二个字母大写