MyBatis-Plus 常用API-1

攻城獅07發表於2019-10-11

=========================================================

一、mybatis-plus詳細介紹

註明：寫這篇mybaits-plus專欄主要是參考http://mp.baomidou.com/guide/這個中文文件進行的，目的是將此中文文件的內容和使用方法更加細緻化的呈現給大家，讓大家能更好的更快速更方便的掌握mybatis-plus。這裡只使用java語言進行講解，通過springboot做案列分析結合maven管理工具進行演示。

1. 簡介

MyBatis-Plus（簡稱 MP）是一個 MyBatis 的增強工具，是國內人員開發的 MyBatis 增強工具，在 MyBatis 的基礎上只做增強不做改變，為簡化開發、提高效率而生。

2. 特性

• 無侵入：只做增強不做改變，引入它不會對現有工程產生影響，如絲般順滑
• 損耗小：啟動即會自動注入基本 CURD，效能基本無損耗，直接物件導向操作
• 強大的 CRUD 操作：內建通用 Mapper、通用 Service，僅僅通過少量配置即
        可實現單表大部分 CRUD 操作，更有強大的條件構造器，滿足各類使用需求
• 支援 Lambda 形式呼叫：通過 Lambda 表示式，方便的編寫各類查詢條件，無需再擔心欄位寫錯
• 支援多種資料庫：支援 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、
        Postgre、SQLServer2005、SQLServer 等多種資料庫
• 支援主鍵自動生成：支援多達 4 種主鍵策略（內含分散式唯一 ID 生成器 - Sequence），
        可自由配置，完美解決主鍵問題
• 支援 XML 熱載入：Mapper 對應的 XML 支援熱載入，對於簡單的 CRUD 操作，甚至可以無 XML 啟動
• 支援 ActiveRecord 模式：支援 ActiveRecord 形式呼叫，實體類只需繼承 Model 類即可進行強大的 CRUD 操作
• 支援自定義全域性通用操作：支援全域性通用方法注入（ Write once, use anywhere ）
• 支援關鍵詞自動轉義：支援資料庫關鍵詞（order、key…）自動轉義，還可自定義關鍵詞
• 內建程式碼生成器：採用程式碼或者 Maven 外掛可快速生成 Mapper 、 Model 、 Service 、 
        Controller 層程式碼，支援模板引擎，更有超多自定義配置等您來使用
• 內建分頁外掛：基於 MyBatis 物理分頁，開發者無需關心具體操作，
        配置好外掛之後，寫分頁等同於普通 List 查詢
• 內建效能分析外掛：可輸出 Sql 語句以及其執行時間，建議開發測試時啟用該功能，能快速揪出慢查詢
• 內建全域性攔截外掛：提供全表 delete 、 update 操作智慧分析阻斷，也可自定義攔截規則，預防誤操作
• 內建 Sql 注入剝離器：支援 Sql 注入剝離，有效預防 Sql 注入攻擊
複製程式碼

3. 框架結構

4. 程式碼託管位置

Gitee : https://gitee.com/baomidou/mybatis-plus
Github : https://github.com/baomidou/mybatis-plus

原文連結：https://blog.csdn.net/m0_37034294/article/details/82892319
複製程式碼

=========================================================

二、快速構建專案

1. 對應的資料庫指令碼與資料庫data指令碼

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)
);
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');
複製程式碼

2. 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>

    <name>springboot-mybatis-plus</name>
    <description>Demo project for Spring Boot</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.5.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <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>
        </dependency>

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

        <!--lombok用來簡化實體類-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

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

        <!--mysql-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </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>
複製程式碼

注意
引入 MyBatis-Plus 之後請不要再次引入 MyBatis 以及 MyBatis-Spring，以避免因版本差異導致的問題。
如果springboot版本是SNAPSHOT快照版還需要新增倉庫

<repository>
    <id>snapshots</id>
    <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
</repository>
複製程式碼

3. applicaiton.yml配置

# DataSource Config
spring:
  datasource:
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://******:3306/crm
    username: ****
    password: ****
