MyBatis-plus 初体验

搞 Java 后端开发的都知道，Java 技术栈曾经广泛使用的持久层框架是 Hibernate ，缺点是使用非常复杂，然后最近比较火的是 MyBatis ，虽然简单了不少，但这玩意是通过 xml 去拼接 sql 语句，因此需要手写大量的 xml 文件。这几天本人了解到了 MyBatis-plus，一个 Mybatis 增强工具包。经过一番研究，发现这玩意真的好用，不用写任何 xml ，内置通用的 Mapper ，而且完全是面向对象编程，文档给的示例代码，跟之前用过的 sequelize (Node.js 的 ORM) 非常像，因此本人也尝试了一把。

1. 初始化 SpringBoot 项目

首先使用 Spring Initializer 脚手架初始化一个 SpringBoot 项目。然后在 pom.xml 中添加相关的依赖：

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <scope>runtime</scope>
</dependency>
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.20</version>
</dependency>
 <dependency>
     <groupId>com.baomidou</groupId>
     <artifactId>mybatis-plus-boot-starter</artifactId>
     <version>3.4.2</version>
</dependency>

mysql 依赖用于连接数据库；为了简化代码，添加了 lombok 依赖，用于减少 getter、setter 等方法

2. 创建数据表

创建用于测试的数据库及相应的数据表

这边用于测试的数据库名为 fin-services ，数据表名为 users

3. 在 application.yml 中配置 mysql 信息

url 的格式：jdbc:mysql://[ip]:[port]/[db name]

4. 编写用于测试的实体类

5. 编写操作实体类的 Mapper 类

这里直接继承 BaseMapper 类 (mybatis-plus 封装好的类)

6. 启动类中扫描 Mapper 类

在启动类中添加 @MapperScan 注解

里面的参数是 mapper 文件夹的路径

7. 写一个测试类

最后写一个测试类测试一下

运行一下这个测试方法，成功拿到查询数据

这边顺便说几个编码的小技巧。这边核心的查询语句其实就是：

List<Users> usersList = usersMapper.selectList(null);

在编写代码的时候，只需要输入 usersMapper.selectList(null).var ，然后按回车，编辑器会自动进行代码补全：

然后编写 for 循环的语句，对需要进行循环的变量输入 usersList.for ，然后按回车，编辑器会自动进行代码补全：

对变量打印输出，只需要输入 users.sout ，然后按回车，编辑器会自动进行代码补全：

8. 配置日志

想要查看执行的 sql 语句，可以在 yml 文件中添加配置信息：

mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

如下图所示，执行时会打印出 sql 语句：

9. 遇到的两个坑

之前本人用的 lombok 1.18.10 ，项目运行的时候报了一个错误：

java: java.lang.IllegalAccessError: class lombok.javac.apt.LombokProcessor (in unnamed module @0x55a9b697) cannot access class com.sun.tools.javac.processing.JavacProcessingEnvironment (in module jdk.compiler) because module jdk.compiler does not export com.sun.tools.javac.processing to unnamed module @0x55a9b697

查了下是因为 lombok 1.18.10 与 Java16 不兼容，改用最新版本 1.18.20 解决。可以直接到 maven 官网查询依赖库的最新版本：https://mvnrepository.com/artifact/org.projectlombok/lombok

然后还有一个错误：

org.springframework.jdbc.BadSqlGrammarException:
### Error querying database. Cause: java.sql.SQLSyntaxErrorException: Table ‘fin-services.user’ doesn’t exist

这是因为之前实体类的类名为 User ，而数据库的表名是 users 。将实体类的类名改为 Users 解决。实体类的类名，需要与数据库的表名对应

10. 总结

现在可以实现不带条件的数据库的查询，后续会补充一下查询条件的使用。为了实现完整的后端服务，还需要实现如下功能：

• 使用 MyBatis-Plus 实现 CURD;
• 进行统一参数校验；
• 后台生成 token ，对请求进行 token 校验
• 后台封装统一响应体 ServerResponse ,统一异常处理

参考：

MyBatis-Plus 用起来真的很舒服
MyBatis-Plus 官方文档
MyBatis-Plus 简单的查询操作
springboot 项目封装：统一结果，统一异常，统一日志
SpringBoot统一响应体解决方案
Java enum常见的用法
JAVA ENUM的用法详解
Java枚举类，你真的了解吗？
TypeScript 枚举类型用法示例