Spring Boot 项目命名后缀

1,840 阅读1分钟

做项目命名是关键的一环,清晰的命名可以使项目更易于维护和阅读。

本文整理了Spring Boot项目最常见的后缀命名列表
开发的时候可以根据团队习惯和项目要求从中选取合适的使用

Entity 数据库模型(不推荐,建议不使用后缀)

UserEntity.java
BookEntity.java
TodoEntity.java

Model 数据库模型(不推荐,建议不使用后缀)

UserModel.java
BookModel.java
TodoModel.java

DTO 正确的实践不应该使用DTO后缀,因为DTO(Data Transfer Object)是一个统称,表意模糊

❌ UserDTO.java

Response 代表数据请求返回数据

CarsResponse.java
BooksResponse.java

Resource 代表对外Restful接口返回资源

CarsResource.java
BooksResource.java

Request 代表数据请求

LoginRequest.java
UpdateUserInfoRequest.java

Command 代表请求操作

SendSMSCommand.java
GeneratePdfCommand.java

Assembler 代表从Entity和其他数据装成Resouce的工具类

UserAssembler.java
OrderAssembler.java

Converter 代表各种DTO相互转换的工具类

BookingConverter.java
OrderConverter.java

Mapper 代表各种DTO相互转换的工具类

BookingMapper.java
OrderMapper.java

Repository 数据库产库操作类

BookRepository.java
OrderRepository.java

Configuration 配置类

BookConfiguration.java
OrderConfiguration.java

Controller API对外接口类

BookController.java
OrderController.java

Service 数据操作服务类

BookService.java
OrderService.java

Client 第三方服务调用类,通常用在feign接口类

AwsClient.java
SendGridClient.java

Util 工具类

StringUtil.java
DateUtil.java

Exception 错误异常类

LoginException.java
DatabaseException.java