菜鸟从0学微服务——MyBatis-Plus

关于“菜鸟从0学微服务”

针对有编程基础，开始学习微服务的同学，我们陆续推出从0学微服务的笔记分享。力求从各个中间件的使用来反思这些中间件的作用和优势。

会分享的比较快，会记录demo演算和中间件的使用过程，至于细节的理论知识请自主查阅相关资料并学习。满是干货，注意查收。

本期我们开始学习MyBatis-Plus。

基础概念

为什么选择 MyBatis-Plus？

1. 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
2. 损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作
3. 强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求
4. 支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错
5. 支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题
6. 支持 ActiveRecord 模式：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD 操作
7. 支持自定义全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）
8. 内置代码生成器：采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用
9. 内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询
10. 分页插件支持多种数据库：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库
11. 内置性能分析插件：可输出 SQL 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询
12. 内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作

学习 MyBatis-Plus 的步骤

1. 了解 MyBatis 基础：虽然 MyBatis-Plus 是 MyBatis 的增强版，但建议先了解 MyBatis 的基本原理和用法，这有助于更好地理解 MyBatis-Plus。

2. 阅读官方文档：MyBatis-Plus 的官方文档是学习的最佳资源，包含了安装、配置、使用、插件等各方面的内容。

3. 搭建开发环境：可以使用 Spring Boot 快速搭建一个 MyBatis-Plus 的开发环境，并尝试运行一些示例代码。

4. 学习 CRUD 操作：MyBatis-Plus 提供了丰富的 CRUD 方法，包括基本的增删改查以及批量操作等，需要熟练掌握。

5. 掌握条件构造器：MyBatis-Plus 的条件构造器是其一大亮点，可以很方便地构造复杂的 SQL 语句，需要重点学习。

6. 使用插件：了解并尝试使用 MyBatis-Plus 提供的各种插件，如分页插件、性能分析插件等，以提高开发效率和系统性能。

7. 实践项目：通过参与实际项目，将 MyBatis-Plus 应用到具体的业务场景中，以加深对其的理解和掌握。

HelloWorld

由于本文阅读对象是已经有其他语言或框架的编程基础的人，所以我们快速的开始一个Demo来变做变学，以战代练。

我们创建一个MP项目，环境选择：

jdk选择了1.8，spring boot版本2.6.13，mysql5.7

工程目录

pom.xml

<properties>         <java.version>1.8</java.version>         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>         <spring-boot.version>2.6.13</spring-boot.version>     </properties>     <dependencies>         <dependency>             <groupId>org.springframework.boot</groupId>             <artifactId>spring-boot-starter</artifactId>         </dependency>          <!-- Spring Boot Starter Web (如果你需要Web支持) -->         <dependency>             <groupId>org.springframework.boot</groupId>             <artifactId>spring-boot-starter-web</artifactId>         </dependency>          <!-- MySQL JDBC 驱动 -->         <dependency>             <groupId>mysql</groupId>             <artifactId>mysql-connector-java</artifactId>             <version>8.0.29</version> <!-- 使用与MySQL 5.7兼容的8.0.x版本 -->         </dependency>          <!-- MyBatis-Plus -->         <dependency>             <groupId>com.baomidou</groupId>             <artifactId>mybatis-plus-boot-starter</artifactId>             <version>3.5.1</version> <!-- 使用一个与Spring Boot 2.x兼容的版本 -->         </dependency>          <dependency>             <groupId>org.springframework.boot</groupId>             <artifactId>spring-boot-starter-test</artifactId>             <scope>test</scope>         </dependency>     </dependencies>

application.properties

# 应用服务 WEB 访问端口 server.port=8080 # 数据库连接信息 spring.datasource.url=jdbc:mysql://localhost:3316/mytest?useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC spring.datasource.username=root spring.datasource.password=**** spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

StudentMapper