複製程式碼

4. 在 Spring Boot 啟動類中新增 @MapperScan 註解，掃描 Mapper 資料夾

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

@SpringBootApplication
@MapperScan("com.lqf.springbootmybatisplus.dao.mapper")//@MapperScan()內容填寫你自己的mapper位置
public class SpringbootMybatisPlusApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringbootMybatisPlusApplication.class, args);
    }
}
複製程式碼

5. 對應資料庫實體類編寫與編寫Mapper類 UserMapper.java

@Data//@Data註解會給此類預設提供Getter,Setter,equals,hashCode,toString方法
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

public interface UserMapper extends BaseMapper<User> {

}
複製程式碼

6. 測試類

import org.junit.Assert;
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;

import java.util.List;
 
@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringbootMybatisPlusApplicationTests {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelect() {
        System.out.println(("----- selectAll method test ------"));
        List<User> userList = userMapper.selectList(null);
        Assert.assertEquals(5, userList.size());
        userList.forEach(System.out::println);
    }

}
複製程式碼

7. 測試結果

----- selectAll method test ------
User(id=1, name=Jone, age=18, email=test1@baomidou.com)
User(id=2, name=Jack, age=20, email=test2@baomidou.com)
User(id=3, name=Tom, age=28, email=test3@baomidou.com)
User(id=4, name=Sandy, age=21, email=test4@baomidou.com)
User(id=5, name=Billie, age=24, email=test5@baomidou.com)
複製程式碼

簡單的springboot+mybatis-plus就整合完成

原文連結：https://blog.csdn.net/m0_37034294/article/details/82892981
複製程式碼

=========================================================

三、整合AutoGenerator快速搭建專案

註明： AutoGenerator 是 MyBatis-Plus 的程式碼生成器，通過 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各個模組的程式碼，極大的提升了開發效率。

1. 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>

    <groupId>com.lqf</groupId>
    <artifactId>springboot-mybatis-plus-genrator</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>springboot-mybatis-plus-genrator</name>
    <description>Demo project for Spring Boot</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.5.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-freemarker</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--lombok用來簡化實體類-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <!--mybatis-plus-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.0.3</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

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

</project>
複製程式碼

2. mybatis-plus.properties展示（自動生成的位置做成了配置）

#此處為本專案src所在路徑（程式碼生成器輸出路徑）
OutputDir=D:/V/springboot-mybatis-plus-genrator/src/main/java
#mapper.xml的生成位置
OutputDirXml=D:/V/springboot-mybatis-plus-genrator/src/main/resources
#資料庫表名(此處切不可為空，如果為空，則預設讀取資料庫的所有表名)
tableName=fy_currency_log
#裝程式碼的資料夾名
className=crm
#設定作者
author=lqf
#正常情況下，下面的程式碼無需修改！！！！！！！！！！
#自定義包路徑
parent=com.lqf.springbootmybatisplusgenrator
#資料庫地址
url=jdbc:mysql://******:3306/crm?useUnicode=true&characterEncoding=utf-8&tinyInt1isBit=false
userName=***
password=***
複製程式碼

3. 程式碼生成器的java類

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;

import java.util.ArrayList;
import java.util.List;
import java.util.ResourceBundle;

/**
 * 程式碼生成器
 */
public class MpGenerator {

