• 簡介
  • 特性
  • 支持資料庫
  • 框架結構
• 快速開始
  • 入門
  • 小結
  • Log配置
  • 注解
• 代碼生成器
  • 依賴
  • 配置
  • 小結
• CRUD
  • Mapper介面
    • Insert
    • Delete
    • Update
    • Select
  • Service介面
• 條件構造器

簡介

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、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多種資料庫
• 內置性能分析插件：可輸出 SQL 陳述句以及其執行時間，建議開發測驗時啟用該功能，能快速揪出慢查詢
• 內置全域攔截插件：提供全表 delete 、 update 操作智能分析阻斷，也可自定義攔截規則，預防誤操作

支持資料庫

• mysql，oracle，db2，h2，hsql，sqlite，postgresql，sqlserver，Phoenix，Gauss ，clickhouse，Sybase，OceanBase，Firebird，cubrid，goldilocks，csiidb
• 達夢資料庫，虛谷資料庫，人大金倉資料庫，南大通用(華庫)資料庫，南大通用資料庫，神通資料庫，瀚高資料庫

框架結構

快速開始

入門

1. 創建資料表

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, '[email protected]'),
(2, 'Jack', 20, '[email protected]'),
(3, 'Tom', 28, '[email protected]'),
(4, 'Sandy', 21, '[email protected]'),
(5, 'Billie', 24, '[email protected]');

2. 創建Spring Boot專案
3. 匯入依賴

<dependency>
    <groupid>org.projectlombok</groupid>
    <artifactid>lombok</artifactid>
</dependency>

<!--jdbc-->
<dependency>
    <groupid>mysql</groupid>
    <artifactid>mysql-connector-java</artifactid>
</dependency>

<dependency>
    <groupid>com.baomidou</groupid>
    <artifactid>mybatis-plus-boot-starter</artifactid>
    <version>3.4.3.2</version>
</dependency>

3. 資料庫配置

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    username: root
    password:
    url: jdbc:mysql://localhost:3306/mybatis-plus?useUnicode=true&characterEncoding=utf8

3. 創建和表對應的物體類

package com.zeng.pojo;
import lombok.Data;

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

4. mapper介面

package com.zeng.mapper;

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

public interface UserMapper extends BaseMapper<user> {

}

5. 掃描Mapper

package com.zeng;

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

@MapperScan("com.zeng.mapper")
@SpringBootApplication
public class MybatisPlusApplication {

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

6. 測驗類

package com.zeng;

import com.zeng.mapper.UserMapper;
import com.zeng.pojo.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.List;

@SpringBootTest
class MybatisPlusApplicationTests {

    @Autowired
    private UserMapper userMapper;

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

7. 輸出結果

...
User(id=1, name=Jone, age=18, [email protected])
User(id=2, name=Jack, age=20, [email protected])
User(id=3, name=Tom, age=28, [email protected])
User(id=4, name=Sandy, age=21, [email protected])
User(id=5, name=Billie, age=24, [email protected])
...

小結

• 遇到的問題

1. @Autowired 標記的變數變紅：
   1. 不影響 正常運行
   2. 可以換成@Resource

2. 匯入依賴問題：
   1. 不要匯入mybatis-plus，要匯入mybatis-plus-boot-starter

• 知識點

1. Mapper介面繼承的BaseMapper類已經封裝了常用的CRUD，直接呼叫即可
2. 一定不要忘了掃描Mapper，@MapperScan

Log配置

# 方式一
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl 
    
# 方式二 application.yml 中增加配置，指定 mapper 檔案所在的包
logging:
  level:
    com.baomidou.example.mapper: debug

注解

簡單認識常用注解

【@TableName 】
    @TableName               用于定義表名
注：
    常用屬性：
        value                用于定義表名

【@TableId】
    @TableId                 用于定義表的主鍵
注：
    常用屬性：
        value           用于定義主鍵欄位名
        type            用于定義主鍵型別（主鍵策略 IdType）

   主鍵策略：
      IdType.AUTO          主鍵自增，系統分配，不需要手動輸入
      IdType.NONE          未設定主鍵
      IdType.INPUT         需要自己輸入 主鍵值，
      IdType.ASSIGN_ID     系統分配 ID，用于數值型資料（Long，對應 mysql 中 BIGINT 型別），
      IdType.ASSIGN_UUID   系統分配 UUID，用于字串型資料（String，對應 mysql 中 varchar(32) 型別），

【@TableField】  
    @TableField            用于定義表的非主鍵欄位，
注：
    常用屬性：
        value                用于定義非主鍵欄位名
        exist                用于指明是否為資料表的欄位， true 表示是，false 為不是，
        fill                 用于指定欄位填充策略（FieldFill），
        