package com.example.mp.repository.mapper;  import com.example.mp.model.Student; import org.apache.ibatis.annotations.Mapper;  @Mapper public interface StudentMapper {     Student findById(Long id);      void save(Student student);      void update(Student student);      void delete(Long id); } 

 @Mapper注解是MyBatis框架中的一个注解，用于标识一个接口为MyBatis的Mapper接口。MyBatis的Mapper接口用于定义数据库操作的方法，这些方法可以通过XML文件或注解来定义SQL语句。

以下是@Mapper注解的一些主要用途：

1. 自动扫描Mapper接口： 当你使用@Mapper注解标记一个接口时，MyBatis会自动扫描这个接口，并将其注册为一个Mapper。这意味着你不需要手动配置Mapper接口的位置。

2. 简化SQL语句的定义： 在Mapper接口中，你可以使用注解来定义SQL语句，而不需要编写XML文件。例如，你可以使用@Select、@Insert、@Update和@Delete注解来定义查询、插入、更新和删除操作。

3. 支持动态SQL： MyBatis的Mapper接口支持动态SQL，这意味着你可以在SQL语句中添加条件、循环等逻辑，以适应不同的查询需求。

以下是一个使用@Mapper注解的例子：

@Mapper public interface StudentMapper {     @Select("SELECT * FROM students WHERE id = #{id}")     Student findById(Long id);      @Insert("INSERT INTO students(name, age) VALUES(#{name}, #{age})")     void save(Student student);      @Update("UPDATE students SET name=#{name}, age=#{age} WHERE id=#{id}")     void update(Student student);      @Delete("DELETE FROM students WHERE id=#{id}")     void delete(Long id); } 

但是看到我之前贴的代码里，SQL语句并不包含在接口代码中，那么SQL去哪里了呢？其实刚才说了，@Mapper注解也可以通过XML文件定义SQL语句。细心点的可以看到工程目录里，有个src/main/resources/mapper/StudentMapper.xml，通过@Mapper注解可以关联到他。

StudentMapper.xml

<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE mapper         PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"         "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="com.example.mp.repository.mapper.StudentMapper">      <select id="findById" resultType="com.example.mp.model.Student">         SELECT * FROM student WHERE id = #{id}     </select>      <insert id="save" parameterType="com.example.mp.model.Student">         INSERT INTO student (id, name, age) VALUES (#{id}, #{name}, #{age})     </insert>      <update id="update" parameterType="com.example.mp.model.Student">         UPDATE student SET name = #{name}, age = #{age} WHERE id = #{id}     </update>      <delete id="delete" parameterType="Long">         DELETE FROM student WHERE id = #{id}     </delete>  </mapper>

在MyBatis（包括MyBatis-Plus）中，Mapper的XML文件提供了一种灵活的方式来定义SQL语句，特别是当SQL语句变得复杂或需要动态构建时。这种方法允许开发者将SQL语句与Java代码分离，使得SQL语句的编写、修改和调试变得更加容易。

写在XML里的好处

1. 分离关注点：将SQL语句与Java代码分离，使得代码更加清晰，也更容易维护。
2. 灵活性：XML文件支持复杂的SQL语句，包括动态SQL（如<if>、<choose>、<when>、<otherwise>、<foreach>等标签），可以轻松地处理各种复杂的查询和更新逻辑。
3. 可读性：对于复杂的SQL语句，使用XML文件可以提高可读性，特别是当SQL语句很长或包含多个条件时。
4. 重用性：XML中的SQL语句可以被多个Mapper接口方法重用，减少了代码重复。

流行性和推荐性

在MyBatis社区中，使用XML文件来定义SQL语句是非常流行和推荐的做法。尽管MyBatis-Plus提供了许多便捷的CRUD操作和条件构造器，但在处理复杂查询和更新时，XML文件仍然是一个强大的工具。

如何使用

1. 定义Mapper接口：首先，你需要定义一个Mapper接口，该接口中的方法将对应于XML文件中的SQL语句。