    public static void main(String[] args) throws InterruptedException {

        //用來獲取Mybatis-Plus.properties檔案的配置資訊
        final ResourceBundle rb = ResourceBundle.getBundle("mybatis-plus");

        // 程式碼生成器
        AutoGenerator mpg = new AutoGenerator();

        // 全域性配置
        GlobalConfig gc = new GlobalConfig();
        gc.setOutputDir(rb.getString("OutputDir"));
        gc.setOpen(false);
        gc.setBaseResultMap(true);
        gc.setBaseColumnList(true);
        gc.setAuthor(rb.getString("author"));
        gc.setMapperName("%sMapper");
        gc.setXmlName("%sMapper");
        gc.setServiceName("%sService");
        gc.setServiceImplName("%sServiceImpl");
        gc.setControllerName("%sController");
        mpg.setGlobalConfig(gc);

        // 資料來源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setDbType(DbType.MYSQL);
        dsc.setUrl(rb.getString("url"));
        dsc.setDriverName("com.mysql.jdbc.Driver");
        dsc.setUsername(rb.getString("userName"));
        dsc.setPassword(rb.getString("password"));
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setParent(rb.getString("parent"));
        pc.setController("controller." + rb.getString("className"));
        pc.setService("service." + rb.getString("className"));
        pc.setServiceImpl("service." + rb.getString("className") + ".impl");
        pc.setEntity("bean." + rb.getString("className"));
        pc.setMapper("dao." + rb.getString("className"));
        mpg.setPackageInfo(pc);

        // 自定義配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };
        List<FileOutConfig> focList = new ArrayList<>();
        focList.add(new FileOutConfig("/templates/mapper.xml.ftl") {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定義輸入檔名稱
                return rb.getString("OutputDirXml") + "/mapper/" + rb.getString("className") + "/" + tableInfo.getEntityName() + StringPool.DOT_XML;
            }
        });
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);
        mpg.setTemplate(new TemplateConfig().setXml(null));

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setEntityLombokModel(true);
        strategy.setInclude(new String[]{rb.getString("tableName")});
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();

    }
}
複製程式碼

4. 下面開始介紹不同系列的坑

(1). 坑1 （錯誤日誌）

com.lqf.springbootmybatisplusgenrator.MpGenerator
20:04:10.529 [main] DEBUG com.baomidou.mybatisplus.generator.AutoGenerator - 
==========================準備生成檔案...==========================
Exception in thread "main" java.lang.NoClassDefFoundError: freemarker/template/Configuration
	at com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine.init(FreemarkerTemplateEngine.java:45)
	at com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine.init(FreemarkerTemplateEngine.java:38)
	at com.baomidou.mybatisplus.generator.AutoGenerator.execute(AutoGenerator.java:98)
	at com.lqf.springbootmybatisplusgenrator.MpGenerator.main(MpGenerator.java:91)
Caused by: java.lang.ClassNotFoundException: freemarker.template.Configuration
	at java.net.URLClassLoader.findClass(URLClassLoader.java:381)
	at java.lang.ClassLoader.loadClass(ClassLoader.java:424)
	at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:331)
	at java.lang.ClassLoader.loadClass(ClassLoader.java:357)
	... 4 more
複製程式碼

看上面的錯誤java.lang.NoClassDefFoundError: freemarker/template/Configuration 問題是找不到freemarker/template/Configuration這是怎麼引起的呢

注意： freemarker我們那裡用到了，看下面的程式碼

 focList.add(new FileOutConfig("/templates/mapper.xml.ftl") {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定義輸入檔名稱
                return rb.getString("OutputDirXml") + "/mapper/" + rb.getString("className") + "/" + tableInfo.getEntityName() + StringPool.DOT_XML;
            }
        });
        cfg.setFileOutConfigList(focList);
複製程式碼

我們在使用new FileOutConfig("/templates/mapper.xml.ftl") 生成模板的時候是需要依賴freemarker包所以我們需要在pom檔案中引入

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-freemarker</artifactId>
</dependency>
複製程式碼

(2). 坑2

欄位型別為 bit、tinyint(1) 時對映為 boolean 型別這個時候MyBatis 是不會自動處理該對映的需要修改請求連線新增引數 tinyInt1isBit=false如下

jdbc:mysql://127.0.0.1:3306/mp?tinyInt1isBit=false
複製程式碼

否則會報很多型別轉換 boolean的錯誤
記得生成成功之後，在測試執行的時候要在主啟動類上新增@MapperScan(value = “”)哦。

原文連結：https://blog.csdn.net/m0_37034294/article/details/82902373
複製程式碼

5. 層級程式碼展示

下圖為自動生成後的層級展示:

