2. 程式人生 > 其它 >Mybatis 入門實戰(4)--Mybatis-Plus 使用

Mybatis 入門實戰(4)--Mybatis-Plus 使用

阿新 • • 發佈：2022-12-04

MyBatis-Plus 是一個 MyBatis 的增強工具，在 MyBatis 的基礎上只做增強不做改變，為簡化開發、提高效率而生。本文主要介紹 Mybatis-Plus 的基本使用，相關的環境及軟體資訊如下：Spring Boot 2.6.12、Mybatis-Plus 3.5.2。

1、Mybatis-Plus 簡介

1.1、特性

  • 無侵入：只做增強不做改變，引入它不會對現有工程產生影響，如絲般順滑
  • 損耗小：啟動即會自動注入基本 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 操作智慧分析阻斷，也可自定義攔截規則，預防誤操作

1.2、支援資料庫

  • MySQL，Oracle，DB2，H2，HSQL，SQLite，PostgreSQL，SQLServer，Phoenix，Gauss ，ClickHouse，Sybase，OceanBase，Firebird，Cubrid，Goldilocks，csiidb
  • 達夢資料庫，虛谷資料庫，人大金倉資料庫，南大通用(華庫)資料庫，南大通用資料庫，神通資料庫，瀚高資料庫

1.3、框架結構

2、Mybatis-Plus 使用

這裡演示下 Mybatis-plus 的基本使用，工程目錄結構如下：

2.1、pom.xml

主要配置如下：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.5.2</version>
    </dependency>

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

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

    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.24</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.12</version>
        <scope>test</scope>
    </dependency>