2. 编写XML文件：然后，在src/main/resources目录下的相应包路径中创建一个XML文件，文件名需要与Mapper接口的全路径名相同，但后缀为.xml。

3. 映射SQL语句：在XML文件中，使用<mapper>标签作为根元素，并使用<select>、<insert>、<update>、<delete>等标签来定义SQL语句。你可以使用id属性来指定该SQL语句对应的Mapper接口中的方法名。

4. 使用动态SQL：如果SQL语句需要根据条件动态构建，可以使用MyBatis提供的动态SQL标签（如<if>、<choose>等）来实现。

5. 配置Mapper扫描：确保你的MyBatis或MyBatis-Plus配置中包含了Mapper接口的扫描路径，这样MyBatis才能找到并加载这些Mapper接口及其对应的XML文件。

6. 在Service层调用：最后，在你的Service层中，你可以像调用普通Java方法一样调用Mapper接口中的方法，MyBatis会自动将调用转发到对应的SQL语句并执行。

三个核心字段说明

Mapper Namespace

mapper namespace在MyBatis中是一个标识符，用于唯一标识一个Mapper接口。它通常设置为Mapper接口的全限定名（即包含包名的类名）。例如，如果你的Mapper接口路径位于com.example.mp.repository.mapper.StudentMapper，那么mapper namespace就应该是"com.example.mp.repository.mapper.StudentMapper"。

resultType

resultType是MyBatis中用于指定SQL查询返回结果应该被映射到的Java类型的别名或全限定名。它并不直接对应于项目中的一个层或包，而是与你的Java模型（Model）类相关。在例子中，resultType="om.example.mp.model.Student"表示查询结果应该被映射到om.example.mp.model.Student类。

parameterType

其实还有第三个字段parameterType，主要就是SQL入参的类型。比如：

<!-- 查询单个用户 -->   <select id="selectUserById" resultType="com.example.User">     SELECT * FROM users WHERE id = #{id}   </select>

在这个例子中，resultType被设置为com.example.User，这意味着查询结果将被映射到User类的实例中。这里不需要（也不应该）设置parameterType，因为MyBatis（包括MyBatis-Plus）可以根据方法参数自动推断出它。但是，如果出于某种原因你想显式地指定它，你可以这样做（尽管这在这个特定例子中是多余的）： 

<!-- 查询单个用户（显式指定parameterType，尽管通常是多余的）-->   <select id="selectUserById" resultType="com.example.User" parameterType="int">     SELECT * FROM users WHERE id = #{id}   </select>

对于单个基本类型参数（如int、long、String等），MyBatis能够自动处理，因此显式指定parameterType通常是不必要的。

StudentService

