三、命名规约

【强制】各服务模块工程名统一以服务名—service 形式命名。如 blog-service ，user-service，order-service 等。
【强制】config/ 包下存放系统配置类，自定义配置类可以重载Spring-Boot的各项默认配置。工程里的初始配置类原则上不允许擅自修改，可以添加配置类。配置类名前要加@Configuration 注解，配置类必须以 Configuration 作后缀。
【推荐】工程里默认生成配置属性类 ApplicationProperties 位于 config/，所有属性项在这个类里添加，嵌套属性要在该内部类增加静态类进行属性获取。建议配置文件采用 YAML 格式文件，语义、可读性更友好。
```
foo:
  enabled : true
  servers : www.host1.com,ww.host2.com
  list:
    - name: my name
      description: my description
```

    正例：

       @ConfigurationProperties("foo")

       public class ApplicationProperties {

         private boolean enabled;

         private List<String>servers;

         private final List<MyPojo> list = new ArrayList<>()；    

         public static class MyPojo{

               private String name;

               private String description;

               /***省略 get/set 方法***/

         }

         public List<MyPojo> getList() {

               return this.list;

          }         

          /***省略 get/set 方法***/

       }

【强制】实体类必须放置在 domain/ 包下，类名前添加注解@Entity 或 @Document 根据数据源类型来选择，SQL选用@Entity，MongoDB选用@Document。属性前不加@Column 的话，默认生成的数据列名时属性的全小写单词，要求多单词属性添加@Column定义列名为下划线分割，或属性与列名不符时也要通过@Column自定义列名，跟数据库实际列名对应一致。
【强制】service类必须放置在 service/ 包下，类名前必须通过@Service 注解，原则上必须先定义接口再定义实现类，业务接口以 Service 为后缀，业务实现类以 ServiceImpl 为后缀。DTO相关类要放置在 dto/ 包下，类名以 DTO 为后缀。
【强制】数据库操作类放在 repository/ 目录下，名称后面以 Repository 为后缀。
【强制】Rest API 统一放置在 web/rest 包下，统一以 Resource 为后缀名，若有 VM 对象，应放在vm/ 包下面，以VM为后缀。

三、命名规约

三、命名规约

results matching ""

No results matching ""