全網最全Mybatis-Plus詳解

更新時間：2024年05月08日 10:45:31 作者：互聯(lián)網底層民工

Mybatis-Plus是一個Mybatis（opens?new?window）的增強工具,在Mybatis的基礎上只做增強不做改變,為簡化開發(fā),這篇文章主要介紹了全網最全Mybatis-Plus詳解,需要的朋友可以參考下

一、mYBATIS-pLUS簡介

（一）什么是mYBATIS-pLUS

mYBATIS-pLUS是一個mYBATIS（OPENS NEW WINDOW）的增強工具，在mYBATIS的基礎上只做增強不做改變，為簡化開發(fā)。

（二）mYBATIS-pLUS的優(yōu)勢

無侵入：只做增強不做改變，引入它不會對現(xiàn)有工程產生影響。
損耗小：啟動即會自動注入基本curd，性能基本無損耗，直接面向對象操作。
強大的crud操作：內置通用mAPPER、通用sERVICE，僅僅通過少量配置即可實現(xiàn)單表大部分crud操作，更有強大的條件構造器，滿足各類使用需求。
支持lAMBDA形式調用：通過 lAMBDA 表達式，方便的編寫各類查詢條件，無需再擔心字段寫
錯。
支持主鍵自動生成：支持多達4種主鍵策略（內含分布式唯一 id 生成器 - sEQUENCE），可自由配置，完美解決主鍵問題。
支持aCTIVErECORD模式：支持 aCTIVErECORD 形式調用，實體類只需繼承 mODEL 類即可進行強大的 crud 操作。
支持自定義全局通用操作：支持全局通用方法注入（ wRITE ONCE, USE ANYWHERE ）。
內置代碼生成器：采用代碼或者 mAVEN 插件可快速生成 mAPPER 、 mODEL 、 sERVICE 、 cONTROLLER 層代碼，支持模板引擎，更有超多自定義配置等您來使用。
內置分頁插件：基于 mYbATIS 物理分頁，開發(fā)者無需關心具體操作，配置好插件之后，寫分頁等同于普通 lIST 查詢。
分頁插件支持多種數(shù)據(jù)庫：支持 mYsql、mARIAdb、oRACLE、db2、h2、hsql、sqlITE、
pOSTGRE、sqlsERVER 等多種數(shù)據(jù)庫。
內置性能分析插件：可輸出 sQL 語句以及其執(zhí)行時間，建議開發(fā)測試時啟用該功能，能快速揪出慢查詢。
內置全局攔截插件：提供全表 DELETE 、 UPDATE 操作智能分析阻斷，也可自定義攔截規(guī)則，預防誤操作。

（三）mYBATIS-pLUS的框架結構

二、sPRINGbOOT整合mYBATIS-pLUS入門

（一）創(chuàng)建MAVEN工程，添加依賴

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.47</version>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.2</version>
</dependency>
<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.12</version>
</dependency>

（二）創(chuàng)建數(shù)據(jù)庫表EMPLOYEE

CREATE TABLE employee(
emp_id BIGINT(20) NOT NULL,
name VARCHAR(30),
emp_gender VARCHAR(6),
age INT,
email VARCHAR(50),
PRIMARY KEY(emp_id)
);
INSERT INTO employee(emp_id,name,emp_gender,age,email)
VALUES(1367686308726788098,'劉曉娟','女',20,'liuxianjuan@qq.com');
INSERT INTO employee(emp_id,name,emp_gender,age,email)
VALUES(1367709299695099906,'張春雨','男',28,'zhangchunyu@sina.com');
INSERT INTO employee(emp_id,name,emp_gender,age,email)
VALUES(1367717669156028418,'何雨柱','男',23,'heyuzhu@126.com');

（三）構建數(shù)據(jù)模型eMPLOYEE

