第二十一章 Spring Boot 整合 MyBatis-Plus

官网

https://baomidou.com

基本介绍

1. MyBatis-Plus （简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。
2. 强大的 CRUD 操作：内置通用 Mapper、通用 Service，通过少量配置即可实现单表大部 分 CRUD 操作，更有强大的条件构造器，满足各类使用需求。

整合 MyBatis-Plus 实例

创建数据库和表

CREATE DATABASE `springboot_mybatisplus`
USE `springboot_mybatisplus` 
CREATE TABLE `monster` ( `id` INT NOT NULL AUTO_INCREMENT,
                        `age` INT NOT NULL, 
                        `birthday` DATE DEFAULT NULL, 
                        `email` VARCHAR(255) DEFAULT NULL,
                        `gender` CHAR(1) DEFAULT NULL,
                        `name` VARCHAR(255) DEFAULT NULL,
                        `salary` DOUBLE NOT NULL, 
                        PRIMARY KEY (`id`) ) CHARSET=utf8 
SELECT * FROM `monster`
INSERT INTO monster VALUES(NULL, 20, '2000-11-11', 'xzj@sohu.com', ' 男 ', ' 蝎 子 精 ', 15000.88); 
INSERT INTO monster VALUES(NULL, 10, '2011-11-11', 'ytj@sohu.com', ' 女 ', ' 玉 兔 精 ', 18000.88);

新建Maven项目

引入相关依赖

<?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>

    <groupId>com.lzw</groupId>
    <artifactId>springboot-mybatisplus</artifactId>
    <version>1.0-SNAPSHOT</version>

    <!--导入springboot父工程-规定写法-->
    <parent>
        <artifactId>spring-boot-starter-parent</artifactId>
        <groupId>org.springframework.boot</groupId>
        <version>2.5.3</version>
    </parent>

    <!--引入必要的依赖-->
    <dependencies>

        <!--引入web starter-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!--引入mysql驱动: 这里老师使用版本仲裁 8.0.26-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

        <!--引入配置处理器 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
        </dependency>

        <!--引入lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

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

        <!--引入druid依赖-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.1.17</version>
        </dependency>

        <!--引入mybatis-plus starter-->
        <!-- https://mvnrepository.com/artifact/com.baomidou/mybatis-plus-boot-starter -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.4.3</version>
        </dependency>

    </dependencies>

</project>

配置 application.yml

server:
  port: 9090
spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/springboot_mybatisplus?useSSL=true&useUnicode=true&characterEncoding=UTF-8
    username: root
    password: 123456

创建 src/main/java/com/lzw/springboot/mybatisplus/config/DruidDataConfig.java

package com.lzw.springboot.mybatisplus.config;

import com.alibaba.druid.pool.DruidDataSource;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;

import javax.sql.DataSource;
import java.sql.SQLException;

/**
 * @author LiAng
 */
public class DruidDataConfig {
    @ConfigurationProperties("spring.datasource")
    @Bean
    public DataSource dataSource() throws SQLException {
        DruidDataSource druidDataSource = new DruidDataSource();
        return druidDataSource;
    }
}

创建 src/main/java/com/lzw/springboot/mybatisplus/Application.java

package com.lzw.springboot.mybatisplus;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * @author LiAng
 */
@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class,args);
    }
}

运行进行测试，出现下图说明mybatisplus引入成功。

创建 src/main/java/com/lzw/springboot/mybatisplus/bean/Monster.java

package com.lzw.springboot.mybatisplus.bean;

import com.fasterxml.jackson.annotation.JsonFormat;
import lombok.Data;

import java.util.Date;

/**
 * @author LiAng
 */
@Data
public class Monster {
    private Integer id;
    private Integer age;
    private Date birthday;
    private String email;
    private String name;
    private String gender;
    private Double salary;
}

创建 src/main/java/com/lzw/springboot/mybatisplus/mapper/MonsterMapper.java

package com.lzw.springboot.mybatisplus.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.lzw.springboot.mybatisplus.bean.Monster;

/**
 * @author LiAng
 * 1. BaseMapper 已经默认提供了很多 crud 方法， 可以直接用
 * 2. 如果 BaseMapper 提供的方法不满足需要，可以再开发 MonsterMapper.xml
 */
@Mapper
public interface MonsterMapper extends BaseMapper<Monster> {
	//自定义方法
}

创建 src/test/java/com/lzw/springboot/mybatisplus/ApplicationTest.java

package com.lzw.springboot.mybatisplus;

import com.lzw.springboot.mybatisplus.bean.Monster;
import com.lzw.springboot.mybatisplus.mapper.MonsterMapper;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

import javax.annotation.Resource;

/**
 * @author LiAng
 */
