1. 程式人生 > 程式設計 >MyBatis通用Mapper和PageHelper的過程詳解

MyBatis通用Mapper和PageHelper的過程詳解

如果專案中使用到了MyBatis框架,那麼使用通用Mapper和PageHelper分頁外掛將極大的簡化我們的操作。通用Mapper可以簡化對單表的CRUD操作,PageHelper分頁外掛可以幫我們自動拼接分頁SQL,並且可以使用MyBatis Geneator來自動生成實體類,Mapper介面和Mapper xml程式碼,非常的方便。外掛地址及作者連結https://gitee.com/free 。

引入依賴

這裡使用Spring Boot來構建,可參考Spring-Boot中使用Mybatis.html搭建一個Spring boot + MyBatis的框架,然後在pom中引入:

<!-- mybatis -->
<dependency>
  <groupId>org.mybatis.spring.boot</groupId>
  <artifactId>mybatis-spring-boot-starter</artifactId>
  <version>1.3.1</version>
</dependency>
<!-- 通用mapper -->
<dependency>
  <groupId>tk.mybatis</groupId>
  <artifactId>mapper-spring-boot-starter</artifactId>
  <version>1.1.5</version>
</dependency>
<!-- pagehelper 分頁外掛 -->
<dependency>
  <groupId>com.github.pagehelper</groupId>
  <artifactId>pagehelper-spring-boot-starter</artifactId>
  <version>1.2.3</version>
</dependency>

接著在pom中配置MyBatis Geneator:

<build>
  <plugins>
    <plugin>
      <groupId>org.mybatis.generator</groupId>
      <artifactId>mybatis-generator-maven-plugin</artifactId>
      <version>1.3.5</version>
      <dependencies>
        <dependency>
          <!-- 資料庫連線驅動 -->
          <groupId>com.oracle</groupId>
          <artifactId>ojdbc6</artifactId>
          <version>6.0</version>
        </dependency>
        <dependency>
          <groupId>tk.mybatis</groupId>
          <artifactId>mapper</artifactId>
          <version>3.4.0</version>
        </dependency>
      </dependencies>
      <executions>
        <execution>
          <id>Generate MyBatis Artifacts</id>
          <phase>package</phase>
          <goals>
            <goal>generate</goal>
          </goals>
        </execution>
      </executions>
      <configuration>
        <!--允許移動生成的檔案 -->
        <verbose>true</verbose>
        <!-- 是否覆蓋 -->
        <overwrite>true</overwrite>
        <!-- 自動生成的配置 -->
        <configurationFile>src/main/resources/mybatis-generator.xml</configurationFile>
      </configuration>
    </plugin>
  </plugins>
</build>

src/main/resources/mybatis-generator.xml為生成器的配置,下文會介紹到。

配置外掛
在Spring Boot配置檔案application.yml中配置MyBatis:

mybatis:
 # type-aliases掃描路徑
 type-aliases-package: com.springboot.bean
 # mapper xml實現掃描路徑
 mapper-locations: classpath:mapper/*.xml
 property:
  order: BEFORE

接下來開始配置外掛。

配置通用Mapper
在Spring Boot配置檔案application.yml中配置通用Mapper:

#mappers 多個介面時逗號隔開
mapper:
 mappers: com.springboot.config.MyMapper
 not-empty: false
 identity: oracle

關於引數的說明,參考https://gitee.com/free/Mapper/blob/master/wiki/mapper3/2.Integration.md中的可配引數介紹。

除此之外,我們需要定義一個MyMapper介面:

import tk.mybatis.mapper.common.Mapper;
import tk.mybatis.mapper.common.MySqlMapper;

public interface MyMapper<T> extends Mapper<T>,MySqlMapper<T> {
	
}

值得注意的是,該介面不能被掃描到,應該和自己定義的Mapper分開。自己定義的Mapper都需要繼承這個介面。

配置PageHelper
在Spring Boot配置檔案application.yml中配置通用配置PageHelper:

#pagehelper
pagehelper: 
 helperDialect: oracle
 reasonable: true
 supportMethodsArguments: true
 params: count=countSql

引數相關說明參考https://github.com/pagehelper/Mybatis-PageHelper/blob/master/wikis/zh/HowToUse.md中的分頁外掛引數介紹。

配置Geneator*
在路徑src/main/resources/下新建mybatis-generator.xml:

<?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="oracle" targetRuntime="MyBatis3Simple" defaultModelType="flat">

    <plugin type="tk.mybatis.mapper.generator.MapperPlugin">
      <!-- 該配置會使生產的Mapper自動繼承MyMapper -->
      <property name="mappers" value="com.springboot.config.MyMapper" />
      <!-- caseSensitive預設false,當資料庫表名區分大小寫時,可以將該屬性設定為true -->
      <property name="caseSensitive" value="false"/>
    </plugin>

    <!-- 阻止生成自動註釋 -->
    <commentGenerator>
      <property name="javaFileEncoding" value="UTF-8"/>
      <property name="suppressDate" value="true"/>
      <property name="suppressAllComments" value="true"/>
    </commentGenerator>

    <!-- 資料庫連結地址賬號密碼 -->
    <jdbcConnection 
      driverClass="oracle.jdbc.driver.OracleDriver"
      connectionURL="jdbc:oracle:thin:@localhost:1521:ORCL"
      userId="scott"
      password="6742530">
    </jdbcConnection>

    <javaTypeResolver>
      <property name="forceBigDecimals" value="false"/>
    </javaTypeResolver>

    <!-- 生成Model類存放位置 -->
    <javaModelGenerator targetPackage="com.springboot.bean" targetProject="src/main/java">
      <property name="enableSubPackages" value="true"/>
      <property name="trimStrings" value="true"/>
    </javaModelGenerator>

    <!-- 生成對映檔案存放位置 -->
    <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">
      <property name="enableSubPackages" value="true"/>
    </sqlMapGenerator>

    <!-- 生成Dao類存放位置 -->
    <!-- 客戶端程式碼,生成易於使用的針對Model物件和XML配置檔案的程式碼
      type="ANNOTATEDMAPPER",生成Java Model 和基於註解的Mapper物件
      type="XMLMAPPER",生成SQLMap XML檔案和獨立的Mapper介面 -->
    <javaClientGenerator type="XMLMAPPER" targetPackage="com.springboot.mapper" targetProject="src/main/java">
      <property name="enableSubPackages" value="true"/>
    </javaClientGenerator>

    <!-- 配置需要生成的表 -->
    <table tableName="T_USER" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false">
      <generatedKey column="id" sqlStatement="oralce" identity="true"/>
    </table>
  </context>
</generatorConfiguration>

轉載:https://mrbird.cc/MyBatis%20common%20Mapper%20PageHelper.html

到此這篇關於MyBatis通用Mapper和PageHelper的文章就介紹到這了,更多相關MyBatis通用Mapper和PageHelper內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們!