MybatisPlus入门案例

入门案例

1.开发环境

• IDE： idea 2019.2
• JDK：JDK8+
• 构建工具： maven 3.5.4
• MySQL版本： MySQL 5.7
• Spring Boot：2.6.3
• MyBatis-Plus：3.5.1

2.创建数据库及表

创建表并添加数据

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;

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工程

创建Spring Boot项目并在idea中安装lombok插件

项目的目录结构如下：

这里采用Maven项目修改为Spring Boot项目即可，只需要修改普通的Maven项目的pom.xml文件即可：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.2.RELEASE</version>
    </parent>
    
    <groupId>com.qcby</groupId>
    <artifactId>MybatisPlus</artifactId>
    <version>1.0-SNAPSHOT</version>

    <!--声明打包方式为jar-->
    <packaging>jar</packaging>


    <!--springBoot的依赖形式  starter启动器 这种依赖（工具包）-->
    <!--不需要配置版本号-->
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

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

        <!--热部署的依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <optional>true</optional>
        </dependency>


        <!--导入配置文件处理器，配置文件进行绑定就会有提示-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>

        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.1</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

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

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

4.编写代码

配置application.yml

spring:
# 配置数据源信息
  datasource:
  # 配置数据源类型
    type: com.zaxxer.hikari.HikariDataSource
    # 配置连接数据库信息
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-8&useSSL=false
    username: root
    password: 123456
    # 配置MyBatis日志
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

注意:

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.7版本的url：
     jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-8&useSSL=false
   • MySQL8.0版本的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

创建启动类

package com.qcby.demo;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@MapperScan("com.qcby.demo.mapper")// 
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class,args);
    }
}

添加实体

实体的字段要与数据库的字段保持一致，这里的id使用Long是因为，id是由雪花算法生成的，会爆int

package com.qcby.demo.pojo;

import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;

/**
 * lombok插件 可以省略实体类的构造器、setter、getter等等
 * 通过注解的方式
 * ctrl + F12 查看
 * @Data 包含一下所有，除了有参构造器
 * @Getter
 * @Setter
 * @NoArgsConstructor
 * @AllArgsConstructor
 *
 *
 * @TableName("user") // 此注解设置该实体类对应的表名
 */
@Data // 不包含有参构造器
public class User {

    private Long id;

    private String name;

    private Integer age;

    private String email;
}

@Data注解：

其他注解：

@Data注解基本上实现了所有的方法，除了有参构造器

添加Mapper

BaseMapper是MyBatis-Plus提供的模板mapper，其中包含了基本的CRUD方法，泛型为操作的 实体类型
这里的mapper不需要加上@Mapper或者@Repository等注解，因为在启动类中以及配置了@MapperScan

package com.qcby.demo.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.qcby.demo.pojo.User;
import org.springframework.stereotype.Repository;

public interface UserMapper extends BaseMapper<User> {
    
}

进行测试

package com.qcby.demo;

import com.qcby.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 TestApplication {
    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelectList(){
        //selectList()根据MP内置的条件构造器查询一个list集合，null表示没有条件，即查询所有
        userMapper.selectList(null).forEach(System.out::println);
    }
}

结果：

这些日志信息的输出是在yml文件中配置了：

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

当然我们也可以从日志信息中看到sql语句等等。