</dependencies>
<build>
    <resources>
        <resource>
            <directory>src/main/java</directory>
            <includes>
                <include>**/*.xml</include>
            </includes>
        </resource>
        <resource>
            <directory>src/main/resources</directory>
        </resource>
    </resources>
</build>

2.2、配置

2.2.1、應用配置(application.yml)

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://10.49.196.23:3306/test?useUnicode=true&characterEncoding=UTF-8
    username: root
    password: 123456

mybatis-plus:
  configuration:
    map-underscore-to-camel-case: true
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

2.2.2、日誌配置(logback.xml)

<?xml version="1.0" encoding="utf-8"?>
<configuration debug="false">
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
          <level>INFO</level>
        </filter>
        
        <encoder>
            <pattern>%d %-5level [%thread] %logger[%L] -> %m%n</pattern>
        </encoder>
    </appender>

    <root level="info">
        <appender-ref ref="STDOUT" />
    </root>

    <logger name="com.abc.mapper" level="debug">
    </logger>
    <logger name="com.baomidou.mybatisplus" level="debug">
    </logger>
</configuration>

2.3、建立 Mybatis-Plus 配置類

package com.abc.config;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MybatisConfig {
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        //分頁外掛
        PaginationInnerInterceptor pageInterceptor = new PaginationInnerInterceptor();
        //設定請求的頁面大於最大頁後操作，true調回到首頁，false繼續請求。預設false
        pageInterceptor.setOverflow(false);
        //單頁分頁條數限制，預設無限制
        pageInterceptor.setMaxLimit(500L);
        //設定資料庫型別
        pageInterceptor.setDbType(DbType.MYSQL);
        interceptor.addInnerInterceptor(pageInterceptor);
        return interceptor;
    }
}

2.4、建立實體類

package com.abc.entity;

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;
import lombok.ToString;

import java.time.LocalDateTime;

@ToString
@Data
@TableName("a_student")
public class Student {
    @TableId(type = IdType.AUTO)
    private Long id;

    private LocalDateTime createTime;

    private LocalDateTime modifyTime;

    private String name;

    private Integer age;

    private String homeAddress;
}

表 a_student 的欄位與實體類的屬性一一對應(表中欄位使用下劃線寫法，實體類屬性使用駝峰寫法)，欄位 id 為自增欄位。

2.5、建立 Mapper

package com.abc.mapper;

import com.abc.entity.Student;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Param;

import java.util.List;
import java.util.Map;

@Mapper
public interface StudentMapper extends BaseMapper<Student> {
    List<Student> select(@Param("name") String name, @Param("homeAddress") String homeAddress);

    List<Map<String, Object>> select2(String name, String homeAddress);
}

Mybatis-Plus 的 BaseMapper 提供了基礎的增刪改查功能，如果不能滿足需求，可以再定義額外的方法，對應的 XML 檔案(StudentMapper.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="com.abc.mapper.StudentMapper">
    <select id="select" resultType="com.abc.entity.Student">
        select * from a_student where 1=1
        <if test="name != null and name != ''">
            and name like #{name}
        </if>
        <if test="homeAddress != null and homeAddress != ''">
            and home_address like #{homeAddress}
        </if>
    </select>

    <select id="select2" resultType="map">
        select * from a_student where 1=1
        <if test="param1 != null and param1 != ''">
            and name like #{param1}
        </if>
        <if test="param2 != null and param2 != ''">
            and home_address like #{param2}
        </if>
    </select>
</mapper>

2.6、建立 Service

package com.abc.service;


import com.abc.entity.Student;
import com.abc.mapper.StudentMapper;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.stereotype.Service;

import java.util.List;
import java.util.Map;

@Service
public class StudentService extends ServiceImpl<StudentMapper, Student> {
    public List<Student> select(String name, String homeAddress) {
        return baseMapper.select(name, homeAddress);
    }

    public List<Map<String, Object>> select2(String name, String homeAddress) {
        return baseMapper.select2(name, homeAddress);
    }
}

Mybatis-Plus 的 ServiceImpl 進一步封裝了增刪改查的功能，可以更好的滿足業務需求；當然對於特定的業務需求也可以定義自己的方法。

2.7、測試用例

2.7.1、Mapper 測試用例

package com.abc.mapper;

import com.abc.entity.Student;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

import java.time.LocalDateTime;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;

@RunWith(SpringRunner.class)
@SpringBootTest
public class StudentMapperCase {
    private static final Logger logger = LoggerFactory.getLogger(StudentMapperCase.class);

    @Autowired
    private StudentMapper studentMapper;

    @Test
    public void insert() {
        Student student = new Student();
        student.setCreateTime(LocalDateTime.now());
        student.setName("李白");
        student.setAge(30);
        student.setHomeAddress("長安");
        studentMapper.insert(student);
        logger.info("id={}", student.getId());
    }

    @Test
    public void update() {
        Student student = new Student();
        student.setId(261L);
        student.setName("李白2");
        studentMapper.updateById(student);
    }

    @Test
    public void selectById() {
        Student student = studentMapper.selectById(261L);
        logger.info(student.toString());
    }

    @Test
    public void select() {
        List<Student> students = studentMapper.select("%李%", "%長%");
        logger.info(students.toString());
    }

    @Test
    public void selectForPage() {
        Page<Student> page = new Page<>(1, 3);
        QueryWrapper queryWrapper = new QueryWrapper();
        queryWrapper.like("name", "%李%");
        queryWrapper.like("home_address", "%長%");
        Page<Student> result = studentMapper.selectPage(page, queryWrapper);
        logger.info(result.getRecords().toString());
    }

    @Test
    public void select2() {
        List<Map<String, Object>> list = studentMapper.select2("%李%", "%長%");
        logger.info(list.toString());
    }

    @Test
    public void delete() {
        List<Long> list = new ArrayList(){{
            add(260L);
            add(263L);
        }};
        studentMapper.deleteBatchIds(list);
    }
}

2.7.2、Service 測試用例

package com.abc.service;

import com.abc.entity.Student;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

import java.time.LocalDateTime;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;

@RunWith(SpringRunner.class)
@SpringBootTest
public class StudentServiceCase {
    private static final Logger logger = LoggerFactory.getLogger(StudentServiceCase.class);

    @Autowired
    private StudentService studentService;

    @Test
    public void insert() {
        Student student = new Student();
        student.setCreateTime(LocalDateTime.now());
        student.setName("李白");
        student.setAge(30);
        student.setHomeAddress("長安");
        studentService.save(student);
        logger.info("id={}", student.getId());
    }

    @Test
    public void update() {
        Student student = new Student();
        student.setId(261L);
        student.setName("杜甫");
        studentService.saveOrUpdate(student);
    }

    @Test
    public void selectById() {
        Student student = studentService.getById(261L);
        logger.info(student.toString());
    }

    @Test
    public void select() {
        List<Student> students = studentService.select("%李%", "%長%");
        logger.info(students.toString());
    }

    @Test
    public void selectForPage() {
        Page<Student> page = new Page<>(1, 3);
        QueryWrapper queryWrapper = new QueryWrapper();
        queryWrapper.like("name", "%李%");
        queryWrapper.like("home_address", "%長%");
        Page<Student> result = studentService.page(page, queryWrapper);
        logger.info(result.getRecords().toString());
    }

    @Test
    public void select2() {
        List<Map<String, Object>> list = studentService.select2("%李%", "%長%");
        logger.info(list.toString());
    }

    @Test
    public void delete() {
        List<Long> list = new ArrayList(){{
            add(260L);
            add(263L);
        }};
        studentService.removeBatchByIds(list);
    }
}

更多詳細說明及使用方法請參考官網文件：https://baomidou.com/。

相關推薦

Mybatis 入門實戰(4)--Mybatis-Plus 使用

MyBatis-Plus 是一個 MyBatis 的增強工具，在 MyBatis 的基礎上只做增強不做改變，為簡化開發、提高效率而生。本文主要介紹 Mybatis-Plus 的基本使用，相關的環境及軟體資訊如下：Spring Boot 2.6.12、Mybatis-Pl

mybatis入門實戰&原始碼解讀(2)：mybatis核心應用配置與原理解析

技術標籤：mybatis入門實戰&amp;原始碼 mybatis的一、二級快取 大多數的持久層框架一樣，MyBatis也提供了快取測了，通過快取測了來減少資料庫的查詢次數，從而提高效能。

Mybatis入門及第一個Mybatis程式

Mybatis筆記整理 所需要的基礎知識 JDBC Mysql Java基礎 Maven Junit 框架：是有配置檔案的。最好的方式：看官網文件

Kafka 入門實戰(4)--開啟 Kerberos 認證

本主要介紹在 Kafka 中如何配置 Kerberos 認證，文中所使用到的軟體版本：Java 1.8.0_191、Kafka 2.13-2.4.1、Kerberos1.15.1。

SpringBoot + Mybatis-plus實戰之Mybatis-plus的一級快取、二級快取

前言 現在的JAVA行業，貌似已經是SpringBoot + SpringCloud 的天下了，早期的SSH,SSM框架已經老去，與SpringBoot相結合的JPA框架雖然省去了很多的增刪改查sql，但是比較笨拙，在面對一些複雜多變的邏輯時常常力不從

MyBatis入門學習-連線oracle實現CURD基本操作

目錄 前言 匯入oracle庫 配置 環境配置 配置引用 配置對映 查詢 單條件查詢 多條件查詢

Mybatis入門第一個程式--->及注意事項

1.瀏覽器開啟Mybatis官網，跟著入門教程走 1.1 新建maven專案 刪除src檔案作為父專案

mybatis 最佳實戰

mybatis 最佳實戰 目錄mybatis 最佳實戰1. mybatis 使用步驟2. 依賴匯入3. 配置檔案4. 一對多對映檔案 （對映裡面有引用類）5. 一對多對映檔案 （對映裡面有列表型別）6. CRUD 標籤7. 動態SQL1.IF3. trim4. set5. fo

yb課堂 實戰之Mybatis打通Mysql資料庫 《二》

配置mybatis連線Mysql資料庫 server.port=8081 # ========================資料庫相關配置=====================

SpringBoot2.x入門：使用MyBatis

這是公眾號《Throwable文摘》釋出的第25篇原創文章，收錄於專輯《SpringBoot2.x入門》。

MyBatis入門踩坑記錄

MyBatis入門程式 問題說明 學習過程中遇到很多問題，記錄一下。 Maven靜態資源過濾問題

Mybatis入門

參考：https://www.bilibili.com/video/BV1Db411s7F5?p=74黑馬老師的mybatis視訊，手寫mybatis入門，可以的

MyBatis-入門

第一個MyBatis程式 學習任何東西的思路都是： 搭建環境 -> 匯入依賴 -> 編寫程式碼 -> 測試

mybatis入門案例測試常見問題以及解決方法

1、什麼是Mybatis MyBatis 是一款優秀的持久層框架 它支援定製化 SQL、儲存過程以及高階對映。

Mybatis 入門案例

之前已經搭好了 Mybatis 的學習環境，下面我們來做一下入門案例； 編寫測試方法

3、MyBatis入門例項

學習資源：動力節點《2020最新MyBatis教程【IDEA版】-MyBatis從入門到精通》 目錄入門例項1、建立 MySQL資料庫和表2、建立Maven工程3、加入Maven座標4、資源外掛6、建立實體類 Student7、編寫dao 介面 StudentDao8

Mybatis入門-第一個程式

MyBatis 一、入門 1.前言 https://mybatis.org/mybatis-3/zh/index.html mybatis3有比較豐富的中文官方文件，一切應該以文件為主。

mybatis專案升級到mybatis-plus專案

1.註釋mybatis-starter 新增 mybatis-plus ```<dependency> <dependency> <groupId>com.baomidou</groupId>

Mybatis入門-02-增刪改查及配置（屬性、別名、對映器）

一、 前言 一切當以官方文件為基準。 參考視訊狂神說Java-Mybatis 本文之前的操作步驟：Mybatis入門-第一個程式

Mybatis入門-03-日誌工廠

一、 前言 一切當以官方文件為基準。 參考網站： 檸檬五個半-log4j使用教程 參考視訊：