Spring中使用Mybatis-Plus

本文轉載自查看原文 2020-10-03 01:15 781 Mybatis-Plus/ java

簡介

概述

MyBatis-Plus（簡稱 MP）是一個 MyBatis 的增強工具，在 MyBatis 的基礎上只做增強不做改變，為簡化開發、提高效率而生。願景是成為 MyBatis 最好的搭檔，就像魂斗羅中的 1P、2P，基友搭配，效率翻倍。

官方文檔：https://mybatis.plus/

特性

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

框架結構

MP與Spring集成

1、准備數據表

CREATE TABLE mp_user
(
    id BIGINT(20) NOT NULL AUTO_INCREMENT 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 mp_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、創建普通的Maven工程，在pom文件中添加依賴。

<!-- 配置版本屬性 -->
<properties>
    <mybatisplus.version>3.4.0</mybatisplus.version>
    <spring.version>5.2.8.RELEASE</spring.version>
    <mysql.version>5.1.47</mysql.version>
    <!-- 注意只能使用2.0以下的版本 -->
    <log4j.version>1.2.17</log4j.version>
</properties>

<dependencies>
    <!-- mybatis-plus會自動維護mybatis以及mybatis與spring的整合-->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus</artifactId>
        <version>${mybatisplus.version}</version>
    </dependency>

    <!-- 導入spring -->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-aspects</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-aop</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-core</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-expression</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-orm</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-jdbc</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-tx</artifactId>
        <version>${spring.version}</version>
    </dependency>

    <!-- mysql數據庫驅動 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>${mysql.version}</version>
    </dependency>
    <!-- c3p0連接池 -->
    <dependency>
        <groupId>com.mchange</groupId>
        <artifactId>c3p0</artifactId>
        <version>0.9.5.2</version>
    </dependency>

    <!-- log4j -->
    <dependency>
        <groupId>log4j</groupId>
        <artifactId>log4j</artifactId>
        <version>${log4j.version}</version>
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-log4j12</artifactId>
        <version>1.6.6</version>
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.30</version>
    </dependency>

    <!-- junit測試 -->
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.12</version>
    </dependency>
</dependencies>

特別說明：Mybatis 及 Mybatis-Spring 依賴請勿加入項目配置，以免引起版本沖突，Mybatis-Plus 會自動維護。

3、准備log4j日志配置文件、數據庫連接配置、mybatis的配置文件及spring的配置文件。

log4j.properties

log4j.rootLogger=DEBUG,myConsole
log4j.appender.myConsole=org.apache.log4j.ConsoleAppender
log4j.appender.myConsole.ImmediateFlush=true
log4j.appender.myConsole.Target=System.out
log4j.appender.myConsole.layout=org.apache.log4j.PatternLayout
log4j.appender.myConsole.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

log4j.logger.com.mchange.v2=ERROR

jdbc.properties

jdbc.user=root
jdbc.password=root123
jdbc.url=jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf8
jdbc.driver=com.mysql.jdbc.Driver

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>

applicationContext.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:aop="http://www.springframework.org/schema/aop"
	xmlns:context="http://www.springframework.org/schema/context"
	xmlns:tx="http://www.springframework.org/schema/tx"
	xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
		http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.3.xsd
		http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.3.xsd
		http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.3.xsd">
	
	<!-- 配置數據源 -->
	<context:property-placeholder location="classpath:jdbc.properties"/>

	<bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">
		<property name="user" value="${jdbc.user}"/>
		<property name="password" value="${jdbc.password}"/>
		<property name="jdbcUrl" value="${jdbc.url}"/>
		<property name="driverClass" value="${jdbc.driver}"/>
	</bean>

	<!-- 整合MyBatis -->
	<!-- mybatis提供的：org.mybatis.spring.SqlSessionFactoryBean -->
	<!-- mp提供的：com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean -->
	<bean id="sqlSessionFactoryBean" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
		<property name="configLocation" value="classpath:mybatis-config.xml"/>
		<property name="dataSource" ref="dataSource"/>
		<!-- 別名處理 -->
		<property name="typeAliasesPackage" value="com.coydone.entity"></property>
		<!-- 注入全局策略配置 -->
		<property name="globalConfig" ref="globalConfig"/>
	</bean>

	<!-- 配置MP的全局策略配置 -->
	<bean id="globalConfig" class="com.baomidou.mybatisplus.core.config.GlobalConfig">
		<property name="dbConfig" ref="dbConfig"/>
	</bean>
	<bean id="dbConfig" class="com.baomidou.mybatisplus.core.config.GlobalConfig.DbConfig">
		<property name="idType" value="AUTO"></property>
	</bean>
	<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
		<property name="basePackage" value="com.coydone.mapper"/>
	</bean>

	<!-- 配置Service自動掃描的包 -->
	<context:component-scan base-package="com.coydone.service"/>

	<!-- 配置聲明式事務 -->
	<bean id="dataSourceTransactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
		<property name="dataSource" ref="dataSource"/>
	</bean>

	<aop:config>
		<aop:advisor advice-ref="txAdvice" pointcut="execution(* *..*Service.*(..))"/>
	</aop:config>

	<tx:advice id="txAdvice" transaction-manager="dataSourceTransactionManager">
		<tx:attributes>
			<tx:method name="get*" read-only="true"/>
			<tx:method name="add*" rollback-for="java.lang.Exception" propagation="REQUIRES_NEW"/>
			<tx:method name="delete*" rollback-for="java.lang.Exception" propagation="REQUIRES_NEW"/>
			<tx:method name="update*" rollback-for="java.lang.Exception" propagation="REQUIRES_NEW"/>
		</tx:attributes>
	</tx:advice>
</beans>

MP和Spring完成基本CRUD

整合MP

1、在Spring的配置文件中，將sqlSessionFactoryBean的配置改為MP的。

<bean id="sqlSessionFactoryBean" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
</bean>

2、編寫數據庫表對應的實體類。

public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
    //省略有參構造、無參構造、getter()、setter()、toString()方法
}