public class Employee {
    private Long empId;
    private String name;
    private String empGender;
    private Integer age;
    private String email;
    public Long getEmpId() {
        return empId;
    }
    public void setEmpId(Long empId) {
        this.empId = empId;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public String getEmpGender() {
        return empGender;
    }
    public void setEmpGender(String empGender) {
        this.empGender = empGender;
    }
    public Integer getAge() {
        return age;
    }
    public void setAge(Integer age) {
        this.age = age;
    }
    public String getEmail() {
        return email;
    }
    public void setEmail(String email) {
        this.email = email;
    }
    @Override
    public String toString() {
        return "Employee{" +
        "empId=" + empId +
        ", name='" + name + '\'' +
        ", empGender='" + empGender + '\'' +
        ", age=" + age +
        ", email='" + email + '\'' +
        '}';
    }
}

（四）配置APPLICATION.YML

spring:
datasource:
 driver-class-name: com.mysql.jdbc.Driver
 url: jdbc:mysql:///mybatis_plus
 username: root
 password: root
logging:
level:
 com:
   offcn:
      mapper: debug

（五）編寫sPRINGbOOT啟動類

@SpringBootApplication
@MapperScan("com.offcn.mapper")
public class MybatisPlus01Application {
    public static void main(String[] args) {
        SpringApplication.run(MybatisPlus01Application.class, args);
    }
}

（六）編寫MAPPER接口

public interface EmployeeMapper extends BaseMapper<Employee> {}

（七）啟動服務測試結果

@RunWith(SpringRunner.class)
@SpringBootTest
public class MybatisPlus01ApplicationTests {
    @Autowired
    private EmployeeMapper employeeMapper;
    @Test
    public void testSelect(){
        List<Employee> employeeList = employeeMapper.selectList(null);
        employeeList.forEach( System.out::println);
    }
}

三、lOMBOK插件

（一）lOMBOK插件簡介

lOMBOK是一個插件，用途是使用注解給你類里面的字段，自動的加上屬性，構造器，tOsTRING方法，eQUALS方法等，比較方便的一點是，你在更改字段的時候，lOMBOK會立即發(fā)生改變以保持和你代碼的一致性。

（二）常用的lOMBOK注解介紹

@dATA	注在類上，提供類的GET、SET、EQUALS、HASHcODE、TOsTRING等方法
@gETTER	加在類上，可以自動生成參數(shù)的GETTER方法
@sETTER	加在類上，可以自動生成參數(shù)的SETTER方法
@tOsTRING	加在類上，調用TOsTRING()方法，可以輸出實體類中所有屬性的值
@rEQUIREDaRGScONSTRUCTOR	生成一個包含常量，和標識了nOTnULL的變量的構造方法。生成的構造方法是私有的PRIVATE
@eQUALSaNDhASHcODE	生成EQUALS和HASHcODE方法，默認使用非靜態(tài)的屬性，可以通過EXCLUDE參數(shù)排除不需要生成的屬性。通過OF參數(shù)來指定需要生成的屬性
@nOaRGScONSTRUCTOR	生成一個無參數(shù)的構造方法
@aLLaRGScONSTRUCTOR	生成一個包含所有變量的構造方法。
@vALUE	這個注解要和sPRING的@vALUE注解區(qū)分，sPRING的是從配置文件讀取內容，這個注解是在類中的所有字段默認全部聲明為PRIVATE FINAL類型，只會生成gETTER方法，不會生成sETTER方法。
@cLEANUP	主要用于關閉資源使用。

（三）IDEA安裝lOMBOK插件

首先我們需要安裝iNTELLIj idea中的LOMBOK插件，打開iNTELLIj idea后點擊菜單欄中的fILE-->sETTINGS，或者使用快捷鍵cTRL+aLT+s進入到設置頁面。 &NBSP;&NBSP;&NBSP;&NBSP;&NBSP;&NBSP;&NBSP;&NBSP;&NBSP;&NBSP;&NBSP;&NBSP;&NBSP;&NBSP;&NBSP;&NBSP;

我們點擊設置中的pLUGINS進行插件的安裝，在右側選擇bROWSE REPOSITORIES...，然后在搜索頁面輸入LOMBOK變可以查詢到下方的lOMBOK pLUGIN，鼠標點擊lOMBOK pLUGIN可在右側看到iNSTALL按鈕，點擊該按鈕便可安裝。 &NBSP;&NBSP;&NBSP;&NBSP;&NBSP;&NBSP;&NBSP;&NBSP;

安裝完成之后重啟IDEAR即可。&NBSP;

（四）lOMBOK插件的使用

1、引入依賴

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.4</version>
    <scope>provided</scope>
</dependency>

2、去除eMPLOYEE類中的SETTER和GETTER方法

public class Employee {
    private Long empId;
    private String name;
    private String empGender;
    private Integer age;
    private String email;
}

3、在eMPLOYEE類上添加lOMBOK注解

@NoArgsConstructor
@AllArgsConstructor
@Data
@ToString
public class Employee {
    private Long empId;
    private String name;
    private String empGender;
    private Integer age;
    private String email;
}

四、crud

（一）bASEmAPPER接口方法介紹

bASEmAPPER中提供了crud方法，具體方法如下：

// 插入一條記錄
int insert(T entity);
// 根據(jù) entity 條件，刪除記錄
int delete(@Param(Constants.WRAPPER) Wrapper<T> wrapper);
// 刪除（根據(jù)ID 批量刪除）
int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
// 根據(jù) ID 刪除
int deleteById(Serializable id);
// 根據(jù) columnMap 條件，刪除記錄
int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);
// 根據(jù) whereEntity 條件，更新記錄
int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper<T> updateWrapper);
// 根據(jù) ID 修改
int updateById(@Param(Constants.ENTITY) T entity);
List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
// 查詢（根據(jù) columnMap 條件）
List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);
// 根據(jù) Wrapper 條件，查詢全部記錄
List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
// 根據(jù) Wrapper 條件，查詢全部記錄。注意： 只返回第一個字段的值
List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
// 根據(jù) entity 條件，查詢全部記錄（并翻頁）
IPage<T> selectPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
// 根據(jù) Wrapper 條件，查詢全部記錄（并翻頁）
IPage<Map<String, Object>> selectMapsPage(IPage<T> page,
@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
// 根據(jù) Wrapper 條件，查詢總記錄數(shù)
Integer selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

（二）iNSERT方法

//插入一條記錄
INT INSERT (t ENTITY);

測試：

@Test
public void testInsert() {
    Employee employee=new Employee();
    //employee.setEmpId(100000);
    employee.setName("劉龍");
    employee.setEmpGender("男");
    employee.setAge(25);
    employee.setEmail("liulong@163.com");
    employeeMapper.insert(employee);
}

從上面的異常可以看出，我們沒有給eMPLOYEE類的EMPiD屬性賦值，定義數(shù)據(jù)庫時對應的EMP_ID列不能為空，所以出錯了，為了解決這個錯誤，你可以給EMPiD屬性賦值一個值，可以解決此問題。

mYBATIS-pLUS默認采用雪花算法生成唯一值，如果想使用mYBATIS-pLUS自動生成的雪花算法值可以在實體類的屬性上加@fILEDiD注解。

（三）@tABLEiD注解

描述：主鍵注解

屬性	類型	必須指定	默認值	描述
VALUE	sTRING	否	" "	主鍵字段名
TYPE	eNUM	否	iDtYPE.none	主鍵類型

iDtYPE

值	描述
aUTO	數(shù)據(jù)庫id自增
nONE	無狀態(tài)，該類型為未設置主鍵類型（注解里等于跟隨全局，全局里約等于iNPUT）
iNPUT	iNSERT前自行SET主鍵值
assign_id	分配id(主鍵類型為nUMBER(lONG和iNTEGER)或sTRING)(SINCE 3.3.0),使用接口iDENTIFIERgENERATOR 的方法 NEXTiD (默認實現(xiàn)類為dEFAULTiDENTIFIERgENERATOR 雪花算法)
assign_uui	分配uuid,主鍵類型為sTRING(SINCE 3.3.0),使用接口 iDENTIFIERgENERATOR 的方法 NEXTuuid (默認DEFAULT方法)

@NoArgsConstructor
@AllArgsConstructor
@Data
@ToString
public class Employee {
    //使用數(shù)據(jù)庫自增策略
    //@TableId(type=IdType.AUTO)
    //默認使用雪花算法生成數(shù)字
    @TableId
    private Long empId;
    private String empName;
    private String empGender;
    private Integer age;
    private String email;
}

（四）@tABLEnAME注解

描述：表名注解

屬性	類型	必須指定	默認值	描述
VALUE	sTRING	否	" "	主鍵字段名
TYPE	eNUM	否	iDtYPE.none	主鍵類型

當表名跟實體類類名不一致時，要使用@tABLEnAME注解進行映射

@NoArgsConstructor
@AllArgsConstructor
@Data
@ToString
@TableName(value = "tb_employee")
public class Employee {
    //使用數(shù)據(jù)庫自增策略
    //@TableId(type=IdType.AUTO)
    //默認使用雪花算法生成數(shù)字
    @TableId
    private Long empId;
    private String empName;
    private String empGender;
    private Integer age;
    private String email;
}

（五）@tABLEfIELD注解

描述：字段注解（非主鍵）

屬性	類型	必須指定	默認值	描述
VALUE	sTRING	否	""	數(shù)據(jù)庫字段名
EL	sTRING	否	""	映射為原生 #{ ... } 邏輯,相當于寫在 XML 里的 #{ ... } 部分
EXIST	BOOLEAN	否	TRUE	是否為數(shù)據(jù)庫表字段
CONDITION	sTRING	否	""	字段 WHERE 實體查詢比較條件,有值設置則按設置的值為準,沒有則為默認全局的 %S=#{%S}
UPDATE	sTRING	否	""	字段 UPDATE SET 部分注入, 例如： UPDATE="%S+1"：表示更新時會SET VERSION=VERSION+1(該屬性優(yōu)先級高于 EL 屬性)
INSERTsTRATEGY	eNUM	n	default	舉例：not_null: INSERT INTO TABLE_A(<IF TEST="COLUMNpROPERTY != NULL">COLUMN</IF>) VALUES (<IF TEST="COLUMNpROPERTY != NULL"># {COLUMNpROPERTY}</IF>)
UPDATEsTRATEGY	eNUM	n	default	舉例：ignored: UPDATE TABLE_A SET COLUMN=#{COLUMNpROPERTY}
WHEREsTRATEGY	eNUM	n	default	舉例：not_empty: WHERE <IF TEST="COLUMNpROPERTY != NULL AND COLUMNpROPERTY!=''">COLUMN=# {COLUMNpROPERTY}</IF>
FILL	eNUM	否	fIELDfILL.default	字段自動填充策略
sELECT	BOOLEAN	否	TRUE	是否進行SELECT查詢
KEEPgLOBALfORMAT	BOOLEAN	否	FALSE	是否保持使用全局的 FORMAT 進行處理
JDBCtYPE	jDBCtYPE	否	jDBCtYPE.undefine	jdbc類型 (該默認值不代表會按照該值生效)
TYPEhANDLER	cLASS<？EXTENDS tYPEhANDLER>	否	uNKNOWNtYPEhANDLER.CLASS	類型處理器 (該默認值不代表會按照該值生效)
NUMERICsCALE	sTRING	否	""	指定小數(shù)點后保留的位數(shù)

@NoArgsConstructor
@AllArgsConstructor
@Data
@ToString
@TableName(value = "tb_employee")
public class Employee {
    @TableId
    private Long empId;
    //當表中的列與實體類屬性不一致時，使用TableField指定數(shù)據(jù)庫中的列名
    @TableField(value = "emp_name")
    private String name;
    private String empGender;
    private Integer age;
    private String email;
    //當表中沒有remark時，使用TableField的exist=false屬性忽略該字段
    @TableField(exist = false)
    private String remark;
}

（六）插入數(shù)據(jù)獲取主鍵值

修改eMPLOYEE的EMPiD注解

@TableId(type=IdType.AUTO)
private Long empId;

MYSQL-PLUS會自動獲取自增主鍵，把數(shù)據(jù)庫的EMP_ID設置為自增。測試獲取自增主鍵

public void testInsert() {
    Employee employee=new Employee();
    employee.setName("劉龍200");
    employee.setEmpGender("男");
    employee.setAge(25);
    employee.setEmail("liulong@163.com");
    employee.setRemark("該員工是一個好員工");
    employeeMapper.insert(employee);
    System.out.println(employee.getEmpId());
}

（七）更新數(shù)據(jù)的通用方法

1、UPDATEbYiD方法

根據(jù)ID進行記錄更新，如果對象屬性未傳值，則不會更新該字段，保持數(shù)據(jù)庫表原來字段值

public void testUpdateById() {
    Employee employee=new Employee();
    employee.setEmpId(10)
    employee.setName("劉龍");
    employee.setEmpGender("女");
    employee.setAge(23);
    employee.setEmail("liulong@163.com");
    employeeMapper.updateById(employee);
}

2、UPDATE(ENTITY，WRAPPER)方法

public void testdateById(){
    //根據(jù)員工的名字,更新
    Employee employee2=new Employee();
    employee2.setEmpGender("男");
    employee2.setAge(18);
    employee2.setEmail("liulong@126.com");
    employeeMapper.update(employee2,new UpdateWrapper<Employee>().eq("name","劉龍"));
}

（八）查詢數(shù)據(jù)的通用方法

1、SELECTbYiD方法

根據(jù)ID查詢指定記錄

@Test
public void testSelectById() {
    Employee employee=employeeMapper.selectById(1);
    System.out.println(employee);
}

2、SELECTbATCHiDS方法

批量查詢指多個ID的記錄集合

@Test
public void testSelectBatchIds() {
    List list= Arrays.asList(1,2,3);
    List<Employee> employeeList = employeeMapper.selectBatchIds(list);
    employeeList.forEach(System.out::println);
}

3、SELECTbYmAP方法

根據(jù)mAP集合中傳入的條件進行查詢，每個條件都是AND關系

@Test
public void testSelectByMap() {
    Map<String,Object> map=new HashMap<>();
    map.put("emp_gender","男");
    map.put("age",29);
    List<Employee> employeeList = employeeMapper.selectByMap(map);
    employeeList.forEach(System.out::println);
}

（九）刪除數(shù)據(jù)方法

1、DELETEbYiD方法

根據(jù)ID刪除記錄

@Test
public void testDeleteById(){
    int rows=employeeMapper.deleteById(1);
    System.out.println("受影響的行數(shù):"+rows);
}

2、DELETEbYmAP方法

根據(jù)mAP中的條件進行刪除，MAP中的條件在SQL語句中是AND關系

@Test
public void testDeleteByMap(){
    Map<String,Object> map=new HashMap<>();
    map.put("emp_gender","男");
    map.put("emp_name","劉輝");
    int rows=employeeMapper.deleteByMap(map);
    System.out.println("受影響的行數(shù):"+rows);
}

3、DELETEBATCHiDS方法

根據(jù)傳入lIST集合中的ID進行批量刪除

@Test
public void testDeleteBatchIds(){
    List list= Arrays.asList(4,7,1);
    int rows=employeeMapper.deleteBatchIds(list);
    System.out.println("受影響的行數(shù):"+rows);
}

五、mYBATIS-pLUS條件構造器

（一）條件構造器介紹

在MYBATIS-PLUS中提了構造條件的類wRAPPER，它可以根據(jù)自己的意圖定義我們需要的條件。wRAPPER是一個抽象類，一般情況下我們用它的子類qUERYwRAPPER來實現(xiàn)自定義條件查詢。

（二）sELECToNE方法

//查詢姓名為劉輝軍并且性別為男的員工
@Test
public void testSelectOne(){
    QueryWrapper<Employee> queryWrapper=new QueryWrapper<>();
    queryWrapper.eq("name","劉輝軍");
    queryWrapper.eq("emp_gender","男");
    Employee employee = employeeMapper.selectOne(queryWrapper);
    System.out.println(employee);
}

（三）sELECTlIST方法

//查詢姓名中帶有"磊"的并且年齡小于30的員工
@Test
public void testSelectList(){
    QueryWrapper<Employee> queryWrapper=new QueryWrapper<>();
    queryWrapper.like("name","磊").lt("age",30);
    List<Employee> employeeList = employeeMapper.selectList(queryWrapper);
    employeeList.forEach(System.out::println);
}
//查詢姓劉的或者性別為男，按年齡的除序排序
@Test
public void testSelectList2(){
    QueryWrapper<Employee> queryWrapper=new QueryWrapper<>();
    queryWrapper.like("name","王")
        .or().eq("emp_gender","男")
        .orderByDesc("age");
    List<Employee> employeeList = employeeMapper.selectList(queryWrapper);
    employeeList.forEach(System.out::println);
}
//查詢姓劉的并且（年齡小于35或者郵箱不為空）
@Test
public void testSelectList3(){
    QueryWrapper<Employee> queryWrapper=new QueryWrapper<>();
    queryWrapper.likeRight("name","劉")
        .and(wq->wq.lt("age",35).or().isNotNull("email"));
    List<Employee> employeeList = employeeMapper.selectList(queryWrapper);
    employeeList.forEach(System.out::println);
}

（四）sELECTpAGE方法

sELECTpAGE用于分頁，在mYBATIS-pLUS中分頁有兩種：一種是邏輯分頁或叫內存分頁，另一個是物理分頁。內存分頁就是把數(shù)據(jù)全部查詢出來放到內容中，返回你想要的一部分數(shù)據(jù)，當數(shù)據(jù)量非常龐大時，這種方法就行不通了，因為太耗內容，所以一般采用物理分頁，需要sPRINGmvc中加入物理分頁配置：

@Configuration
public class MybatisPlusConfig {
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }
}

@Test
public void testSelectPage(){
    QueryWrapper<Employee> queryWrapper=new QueryWrapper<>();
    queryWrapper.lt("age",50);
    Page<Employee> page=new Page<>(1,2);
    Page<Employee> employeePage = employeeMapper.selectPage(page, queryWrapper);
    System.out.println("當前頁:"+ employeePage.getCurrent());
    System.out.println("每頁記錄數(shù):"+employeePage.getSize());
    System.out.println("總記錄數(shù):"+employeePage.getTotal());
    System.out.println("總頁數(shù):"+employeePage.getPages());
    List<Employee> employeeList = employeePage.getRecords();
    employeeList.forEach(System.out::println);
}

（五）uPDATE方法

//根據(jù)姓名和年齡修改記錄
@Test
public void testUpdate(){
    QueryWrapper<Employee> updateWrapper=new QueryWrapper<>();
    updateWrapper.eq("name","劉龍")
        .eq("age",25);
    Employee employee=new Employee();
    employee.setEmpId(1367720249630318593L);
    employee.setName("劉龍");
    employee.setEmail("lilong111@.qq.com");
    employee.setAge(26);
    employee.setEmpGender("女");
    int rows=employeeMapper.update(employee,updateWrapper);
    System.out.println("受影響的行數(shù):"+rows);
}

（六）dELETE方法

//根據(jù)姓名和年齡刪除記錄
@Test
public void testDelete(){
    QueryWrapper<Employee> queryWrapper=new QueryWrapper<>();
    queryWrapper.eq("name","劉龍")
        .eq("age",26);
    int rows=employeeMapper.delete(queryWrapper);
    System.out.println("受影響的行數(shù):"+rows);
}

六、mYBATIS-pLUS的sERVICE封裝

（一）通用SERVICE簡介

mYBATIS-pLUS除了通用的mAPPER還有通用的sERVCIE層，這也減少了相對應的代碼工作量，把通用的接口提取到公共。其實按照mp的這種思想，可以自己也實現(xiàn)一些通用的cONTROLLER。

（二）通用SERVICE常用方法介紹

/**
* 插入一條記錄（選擇字段，策略插入）
*
* @param entity 實體對象
*/
default boolean save(T entity) {
    return SqlHelper.retBool(getBaseMapper().insert(entity));
}
/**
* 根據(jù) ID 選擇修改
*
* @param entity 實體對象
*/
default boolean updateById(T entity) {
    return SqlHelper.retBool(getBaseMapper().updateById(entity));
}
/**
* TableId 注解存在更新記錄，否插入一條記錄
*
* @param entity 實體對象
*/
boolean saveOrUpdate(T entity);
/**
* 根據(jù) Wrapper，查詢一條記錄 <br/>
* <p>結果集，如果是多個會拋出異常，隨機取一條加上限制條件 wrapper.last("LIMIT
1")</p>
*
* @param queryWrapper 實體對象封裝操作類 {@link
com.baomidou.mybatisplus.core.conditions.query.QueryWrapper}
*/
default T getOne(Wrapper<T> queryWrapper) {
    return getOne(queryWrapper, true);
}
/**
* 根據(jù) Wrapper，查詢一條記錄
*
* @param queryWrapper 實體對象封裝操作類 {@link
com.baomidou.mybatisplus.core.conditions.query.QueryWrapper}
* @param throwEx 有多個 result 是否拋出異常
*/
T getOne(Wrapper<T> queryWrapper, boolean throwEx);

（三）通用SERVICE的案例

1、構建工程，添加依賴

<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>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.2</version>
</dependency>

2、構建SERVICE接口

public interface EmloyeeService extends IService<Employee> {
}

3、構建SERVICE實現(xiàn)類

@Service
public class EmployeeServiceImpl extends ServiceImpl<EmployeeMapper,Employee> implements EmloyeeService {
}

4、通用SERVICE測試

@Test
public void testSave(){
    Employee employee=new Employee();
    employee.setName("孫寶來");
    employee.setEmpGender("男");
    employee.setAge(30);
    employee.setEmail("sunbaolai@qq.com");
    employeeService.save(employee);
}
@Test
public void testSaveOrUpdate(){
    Employee employee=new Employee();
    employee.setEmpId(1367720249630318594L);
    employee.setName("孫寶來");
    employee.setEmpGender("女");
    employee.setAge(33);
    employee.setEmail("sunbaolai@qq.com");
    employeeService.saveOrUpdate(employee);
}
@Test
public void testGetOne(){
    QueryWrapper<Employee> queryWrapper=new QueryWrapper<>();
    queryWrapper.gt("age",24);
    Employee employee = employeeService.getOne(queryWrapper,false);
    System.out.println(employee);
}

七、mYBATIS-pLUS代碼生成器

（一）代碼生成器介紹

代碼生成器顧名思義就是為我們生成一些代碼，省去了我們一些時間。aUTOgENERATOR 是 mYbATIS-pLUS 的代碼生成器，通過 aUTOgENERATOR 可以快速生成 eNTITY、mAPPER、mAPPER xml、sERVICE、cONTROLLER 等各個模塊的代碼，極大的提升了開發(fā)效率,mYbATIS-pLUS從3.0.3 之后移除了代碼生成器與模板引擎的默認依賴，需要手動添加相關依賴，才能實現(xiàn)代碼生成器功能。

（二）構建MAVEN工程，引入依賴

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.47</version>
</dependency>
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.2.0</version>
</dependency>
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.2.0</version>
</dependency>
<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.3</version>
</dependency>
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>

（三）編寫生成器代碼

1、gLOBALcONFIG全局配置編碼

// 代碼生成器
AutoGenerator mpg = new AutoGenerator();
// 全局配置
GlobalConfig gc = new GlobalConfig();
//獲取工程路徑
String projectPath = System.getProperty("user.dir");
gc.setOutputDir(projectPath + "/src/main/java");
gc.setAuthor("zs");//設置作者
gc.setOpen(false);//生成是后是否打開資源管理器
gc.setFileOverride(false);//重新生成文件時是否覆蓋
gc.setServiceName("%sService");
// gc.setSwagger2(true); 實體屬性 Swagger2 注解
mpg.setGlobalConfig(gc);

2、dATAsOURCEcONFIG數(shù)據(jù)源配置編碼

// 數(shù)據(jù)源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/mybatis_plus?
useUnicode=true&useSSL=false&characterEncoding=utf8");
// dsc.setSchemaName("public");
dsc.setDriverName("com.mysql.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("root");
dsc.setDbType(DbType.MYSQL);
mpg.setDataSource(dsc);

3、pACKAGEcONFIG包名策略配置

// 包配置
PackageConfig pc = new PackageConfig();
pc.setModuleName(null);
pc.setParent("com.offcn.ssm");
pc.setController("controller");
pc.setEntity("entity");
pc.setService("service");
pc.setMapper("mapper");
mpg.setPackageInfo(pc);

4、sTRATEGYcONFIG策略配置編碼

//策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setInclude("tb_employee");//對那一張表生成代碼
strategy.setNaming(NamingStrategy.underline_to_camel);//數(shù)據(jù)庫表映射到實體的命名策略
strategy.setTablePrefix(pc.getModuleName() + "_"); //生成實體時去掉表前綴
strategy.setColumnNaming(NamingStrategy.underline_to_camel);//數(shù)據(jù)庫表字段映射到實體的命名策略
strategy.setEntityLombokModel(true); // lombok 模型 @Accessors(chain = true) setter鏈式操作
strategy.setRestControllerStyle(true); //restful api風格控制器
strategy.setControllerMappingHyphenStyle(true); //url中駝峰轉連字符
mpg.setStrategy(strategy);

5、執(zhí)行

//執(zhí)行
mpg.execute();

（四）執(zhí)行生成器代碼完成測試

在主啟動類上用@mAPPERsCAN掃描MAPPER接口

@MapperScan("com.offcn.ssm.mapper")

在APPLICATION.YML中添加數(shù)據(jù)庫配置信息

spring:
 datasource:
  driver-class-name: com.mysql.jdbc.Driver
  url: jdbc:mysql:///mybatis_plus
  username: root
  password: root
logging:
level:
 com:
  offcn:
   mybatis:
    dao: debug

在生成的cONTROLLER中編寫查詢方法

@RequestMapping("/tb-employee")
public class TbEmployeeController {
    @Autowired
    private TbEmployeeService tbEmployeeService;
    @RequestMapping("/emps")
    public List<TbEmployee> getEmployees(){
        List<TbEmployee> list = tbEmployeeService.list();
        return list;
    }
}

到此這篇關于全網最全Mybatis-Plus詳解的文章就介紹到這了,更多相關Mybatis-Plus詳解內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章:

簡單通用JDBC輔助類封裝(實例)
下面小編就為大家?guī)硪黄唵瓮ㄓ肑DBC輔助類封裝(實例)。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧
2016-07-07
JAVA實現(xiàn)空間索引編碼——GeoHash的示例
本篇文章主要介紹了JAVA實現(xiàn)空間索引編碼——GeoHash的示例，如何從眾多的位置信息中查找到離自己最近的位置，有興趣的朋友可以了解一下
2016-10-10
spring-redis-session 自定義 key 和過期時間
這篇文章主要介紹了spring-redis-session 自定義 key 和過期時間,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧
2019-12-12
Java基礎之ClassLoader詳解
這篇文章主要介紹了Java基礎之ClassLoader詳解,文中對ClassLoader有非常詳細的解說,對正在學習java基礎的小伙伴們有非常好的幫助,需要的朋友可以參考下
2021-04-04
Java中Optional的正確用法與爭議點詳解
這篇文章主要介紹了Java中Optional的正確用法與爭議點的相關資料,需要的朋友可以參考下
2022-11-11
關于Java如何用好線程池的方法分享(建議收藏)
這篇文章主要來和大家分享幾個關于Java如何用好線程池的建議，文中的示例代碼講解詳細，具有一定的借鑒價值，感興趣的小伙伴可以了解一下
2023-06-06
解決spring @ControllerAdvice處理異常無法正確匹配自定義異常
這篇文章主要介紹了解決spring @ControllerAdvice處理異常無法正確匹配自定義異常的問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
2021-06-06
如何通過Java監(jiān)聽MySQL數(shù)據(jù)的變化
對于二次開發(fā)來說，很大一部分就找找文件和找數(shù)據(jù)庫的變化情況,下面這篇文章主要給大家介紹了關于如何通過Java監(jiān)聽MySQL數(shù)據(jù)的變化的相關資料,文中通過實例代碼介紹的非常詳細,需要的朋友可以參考下
2023-03-03
Spring中的@ConfigurationProperties詳解
這篇文章主要介紹了Spring中的@ConfigurationProperties詳解,ConfigurationProperties注解主要用于將外部配置文件配置的屬性填充到這個Spring Bean實例中,需要的朋友可以參考下
2023-09-09
gRPC與SpringBoot整合思路和步驟
在現(xiàn)代微服務架構中，gRPC已經成為了非常受歡迎的通信協(xié)議，與SpringBoot整合，它為開發(fā)者提供了簡潔、高效構建分布式應用，在整合gRPC與SpringBoot時，將gRPC的服務端和客戶端分別封裝到SpringBoot的應用中，感興趣的朋友一起看看吧
2023-08-08

欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片