Mybatis生產(chǎn)力工具 mybatis generator

mybatis是數(shù)據(jù)庫開發(fā)最常用的ORM框架,目前有很多碼農(nóng)仍然采用傳統(tǒng)的手工編寫sql語句的方式來開發(fā),
經(jīng)常出現(xiàn)的問題是工作量大,字段名拼寫錯誤,排錯困難,特別是做老代碼維護(hù),更是巨大的陷阱,雷同語句多,誰都不敢動,需求來了只能新增語句(這也符合開閉原則,哈哈),面對系統(tǒng)不斷增加的熵值,你該如何解呢?

我給大家介紹一款生產(chǎn)力工具mybatis generator.它是一款mybatis 代碼生成器,可以自動生成dto,dao及sqlmapper.xml,其中的亮點是自動生成可編程的動態(tài)查詢構(gòu)造器--Example,采用這款工具基本可以應(yīng)付90%的開發(fā)場景,都可以不用寫sql語句.更值得一提的是

使用非常簡單!!!

下面簡要介紹下這款工具
本文采用Maven插件mybatis-generator-maven-plugin來配置MyBatis Generator

準(zhǔn)備條件:maven工程,mysql庫

1. 增加maven依賴

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

    <dependency>
      <groupId>org.mybatis</groupId>
      <artifactId>mybatis</artifactId>
      <version>3.4.0</version>
    </dependency>

    <dependency>
      <groupId>org.mybatis</groupId>
      <artifactId>mybatis-spring</artifactId>
      <version>1.3.0</version>
    </dependency>

2. 增加maven插件

<build>
    <plugins>
        <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.3.2</version>
            <configuration>
                <verbose>true</verbose>
                <overwrite>true</overwrite>
                <!--mybatis generator配置文件-->
                <configurationFile>src/main/resources/db-init/generatorConfig.xml</configurationFile>
            </configuration>
    
            <dependencies>
                <!-- 數(shù)據(jù)庫驅(qū)動  -->
                <dependency>
                    <groupId>mysql</groupId>
                    <artifactId>mysql-connector-java</artifactId>
                    <version>${mysql.version}</version>
                </dependency>
            </dependencies>
        </plugin>
    </plugins>
</build>

3. 編輯mybatis-generator配置文件

<?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE generatorConfiguration
    PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
    "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">

    <generatorConfiguration>
        <context id="mysqlTables" targetRuntime="MyBatis3">
            <commentGenerator>
                <property name="suppressDate" value="false"/>
                <property name="suppressAllComments" value="true"/>
            </commentGenerator>
            <!--目標(biāo)數(shù)據(jù)庫配置-->
            <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                    connectionURL="jdbc:mysql://localhost:3306/test?useUnicode=true&amp;characterEncoding=utf-8&amp;useSSL=false&amp;nullNamePatternMatchesAll=true"
         userId="root" password="root"/>
            <!-- 指定生成的類型為java類型，避免數(shù)據(jù)庫中number等類型字段 -->
            <javaTypeResolver>
                  <property name="forceBigDecimals" value="false"/>
            </javaTypeResolver>
            <!-- 生成model模型，對應(yīng)的包，存放位置可以指定具體的路徑,如/ProjectName/src，也可以使用MAVEN來自動生成 -->
            <javaModelGenerator targetPackage="org.test.repo.dto" targetProject="src/main/java">
                <property name="enableSubPackages" value="false"/>
                <property name="trimStrings" value="true"/>
                <property name="immutable" value="false"/>
            </javaModelGenerator>
            <!--對應(yīng)的xml mapper文件  -->
            <sqlMapGenerator targetPackage="org.test.repo.dao.mapper"  targetProject="src/main/java">
                <property name="enableSubPackages" value="false"/>
            </sqlMapGenerator>
            <!-- 對應(yīng)的dao接口 -->
            <javaClientGenerator type="XMLMAPPER" targetPackage="org.test.repo.dao" targetProject="src/main/java">
                <property name="enableSubPackages" value="false"/>
            </javaClientGenerator>
              <!--定義需要操作的表及對應(yīng)的DTO名稱-->
            <table tableName="order" domainObjectName="OrderDTO"/>
            <table tableName="order_item" domainObjectName="OrderItemDTO"/>
        </context>
</generatorConfiguration>

4. 生成dto,dao和mapper.xml文件

image.png

雙擊運行mybatis-generator.generate插件會自動生成dto,dao,example和mapper.xml文件

也可以通過運行mvn mybatis-generator:generate命令來生成代碼

生成文件如圖所示

image.png

我創(chuàng)建了order,order_item兩張表做例子,紅色圈自動生成的動態(tài)查詢構(gòu)造器Example,每張表都生成一個對應(yīng)的Example類.

5. mapper類介紹

