JAVA开发规范随笔

一：项目管理相关
1、流程规范化：立项–>评估–>排期–>设计–>开发–>测试–>sit–>uat–>上线。每个节点根据情况留档，以备追溯。

2、git分支命名：

master（默认分支）
dev-版本号（版本分支，如dev-1.2.0）
dev-版本号-开发人员（开发分支，如dev-1.2.0-johnson）
fix-版本（修复分支）
二：团队管理相关
1、2-pizza rule

2、开会时明确会议议题，提前和与会人员简介，提高会议的效率。

三：运维管理相关
1、生产环境和测试环境严格隔离，仅运维人员可操作生产环境服务器，特殊情况下可以赋予开发测试人员服务日志读权限。

2、通过NAT配置生产环境和测试环境的机器IP，如:

生产环境内网IP映射为 10.250..-10.250.255.255
测试环境内网IP映射为 10.251..-10.251.255.255
3、统一Linux服务器端口规则，防止端口冲突。

java：8080递增最大至，jmxremote端口在tomcat端口+10000，jdwp端口再tomcat端口+20000。
python：9000递增。
redis集群：7000、7001、7002、7003、7004、7005
四：开发管理相关
1、前后端交互参数，遵循restful风格，参数采用驼峰命名法，分页参数采用pageNum,pageSize， 排序参数采用sort，order，封装到pageBO（@ModelAttribute接收），排序字段后端通过NamingUtils转换成蛇形。
2、Class和method要有作者、时间、解释，复杂逻辑添加必要的注释。
3、表设计尽量符合3NF以上，尽量减少冗余。表名根据业务模块添加前缀，添加表字段说明。尤其枚举类型字段，妥善使用-1，0，1等字段值。
4、数据分页采用pageHelper，禁用内存分页。
5、实体类采用lombok减少代码量。

6、打印日志使用@Slf4j

7、集成swagger以便前端调试。

8、谨慎使用java8 stream处理复杂的业务逻辑，防止大大降低代码可读性。
9、controller(控制器)–>service(业务接口)–>serviceimpl(业务实现)–>persist(持久层)–>mapper(映射)–>xml(sql)