Spring Boot：MyBatis之MyBatis-Plus的使用

时间：2025-04-27 17:16:34

一.MyBatis-Plus 介绍

MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

官网地址：/，本文大部分内容参考自官网。

特性
官网说的特性太多了，挑了几个有特点的分享给大家。

  • 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑。
  • 损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作。
  • 强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求。
  • 支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错。
  • 支持多种数据库：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer2005、SQLServer
    等多种数据库。
  • 内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询。

二.快速上手

1.准备数据

我们首先设计一个这样的用户表，如下：

id name age email
1 neo 18 smile1@
2 keep 36 smile2@
3 pure 28 smile3@
4 smile 21 smile4@
5 it 24 smile5@

我们要创建两个 Sql 文件，以便项目启动的时候，将表结构和数据初始化到数据库。
表结构文件（）内容：

	DROP TABLE IF EXISTS user;
	
	CREATE TABLE user
	(
		id BIGINT(20) NOT NULL COMMENT '主键ID',
		name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
		age INT(11) NULL DEFAULT NULL COMMENT '年龄',
		email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
		PRIMARY KEY (id)
	);

表数据文件（）内容：

	INSERT INTO user (id, name, age, email) VALUES
	(1, 'neo', 18, 'smile1@'),
	(2, 'keep', 36, 'smile2@'),
	(3, 'pure', 28, 'smile3@'),
	(4, 'smile', 21, 'smile4@'),
	(5, 'it', 24, 'smile5@');
2.添加依赖

添加相关依赖包， 中的相关依赖内容如下：

	<dependencies>
		<dependency>
			<groupId></groupId>
			<artifactId>lombok</artifactId>
			<optional>true</optional>
		</dependency>
		<dependency>
			<groupId></groupId>
			<artifactId>mybatis-plus-boot-starter</artifactId>
			<version>3.1.1</version>
		</dependency>
		<dependency>
			<groupId>com.h2database</groupId>
			<artifactId>h2</artifactId>
			<scope>runtime</scope>
		</dependency>
		<dependency>
			<groupId></groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
	</dependencies>
  • lombok：帮忙省略掉 Get/Set 方法，具体可以参考这篇文章。
  • mybatis-plus-boot-starter：MyBatis Plus 的依赖包。
  • h2：本次测试我们使用内存数据库 h2 来演示。
  • spring-boot-starter-test：Spring Boot 的测试包。
3.配置文件
	# DataSource Config
	spring:
	    datasource:
	        driver-class-name: org.
	        schema: classpath:db/
	        data: classpath:db/
	        url: jdbc:h2:mem:test
	        username: root
	        password: test
	
	# Logger Config
	logging:
	    level:
	      : debug

配置了 h2 数据库，已经项目的日志级别。配置 schema 和 data 后，项目启动时会根据配置的文件地址来执行数据。

4.业务代码

创建 MybatisPlusConfig 类，指定 Mapper 地址，启用分页功能。

	@Configuration
	@MapperScan("")
	public class MybatisPlusConfig {
	
	    /**
	     * 分页插件
	     */
	    @Bean
	    public PaginationInterceptor paginationInterceptor() {
	        return new PaginationInterceptor();
	    }
	}

创建实体类 User：

	@Data
	public class User {
	    private Long id;
	    private String name;
	    private Integer age;
	    private String email;
	}

@Data 为 lombok 语法，自动注入 getter/setter 方法。
接下来创建对象对于的 Mapper。

	public interface UserMapper extends BaseMapper<User> {
	}
5.测试

创建 MyBatisPlusTest 类，注入上面创建的 UserMapper 类。

	@RunWith()
	@SpringBootTest
	public class MyBatisPlusTest {
	    @Autowired
	    private UserMapper userMapper;
	}

测试查询单挑数据，并输出：

	@Test
	public void testSelectOne() {
	    User user = (1L);
	    (user);
	}

测试添加数据：

	@Test
	public void testInsert() {
	    User user = new User();
	    ("微笑");
	    (3);
	    ("neo@");
	    assertThat((user)).isGreaterThan(0);
	    // 成功直接拿会写的 ID
	    assertThat(()).isNotNull();
	}

assertThat() 是 Assert 的一个精通方法，用来比对返回结果，包来自 import static ;。
测试删除数据：

	@Test
	public void testDelete() {
	    assertThat((3L)).isGreaterThan(0);
	    assertThat((new QueryWrapper<User>()
	            .lambda().eq(User::getName, "smile"))).isGreaterThan(0);
	}

QueryWrapper 是 MyBatis-Plus 内部辅助查询类，可以使用 lambda 语法，也可以不使用。利用 QueryWrapper 类可以构建各种查询条件。
测试更新数据：

	@Test
	public void testUpdate() {
	    User user = (2);
	    assertThat(()).isEqualTo(36);
	    assertThat(()).isEqualTo("keep");
	
	    (
	            null,
	            Wrappers.<User>lambdaUpdate().set(User::getEmail, "123@123").eq(User::getId, 2)
	    );
	    assertThat((2).getEmail()).isEqualTo("123@123");
	}

测试查询所有数据：

	@Test
	public void testSelect() {
	    List<User> userList = (null);
	    (5, ());
	    (::println);
	}

测试非分页查询：

	@Test
	public void testPage() {
	    ("----- baseMapper 自带分页 ------");
	    Page<User> page = new Page<>(1, 2);
	    IPage<User> userIPage = (page, new QueryWrapper<User>()
	            .gt("age", 6));
	    assertThat(page).isSameAs(userIPage);
	    ("总条数 ------> " + ());
	    ("当前页数 ------> " + ());
	    ("当前每页显示数 ------> " + ());
	    print(());
	    ("----- baseMapper 自带分页 ------");
	}

查询大于 6 岁的用户，并且分页展示，每页两条数据，展示第一页。

参考文章：/springboot/2019/05/14/

相关文章