MyBatis Spring Boot集成后的数据访问层代码规范

在使用MyBatis和Spring Boot进行项目开发时，遵循一些代码规范和最佳实践可以提高代码的可读性、可维护性和可扩展性。以下是一些建议的代码规范：

1. 目录结构：

   • 按照Maven或Gradle的标准目录结构组织代码。
   • 将Java代码放在src/main/java目录下，资源文件（如配置文件、SQL映射文件等）放在src/main/resources目录下。

2. 包结构：

   • 通常将包结构分为以下几个部分：controller、service、dao、entity、mapper、config等。
   • 例如：com.example.demo.controller、com.example.demo.service、com.example.demo.dao等。

3. 命名规范：

   • 类名、接口名、方法名采用驼峰命名法，首字母大写。
   • 变量名、参数名采用驼峰命名法，首字母小写。
   • 常量名全部大写，单词间用下划线分隔。
   • 测试类和测试方法以Test结尾。

4. 注解和配置：

   • 使用Spring Boot的自动配置功能，尽量避免手动编写配置文件。
   • 使用@Mapper注解标注MyBatis的Mapper接口。
   • 使用@Service注解标注服务层类。
   • 使用@Autowired注解进行依赖注入。

5. 代码风格：

   • 保持代码整洁，避免过长的行和过多的空行。
   • 使用有意义的变量名和方法名，避免使用单个字母作为变量名。
   • 适当添加注释，特别是对于复杂的业务逻辑和算法。
   • 使用try-catch语句处理异常，并在catch块中记录日志。

6. 实体类：

   • 使用 Lombok 库的 @Data 注解简化 getter 和 setter 方法的编写。
   • 为实体类添加 @TableName 注解，指定对应的数据库表名。

7. Mapper接口：

   • 继承 BaseMapper 接口，以获得基本的 CRUD 操作方法。
   • 根据需要编写自定义的 SQL 查询方法。

8. Service层：

   • 使用 @Service 注解标注服务类。
   • 使用 @Autowired 注解注入 Mapper 接口。
   • 编写业务逻辑方法，调用 Mapper 接口进行数据访问。

9. Controller层：

   • 使用 @RestController 注解标注控制器类。
   • 使用 @Autowired 注解注入 Service 类。
   • 编写 RESTful API 方法，调用 Service 层进行业务处理。

遵循以上代码规范和最佳实践，可以提高代码的质量和可维护性。在实际项目中，还需要根据团队的具体情况和项目需求进行调整。