mybatis-plus的使用 ------ 入門

前言:

mybatis在持久層框架中還是比較火的,一般項(xiàng)目都是基于ssm。雖然mybatis可以直接在xml中通過SQL語句操作數(shù)據(jù)庫,很是靈活。但正其操作都要通過SQL語句進(jìn)行,就必須寫大量的xml文件,很是麻煩。mybatis-plus就很好的解決了這個(gè)問題。

一、mybatis-plus簡介:

Mybatis-Plus(簡稱MP)是一個(gè) Mybatis 的增強(qiáng)工具,在 Mybatis 的基礎(chǔ)上只做增強(qiáng)不做改變,為簡化開發(fā)、提高效率而生。這是官方給的定義,關(guān)于mybatis-plus的更多介紹及特性,可以參考mybatis-plus官網(wǎng)。那么它是怎么增強(qiáng)的呢?其實(shí)就是它已經(jīng)封裝好了一些crud方法,我們不需要再寫xml了,直接調(diào)用這些方法就行,就類似于JPA。

二、spring整合mybatis-plus:

正如官方所說,mybatis-plus在mybatis的基礎(chǔ)上只做增強(qiáng)不做改變,因此其與spring的整合亦非常簡單。只需把mybatis的依賴換成mybatis-plus的依賴,再把sqlSessionFactory換成mybatis-plus的即可。接下來看具體操作:
1、pom.xml:
核心依賴如下:

    <!-- spring -->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>4.3.14.RELEASE</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-orm</artifactId>
        <version>4.3.14.RELEASE</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-test</artifactId>
        <version>4.3.14.RELEASE</version>
        <scope>test</scope>
    </dependency>
    <!-- mp 依賴 -->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus</artifactId>
        <version>2.3</version>
    </dependency>

注意:這些是核心依賴,本項(xiàng)目還用到了mysql驅(qū)動(dòng)、c3p0、日志(slf4j-api,slf4j-log4j2)、lombok。集成mybatis-plus要把mybatis、mybatis-spring去掉,避免沖突;lombok是一個(gè)工具,添加了這個(gè)依賴,開發(fā)工具再安裝Lombok插件,就可以使用它了,最常用的用法就是在實(shí)體類中使用它的@Data注解,這樣實(shí)體類就不用寫set、get、toString等方法了。關(guān)于Lombok的更多用法,請自行百度。
2、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>

3、jdbc.properties:

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql:///數(shù)據(jù)庫名?useUnicode=true&characterEncoding=utf8
jdbc.username=#
jdbc.password=#

4、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>

注:因?yàn)槭桥cspring整合,所有mybatis-plus的大部分都寫在spring的配置文件中,這里定義一個(gè)空的mybatis-config.xml即可。
5、spring-dao.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:p="http://www.springframework.org/schema/p"  
    xmlns:aop="http://www.springframework.org/schema/aop"   
    xmlns:context="http://www.springframework.org/schema/context"  
    xmlns:jee="http://www.springframework.org/schema/jee"  
    xmlns:tx="http://www.springframework.org/schema/tx"  
    xsi:schemaLocation="    
        http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.0.xsd  
        http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd  
        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd  
        http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee-4.0.xsd  
        http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.0.xsd">    
        
    <!-- 配置整合mybatis-plus過程 -->
    <!-- 1、配置數(shù)據(jù)庫相關(guān)參數(shù)properties的屬性:${url} -->
    <context:property-placeholder location="classpath:jdbc.properties" />
    <!-- 2、配置數(shù)據(jù)庫連接池 -->
    <bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">
        <property name="driverClass" value="${jdbc.driver}"/>
        <property name="jdbcUrl" value="${jdbc.url}"/>
        <property name="user" value="${jdbc.username}"/>
        <property name="password" value="${jdbc.password}"/>
    </bean>
    <!-- mybatis的sqlsessionFactorybean:org.mybatis.spring.SqlSessionFactoryBean-->
    <!-- 3、配置mybatis-plus的sqlSessionFactory -->
    <bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.spring.MybatisSqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource" />
        <property name="configLocation" value="classpath:mybatis-config.xml"/>
        <property name="typeAliasesPackage" value="com.zhu.mybatisplus.entity"/>
    </bean>
    <!-- 4、DAO接口所在包名,Spring會自動(dòng)查找其下的類 -->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <property name="basePackage" value="com.zhu.mybatisplus.dao" />
        <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"/>
    </bean> 
</beans>

6、entity:

@Data
@TableName(value = "tb_employee")//指定表名
public class Employee {
    //value與數(shù)據(jù)庫主鍵列名一致,若實(shí)體類屬性名與表主鍵列名一致可省略value
    @TableId(value = "id",type = IdType.AUTO)//指定自增策略
    private Integer id;
    //若沒有開啟駝峰命名,或者表中列名不符合駝峰規(guī)則,可通過該注解指定數(shù)據(jù)庫表中的列名,exist標(biāo)明數(shù)據(jù)表中有沒有對應(yīng)列
    @TableField(value = "last_name",exist = true)
    private String lastName;
    private String email;
    private Integer gender;
    private Integer age;
}

7、mapper:

public interface EmplopyeeDao extends BaseMapper<Employee> {
}

這樣就完成了mybatis-plus與spring的整合。首先是把mybatis和mybatis-spring依賴換成mybatis-plus的依賴,然后把sqlsessionfactory換成mybatis-plus的,然后實(shí)體類中添加@TableName、@TableId等注解,最后mapper繼承BaseMapper即可。
8、測試:

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration({"classpath:spring/spring-dao.xml"})
public class test {
    @Autowired
    private DataSource dataSource;
    @Test
    public void testDataSource() throws SQLException {
        System.out.println(dataSource.getConnection());
    }
}

運(yùn)行該junit,可輸出獲取到的連接,說明整合沒問題:

三、mp的通用crud:

需求:
存在一張 tb_employee 表,且已有對應(yīng)的實(shí)體類 Employee,實(shí)現(xiàn)tb_employee 表的 CRUD 操作我們需要做什么呢?
基于 Mybatis:
需要編寫 EmployeeMapper 接口,并在 EmployeeMapper.xml 映射文件中手動(dòng)編寫 CRUD 方法對應(yīng)的sql語句。
基于 MP:
只需要?jiǎng)?chuàng)建 EmployeeMapper 接口, 并繼承 BaseMapper 接口。
我們已經(jīng)有了Employee、tb_employee了,并且EmployeeDao也繼承了BaseMapper了,接下來就使用crud方法。
1、insert操作:

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration({"classpath:spring/spring-dao.xml"})
public class test {
    @Autowired
    private EmplopyeeDao emplopyeeDao;
    @Test
    public void testInsert(){
        Employee employee = new Employee();
        employee.setLastName("東方不敗");
        employee.setEmail("dfbb@163.com");
        employee.setGender(1);
        employee.setAge(20);
        emplopyeeDao.insert(employee);
        //mybatisplus會自動(dòng)把當(dāng)前插入對象在數(shù)據(jù)庫中的id寫回到該實(shí)體中
        System.out.println(employee.getId());
    }
}

執(zhí)行添加操作,直接調(diào)用insert方法傳入實(shí)體即可。

2、update操作:

@Test
public void testUpdate(){
        Employee employee = new Employee();
        employee.setId(1);
        employee.setLastName("更新測試");
        //emplopyeeDao.updateById(employee);//根據(jù)id進(jìn)行更新,沒有傳值的屬性就不會更新
        emplopyeeDao.updateAllColumnById(employee);//根據(jù)id進(jìn)行更新,沒傳值的屬性就更新為null
}

注:注意這兩個(gè)update操作的區(qū)別,updateById方法,沒有傳值的字段不會進(jìn)行更新,比如只傳入了lastName,那么age、gender等屬性就會保留原來的值;updateAllColumnById方法,顧名思義,會更新所有的列,沒有傳值的列會更新為null。
3、select操作:

(1)、根據(jù)id查詢:

Employee employee = emplopyeeDao.selectById(1);

(2)、根據(jù)條件查詢一條數(shù)據(jù):

Employee employeeCondition = new Employee();
employeeCondition.setId(1);
employeeCondition.setLastName("更新測試");
//若是數(shù)據(jù)庫中符合傳入的條件的記錄有多條,那就不能用這個(gè)方法,會報(bào)錯(cuò)
Employee employee = emplopyeeDao.selectOne(employeeCondition);

注:這個(gè)方法的sql語句就是where id = 1 and last_name = 更新測試,若是符合這個(gè)條件的記錄不止一條,那么就會報(bào)錯(cuò)。

(3)、根據(jù)查詢條件返回多條數(shù)據(jù):
當(dāng)符合指定條件的記錄數(shù)有多條時(shí),上面那個(gè)方法就會報(bào)錯(cuò),就應(yīng)該用這個(gè)方法。

Map<String,Object> columnMap = new HashMap<>();
columnMap.put("last_name","東方不敗");//寫表中的列名
columnMap.put("gender","1");
List<Employee> employees = emplopyeeDao.selectByMap(columnMap);
System.out.println(employees.size());