=========================================================

作者：「青蛙與大鵝」
來源：CSDN
複製程式碼

API-1
2018-06-19
API
MyBatis-Plus 常用API-2
2019-10-11
MyBatisAPI
MyBatis-Plus
2021-08-29
MyBatis
Mybatis-Plus常用的查詢方法--看這一篇就夠了！！！
2021-09-13
MyBatis
MyBatis-Plus 3.0.7.1
2019-01-04
MyBatis
MyBatis-Plus 整理
2024-07-10
MyBatis
mybatis-plus思維導圖，讓mybatis-plus不再難懂
2018-01-31
MyBatis
MyBatis-Plus學習
2020-10-19
MyBatis
mybatis-plus分表
2024-07-05
MyBatis
Mybatis-Plus增強包
2021-09-08
MyBatis
mybatis-plus 使用心得
2020-12-19
MyBatis
MyBatis-Plus——實踐篇
2021-10-08
MyBatis
mybatis-plus 使用In查詢
2020-12-24
MyBatis
mybatis-plus程式碼生成
2024-03-16
MyBatis
Mybatis-plus的Service介面
2024-05-24
MyBatis
Mybatis-plus外掛功能
2024-05-25
MyBatis
Mybatis-Plus中的MetaObjectHandler
2024-08-24
MyBatisObject
Spring Boot 教程 - MyBatis-Plus
2020-08-13
Spring BootMyBatis
Mybatis-Plus入門實踐
2022-05-10
MyBatis
SpringBoot整合Mybatis-Plus
2021-09-09
Spring BootMyBatis
MyBatis-Plus Generator自定義模板
2021-04-04
MyBatis
MyBatis-Plus筆記(入門)
2021-04-17
MyBatis筆記
【mybatis-plus】條件查詢
2020-12-29
MyBatis
Mybatis-Plus Generate 原始碼分析
2018-06-08
MyBatis原始碼
Spring Boot —— 整合 MyBatis-Plus
2024-05-20
Spring BootMyBatis
MyBatis-Plus日常工作學習
2021-04-14
MyBatis
SpringBoot | 3.3 整合MyBatis-Plus
2021-08-14
Spring BootMyBatis
Mybatis-Plus 更新欄位為 NULL
2022-08-08
MyBatisNull
【Spring Boot】快速整合Mybatis-Plus
2023-02-07
Spring BootMyBatis
MyBatis-Plus詳細講解（一）
2020-12-27
MyBatis
mybatis-plus pageHelper 合理化配置
2024-05-13
MyBatis
mybatis-plus匯入sql日誌
2024-07-15
MyBatisSQL
SpringBoot整合系列–整合MyBatis-plus
2018-12-15
Spring BootMyBatis
【mybatis-plus】分頁、邏輯刪除
2020-12-28
MyBatis
MyBatis-Plus之程式碼生成器
2020-10-18
MyBatis
5. MyBatis-Plus效能分析外掛
2020-10-17
MyBatis
關於 mybatis-plus 與JPA 混合使用
2022-03-08
MyBatis
Mybatis-plus核心功能-自定義SQL
2024-05-24
MyBatisSQL

MyBatis-Plus 常用API-1

一、mybatis-plus詳細介紹

1. 簡介

2. 特性

3. 框架結構

4. 程式碼託管位置

二、快速構建專案

1. 對應的資料庫指令碼與資料庫data指令碼

2. pom.xml展示

3. applicaiton.yml配置

4. 在 Spring Boot 啟動類中新增 @MapperScan 註解，掃描 Mapper 資料夾

5. 對應資料庫實體類編寫與編寫Mapper類 UserMapper.java

6. 測試類

7. 測試結果

三、整合AutoGenerator快速搭建專案

1. pom.xml 展示

2. mybatis-plus.properties展示（自動生成的位置做成了配置）

3. 程式碼生成器的java類

4. 下面開始介紹不同系列的坑

(1). 坑1 （錯誤日誌）

(2). 坑2

5. 層級程式碼展示

相關文章