编码规范.md

日志打印规范

1. 日志打印级别： FATAL > ERROR > WARN > INFO > DEBUG > TRACE 当前项目debug级别已关闭
2. 请求日志：不需要打印，当前项目网关已进行处理、avic-parent-core的链路追踪拦截器TraceFilter也已经处理请求Log
3. 响应日志：暂时没处理，如果都需要开启打印，那么可以实现一个响应后置拦截器ResponseBodyAdvice<Object>，减少业务代码量
4. 业务代码：进行使用占位符进行替换

log.error("参数错误：{}",params);

5. 目前打印日志很少使用LogFactory了，基本都用lombok提供的日志门面，为了减少字节数，降低磁盘IO压力，尽量@Slf4j(topic = "name")

（1）LogFactory默认输出：com.avic.example.log.LogFactoryExample ==> balabalaba
（2）@Slf4j默认输出：c.a.e.l LogFactoryExample ==> balabalaba
（3）@Slf4j(topic = "LogFactoryExample")输出：LogFactoryExample ==> balabalaba

工具类规范

1. 私有构造，禁止new
2. 方法进行静态处理

@NoArgsConstructor(access = AccessLevel.PRIVATE)
public class ExampleUtils {

    public static String demo() {
        return "";
    }
}

枚举规范

1. 属性进行final处理，禁止修改
2. 仅对外提供get方法，禁止set属性

@Getter
@AllArgsConstructor
public enum XxxEnum {

    A(1, "a", "a描述"),

    B(3, "b", "b描述"),

    ;

    //id值，按照老的项目顺位增加
    private final Integer id;

    //名称
    private final String name;

    //描述
    private final String description;

    public static ChannelEnum getChannel(Integer id) {
        return EnumUtil.getBy(ChannelEnum::getId, id, JD);
    }
}

软件架构分包规范

1. github找的现成的图，无视eden-demo-layer
2. 若有想法，可以自己去学习，里面还有阿里的cola架构规范demo。Github地址
3. DAO层在当前项目中，叫做repository