java代码开发规范
目录
- 风格指南
- 相关工具
- 开发规范
- 日志规范
- 链路追踪规范
- 其他命名规范
- 分支管理
- 项目与服务名称
- 镜像规范
- 参考资料
啦啦啦~~我不生产规范，我只是规范的搬运工
风格指南
代码风格以google code style为 标准，规范内容:
- 英文原文: https://google.github.io/styleguide/javaguide.html
- 中文参考: https://github.com/fantasticmao/google-java-style-guide-zh_cn/blob/master/README.md
相关工具
- intellij idea 插件
插件市场搜索google-java-format下载安装，使用Ctrl+Alt+L格式化代码即可满足大多数风格指南； - eclipse 插件
下载google-java-format-eclipse-plugin-1.13.0.jar到eclipse安装目录下的dropins目录，重启eclipse.
Window > Preferences > Java > Code Style > Formatter > Formatter Implementation 可以查看和配置插件。
开发规范
- 编码过程需遵循
阿里巴巴Java开发手册，其中与风格指南冲突的部分，以风格指南为准。下载地址: 阿里巴巴Java开发手册； - 编码完成后，需执行
sonarQube静态扫描，消除所有bug、漏洞与异味后方可提交。操作方式参考: SonarQube代码扫描操作指南
日志规范
为满足日志收集需求，日志格式需满足给定的要求: 日志开发指南
链路追踪规范
为满足链路追踪需求，对项目依赖项以及线程切换有给定的要求:链路追踪系统Skywalking接入说明
其他命名规范
分支管理
按主版本和客户版本分类，客户版本增加前缀用于区分，如下表格：
| 类型 | 主分支 | 开发分支 | 特性分支 |
|---|---|---|---|
| 内部 | main | dev | feature_功能点 |
| 客户-sk | sk_main | sk_dev | sk_feature_功能点 |
项目与服务名称
项目与服务名称统一使用小写字母+横杠连接，正确示例:
space-fence
镜像规范
- 常规开发版本
镜像命名规范为"项目名称/模块名称:3位版本号"，版本号与开发迭代版本号一致。正确示例:
iot/space-fence:V1.0.1 - 对外发布版本
镜像命名规范为"项目名称/模块名称:stable-3位版本号"，正确示例:
iot/space-fence:stable-1.0.1
参考资料
- google-java-format
- alibaba java coding guidelines