前有阿里巴巴开发手册,但是我觉得并不是100%切合我实际项目中的需求,所以有了这篇文章。可能我有点啰嗦,希望不要失去耐心哈。

1、常量定义使用public final class ***Constants声明,不允许使用interface。并且需要声明一个私有的构造器,防止类被实例化,在私有构造器中抛出异常是为了防止通过反射的方式创建实例,示例如下。

public final class DeviceStateConstants {
    private DeviceStateConstants() {
        throw new AssertionError("No DeviceStateConstants instances for you!")
    }
    public static final String ENABLE = "1";
    public static final String DISABLE = "0";
}

2、提交代码前一定要先pull一下最新代码,避免产生不必要的合并。如果实在运气不好,还是有冲突,可以选择使用rebase,rebase的唯一缺点就是会使得时间线错位,可以接受的话选用rebase可以让提交树看起来特别的舒服。

3、文档注释的标签不能用javadoc不允许的,否则在生成文档的时候会报错。例如很多人喜欢的@date,我是觉得在代码中写创建日期用处不大,毕竟版本控制系统也能记得你什么时候第一次提交的这个文件,也就知道了你什么时候创建的。

4、依赖尽量不在父依赖中指定,父依赖只配置版本号等信息,等到真正使用的时候再引入。

5、数据表基础字段,建议写成BaseEntity,所有实体类继承之。

CREATE TABLE BASE (
    id BIGINT ( 20 ) PRIMARY KEY,
    owner_id BIGINT ( 10 ) NULL,
    owner_name VARCHAR ( 50 ) NULL,
    creation_date datetime DEFAULT NULL,
    modifier_id BIGINT ( 10 ) NULL,
    modifier_name VARCHAR ( 50 ) NULL,
    modified_date datetime DEFAULT NULL,
    is_active CHAR ( 1 ) NULL 
);
最后修改:2021 年 07 月 12 日 01 : 42 PM