【快學springboot】SpringBoot整合Mybatis Plus

原創聲明

本文首發於頭條號【Happyjava】。Happy的掘金地址：https://juejin.im/user/5cc2895df265da03a630ddca，Happy的我的博客：http://blog.happyjava.cn。歡迎轉載，但須保留此段聲明。

mybatis plus簡介

來自官方對於mybatis plus的介紹：MyBatis-Plus（簡稱 MP）是一個 MyBatis 的加強工具，在 MyBatis 的基礎上只作加強不作改變，爲簡化開發、提升效率而生。其支持如下特性：

• 無侵入：只作加強不作改變，引入它不會對現有工程產生影響，如絲般順滑
• 損耗小：啓動即會自動注入基本 CURD，性能基本無損耗，直接面向對象操做
• 強大的 CRUD 操做：內置通用 Mapper、通用 Service，僅僅經過少許配置便可實現單表大部分 CRUD 操做，更有強大的條件構造器，知足各種使用需求
• 支持 Lambda 形式調用：經過 Lambda 表達式，方便的編寫各種查詢條件，無需再擔憂字段寫錯
• 支持主鍵自動生成：支持多達 4 種主鍵策略（內含分佈式惟一 ID 生成器 - Sequence），可自由配置，完美解決主鍵問題
• 支持 ActiveRecord 模式：支持 ActiveRecord 形式調用，實體類只需繼承 Model 類便可進行強大的 CRUD 操做
• 支持自定義全局通用操做：支持全局通用方法注入（ Write once, use anywhere ）
• 內置代碼生成器：採用代碼或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 層代碼，支持模板引擎，更有超多自定義配置等您來使用
• 內置分頁插件：基於 MyBatis 物理分頁，開發者無需關心具體操做，配置好插件以後，寫分頁等同於普通 List 查詢
• 分頁插件支持多種數據庫：支持 MySQL、MariaDB、Oracle、DB二、H二、HSQL、SQLite、Postgre、SQLServer200五、SQLServer 等多種數據庫
• 內置性能分析插件：可輸出 Sql 語句以及其執行時間，建議開發測試時啓用該功能，能快速揪出慢查詢
• 內置全局攔截插件：提供全表 delete 、 update 操做智能分析阻斷，也可自定義攔截規則，預防誤操做

mybatis plus，對於mybatis的加強不是一點半點的，這二者結合使用，真的能夠大幅的提高開發效率。目前，也有衆多互聯網公司正在使用mybatis plus。下面，就讓咱們快速上手mybatis plus吧。

快速開始

數據庫表(來自官方文檔)：

id	name	age	email
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

建表語句：

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

數據：

DELETE FROM user;

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

引入依賴

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

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

一個是mysql的依賴，一個是mybatis-plus的依賴

編寫User.java實體類

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

UserMapper接口

@Mapper
public interface UserMapper extends BaseMapper<User> {

}

快速使用

上面的步驟作完，就能夠開始使用mybatis plus了。

@RunWith(SpringRunner.class)
@SpringBootTest
public class MybatisPlusApplicationTests {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void test1() {
        List<User> users = userMapper.selectList(null);
        users.forEach(e -> {
            System.out.println(e.toString());
        });
    }

}

輸出結果：

經過註解寫sql

經過Select Insert Update Delete 註解，能夠寫增刪查改語句，以下：

@Mapper
public interface UserMapper extends BaseMapper<User> {

    @Select("select * from user where id = #{id}")
    User findUserById(int id);

}

經過xml配置寫sql

經過xml的方式寫sql的話，須要先配置xml的位置：

mybatis-plus.mapper-locations=classpath:mappers/*.xml

示例xml配置以下：userMapper.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<mapper namespace="happy.mybatisplus.mapper.UserMapper">

    <select id="findUserByName" parameterType="string"
            resultType="happy.mybatisplus.entity.User">
        SELECT * FROM user WHERE name = #{name}
    </select>

</mapper>

這些都屬於mybatis的範疇了，這裏就不作過多介紹。

mybatis-plus經常使用

下面列出一些mybatis-plus中經常使用的東西：

一、指定實體類對應的數據庫表名

@TableName(value = "user")

在實體類與數據庫代表不是對應的狀況下使用，如：

@Data
@TableName(value = "user")
public class UserEntity {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

二、指定字段對應的數據庫字段名

@TableField(value = "age")

如：

@Data
@TableName(value = "user")
public class UserEntity {
    private Long id;
    private String name;

    @TableField(value = "age")
    private Integer userAge;
    private String email;
}

三、插入數據，獲得主鍵

調用mybatis plus 提供的insert方法，執行後，會把主鍵設置到入參的id屬性中，以下：

四、分頁

配置分頁插件：

@Bean
public PaginationInterceptor paginationInterceptor() {
    return new PaginationInterceptor();
}

分頁示例：

總結

這裏演示了springboot快速使用mybatis-plus，mybatis-plus有很是豐富的用法，這裏無法一一列舉。有興趣的朋友，能夠直接到官方文檔裏查看。