MyBatisPlus--入门案例

1、开发环境

IDE：idea 2021.3

JDK：JDK8+

构建工具：maven 3.8.1

MySQL版本：MySQL 5.5.28

Spring Boot：2.6.6

MyBatis-Plus：3.5.1

2、创建数据库及表

a>创建表

CREATE DATABASE `mybatis_plus` /*!40100 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;

b>添加数据

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');

3、创建Spring Boot工程

a>初始化工程

使用 Spring Initializr 快速初始化一个 Spring Boot 工程，需保持联网


创建好的SpringBoot项目结构如下：（将圈起来的文件可以删除）

b>引入依赖

在pom.xml中引入

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

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

        <!--新引入-->
        <!--mybatis-plus启动器-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.1</version>
        </dependency>
        <!--lombok用于简化实体类开发-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <!--mysql驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <!--单元测试-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <scope>test</scope>
        </dependency>

    </dependencies>

IDEA2021.3版本已经内置了lombok插件，其它版本需要自行安装

4、编写代码

a>配置application.yml

路径在src/main/resources/application.yml

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

若是使用application.properties，则如下：

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

application.yml和application.properties文件这两种文件都是Springboot的配置文件，注释都可以用#号来注释，只不过因为application.yml看起来更直观，更清晰。
但是要注意一点：properties文件的优先级高于yml文件，即如果两个文件中都配置了端口号，只有properties中的端口号有效，而yml文件中端口配置无效。

注意：

1、驱动类driver-class-name

spring boot 2.0（内置jdbc5驱动），驱动类使用：

driver-class-name: com.mysql.jdbc.Driver

spring boot 2.1及以上（内置jdbc8驱动），驱动类使用：

driver-class-name: com.mysql.cj.jdbc.Driver

否则运行测试用例的时候会有 WARN 信息

2、连接地址url

MySQL5版本的url：

jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-8&useSSL=false

MySQL8版本的url：

jdbc:mysql://localhost:3306/mybatis_plus?
serverTimezone=GMT%2B8&characterEncoding=utf-8&useSSL=false

否则运行测试用例报告如下错误：

java.sql.SQLException: The server time zone value 'Öйú±ê׼ʱ¼ä' is unrecognized or
represents more

b>添加实体

路径为src/main/java/com/mybatisplus_demo/pojo/User.java

package com.mybatisplus_demo.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

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

在IDEA中，打开Maven，找到compile，双击编译

找到User类编译之后的结果，路径在target/classes/com/mybatisplus_demo/pojo/User.class，按Ctrl+F12查看：

c>添加mapper

路径为src/main/java/com/mybatisplus_demo/mapper/UserMapper.java

package com.mybatisplus_demo.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.mybatisplus_demo.pojo.User;

public interface UserMapper extends BaseMapper<User> {
}

BaseMapper是MyBatis-Plus提供的模板mapper，其中包含了基本的CRUD方法，泛型为操作的实体类型

d>启动类

@SpringBootApplication
@MapperScan("com.mybatisplus_demo.mapper")
public class MyBatisPlusDemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(MyBatisPlusDemoApplication.class, args);
    }

}

在Spring Boot启动类中添加@MapperScan注解，扫描mapper包

实际上在mapper接口上面加个@Mapper注解也能做到

e>测试

创建测试类，路径为src/test/java/com/mybatisplus_demo/MyBatisPlusTest.java

package com.mybatisplus_demo;

import com.mybatisplus_demo.mapper.UserMapper;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

@SpringBootTest
@RunWith(SpringRunner.class)
public class MyBatisPlusTest {
    @Autowired(required = false)
    private UserMapper userMapper;

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

@RunWith(SpringRunner.class)注解是一个测试启动器，可以加载SpringBoot测试注解。

IDEA在 userMapper 处报错，找不到注入的对象，因为类是动态创建的，但是程序可以正确执行。

为了避免报错，解决方法（三种）：

1. 可以将@Autowired换成@Resource，不会警告
2. 可以在@Autowired(required = false)
3. 在UserMapper接口上添加@Repository注解

运行结果

f>添加日志

在application.yml进行配置日志输出

# 配置MyBatis日志
mybatis-plus:
	configuration:
		log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

若是使用application.properties，则如下：

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

再次测试运行：