MyBatis在SpringBoot2中的代码风格规范

在Spring Boot 2中使用MyBatis时，遵循一定的代码风格规范可以提高代码的可读性和可维护性。以下是一些建议的代码风格规范：

1. 命名规范：

• 类名：使用大驼峰命名法，首字母大写，每个单词的首字母都大写。例如：UserMapper.java。
• 方法名：使用小驼峰命名法，首字母小写，每个单词的首字母都大写。例如：selectUserById。
• 变量名：使用小驼峰命名法，首字母小写，每个单词的首字母都大写。例如：userDao。
• 属性名：使用小驼峰命名法，首字母小写，每个单词的首字母都大写。例如：userId。

2. 代码缩进：

• 使用4个空格进行缩进，避免使用制表符（Tab）。
• 方法内部的代码块应有一个额外的缩进级别。

3. 注释规范：

• 使用JavaDoc标准注释格式编写类和方法的注释。
• 注释内容应简洁明了，描述方法的功能、参数和返回值等信息。
• 避免使用过长的注释，尽量保持在一行以内。

4. 配置文件规范：

• MyBatis的配置文件（如application.yml或application.properties）应与主类位于同一包或其子包中。
• 配置文件的键值对应保持简洁明了，避免冗余。

5. XML映射文件规范：

• XML映射文件的命名应以Mapper为后缀，例如：UserMapper.xml。
• XML映射文件应与对应的Mapper接口位于同一包或其子包中。
• 使用<mapper>标签包裹整个映射文件，并在其中声明namespace属性，其值应与Mapper接口的完全限定名相同。
• 使用<select>、<insert>、<update>和<delete>标签定义SQL语句，并在其中声明id属性，其值应与Mapper接口中的方法名相同。
• 使用<resultMap>标签定义结果映射，并在其中声明id和type属性，分别表示结果映射的ID和对应的实体类。

6. 依赖规范：

• 在项目的pom.xml或build.gradle文件中，添加MyBatis和Spring Boot相关依赖。
• 确保依赖版本与项目兼容，避免使用过时的版本。

遵循以上代码风格规范，可以使你的Spring Boot 2项目中的MyBatis代码更加整洁、易读和可维护。