    欄位填充策略：（一般用于填充 創建時間、修改時間等欄位）
        FieldFill.DEFAULT         默認不填充
        FieldFill.INSERT          插入時填充
        FieldFill.UPDATE          更新時填充
        FieldFill.INSERT_UPDATE   插入、更新時填充，

【@TableLogic】
    @TableLogic           用于定義表的欄位進行邏輯洗掉（非物理洗掉）
注：
    常用屬性：
        value            用于定義未洗掉時欄位的值
        delval           用于定義洗掉時欄位的值
        
【@Version】
    @Version             用于欄位實作樂觀鎖

代碼生成器

依賴

代碼生成器依賴

<dependency>
    <groupid>com.baomidou</groupid>
    <artifactid>mybatis-plus-generator</artifactid>
    <version>3.4.1</version>
</dependency>

模板引擎 依賴

<dependency>
    <groupid>org.apache.velocity</groupid>
    <artifactid>velocity-engine-core</artifactid>
    <version>2.3</version>
</dependency>

配置

// Step1：代碼生成器
AutoGenerator mpg = new AutoGenerator();

// Step2：全域配置
GlobalConfig gc = new GlobalConfig();
// 填寫代碼生成的目錄(需要修改)
String projectPath = "E:\\Course\\Java\\IdeaProjects\\Mybatis-Plus";
// 拼接出代碼最終輸出的目錄
gc.setOutputDir(projectPath + "/src/main/java");
// 配置開發者資訊（可選）（需要修改）
gc.setAuthor("Jiuan");
// 配置是否打開目錄，false 為不打開（可選）
gc.setOpen(false);
// 物體屬性 Swagger2 注解，添加 Swagger 依賴，開啟 Swagger2 模式（可選）
//gc.setSwagger2(true);
// 重新生成檔案時是否覆寫，false 表示不覆寫（可選）
gc.setFileOverride(false);
// 配置主鍵生成策略，此處為 ASSIGN_ID（可選）
gc.setIdType(IdType.ASSIGN_ID);
// 配置日期型別，此處為 ONLY_DATE（可選）
gc.setDateType(DateType.ONLY_DATE);
// 默認生成的 service 會有 I 前綴
gc.setServiceName("%sService");
mpg.setGlobalConfig(gc);

// Step3：資料源配置（需要修改）
DataSourceConfig dsc = new DataSourceConfig();
// 配置資料庫 url 地址
dsc.setUrl("jdbc:mysql://localhost:3306/mybatis-plus?useUnicode=true&characterEncoding=utf8");
// dsc.setSchemaName("testMyBatisPlus"); // 可以直接在 url 中指定資料庫名
// 配置資料庫驅動
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
// 配置資料庫連接用戶名
dsc.setUsername("root");
// 配置資料庫連接密碼
dsc.setPassword("");
mpg.setDataSource(dsc);

// Step:4：包配置
PackageConfig pc = new PackageConfig();
// 配置父包名（需要修改）
pc.setParent("com.zeng");
// 配置模塊名（需要修改）
pc.setModuleName("test_mybatis_plus");
// 配置 entity 包名
pc.setEntity("entity");
// 配置 mapper 包名
pc.setMapper("mapper");
// 配置 service 包名
pc.setService("service");
// 配置 controller 包名
pc.setController("controller");
mpg.setPackageInfo(pc);

// Step5：策略配置（資料庫表配置）
StrategyConfig strategy = new StrategyConfig();
// 指定表名（可以同時操作多個表，使用 , 隔開）（需要修改）
strategy.setInclude("user");
// 配置資料表與物體類名之間映射的策略
strategy.setNaming(NamingStrategy.underline_to_camel);
// 配置資料表的欄位與物體類的屬性名之間映射的策略
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
// 配置 lombok 模式
strategy.setEntityLombokModel(true);
// 配置 rest 風格的控制器（@RestController）
strategy.setRestControllerStyle(true);
// 配置駝峰轉連字符
strategy.setControllerMappingHyphenStyle(true);
// 配置表前綴，生成物體時去除表前綴
// 表名為 test_mybatis_plus_user，模塊名為 test_mybatis_plus，去除前綴后剩下為 user，
strategy.setTablePrefix(pc.getModuleName() + "_");
mpg.setStrategy(strategy);

// Step6：執行代碼生成操作
mpg.execute();

小結

1. 使用代碼生成器之前先要配置資料庫才能使用

spring:
    datasource:
        driver-class-name: com.mysql.cj.jdbc.Driver
        username: root
        password:
        url: jdbc:mysql://localhost:3306/mybatis-plus?useUnicode=true&characterEncoding=utf8

2. 一定要匯入依賴，生成器只是生成代碼，沒有依賴，如lombok

CRUD

Mapper介面

說明:

• 通用 CRUD 封裝BaseMapper介面，為 Mybatis-Plus 啟動時自動決議物體表關系映射轉換為 Mybatis 內部物件注入容器
• 泛型 T 為任意物體物件
• 引數 Serializable 為任意型別主鍵 Mybatis-Plus 不推薦使用復合主鍵約定每一張表都有自己的唯一 id 主鍵
• 物件 Wrapper 為條件構造器

Insert

// 插入一條記錄
int insert(T entity);

引數說明

@Test
void testInsert(){
    //根據物件增加
    User user = new User();
    user.setName("zeng");
    user.setEmail("[email protected]");
    user.setAge(18);
    userMapper.insert(user);
}

Delete

// 根據 entity 條件，洗掉記錄
int delete(@Param(Constants.WRAPPER) Wrapper<t> wrapper);
// 洗掉（根據ID 批量洗掉）
int deleteBatchIds(@Param(Constants.COLLECTION) Collection<!--? extends Serializable--> idList);
// 根據 ID 洗掉
int deleteById(Serializable id);
// 根據 columnMap 條件，洗掉記錄，多條件
int deleteByMap(@Param(Constants.COLUMN_MAP) Map<string, object=""> columnMap);

引數說明

void testDelete(){
    //構造器
    //userMapper.delete(null);

    //根據主鍵多個洗掉
    List<integer> idList = new ArrayList<>();
    idList.add(1);
    idList.add(2);
    userMapper.deleteBatchIds(idList);

    //主鍵洗掉
    userMapper.deleteById("3");

    //多條件洗掉
    Map<string, object=""> columnMap = new HashMap<>();
    columnMap.put("id",4);
    columnMap.put("age",21);
    userMapper.deleteByMap(columnMap);
}

Update

// 根據 whereWrapper 條件，更新記錄
int update(@Param(Constants.ENTITY) T updateEntity, @Param(Constants.WRAPPER) Wrapper<t> whereWrapper);
// 根據 ID 修改
int updateById(@Param(Constants.ENTITY) T entity);

引數說明

@Test
void testUpdate(){
    //構造器
    //userMapper.update();

    //根據物件
    User user = new User();
    user.setId((long)1);
    user.setName("張三");
    userMapper.updateById(user);
}

Select

// 根據 ID 查詢
T selectById(Serializable id);
// 根據 entity 條件，查詢一條記錄
T selectOne(@Param(Constants.WRAPPER) Wrapper<t> queryWrapper);

// 查詢（根據ID 批量查詢）
List<t> selectBatchIds(@Param(Constants.COLLECTION) Collection<!--? extends Serializable--> idList);
// 根據 entity 條件，查詢全部記錄
List<t> selectList(@Param(Constants.WRAPPER) Wrapper<t> queryWrapper);
// 查詢（根據 columnMap 條件）
List<t> selectByMap(@Param(Constants.COLUMN_MAP) Map<string, object=""> columnMap);
// 根據 Wrapper 條件，查詢全部記錄
List<map<string, object="">> selectMaps(@Param(Constants.WRAPPER) Wrapper<t> queryWrapper);
// 根據 Wrapper 條件，查詢全部記錄，注意： 只回傳第一個欄位的值
List<object> selectObjs(@Param(Constants.WRAPPER) Wrapper<t> queryWrapper);

// 根據 entity 條件，查詢全部記錄（并翻頁）
IPage<t> selectPage(IPage<t> page, @Param(Constants.WRAPPER) Wrapper<t> queryWrapper);
// 根據 Wrapper 條件，查詢全部記錄（并翻頁）
IPage<map<string, object="">> selectMapsPage(IPage<t> page, @Param(Constants.WRAPPER) Wrapper<t> queryWrapper);
// 根據 Wrapper 條件，查詢總記錄數
Integer selectCount(@Param(Constants.WRAPPER) Wrapper<t> queryWrapper);

引數說明

@Test
void testSelect(){
    //查詢全部
    List<user> users = userMapper.selectList(null);

    for (User user:users) {
        System.out.println(user);
    }
}

Service介面

說明:

• 通用 Service CRUD 封裝IService介面，進一步封裝 CRUD 采用 get 查詢單行 remove 洗掉``list 查詢集合 page 分頁 前綴命名方式區分 Mapper 層避免混淆，
• 泛型 T 為任意物體物件
• 建議如果存在自定義通用 Service 方法的可能，請創建自己的 IBaseService 繼承 Mybatis-Plus 提供的基類
• 物件 Wrapper 為 條件構造器

條件構造器

標籤：MySQL

上一篇：記一次線上問題 → 對 MySQL 的 ON UPDATE CURRENT_TIMESTAMP 的片面認知

下一篇：MyBatis-Plus