@SpringBootTest
public class ApplicationTest {

    @Resource
    private MonsterMapper monsterMapper;

    @Test
    public void testMonsterMapper(){
        Monster monster = monsterMapper.selectById(2);
        System.out.printf("monster: " + monster);
    }
}

修改 application.yml

server:
  port: 9090
spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/springboot_mybatisplus?useSSL=true&useUnicode=true&characterEncoding=UTF-8
    username: root
    password: 123456
mybatis-plus:
  configuration: # 进行mybatis-plus配置，配置项和mybatis是一样的
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

运行测试

创建 src/main/java/com/lzw/springboot/mybatisplus/service/MonsterService.java

package com.lzw.springboot.mybatisplus.service;

import com.baomidou.mybatisplus.extension.service.IService;
import com.lzw.springboot.mybatisplus.bean.Monster;

/**
 * @author LiAng
 * 1. 传统方式：在接口中定义方法/声明方法，然后在实现类中进行实现
 * 2. 在mybatis-plus中，我们可以继承父接口，IService
 * 3. 这个 IService 接口声明很多方法，比如crud
 * 4. 如果默认提供的方法不能满足需求，可以再声明需要的方法，然后在实现类中进行实现即可
 */
public interface MonsterService extends IService<Monster> {

}

创建 src/main/java/com/lzw/springboot/mybatisplus/service/impl/MonsterServiceImpl.java

package com.lzw.springboot.mybatisplus.service.impl;

import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.lzw.springboot.mybatisplus.bean.Monster;
import com.lzw.springboot.mybatisplus.mapper.MonsterMapper;
import com.lzw.springboot.mybatisplus.service.MonsterService;
import org.springframework.stereotype.Service;

/**
 * @author LiAng
 * 1. 以前在实现类中直接进行 implements MonsterService
 * 2. 在mybatis-plus中，开发Service实现类，需要继承 ServiceImpl
 * 3. ServiceImpl类实现 IService
 * 4. MonsterService 接口继承了 IService 接口
 * 5. 这里 MonsterServiceImpl 就可以认为是实现了 MonsterService 接口，这样 MonsterServiceImpl
 * 就可以使用 IService 方法，也可以理解成可以使用 MonsterService
 * 6. 如果 MonsterService 接口中，声明了其它的方法/自定义方法，那么我们依然需要在 MonsterServiceImpl 中实现
 */
@Service
public class MonsterServiceImpl extends ServiceImpl<MonsterMapper, Monster> implements MonsterService {
}

修改 ApplicationTest.java

	@Resource
    private MonsterService monsterService;
    @Test
    public void testMonsterService(){
        //Monster monster = monsterService.getById(2);
        //System.out.printf("monster: " + monster);
        List<Monster> list = monsterService.list();
        for (Monster monster : list) {
            System.out.println("monster = " + monster);
        }
    }

进行测试

创建 src/main/java/com/lzw/springboot/mybatisplus/controller/MonsterController.java

package com.lzw.springboot.mybatisplus.controller;

import com.lzw.springboot.mybatisplus.bean.Monster;
import com.lzw.springboot.mybatisplus.service.MonsterService;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.annotation.Resource;

/**
 * @author LiAng
 */
@Controller
public class MonsterController {

    @Resource
    private MonsterService monsterService;

    //方法，根据id返回对应对象
    @GetMapping("/monster")
    @ResponseBody
    public Monster getMonsterById(@RequestParam(value = "id") Integer id){
        return monsterService.getById(id);
    }
}

运行 Application.java 进行测试

更改日期格式，修改 Monster.java

	@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss",timezone = "GMT+8")
    private Date birthday;

修改 MonsterMapper.java

//@Mapper
public interface MonsterMapper extends BaseMapper<Monster> {
    //自定义方法
}

修改 Application.java

/**
 * @author LiAng
 * 1. 使用 @MapperScan 可以指定要扫描的Mapper接口
 * 2. 属性basePackages 可以指定多个包，这里指定的是 com.lzw.springboot.mybatisplus.mapper
 */
@MapperScan(basePackages = {"com.lzw.springboot.mybatisplus.mapper"})
@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class,args);
    }
}

注意事项和细节

@TableName

如果这个类名 Monster 和表名 monster 一致，可以映射上，则 @TableName 可以省略。

如果这个类名 Monster 和表名不一致，不能映射上，则可以通过 @TableName 指定。

@TableName(value = "monster")
public class Monster {
    private Integer id;
    private Integer age;
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss",timezone = "GMT+8")
    private Date birthday;
    private String email;
    private String name;
    private String gender;
    private Double salary;
}

MyBatis-Plus starter 到底引入了哪些依赖

原文地址：http://www.cnblogs.com/liangnice/p/16884412.html