二、入门案例

18 阅读3分钟

开发环境 → 建库建表 → 建工程 → 写代码 → 测试 → 加日志。


MyBatis-Plus 二、入门案例学习文档(SpringBoot版)

1. 学习目标

学完这一章你应该能独立做出一个最小可运行项目:

  • Spring Boot 连接 MySQL
  • 引入 MyBatis-Plus
  • 创建实体 User
  • 创建 UserMapper extends BaseMapper<User>
  • 写一个测试用例 selectList(null) 查询全表数据并打印
  • 开启 SQL 日志查看 MP 生成的 SQL

2. 开发环境

文档建议版本如下(你可以不同,但照着跑最稳):IDEA、JDK8+、Maven、MySQL 5.7、Spring Boot 2.6.3、MyBatis-Plus 3.5.1。


3. 创建数据库与表

按文档创建库 mybatis_plus、表 user,并插入 5 条数据。

CREATE DATABASE `mybatis_plus` DEFAULT CHARACTER SET utf8mb4;
USE `mybatis_plus`;

CREATE TABLE `user` (
  `id` BIGINT(20) NOT NULL COMMENT '主键ID',
  `name` VARCHAR(30) DEFAULT NULL COMMENT '姓名',
  `age` INT(11) DEFAULT NULL COMMENT '年龄',
  `email` VARCHAR(50) DEFAULT NULL COMMENT '邮箱',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, 'test1@baomidou.com'),
(2, 'Jack', 20, 'test2@baomidou.com'),
(3, 'Tom', 28, 'test3@baomidou.com'),
(4, 'Sandy', 21, 'test4@baomidou.com'),
(5, 'Billie', 24, 'test5@baomidou.com');

4. 创建 Spring Boot 工程

4.1 初始化工程

用 Spring Initializr 创建一个 Spring Boot 工程(普通 Java Web 工程即可)。

4.2 引入依赖(pom.xml)

核心依赖是:mybatis-plus-boot-startermysql-connector-javalombokspring-boot-starter-test

<dependencies>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
  </dependency>

  <dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.5.1</version>
  </dependency>

  <dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <scope>runtime</scope>
  </dependency>

  <dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
  </dependency>

  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
  </dependency>
</dependencies>

4.3 安装 Lombok 插件

IDEA 安装 Lombok 插件(否则 @Data 等注解可能没效果)。


5. 编写代码

5.1 配置 application.yml(数据源)

最关键就是把数据库连上:driver、url、username、password。

spring:
  datasource:
    type: com.zaxxer.hikari.HikariDataSource
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-8&useSSL=false
    username: root
    password: 123456

排雷 1:driver-class-name

  • Spring Boot 2.1+ 推荐用 com.mysql.cj.jdbc.Driver,否则跑测试时可能出现 WARN。

排雷 2:MySQL 8 时区问题

  • MySQL 8 的 url 往往要加 serverTimezone=GMT%2B8,不加可能会报时区不识别异常。

5.2 启动类加 @MapperScan

在 Spring Boot 启动类上加 @MapperScan 扫描 mapper 包。

@SpringBootApplication
@MapperScan("com.atguigu.mybatisplus.mapper")
public class MybatisplusApplication {
  public static void main(String[] args) {
    SpringApplication.run(MybatisplusApplication.class, args);
  }
}

5.3 添加实体类 User

用 Lombok 的 @Data 简化 getter/setter。

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

5.4 添加 Mapper:UserMapper

让 mapper 继承 BaseMapper<User>,MP 就会自动给你注入基础 CRUD。

public interface UserMapper extends BaseMapper<User> {
}

6. 测试(验证是否成功连通)

写一个 SpringBootTest,注入 UserMapper,调用 selectList(null)(null 表示无条件查询全表)。

@SpringBootTest
public class MybatisPlusTest {

  @Autowired
  private UserMapper userMapper;

  @Test
  public void testSelectList() {
    userMapper.selectList(null).forEach(System.out::println);
  }
}

排雷:IDEA mapper 注入报红
文档说明:IDEA 可能提示 userMapper 找不到注入对象(动态代理创建),但程序能正常运行;想消除报红可以在 mapper 上加 @Repository


7. 添加日志(学习效率翻倍)

application.yml 加上 MP 的日志实现类,控制台就能看到执行的 SQL。

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

8. 本章自检

你可以用这 4 条来检查自己是否真正掌握:

  1. selectList(null)null 代表什么?
  2. 为什么 UserMapper extends BaseMapper<User> 就自动拥有 CRUD?
  3. @MapperScan 不加会出现什么问题?
  4. 你能从控制台日志里指出 MP 发出的 SQL 是哪一条吗?