3、編寫mapper接口。

繼承MP的BaseMapper接口，此時對單表的基本CRUD操作無需寫Mapper映射文件，使用方法同通用Mapper，這里利用了JPA的原理

public interface UserMapper extends BaseMapper<User> {
}

4、編寫測試方法對BaseMapper接口中的方法測試。

public class MapperTest {
    private ApplicationContext ac = new ClassPathXmlApplicationContext("applicationContext.xml");
    private UserMapper userMapper = ac.getBean(UserMapper.class);
    @Test
    public void testAdd(){
        User user = new User(null, "李四", 22, "ls@163.com");
        int i = userMapper.insert(user);
        System.out.println(i);
        //獲取插入的主鍵id
        System.out.println(user.getId());
    }
}

這里的id值為null，id采取自增形式。我們需要在實體類中對其進行配置。

@TableName("mp_user")
public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
}

@TableName()注解用於將數據庫表與實體類相互映射，默認為下划線轉大寫。（mp_user→MpUser）。
@TableId()注解用於指定實體類中的主鍵Id字段，type = IdType.AUTO表示id自增。

如果不想在每個實體類中這樣指定，我們可以在Spring的配置文件中配置MP的全局策略。

<bean id="sqlSessionFactoryBean" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
    <!-- 注入全局策略配置 -->
    <property name="globalConfig" ref="globalConfig"/>
</bean>

<!-- 配置MP的全局策略配置 -->
<bean id="globalConfig" class="com.baomidou.mybatisplus.core.config.GlobalConfig">
    <property name="dbConfig" ref="dbConfig"/>
</bean>
<bean id="dbConfig" class="com.baomidou.mybatisplus.core.config.GlobalConfig.DbConfig">
    <!-- 配置主鍵id自增 -->
    <property name="idType" value="AUTO"></property>