注:查詢條件用map集合封裝,columnMap,寫的是數(shù)據(jù)表中的列名,而非實(shí)體類的屬性名。比如屬性名為lastName,數(shù)據(jù)表中字段為last_name,這里應(yīng)該寫的是last_name。selectByMap方法返回值用list集合接收。
(4)、通過id批量查詢:

List<Integer> idList = new ArrayList<>();
idList.add(1);
idList.add(2);
idList.add(3);
List<Employee> employees = emplopyeeDao.selectBatchIds(idList);
System.out.println(employees);

注:把需要查詢的id都add到list集合中,然后調(diào)用selectBatchIds方法,傳入該list集合即可,該方法返回的是對應(yīng)id的所有記錄,所有返回值也是用list接收。

(5)、分頁查詢:

List<Employee> employees = emplopyeeDao.selectPage(new Page<>(1,2),null);
System.out.println(employees);

注:selectPage方法就是分頁查詢,在page中傳入分頁信息,后者為null的分頁條件,這里先讓其為null,講了條件構(gòu)造器再說其用法。這個(gè)分頁其實(shí)并不是物理分頁,而是內(nèi)存分頁。也就是說,查詢的時(shí)候并沒有l(wèi)imit語句。等配置了分頁插件后才可以實(shí)現(xiàn)真正的分頁。
4、delete操作:

(1)、根據(jù)id刪除:

emplopyeeDao.deleteById(1);

(2)、根據(jù)條件刪除:

Map<String,Object> columnMap = new HashMap<>();
columnMap.put("gender",0);
columnMap.put("age",18);
emplopyeeDao.deleteByMap(columnMap);

注:該方法與selectByMap類似,將條件封裝在columnMap中,然后調(diào)用deleteByMap方法,傳入columnMap即可,返回值是Integer類型,表示影響的行數(shù)。

(3)、根據(jù)id批量刪除:

 List<Integer> idList = new ArrayList<>();
 idList.add(1);
 idList.add(2);
 emplopyeeDao.deleteBatchIds(idList);

注:該方法和selectBatchIds類似,把需要?jiǎng)h除的記錄的id裝進(jìn)idList,然后調(diào)用deleteBatchIds,傳入idList即可。

四、全局策略配置:

通過上面的小案例我們可以發(fā)現(xiàn),實(shí)體類需要加@TableName注解指定數(shù)據(jù)庫表名,通過@TableId注解指定id的增長策略。實(shí)體類少倒也無所謂,實(shí)體類一多的話也麻煩。所以可以在spring-dao.xml的文件中進(jìn)行全局策略配置。

<!-- 5、mybatisplus的全局策略配置 -->
<bean id="globalConfiguration" class="com.baomidou.mybatisplus.entity.GlobalConfiguration">
        <!-- 2.3版本后,駝峰命名默認(rèn)值就是true,所以可不配置 -->
        <!--<property name="dbColumnUnderline" value="true"/>-->
        <!-- 全局主鍵自增策略,0表示auto -->
        <property name="idType" value="0"/>
        <!-- 全局表前綴配置 -->
        <property name="tablePrefix" value="tb_"/>
</bean>

這里配置了還沒用,還需要在sqlSessionFactory中注入配置才會生效。如下:

<!-- 3、配置mybatisplus的sqlSessionFactory -->
<bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.spring.MybatisSqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource" />
        <property name="configLocation" value="classpath:mybatis-config.xml"/>
        <property name="typeAliasesPackage" value="com.zhu.mybatisplus.entity"/>
        <!-- 注入全局配置 -->
        <property name="globalConfig" ref="globalConfiguration"/>
</bean>

如此一來,實(shí)體類中的@TableName注解和@TableId注解就可以去掉了。

五、條件構(gòu)造器(EntityWrapper):

以上基本的 CRUD 操作,我們僅僅需要繼承一個(gè) BaseMapper 即可實(shí)現(xiàn)大部分單表 CRUD 操作。BaseMapper 提供了多達(dá) 17 個(gè)方法供使用, 可以極其方便的實(shí)現(xiàn)單一、批量、分頁等操作,極大的減少開發(fā)負(fù)擔(dān)。但是mybatis-plus的強(qiáng)大不限于此,請看如下需求該如何處理:
需求:
我們需要分頁查詢 tb_employee 表中,年齡在 18~50 之間性別為男且姓名為 xx 的所有用戶,這時(shí)候我們該如何實(shí)現(xiàn)上述需求呢?
使用MyBatis : 需要在 SQL 映射文件中編寫帶條件查詢的 SQL,并用PageHelper 插件完成分頁. 實(shí)現(xiàn)以上一個(gè)簡單的需求,往往需要我們做很多重復(fù)單調(diào)的工作。
使用MP: 依舊不用編寫 SQL 語句,MP 提供了功能強(qiáng)大的條件構(gòu)造器 ------ EntityWrapper。