mapper也就是數(shù)據(jù)庫訪問類dao,我們看下都有什么內(nèi)容

package org.dev.repo.dao;

import java.util.List;
import org.apache.ibatis.annotations.Param;
import org.dev.repo.dto.OrderDTO;
import org.dev.repo.dto.OrderDTOExample;

public interface OrderDTOMapper {
    //通過條件計數(shù)
    int countByExample(OrderDTOExample example);
    //通過條件刪除
    int deleteByExample(OrderDTOExample example);
    //通過主鍵刪除
    int deleteByPrimaryKey(Long id);
    //插入DTO
    int insert(OrderDTO record);
    //dto非空字段插入
    int insertSelective(OrderDTO record);
    //條件查詢,返回結(jié)果包括text等大字段
    List<OrderDTO> selectByExampleWithBLOBs(OrderDTOExample example);
    //條件查詢,返回結(jié)果不包括text等大字段
    List<OrderDTO> selectByExample(OrderDTOExample example);
    //通過主鍵查詢
    OrderDTO selectByPrimaryKey(Long id);
    //條件更新,只更新dto中非空字段的值
    int updateByExampleSelective(@Param("record") OrderDTO record, @Param("example") OrderDTOExample example);
    //條件更新全部字段,并包含text等大字段
    int updateByExampleWithBLOBs(@Param("record") OrderDTO record, @Param("example") OrderDTOExample example);
    //條件更新dto全部字段
    int updateByExample(@Param("record") OrderDTO record, @Param("example") OrderDTOExample example);
    //通過主鍵更新,dto非空字段
    int updateByPrimaryKeySelective(OrderDTO record);
    //通過主鍵更新,dto全部字段,包含text等大字段
    int updateByPrimaryKeyWithBLOBs(OrderDTO record);
    //通過主鍵更新,dto全部字段,不包含text等大字段
    int updateByPrimaryKey(OrderDTO record);
}

通過OrderDTOMapper.java,我們看出基本我們常用的創(chuàng)建,修改,查詢和刪除都有了.

我們來看下幾個常用方法:

  • 最常用的動態(tài)查詢方法selectByExample(OrderDTOExample example),簡單通過構(gòu)造不同的example對象就可以實現(xiàn).
  • 后綴為Selective的插入和更新方法,只處理dto對象的非空字段,例如經(jīng)常我們只想更新某些記錄的部分字段,那么updateByExampleSelective方法最合適不過.
  • 后綴為WithBLOBs的方法是對大字段的處理方法,與常規(guī)處理方法分離,也體現(xiàn)了作者的周到.

6. 動態(tài)查詢例子

我們看下如何使用Example來進(jìn)行動態(tài)查詢

例如:我們要查詢id為123456用戶在2017年1月1日后金額在300元以上的所有訂單,并按照創(chuàng)建時間倒排序,可以構(gòu)建如下語句

LocalDate ld=LocalDate.of(2017,1,1);
Instant instant = Instant.from(ld);
Date date = Date.from(instant);

OrderDTOExample example=new OrderDTOExample();
//設(shè)置排序字段
example.setOrderByClause(" order by create_time desc ");

//創(chuàng)建查詢條件對象
example.createCriteria().andCustomerIdEqualTo(123456L).
andCreateTimeGreaterThan(date).
andPaymentAmtGreaterThan(300L);

//執(zhí)行查詢
return orderMapper.selectByExample(example);

一個動態(tài)查詢不到一分鐘就寫出來了,沒有特殊需求,根本不用寫sql,簡單不簡單,驚喜不驚喜!!!

條件更新的使用方法類似,有興趣可以自己試下.

7. 解析Example及sqlmapper.xml

通常表中的每個字段會生成對應(yīng)Example.Criteria對象的12個方法

例如創(chuàng)建時間這個字段就生成了相等,不相等,區(qū)間內(nèi),區(qū)間外,大于,小于,空,非空等方法,基本覆蓋了常用的計算表達(dá)式

image.png

我們再來看看example對象的內(nèi)部結(jié)構(gòu)

image.png

我們可以看到在Example類中有三個內(nèi)部類Criteria,Criterion,GeneratedCriteria

  • Criteria是查詢條件類,繼承GeneratedCriteria類,,我們構(gòu)造查詢條件就是使用它的方法,它由Example對象的createCriteria()方法來創(chuàng)建.
  • Criterion是存儲字段的條件,例如id=5這個條件就是存儲在這個類對象的屬性中.
  • GeneratedCriteria是Criteria父類,Example對象映射表的每個字段的12個方法都屬于這個類,它保存一組Criterion對象.