</bean>

詳細說明見官方文檔：https://mybatis.plus/config/#dbconfig-2

@TableField(exist = false)表示實體中的字段在數據庫表中不存在。

配置xxxMapper.xml

如在resources下的mapper目錄下創建UserMapper.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.coydone.mapper.UserMapper">
</mapper>

在Spring配置文件中配置其所在位置。在sqlSessionFactoryBean下。

<!-- 加載xxxMapper.xml -->
<property name="mapperLocations">
   <array>
      <value>classpath:mapper/*Mapper.xml</value>
   </array>
</property>

增加

int insert(T entity);

該方法會自動將主鍵值回寫到實體類中，支持可變的插入，如我們要插入的字段只是表的一部分，MP會自動判斷是否為空，進行靈活的插入。

刪除

//根據id刪除
int deleteById(Serializable id);
//根據map條件刪除（map為表字段的map對象）
int deleteByMap(@Param("cm") Map<String, Object> columnMap);
//條件刪除
int delete(@Param("ew") Wrapper<T> wrapper);
//通過id批量刪除
int deleteBatchIds(@Param("coll") Collection<? extends Serializable> idList);

@Test
public void testDelete(){
    //根據id批量刪除
    List<Serializable> idList= new ArrayList<>();
    idList.add(8);
    idList.add(9);
    int rows = userMapper.deleteBatchIds(idList);
    System.out.println(rows);//2
}
@Test
public void testDeleteByMap(){
    //刪除id為2的記錄
    Map<String, Object> map = new HashMap<>();
    map.put("id",2);
    userMapper.deleteByMap(map);
}

修改

//根據主鍵修改
int updateById(@Param("et") T entity);
//根據條件修改
int update(@Param("et") T entity, @Param("ew") Wrapper<T> updateWrapper);

@Test
public void testUpdateById(){
    //根據id修改
    int rows = userMapper.updateById(new User(3L, "趙六", 20, "zl@163.com"));
    System.out.println(rows);//1
}
@Test
//將姓名為 yasuo 的用戶的姓名修改為 亞索。
public void testUpdate(){
    User user = new User();
    user.setName("亞索");
    //使用條件構造器
    UpdateWrapper<User> userWrapper = new UpdateWrapper<>();
    userWrapper.eq("name","yasuo");
    userMapper.update(user, userWrapper);
}

查詢

//通過id查詢一個
T selectById(Serializable id);
//通過id批量查詢多個
List<T> selectBatchIds(@Param("coll") Collection<? extends Serializable> idList);

@Test
//根據id批量查詢
public void testSelect2(){
    List idList = new ArrayList();
    idList.add(3);
    idList.add(5);
    idList.add(6);
    List<User> list = userMapper.selectBatchIds(idList);
    for (User user : list) {
        System.out.println(user);
    }
}

@Test
//查詢年齡在20-22之間或者姓名為coydone的用戶
public void testSelect3(){
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.between("age", 20, 22).or().eq("name","coydone");
    List<User> users = userMapper.selectList(queryWrapper);
    for (User user : users) {
        System.out.println(user);
    }
}

MP-AR模式開發

AR(ActiveRecord)：ActiveRecord 一直廣受動態語言（ PHP 、 Ruby 等）的喜愛，而 Java 作為准靜態語言，對於ActiveRecord 往往只能感嘆其優雅，然后MP提供了一套API可以把靜態變成動態。

讓實體類繼承Model接口。

public class User extends Model<User> implements Serializable {}

此時調用user對象時，它本身就有了userMapper的所有方法，可以通過自己調用其CRUD方法。

@Test
public void testAR1(){
    User user = new User();
    user.deleteById(3);
}
@Test
public void testAR2(){
    User user = new User();
    User selectById = user.selectById(4);
    System.out.println(selectById);
}

MP的分頁

在Spring的配置文件中配置分頁插件。在sqlSessionFactoryBean下。

<property name="plugins">
    <array>
        <!-- 配置分頁插件 -->
        <bean class="com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor"></bean>
    </array>
</property>

@Test
public void testSelect4(){
    IPage<User> page=new Page<>(1, 5);
    userMapper.selectPage(page, null);
    System.out.println("總條數:"+page.getTotal());
    System.out.println("總頁數："+page.getPages());
    System.out.println("當前頁碼："+page.getCurrent());
    System.out.println("每頁條數："+page.getSize());
    page.getRecords().forEach(user -> System.out.println(user));
}

條件構造器

MP的條件構造器為Wrapper，其作用是為我們動態拼接SQL。

官方文檔：https://mybatis.plus/guide/wrapper.html

代碼生成器

MP 的代碼生成器可生成: 實體類(可以選擇是否支持 AR)、Mapper 接口、Mapper 映射文件、 Service 層、Controller 層。

代碼生成器依賴

1、模板引擎

MP 的代碼生成器默認使用的是 Apache 的 Velocity 模板，當然也可以更換為別的模板技術，例如 freemarker。需要加入 Apache Velocity 的依賴。

2、加入mybatis-plus-generator依賴。

<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.2</version>
</dependency>
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.4.0</version>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.47</version>
</dependency>

MP 代碼生成器示例代碼

package com.coydone.generator;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;

public class CodeGenerator {
    public static void main(String[] args) {
        // 1、全局配置
        GlobalConfig config = new GlobalConfig();
        config.setActiveRecord(true) // 是否支持AR模式
                .setAuthor("coydone")   // 作者
                .setOutputDir("E:\\idea_workspace\\zixue\\mp_generator\\src\\main\\java") // 生成路徑
                .setFileOverride(true) // 文件覆蓋
                .setOpen(false)//是否打開文件目錄
                .setIdType(IdType.AUTO) // 主鍵策略自增
                .setServiceName("%sService") //設置生成的service接口名首字母是否為I,默認是以I開頭
                .setBaseColumnList(true) // 基本列
                .setBaseResultMap(true); // 返回結果map

        // 2、數據源配置
        DataSourceConfig dataSourceConfig = new DataSourceConfig();
        dataSourceConfig.setDbType(DbType.MYSQL) // 設置數據庫類型
                .setDriverName("com.mysql.jdbc.Driver")
                .setUrl("jdbc:mysql:///kgcnews?useUnicode=true&characterEncoding=UTF-8")
                .setUsername("root")
                .setPassword("root123");

        // 3、策略配置
        StrategyConfig stConfig = new StrategyConfig();
        stConfig.setCapitalMode(true) // 全局大寫命名
                .setColumnNaming(NamingStrategy.underline_to_camel)  //表名 字段名 是否使用下滑線命名
                .setNaming(NamingStrategy.underline_to_camel) // 數據庫表映射到實體的命名策略
                .setTablePrefix("news_");// 表前綴
                //生成的表,不寫表示生成所有的表
                // .setInclude("news_category");

        // 4、包名策略配置
        PackageConfig pkConfig = new PackageConfig();
        pkConfig.setParent("com.coydone")
                .setController("controller")
                .setEntity("entity")
                .setMapper("mapper")
                .setService("service")
                .setXml("mapper");

        // 5、整合配置
        AutoGenerator ag = new
                AutoGenerator().setGlobalConfig(config)
                .setDataSource(dataSourceConfig)
                .setStrategy(stConfig)
                .setPackageInfo(pkConfig);

        // 6、執行
        ag.execute();
    }
}

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。

猜您在找 Spring Cloud集成 Mybatis-plus使用 mybatis-plus集成spring boot使用 Mybatis-plus的使用 Mybatis-Plus的使用 MyBatis-Plus使用 MyBatis-Plus And和Or的使用 MyBatis-Plus 的使用 mybatis-plus中使用FIND_IN_SET函數 spring集成mybatis-plus mybatis-plus中使用 Wrapper 自定義SQL