接下來就直接看幾個(gè)案例體會EntityWrapper的使用。

1、分頁查詢年齡在18 - 50且gender為0、姓名為tom的用戶:

List<Employee> employees = emplopyeeDao.selectPage(new Page<Employee>(1,3),
     new EntityWrapper<Employee>()
        .between("age",18,50)
        .eq("gender",0)
        .eq("last_name","tom")
);

注:由此案例可知,分頁查詢和之前一樣,new 一個(gè)page對象傳入分頁信息即可。至于分頁條件,new 一個(gè)EntityWrapper對象,調(diào)用該對象的相關(guān)方法即可。between方法三個(gè)參數(shù),分別是column、value1、value2,該方法表示column的值要在value1和value2之間;eq是equals的簡寫,該方法兩個(gè)參數(shù),column和value,表示column的值和value要相等。注意column是數(shù)據(jù)表對應(yīng)的字段,而非實(shí)體類屬性字段。
2、查詢gender為0且名字中帶有老師、或者郵箱中帶有a的用戶:

List<Employee> employees = emplopyeeDao.selectList(
                new EntityWrapper<Employee>()
               .eq("gender",0)
               .like("last_name","老師")
                //.or()//和or new 區(qū)別不大
               .orNew()
               .like("email","a")
);

注:未說分頁查詢,所以用selectList即可,用EntityWrapper的like方法進(jìn)行模糊查詢,like方法就是指column的值包含value值,此處like方法就是查詢last_name中包含“老師”字樣的記錄;“或者”用or或者orNew方法表示,這兩個(gè)方法區(qū)別不大,用哪個(gè)都可以,可以通過控制臺的sql語句自行感受其區(qū)別。

3、查詢gender為0,根據(jù)age排序,簡單分頁:

List<Employee> employees = emplopyeeDao.selectList(
                new EntityWrapper<Employee>()
                .eq("gender",0)
                .orderBy("age")//直接orderby 是升序,asc
                .last("desc limit 1,3")//在sql語句后面追加last里面的內(nèi)容(改為降序,同時(shí)分頁)
);

注:簡單分頁是指不用page對象進(jìn)行分頁。orderBy方法就是根據(jù)傳入的column進(jìn)行升序排序,若要降序,可以使用orderByDesc方法,也可以如案例中所示用last方法;last方法就是將last方法里面的value值追加到sql語句的后面,在該案例中,最后的sql語句就變?yōu)閟elect ······ order by desc limit 1, 3,追加了desc limit 1,3所以可以進(jìn)行降序排序和分頁。
4、分頁查詢年齡在18 - 50且gender為0、姓名為tom的用戶:
條件構(gòu)造器除了EntityWrapper,還有Condition。用Condition來處理一下這個(gè)需求:

 List<Employee> employees = emplopyeeDao.selectPage(
                new Page<Employee>(1,2),
                Condition.create()
                        .between("age",18,50)
                        .eq("gender","0")
 );

注:Condition和EntityWrapper的區(qū)別就是,創(chuàng)建條件構(gòu)造器時(shí),EntityWrapper是new出來的,而Condition是調(diào)create方法創(chuàng)建出來。

5、根據(jù)條件更新:

@Test
public void testEntityWrapperUpdate(){
        Employee employee = new Employee();
        employee.setLastName("蒼老師");
        employee.setEmail("cjk@sina.com");
        employee.setGender(0);
        emplopyeeDao.update(employee,
                new EntityWrapper<Employee>()
                .eq("last_name","tom")
                .eq("age",25)
        );
}

注:該案例表示把last_name為tom,age為25的所有用戶的信息更新為employee中設(shè)置的信息。
6、根據(jù)條件刪除:

emplopyeeDao.delete(
        new EntityWrapper<Employee>()
        .eq("last_name","tom")
        .eq("age",16)
);

注:該案例表示把last_name為tom、age為16的所有用戶刪除。

總結(jié):

以上便是mybatis-plus的入門教程,介紹了其如何與spring整合、通用crud的使用、全局策略的配置以及條件構(gòu)造器的使用,但是這并不是MP的所有內(nèi)容,其強(qiáng)大不限于此。避免篇幅過長,想了解mybatis-plus的更多用法請參考《mybatis-plus的使用 ------ 進(jìn)階》,同時(shí)在文末會給出案例的源碼。

以上內(nèi)容屬于個(gè)人筆記整理,如有錯(cuò)誤,歡迎批評指正!
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容