package com.example.mp.service;  import com.example.mp.model.Student; import com.example.mp.repository.mapper.StudentMapper; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service;  @Service public class StudentService {     @Autowired     private StudentMapper studentMapper;      public void saveStudent(Student student) {         // 检查必要属性是否为空         if (student.getName() != null && student.getAge() > 0) {             // 执行插入操作             studentMapper.save(student);             System.out.println("学生信息插入成功");         } else {             System.out.println("学生信息插入失败，缺少必要属性");         }     } } 

StudentController

package com.example.mp.controller;  import com.example.mp.model.Student; import com.example.mp.service.StudentService; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.*;  @RestController @RequestMapping("/students") public class StudentController {     @Autowired     private StudentService studentService;      @PostMapping     public String addStudent(@RequestBody Student student) {         studentService.saveStudent(student);         return "Student added successfully";     }     @GetMapping     public String addStudent(long id,String name,int age) {         Student student = new Student();         student.setId(id);         student.setName(name);         student.setAge(age);         studentService.saveStudent(student);         return "Student added successfully";     } } 

分别用get，post，body和参数的方式做了实验，结果能成功插入数据库。棒棒哒。

但是我们对MP的学习还没有结束。还有个重要课题，就是构造器。

构造器（Wrapper）

使用构造器方式（Wrapper）是MyBatis Plus提供的一种更灵活的SQL查询方式，它可以帮助你快速构建复杂的查询条件，并生成对应的SQL语句。相比于传统的XML映射文件，使用构造器方式可以减少重复代码，提高代码的可读性和灵活性。

推荐MyBatis-Plus中的Wrapper（包括QueryWrapper、UpdateWrapper、LambdaQueryWrapper和LambdaUpdateWrapper）的理由主要有以下几点：

1. 简化复杂查询和更新条件的构建

• 链式调用：Wrapper提供了丰富的链式函数，允许开发者通过链式调用的方式构建复杂的查询和更新条件。这种方式比传统的XML SQL语句或字符串拼接更加直观和易于维护。
• 类型安全：LambdaQueryWrapper和LambdaUpdateWrapper通过Lambda表达式的方式引用实体类的属性名，避免了手写字段名字符串可能带来的拼写错误和不易维护的问题，提高了代码的类型安全性。

2. 提高开发效率

• 减少模板代码：使用Wrapper可以显著减少重复的代码模板，使得开发者能够更加专注于业务逻辑的实现。
• 快速迭代：在快速迭代的开发环境中，Wrapper的灵活性和易用性可以帮助开发者快速构建查询和更新条件，提高开发效率。

3. 易于维护和扩展

• 清晰的代码结构：Wrapper的链式调用方式使得代码结构更加清晰，易于理解和维护。
• 易于扩展：随着业务需求的变化，Wrapper提供的灵活条件构建能力使得开发者可以轻松地扩展查询和更新条件，而不需要对原有代码进行大规模修改。

4. 安全性

• 防SQL注入：虽然Wrapper本身并不直接提供防SQL注入的功能，但MyBatis-Plus在内部对SQL语句进行了预处理和参数绑定，这在一定程度上降低了SQL注入的风险。然而，开发者仍然需要确保传递给Wrapper的参数是安全的，避免将用户输入直接用于构建条件。

Wrapper的使用

若要使用Wrapper来快速实现SQL读写，上面的关于Student的Demo代码，我们可以改造如下：

StudentService

package com.example.application.service;  import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper; import com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper; import com.example.application.mapper.StudentMapper; import com.example.application.model.Student; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service;  import java.util.List;  @Service public class StudentService {      @Autowired     private StudentMapper studentMapper;      public List<Student> findStudentsByName(String name) {         QueryWrapper<Student> queryWrapper = new QueryWrapper<>();         queryWrapper.eq("name", name);         return studentMapper.selectList(queryWrapper);     }      public void updateStudentAge(Long id, int age) {         UpdateWrapper<Student> updateWrapper = new UpdateWrapper<>();         updateWrapper.eq("id", id).set("age", age);         studentMapper.update(null, updateWrapper);     } }

StudentMapper

package com.example.application.mapper;  import com.baomidou.mybatisplus.core.mapper.BaseMapper; import com.example.application.model.Student;  public interface StudentMapper extends BaseMapper<Student> { }

在上面的示例中， StudentService 中的 findStudentsByName 方法使用 QueryWrapper 构造器来构建查询条件，实现根据学生姓名查询学生信息； updateStudentAge 方法使用 UpdateWrapper 构造器来构建更新条件，实现根据学生ID更新学生年龄的操作。

selectList 和 update 方法是基于MyBatis Plus提供的 BaseMapper 接口而来，不需要在Mapper接口中显式定义。

通过使用Wrapper，可以简化SQL查询条件的构建，提高代码的可维护性和可读性。

PS：尽管见识了MP的构造器Wrapper的灵巧和强大，但是我个人而言，潜意识还是很抗拒摆脱SQL的写法，不知道你怎么想？

好了，先到这里，下次《菜鸟从0学微服务》再见！