Java编程规范（三）

Java编程规范（三）

1 代码分支管理规范

1.1 概述

合并分支用于在同一环境下同一个项目需要联调多个特性功能时使用，仅用于Jenkins部署，不允许进行merge

1.2 代码提测拉分支流程

• 1、release分支合并到develop分支
• 2、release分支版本号由snapshot改为release、release分支合并到master分支、master分支打tag
• 3、从master分支拉新的release分支并升级版本

2 接口版本管理规范

2.1 概述

为满足接口兼容性，业务常用的方法是通过版本号来管理，接口变更后通过维护版本号，新旧接口同时并存，后期逐步移除旧接口。

2.2 接口变更的规范

但因目前系统还未稳定，接口变更比较频繁，维护版本号会导致版本号增加过快，不利于版本管理。因此在系统正式运营前，不采用版本管理制定临时规范，在正式运营后采用版本管理。具体如下：

• 1.新增字段

 在新增字段注释上写明创建说明、创建日期、创建人，例如：
/**
 * 创建人：jys
 * 创建时间：2022年07月05日 12:00:00
 * 创建原因：新增显示字段
 */

• 2.修改字段

 在修改字段上标注@Deprecated，写明注释，一个月后删除，例如：
/**
 * 修改人：jys
 * 修改时间：2022年07月05日 12:00:00
 * 修改原因：优化，修改为新字段
 */
@Deprecated

• 3.删除字段

在删除字段上标注@Deprecated，写明注释，一个月后删除，例如：
/**
 * 删除人：jys
 * 删除时间：2022年07月05日 12:00:00
 * 删除原因：页面变更
 */
@Deprecated

3 参考资料

资料来自于一人一车公司