工作了半年多,主管分了几个spring boot微服务给我,让我做服务owner,负责服务整体的维护。
作为服务owner,除了开发代码外,还要从大的方面把握我们自己项目/微服务代码的质量,提升之后开发效率。 这些东西都是一开始就要把控好,让大家默认去遵循的。
下面这些只是作为新人程序员想到的以及我们自己的微服务已经在遵循的一些规范准则,每个规则的具体实现还需要深入学习。 后面也打算单独写帖子去总结。
-
项目依赖通过一个专门的父module统一管理,方便后续进行统一替换/开源整改。开源软件出现漏洞,能方便快速的进行替换。 典型的如21年的log4j漏洞。
-
代码规范方面
-
代码格式checkStyle统一
-
引入代码静态检查工具(codecheck或codedex fossbot jacoo_junit buildcheck、cetrmics等) 不满足要求的不允许合入。
-
包括前端项目可以使用ESLint进行检查
-
-
接口满足restful风格, 在REST中的一切都被认为是一种资源。 每个资源由URI标识。 使用统一的接口
-
引入参数校验框架 如Validator,对参数进行校验
-
·根据某种分层策略,完善处理错误代码
-
代码注释
-
风格统一
-
注释一定不能少,尤其是类class的注释
-
-
不要重复造轮子
-
-
数据库、微服务一定设置好时区,关键是保持一致。 数据库设计时间的字段统一就用dateTime 存入数据库的统一是UTC时间。 时间不一致, 涉及国际站国内站的整改的时候,会很麻烦。
-
做好代码review,review 代码不管是对自己还是对被review的人,都是一个很好的学习过程。
-
将review意见抽取为公共模板,提升review效率。 比如:无用代码删除、代码格式化、接口兼容性、魔鬼数字/硬编码、多线程问题、命名问题、存在注入风险、抽取为公共方法、超大函数拆分、使用公共方法/工具类等等
-
-
代码日志的处理
-
一定多添加日志,方便定位
-
slf4j log.info 、log.error 打印日志 统一采用 [类名][方法名] 详细信息,方便 定位
-
不要在日志中打印敏感信息
-
现网输出的日志要有线程号
-
-
版本管理工具git使用
-
公共代码仓
-
通过正则校验commitMessage的格式, 比如某个 需求单号+改动信息
-
禁止向公共仓强推
-
-
拉取代码的时候,通过rebase进行合并, 保证版本树清晰
-
开发人员在本地对同一个功能可能会提交很多次,向公共仓推时,要把重复的提交点(干同一件事情的提交点)合并。
-
每个提交点功能单一。
-
每个提交点编译尽量保证不出错,单独checkout出来都是可用的.
-
持续完善中。。。。



