文章目錄
#簡介
Mybatis-Plus（簡稱MP）是一個 Mybatis 的增強工具，在 Mybatis 的基礎上只做增強不做改變，爲簡化開發、提高效率而生。這是官方給的定義，關於mybatis-plus的更多介紹及特性，可以參考mybatis-plus官網。那麼它是怎麼增強的呢？其實就是它已經封裝好了一些crud方法，我們不需要再寫xml了，直接調用這些方法就行，就類似於JPA。
https://mp.baomidou.com/guide/config.html#%E5%9F%BA%E6%9C%AC%E9%85%8D%E7%BD%AE
#特性
無侵入：只做增強不做改變，引入它不會對現有工程產生影響，如絲般順滑
損耗小：啓動即會自動注入基本 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 注入攻擊
#初始數據庫:
CREATE TABLE `user` (
`id` bigint(20) NOT NULL COMMENT '主鍵ID',
`name` varchar(30) DEFAULT NULL COMMENT '姓名',
`age` int(11) DEFAULT NULL COMMENT '年齡',
`email` varchar(50) DEFAULT NULL COMMENT '郵箱',
PRIMARY KEY (`id`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
-- 插入數據
INSERT INTO `user` (`id`, `name`, `age`, `email`) VALUES ('1', 'Jone', '18', '[email protected]');
INSERT INTO `user` (`id`, `name`, `age`, `email`) VALUES ('2', 'Jack', '20', '[email protected]');
INSERT INTO `user` (`id`, `name`, `age`, `email`) VALUES ('3', 'Tom', '28', '[email protected]');
INSERT INTO `user` (`id`, `name`, `age`, `email`) VALUES ('4', 'Sandy', '21', '[email protected]');
INSERT INTO `user` (`id`, `name`, `age`, `email`) VALUES ('5', 'Billie', '24', '[email protected]');
#pom
<?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>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.0.RELEASE</version>
</parent>
<groupId>mybatisplus</groupId>
<artifactId>mybatis-plus</artifactId>
<version>1.0-SNAPSHOT</version>
<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>
<scope>test</scope>
</dependency>
<!--mybatis-plus的springboot支持-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.5</version>
</dependency>
<!--mysql驅動-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.47</version>
</dependency>
<!--簡化代碼的工具包-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
<version>1.18.4</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
#log4j.xml
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
<appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">
<param name="Encoding" value="UTF-8" />
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%-5p %d{MM-dd
HH:mm:ss,SSS} %m (%F:%L) \n" />
</layout>
</appender>
<logger name="java.sql">
<level value="debug" />
</logger>
<logger name="org.apache.ibatis">
<level value="info" />
</logger>
<root>
<level value="debug" />
<appender-ref ref="STDOUT" />
</root>
</log4j:configuration>
#jdbc.properties
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql:///數據庫名?useUnicode=true&characterEncoding=utf8
jdbc.username=#
jdbc.password=#
#mybatis-config.xml
因爲是與spring整合，所有mybatis-plus的大部分都寫在spring的配置文件中，這裏定義一個空的mybatis-config.xml即可
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
</configuration>
#BaseMapper
在MybatisPlus中，BaseMapper中定義了一些常用的CRUD方法，當我們自定義的Mapper接口繼承BaseMapper後即可擁有了這些方法。
import com.baomidou.mybatisplus.core.conditions.Wrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.core.toolkit.Constants;
import org.apache.ibatis.annotations.Param;
import java.io.Serializable;
import java.util.Collection;
import java.util.List;
/*** <p> * Mapper 繼承該接口後，無需編寫 mapper.xml 文件，即可獲得CRUD功能 * </p> * <p> * 這個 Mapper 支持 id 泛型 * </p> ** @author hubin * @since 2016-01-23 */
public interface BaseMapper<T> {
/*** <p> * 插入一條記錄 * </p> ** @param entity 實體對象 */
int insert(T entity);
/*** <p> * 根據 ID 刪除 * </p> ** @param id 主鍵ID */
int deleteById(Serializable id);
/*** <p> * 根據 columnMap 條件，刪除記錄 * </p> ** @param columnMap 表字段 map 對象 */
int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);
/*** <p> * 根據 entity 條件，刪除記錄 * </p> ** @param queryWrapper 實體對象封裝操作類（可以爲 null） */
int delete(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
/*** <p> * 刪除（根據ID 批量刪除） * </p>
** @param idList 主鍵ID列表(不能爲 null 以及 empty) */
int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
/*** <p> * 根據 ID 修改 * </p> ** @param entity 實體對象 */
int updateById(@Param(Constants.ENTITY) T entity);
/*** <p> * 根據 whereEntity 條件，更新記錄 * </p> ** @param entity 實體對象 (set 條件值,不能爲 null) * @param updateWrapper 實體對象封裝操作類（可以爲 null,裏面的 entity 用於生成 where 語句）*/
int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper<T> updateWrapper);
/*** <p> * 根據 ID 查詢 * </p> ** @param id 主鍵ID */
T selectById(Serializable id);
/*** <p> * 查詢（根據ID 批量查詢） * </p> ** @param idList 主鍵ID列表(不能爲 null 以及 empty) */
List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
/*** <p> * 查詢（根據 columnMap 條件） * </p> ** @param columnMap 表字段 map 對象 */
List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);
/*** <p> * 根據 entity 條件，查詢一條記錄 * </p> ** @param queryWrapper 實體對象 */
T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
/*** <p> * 根據 Wrapper 條件，查詢總記錄數 * </p> ** @param queryWrapper 實體對象 */
Integer selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
/*** <p> * 根據 entity 條件，查詢全部記錄 * </p> ** @param queryWrapper 實體對象封裝操作類（可以爲 null） */
List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
/*** <p> * 根據 Wrapper 條件，查詢全部記錄 * </p> ** @param queryWrapper 實體對象封裝操作類（可以爲 null） */
List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
/*** <p> * 根據 Wrapper 條件，查詢全部記錄 * 注意： 只返回第一個字段的值 * </p> ** @param queryWrapper 實體對象封裝操作類（可以爲 null） */
List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
/*** <p> * 根據 entity 條件，查詢全部記錄（並翻頁）* </p> ** @param page 分頁查詢條件（可以爲 RowBounds.DEFAULT） * @param queryWrapper 實體對象封裝操作類（可以爲 null） */
IPage<T> selectPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
/*** <p> * 根據 Wrapper 條件，查詢全部記錄（並翻頁） * </p> ** @param page 分頁查詢條件 * @param queryWrapper 實體對象封裝操作類 */
IPage<Map<String, Object>> selectMapsPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
}
#實體類註解:
@Data
@TableName(value = "tb_employee")//指定表名
public class User{
//value與數據庫主鍵列名一致，若實體類屬性名與表主鍵列名一致可省略value
@TableId(value = "id",type = IdType.AUTO)//指定自增策略
private Integer id;
//若沒有開啓駝峯命名，或者表中列名不符合駝峯規則，可通過該註解指定數據庫表中的列名，exist標明數據表中有沒有對應列
//@TableField(value = "last_name",exist = true)
//private String lastName;
private String name;
private Integer age;
private String email;
}
#interface
@mapper
public interface UserMapper extends BaseMapper<User> {
}
#分頁查詢: 記得在啓動類上加@MapperScan 註解, 指定掃描的包
/**
* 分頁插件
*/
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
#main方法上面要加 @MapperScan({“com.service.main.interfaces”}) 掃描註解
#配置
雖然在MybatisPlus中可以實現零配置，但是有些時候需要我們自定義一些配置，就需要使用Mybatis原生的一些配置文件方式了。
# 指定全局配置文件
mybatis-plus.config-location = classpath:mybatis-config.xml
# 指定mapper.xml文件
mybatis-plus.mapper-locations = classpath*:mybatis/*.xml
#測試案例:
import cn.itcast.mybatisplus.pojo.User;
import com.baomidou.mybatisplus.core.conditions.Wrapper;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
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 UserMaperTest {
@Autowired
private UserMapper userMapper;
@Test
public void testSelect(){
List<User> users = this.userMapper.selectList(null);
for (User user : users) {
System.out.println(user);
}
}
@Test
public void testSelectById(){
User user = this.userMapper.selectById(3L);
System.out.println(user);
}
@Test
public void testSelectByLike(){
QueryWrapper<User> wrapper = new QueryWrapper<User>();
wrapper.like("name", "o");
List<User> list = this.userMapper.selectList(wrapper);
for (User user : list) {
System.out.println(user);
}
}
@Test
public void testSelectByLe(){
QueryWrapper<User> wrapper = new QueryWrapper<User>();
wrapper.le("age", 20);
List<User> list = this.userMapper.selectList(wrapper);
for (User user : list) {
System.out.println(user);
}
}
@Test
public void testSave(){
User user = new User();
user.setAge(25);
user.setEmail("[email protected]");
user.setName("zhangsan");
int count = this.userMapper.insert(user);
System.out.println("新增數據成功! count => " + count);
}
@Test
public void testDelete(){
this.userMapper.deleteById(7L);
System.out.println("刪除成功!");
}
@Test
public void testUpdate(){
User user = new User();
user.setId(6L);
user.setName("lisi");
this.userMapper.updateById(user);
System.out.println("修改成功!");
}
@Test
public void testSelectPage() {
Page<User> page = new Page<>(2, 2);
IPage<User> userIPage = this.userMapper.selectPage(page, null);
System.out.println("總條數 ------> " + userIPage.getTotal());
System.out.println("當前頁數 ------> " + userIPage.getCurrent());
System.out.println("當前每頁顯示數 ------> " + userIPage.getSize());
List<User> records = userIPage.getRecords();
for (User user : records) {
System.out.println(user);
}
}
}
#使用MybatisPlus的AutoGenerator插件生成代碼文件
編寫BasePojo文件
抽取公共的字段 根據自己的業務來抽取. 如果沒有的話, 也可以不加
import lombok.Data;
import java.util.Date;
@Data
public abstract class BasePojo implements java.io.Serializable {
private Date created;
private Date updated;
}
增加模版依賴
<dependencies>
<!-- freemarker 模板引擎 -->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.28</version>
</dependency>
</dependencies>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.7.1</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.0.7.1</version>
</dependency>
編寫CodeGenerator
參照官方文檔案例改一下就ok了.
https://mp.baomidou.com/guide/generator.html
注意:
文檔上寫的目錄 user.dir 是項目的根目錄.
@EqualsAndHashCode(callSuper = true)
這個是自動生成equals和hashCode方法，我們一般不需要，所以將該註解去掉
@Accessors(chain = true)
這個是表示，生成的set方法將採用鏈式編程方式，建議保留。
生成完實體之後,記得寫指定 表名和主鍵id的註解.
注意int類型和布爾類型的值 是否正確. 數據庫的int容易翻譯成Boolean
#yml配置文件
server:
port: 8090
spring:
application:
name: my-service
datasource:
name: datasource
url: jdbc:mysql://localhost:3306/service?useSSL=false&useUnicode=true&characterEncoding=utf-8&rewriteBatchedStatements=true&autoReconnect=true&serverTimezone=GMT%2B8
username: root
password: 123456
# type: com.alibaba.druid.pool.DruidDataSource
driver-class-name: com.mysql.cj.jdbc.Driver
maxActive: 20
initialSize: 1
maxWait: 60000
minIdle: 1
timeBetweenEvictionRunsMillis: 60000
minEvictableIdleTimeMillis: 300000
testWhileIdle: true
testOnBorrow: false
testOnReturn: false
poolPreparedStatements: true
maxPoolPreparedStatementPerConnectionSize: 20
connectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=5000
#mybatis-plus:
# mapper-locations: classpath*:/mapper/*.xml
# type-aliases-package: com.service.main.model
#================================================= mybatis-plus start =================================================
mybatis-plus:
global-config:
db-config:
id-type: auto
# field-strategy: not_empty
#駝峯下劃線轉換
# column-underline: false
#邏輯刪除配置
# logic-delete-value: 0
# logic-not-delete-value: 1
db-type: mysql
refresh: false
configuration:
map-underscore-to-camel-case: true
cache-enabled: false
# 這個配置會將執行的sql打印出來，在開發或測試的時候可以用
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
mapper-locations: classpath*:mapper/custinfo/*.xml
type-aliases-package: com.service.main.model
# 如果查詢結果中包含空值的列，則 MyBatis 在映射的時候，不會映射這個字段
call-setters-on-nulls: true
#================================================= mybatis-plus end ===================================================