我們來分析下動查詢的sqlmapper.xml片段

  <select id="selectByExample" parameterType="org.dev.repo.dto.OrderDTOExample" resultMap="BaseResultMap">
    select
    <!--對應(yīng)Example中的distinct屬性 -->
    <if test="distinct">
      distinct
    </if>
    <!-- sql片段,order表字段 -->
    <include refid="Base_Column_List" />
    from order
    <if test="_parameter != null">
      <!--這里是重點,sql片段,查詢條件-->
      <include refid="Example_Where_Clause" />
    </if>
    <!--對應(yīng)Example中的orderByClause屬性 -->
    <if test="orderByClause != null">
      order by ${orderByClause}
    </if>
  </select>

我們再看下sqlmapper.xml是如何構(gòu)造動態(tài)查詢條件

<sql id="Example_Where_Clause">
    <where>
      <!-- 遍歷Example中的oredCriteria屬性中的元素Criteria,多個Criteria組成or條件 -->
      <foreach collection="oredCriteria" item="criteria" separator="or">
      <!-- 如果Example.Criteria對象存在一個或多個Criterion對象那么進(jìn)行遍歷,多個Criterion構(gòu)成and條件 -->
        <if test="criteria.valid">
          <trim prefix="(" prefixOverrides="and" suffix=")">
            <foreach collection="criteria.criteria" item="criterion">
              <choose>
                <!-- 無值條件,例如name is null -->
                <when test="criterion.noValue">
                  and ${criterion.condition}
                </when>
                <!-- 單值條件,例如 name='張三' -->
                <when test="criterion.singleValue">
                  and ${criterion.condition} #{criterion.value}
                </when>
                <!-- 雙值條件,對應(yīng)between -->
                <when test="criterion.betweenValue">
                  and ${criterion.condition} #{criterion.value} and #{criterion.secondValue}
                </when>
                <!-- 多值條件,對應(yīng)in -->
                <when test="criterion.listValue">
                  and ${criterion.condition}
                  <foreach close=")" collection="criterion.value" item="listItem" open="(" separator=",">
                    #{listItem}
                  </foreach>
                </when>
              </choose>
            </foreach>
          </trim>
        </if>
      </foreach>
    </where>
  </sql>

通過以上sqlmapper.xml我們可以看出Example對象及它的內(nèi)部對象屬性在運行時被mybatis框架循環(huán)遍歷解析成動態(tài)sql語句,與我們手寫sql語句并無差別.

再舉個例子來收官

例如我們想查詢id等于123456的客戶在2017年11月11日的訂單

對應(yīng)的sql查詢條件是
customer_id=5 and create_time between '2017-11-11 00:00' and '2017-11-11 23:59'

對應(yīng)的程序代碼是
LocalDateTime start=LocalDateTime.of(2017,11,11,0,0);
Instant instant_start = Instant.from(start);
Date date_start = Date.from(instant_start);

LocalDateTime end=LocalDateTime.of(2017,11,11,23,59);
Instant instant_end = Instant.from(end);
Date date_end = Date.from(instant_end);

OrderDTOExample example=new OrderDTOExample();

example.createCriteria().andCustomerIdEqualTo(123456L).
andCreateTimeBetween(date_start,date_end);
        
return orderMapper.selectByExample(example);

在這段程序中andCustomerIdEqualTo(123456L)和andCreateTimeBetween(date_start,date_end),實際上創(chuàng)建了兩個Criterion對象,并被Example對象內(nèi)的Criteria對象持有.mybatis框架運行時會按照sqlmapper.xml中定義的標(biāo)簽去遍歷解析Criteria對象(多個Criteria組成or關(guān)系),及Criteria對象中的所有Criterion對象(多個Criterion組成and關(guān)系),最終組成完整的sql語句,交給jdbc執(zhí)行.

8. 擴(kuò)展話題

  • 關(guān)于大文本字段的處理,需要自己實現(xiàn)org.apache.ibatis.type.BaseTypeHandler類,并配置到mybatis配置文件中才能正常使用,否則會出錯;

  • 批量寫入和更新,仍然可以使用dao提供的所有方法,只是Mapper對象需要從sqlSession中獲取,session需要設(shè)置成批量模式和禁止自動提交

    public<T,M extends BaseMapper> long saveBatch(List<T> newRecord, Class<M> clazz) {

        Stopwatch sw=Stopwatch.createStarted();

        long rows=0;

        try(SqlSession sqlSession=sqlSessionFactory.openSession(ExecutorType.BATCH,false)){
            BaseMapper mapper=sqlSession.getMapper(clazz);
            rows=newRecord.stream().map(i->mapper.insertSelective(i)).collect(Collectors.counting());
            sqlSession.clearCache();
            sqlSession.commit();
        }

        sw.stop();
        log.info("batch insert ,total consume="+sw.elapsed(TimeUnit.MILLISECONDS)+"ms");
        return rows;
    }

9. 參考:

官網(wǎng)和教程http://www.mybatis.org/generator/index.html

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

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