當前位置：首頁 > 编程资源 > 编程问答 >内容正文

编程问答

TK mapper与 PageHelper

發布時間：2024/1/1 编程问答 44 豆豆

生活随笔收集整理的這篇文章主要介紹了 TK mapper与 PageHelper 小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

TK?mapper(通用Mapper)和MP?mapepr(MyBatis-Plus)是mybatis兩大插件,功能相同,都提供了常規的增刪改查操作,增強mybatis的功能,篇幅有限,文章僅說下兩者的區別!

PageHelper是一個分頁插件

TK?mapper

1.Spring Boot 集成

2.Example 用法

3.Mapper接口

4.Mybatis Geneator 概述

5.TK?mapper專用代碼生成器

TK與mybatis-plus的區別

PageHelper

TK?mapper

官方wiki:

https://gitee.com/free/Mapper/wikis/Home

JavaDoc

https://apidoc.gitee.com/free/Mapper/

demo(不看官網系列)

碼云:https://gitee.com/liuyandeng/tkmapper-generator

GitHub:https://github.com/877507054/tkmapper-generator

項目升級

只需要升級版本號，例如通用 Mapper：

<dependency><groupId>tk.mybatis</groupId><artifactId>mapper</artifactId><version>版本號</version></dependency>

MyBatis 通用 Mapper4(tk mapepr4)更新日志(了解)

此次更新最大的變化是項目結構調整了，將原來的 mapper 拆分成了 core, base, extra, generator, spring 五個子模塊，將獨立的 mapper-weekend 和 spring-boot-starter 項目添加到 mapper 中作為兩個子項目，拆分后的整個項目如下：

all - 為了方便開發人員使用，屏蔽模塊細節，提供的整合，下面兩個子模塊是具體實現，具體包含了 core, base, extra, generator, spring, weekend 六個項目。

dependencies - 以依賴方式整合，包含 tk.mybatis:mapper 的完整功能。

mapper - 通過 maven-shade-plugin 打包整合，和原來的 tk.mybatis:mapper 完全一樣，并且 Maven 坐標就是 tk.mybatis:mapper。

base - 所有 Mapper<T> 等接口的實現，獨立出來后方便整體替換這部分實現。

core - 通用 Mapper 的核心，依賴 core 可以實現自己的通用方法，base 就是以此為依賴的一種實現。

extra - base 方法擴展，提供有局限性的通用接口。

generator - 代碼生成器，包含了通用 Mapper 代碼生成器和一個通用的全功能代碼生成器插件。

spring - 通用 Mapper 和 Spring 集成需要的關鍵類，重寫了 MyBatis 幾個實現類。

spring-boot-starter - 通用 Mapper 和 Spring Boot 集成。

weekend - 基于 Java8 方法引用的 Example 替代對象 Weekend，可以避免字符串形式的字段名。

1.Spring Boot 集成

Spring Boot 在微服務領域中已經成為主流。

Mapper 如何同 Spring Boot 進行集成?

基本上分為兩大類。

基于 starter 的自動配置
基于?@MapperScan?注解的手工配置

mapper-spring-boot-starter

在 starter 的邏輯中，如果你沒有使用 @MapperScan 注解，你就需要在你的接口上增加 @Mapper 注解，否則 MyBatis 無法判斷掃描哪些接口。

這里的第一種用法沒有用 @MapperScan 注解，所以你需要在所有接口上增加 @Mapper 注解。

以后會考慮增加其他方式。

你只需要添加通用 Mapper 提供的 starter 就完成了最基本的集成，依賴如下：

<dependency><groupId>tk.mybatis</groupId><artifactId>mapper-spring-boot-starter</artifactId><version>版本號</version></dependency>

最新版本號如上所示，你也可以從下面地址查看：點擊

注意：引入該 starter 時，和 MyBatis 官方的 starter 沒有沖突，但是官方的自動配置不會生效！

如果你需要對通用 Mapper 進行配置，你可以在 Spring Boot 的配置文件中配置 mapper. 前綴的配置。

例如在 yml 格式中配置：

mapper:mappers:- tk.mybatis.mapper.common.Mapper- tk.mybatis.mapper.common.Mapper2notEmpty: true

在 properties 配置中：

mapper.mappers=tk.mybatis.mapper.common.Mapper,tk.mybatis.mapper.common.Mapper2mapper.notEmpty=true

mappers

在 4.0 以前這是一個非常重要的參數，當時只有通過 mappers 配置過的接口才能真正調用，由于很多人不注意看文檔，通用 Mapper 90% 的問題都出在這個參數上。

4.0 之后，增加了一個 @RegisterMapper 注解，通用 Mapper 中提供的所有接口都有這個注解，有了該注解后，通用 Mapper 會自動解析所有的接口，如果父接口（遞歸向上找到的最頂層）存在標記該注解的接口，就會自動注冊上。因此 4.0 后使用通用 Mapper 提供的方法時，不需要在配置這個參數。

當你自己擴展通用接口時，建議加上該注解，否則就要配置 mappers 參數。

notEmpty

insertSelective 和 updateByPrimaryKeySelective 中，是否判斷字符串類型 !=''。

配置方式：

notEmpty=true

更多配置:點擊

@MapperScan 注解配置

你可以給帶有 @Configuration 的類配置該注解，或者直接配置到 Spring Boot 的啟動類上，如下：

@tk.mybatis.spring.annotation.MapperScan(basePackages = "掃描包") @SpringBootApplication public class SampleMapperApplication implements CommandLineRunner {

2.Example 用法

條件構造器

1.通用 Example

查詢

示例：

Example example = new Example(Country.class); example.setForUpdate(true); example.createCriteria().andGreaterThan("id", 100).andLessThan("id",151); example.or().andLessThan("id", 41); List<Country> countries = mapper.selectByExample(example);

日志：

DEBUG [main] - ==> Preparing: SELECT id,countryname,countrycode FROM country WHERE ( id > ? and id < ? ) or ( id < ? ) ORDER BY id desc FOR UPDATE DEBUG [main] - ==> Parameters: 100(Integer), 151(Integer), 41(Integer) DEBUG [main] - <== Total: 90

動態 SQL

示例：

Example example = new Example(Country.class); Example.Criteria criteria = example.createCriteria(); if(query.getCountryname() != null){criteria.andLike("countryname", query.getCountryname() + "%"); } if(query.getId() != null){criteria.andGreaterThan("id", query.getId()); } List<Country> countries = mapper.selectByExample(example);

日志：

DEBUG [main] - ==> Preparing: SELECT id,countryname,countrycode FROM country WHERE ( countryname like ? ) ORDER BY id desc DEBUG [main] - ==> Parameters: China%(String) DEBUG [main] - <== Total: 1

排序

示例：

Example example = new Example(Country.class); example.orderBy("id").desc().orderBy("countryname").orderBy("countrycode").asc(); List<Country> countries = mapper.selectByExample(example);

日志：

DEBUG [main] - ==> Preparing: SELECT id,countryname,countrycode FROM country order by id DESC,countryname,countrycode ASC DEBUG [main] - ==> Parameters: DEBUG [main] - <== Total: 183

去重

示例：

Example example = new Example(); //設置 distinct example.setDistinct(true); example.createCriteria().andCountrynameLike("A%"); example.or().andIdGreaterThan(100); List<Country> countries = mapper.selectByExample(example);

日志：

DEBUG [main] - ==> Preparing: SELECT distinct id,countryname,countrycode FROM country WHERE ( countryname like ? ) or ( Id > ? ) ORDER BY id desc DEBUG [main] - ==> Parameters: A%(String), 100(Integer) DEBUG [main] - <== Total: 95

設置查詢列

示例：

Example example = new Example(Country.class); example.selectProperties("id", "countryname"); List<Country> countries = mapper.selectByExample(example);

日志：

DEBUG [main] - ==> Preparing: SELECT id , countryname FROM country ORDER BY id desc DEBUG [main] - ==> Parameters: DEBUG [main] - <== Total: 183

除了這里提到的方法外，還有很多其他的方法，可以查看 Example 源碼進行了解。

2.Example.builder 方式

示例：

Example example = Example.builder(Country.class).select("countryname").where(Sqls.custom().andGreaterThan("id", 100)).orderByAsc("countrycode").forUpdate().build(); List<Country> countries = mapper.selectByExample(example);

日志：

DEBUG [main] - ==> Preparing: SELECT countryname FROM country WHERE ( id > ? ) order by countrycode Asc FOR UPDATE DEBUG [main] - ==> Parameters: 100(Integer) DEBUG [main] - <== Total: 83

3.Weekend

使用以上中的 Example 時，需要自己輸入屬性名，例如 "countryname"，假設輸入錯誤，或者數據庫有變化，這里很可能就會出錯，因此基于 Java 8 的方法引用是一種更安全的用法，如果你使用 Java 8，你可以試試 Weekend。

示例：

List<Country> selectByWeekendSql = mapper.selectByExample(new Example.Builder(Country.class).where(WeekendSqls.<Country>custom().andLike(Country::getCountryname, "%a%").andGreaterThan(Country::getCountrycode, "123")).build());

日志：

DEBUG [main] - ==> Preparing: SELECT id,countryname,countrycode FROM country WHERE ( countryname like ? and countrycode > ? ) DEBUG [main] - ==> Parameters: %a%(String), 123(String) DEBUG [main] - <== Total: 151

在代碼中的 Country::getCountryname 就是方法引用，通過該方法可以自動轉換對應的列名。

3.Mapper接口

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

這個方法提供了基本的增刪改查

4.Mybatis Geneator 概述

在MBG中，最主要也最重要的就是XML配置文件.

配置文件頭

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

根節點<generatorConfiguration>

子元素

<properties>?(0個或1個)
<classPathEntry>?(0個或多個)
<context>?(1個或多個)

<properties>

這個元素用來指定外部的屬性元素，不是必須的元素。元素用于指定一個需要在配置中解析使用的外部屬性文件

案例

<classPathEntry>

最常見的用法是通過這個屬性指定驅動的路徑

<context>

在MBG的配置中，至少需要有一個<context>元素。

<context>元素用于指定生成一組對象的環境。例如指定要連接的數據庫，要生成對象的類型和要處理的數據庫中的表。

屬性

id:

必須,用來唯一確定一個<context>元素

可選屬性

defaultModelType:

定義了MBG如何生成**實體類**

這個屬性有以下可選值：

conditional:*這是默認值*,這個模型和下面的hierarchical類似，除了如果那個單獨的類將只包含一個字段，將不會生成一個單獨的類。因此,如果一個表的主鍵只有一個字段,那么不會為該字段生成單獨的實體類,會將該字段合并到基本實體類中。

flat:該模型為每一張表只生成一個實體類。這個實體類包含表中的所有字段。**這種模型最簡單，推薦使用。**

hierarchical:如果表有主鍵,那么該模型會產生一個單獨的主鍵實體類,如果表還有BLOB字段，則會為表生成一個包含所有BLOB字段的單獨的實體類,然后為所有其他的字段生成一個單獨的實體類。 MBG會在所有生成的實體類之間維護一個繼承關系。

targetRuntime:

此屬性用于指定生成的代碼的運行時環境。MyBatis3:*是默認值*,一般情況下使用默認值即可

introspectedColumnImpl:

該參數可以指定擴展org.mybatis.generator.api.IntrospectedColumn該類的實現類。

子元素

這些子元素（有嚴格的配置順序）包括：

<property>?(0個或多個)
<plugin>?(0個或多個)
<commentGenerator>?(0個或1個)
<jdbcConnection>?(1個)
<javaTypeResolver>?(0個或1個)
<javaModelGenerator>?(1個)
<sqlMapGenerator>?(0個或1個)
<javaClientGenerator>?(0個或1個)
<table>?(1個或多個)

下面一一講解:

<property>

<property>支持的屬性：

autoDelimitKeywords
beginningDelimiter
endingDelimiter
javaFileEncoding
javaFormatter
xmlFormatter

由于這些屬性比較重要，這里一一講解。

autoDelimitKeywords:

當表名或者字段名為SQL關鍵字的時候，可以設置該屬性為true，MBG會自動給表名或字段名添加**分隔符**。

beginningDelimiter和endingDelimiter屬性。

由于beginningDelimiter和endingDelimiter的默認值為雙引號(")，在Mysql中不能這么寫，所以還要將這兩個默認值改為**反單引號(`)**，配置如下：

<property name="beginningDelimiter" value="`"/><property name="endingDelimiter" value="`"/> ?

javaFileEncoding:

設置要使用的Java文件的編碼，默認使用當前平臺的編碼，只有當生產的編碼需要特殊指定時才需要使用，一般用不到。

javaFormatter和xmlFormatter屬性

如果你想使用模板來定制生成的java文件和xml文件的樣式，你可以通過指定這兩個屬性的值來實現

<plugin>

<plugin>元素用來定義一個插件。插件用于擴展或修改通過MyBatis Generator (MBG)代碼生成器生成的代碼。

<jdbcConnection>?

用于指定數據庫連接信息，該元素必選，并且只能有一個。

<javaTypeResolver>?

這個元素的配置用來指定JDBC類型和Java類型如何轉換。

<commentGenerator>

生成的代碼中可以包含**注釋信息**，生成表或字段的備注信息。

<javaModelGenerator>?

<javaModelGenerator targetPackage="com.jbdp.zgcfz.generator.domain.model" targetProject="D:/Workspaces/IdeaProjects/zgcfz_generator/src/main/java" />注:項目路徑為個人測試地址

<sqlMapGenerator>?

<sqlMapGenerator targetPackage="mapper" targetProject="D:/Workspaces/IdeaProjects/zgcfz_generator/src/main/resources/mybatis" />

<javaClientGenerator>

<table>

該元素用來配置要通過內省的表。只有配置的才會生成實體類和其他文件。

<table tableName="test"></table>

必選屬性

該元素有一個必選屬性：

tableName：指定要生成的表名，可以使用SQL通配符匹配多個表。

可選屬性

該元素包含多個可選屬性：

schema:數據庫的schema,可以使用SQL通配符匹配。如果設置了該值，生成SQL的表名會變成如schema.tableName的形式。

catalog:數據庫的catalog，如果設置了該值，生成SQL的表名會變成如catalog.tableName的形式。

alias:如果指定，這個值會用在生成的select查詢SQL的表的別名和列名上。列名會被別名為 alias_actualColumnName(別名_實際列名) 這種模式。

domainObjectName:生成對象的基本名稱。如果沒有指定，MBG會自動根據表名來生成名稱。

enableXXX:XXX代表多種SQL方法，該屬性用來指定是否生成對應的XXX語句。

selectByPrimaryKeyQueryId:DBA跟蹤工具會用到，具體請看詳細文檔。

selectByExampleQueryId:DBA跟蹤工具會用到，具體請看詳細文檔。

modelType:和<context>的defaultModelType含義一樣，這里可以針對表進行配置，這里的配置會覆蓋<context>的defaultModelType配置。

escapeWildcards:這個屬性表示當查詢列，是否對schema和表名中的SQL通配符 ('_' and '%') 進行轉義。對于某些驅動當schema或表名中包含SQL通配符時（例如，一個表名是MY_TABLE，有一些驅動需要將下劃線進行轉義）是必須的。默認值是false。

delimitIdentifiers:是否給標識符增加**分隔符**。默認false。當catalog,schema或tableName中包含空白時，默認為true。

delimitAllColumns:是否對所有列添加**分隔符**。默認false。

子元素

該元素包含多個可用的<property>子元素，可選屬性為：

constructorBased:和<javaModelGenerator>中的屬性含義一樣。

ignoreQualifiersAtRuntime:生成的SQL中的表名將不會包含schema和catalog前綴。

immutable:和<javaModelGenerator>中的屬性含義一樣。

modelOnly:此屬性用于配置是否為表只生成實體類。如果設置為true就不會有Mapper接口。如果配置了<sqlMapGenerator>，并且modelOnly為true，那么XML映射文件中只有實體對象的映射元素(<resultMap>)。如果為true還會覆蓋屬性中的enableXXX方法，將不會生成任何CRUD方法。

rootClass:和<javaModelGenerator>中的屬性含義一樣。

rootInterface:和<javaClientGenerator>中的屬性含義一樣。

runtimeCatalog:運行時的catalog，當生成表和運行環境的表的catalog不一樣的時候可以使用該屬性進行配置。

runtimeSchema:運行時的schema，當生成表和運行環境的表的schema不一樣的時候可以使用該屬性進行配置。

runtimeTableName:運行時的tableName，當生成表和運行環境的表的tableName不一樣的時候可以使用該屬性進行配置。

selectAllOrderByClause:該屬性值會追加到selectAll方法后的SQL中，會直接跟order by拼接后添加到SQL末尾。

useActualColumnNames:如果設置為true,那么MBG會使用從數據庫元數據獲取的列名作為生成的實體對象的屬性。如果為false(默認值)，MGB將會嘗試將返回的名稱轉換為駝峰形式。在這兩種情況下，可以通過元素顯示指定，在這種情況下將會忽略這個（useActualColumnNames）屬性。

useColumnIndexes:如果是true,MBG生成resultMaps的時候會使用列的索引,而不是結果中列名的順序。

useCompoundPropertyNames:如果是true,那么MBG生成屬性名的時候會將列名和列備注接起來. 這對于那些通過第四代語言自動生成列(例如:FLD22237),但是備注包含有用信息(例如:"customer id")的數據庫來說很有用. 在這種情況下,MBG會生成屬性名FLD2237_CustomerId。

其它子元素

除了<property>子元素外，<table>還包含以下子元素：

<generatedKey>?(0個或1個)
<columnRenamingRule>?(0個或1個)
<columnOverride>?(0個或多個)
<ignoreColumn>?(0個或多個)

下面對這4個元素進行詳細講解。

1.?<generatedKey>?元素

這個元素最多可以配置一個。

這個元素用來指定自動生成主鍵的屬性（identity字段或者sequences序列）。如果指定這個元素，MBG在生成insert的SQL映射文件中插入一個<selectKey>元素。這個元素**非常重要**，這個元素包含下面兩個必選屬性：

·column:生成列的列名。

·sqlStatement:將返回新值的 SQL 語句。如果這是一個identity列，您可以使用其中一個預定義的的特殊值。預定義值如下：

Cloudscape
DB2
DB2_MF
Derby
HSQLDB
Informix
MySql
SqlServer
SYBASE
JDBC:這會配置MBG使用MyBatis3支持的JDBC標準的生成key來生成代碼。這是一個獨立于數據庫獲取標識列中的值的方法。?重要: 只有當目標運行為MyBatis3時才會產生正確的代碼。如果與iBATIS2一起使用目標運行時會產生運行時錯誤的代碼。

這個元素還包含兩個可選屬性：

·identity:當設置為true時,該列會被標記為identity列，并且<selectKey>元素會被插入在insert后面。當設置為false時，<selectKey>會插入到insert之前（通常是序列）。**重要**: 即使您type屬性指定為post，您仍然需要為identity列將該參數設置為true。這將標志MBG從插入列表中刪除該列。默認值是false。

·type:type=post and identity=true的時候生成的<selectKey>中的order=AFTER,當type=pre的時候，identity只能為false，生成的<selectKey>中的order=BEFORE。可以這么理解，自動增長的列只有插入到數據庫后才能得到ID，所以是AFTER,使用序列時，只有先獲取序列之后，才能插入數據庫，所以是BEFORE。

配置示例一：

對應的生成的結果：

<insert id="insert" parameterType="test.model.UserLoginInfo"><selectKey keyProperty="id" order="AFTER" resultType="java.lang.Integer">SELECT LAST_INSERT_ID()</selectKey>insert into `user login info` (Id, username, logindate, loginip)values (#{id,jdbcType=INTEGER}, #{username,jdbcType=VARCHAR}, #{logindate,jdbcType=TIMESTAMP}, #{loginip,jdbcType=VARCHAR}) </insert>

配置示例二：

對應的生成結果：

<insert id="insert" parameterType="test.model.UserLoginInfo"><selectKey keyProperty="id" order="BEFORE" resultType="java.lang.Integer">select SEQ_ID.nextval from dual</selectKey>insert into `user login info` (Id, username, logindate, loginip)values (#{id,jdbcType=INTEGER}, #{username,jdbcType=VARCHAR}, #{logindate,jdbcType=TIMESTAMP},#{loginip,jdbcType=VARCHAR}) </insert>

2.?<columnRenamingRule>?元素

該元素最多可以配置一個，使用該元素可以在生成列之前，對列進行重命名。這對那些存在同一前綴的字段想在生成屬性名時去除前綴的表非常有用。例如假設一個表包含以下的列：

CUST_BUSINESS_NAME
CUST_STREET_ADDRESS
CUST_CITY
CUST_STATE

生成的所有屬性名中如果都包含CUST的前綴可能會讓人不爽。這些前綴可以通過如下方式定義重命名規則:

注意，在內部，MBG使用java.util.regex.Matcher.replaceAll方法實現這個功能。請參閱有關該方法的文檔和在Java中使用正則表達式的例子。

當<columnOverride>匹配一列時，這個元素（<columnRenamingRule>）會被忽略。<columnOverride>優先于重命名的規則。

該元素有一個必選屬性：

searchString:定義將被替換的字符串的正則表達式。

該元素有一個可選屬性：

replaceString:這是一個用來替換搜索字符串列每一個匹配項的字符串。如果沒有指定，就會使用空字符串。

關于<table>的<property>屬性useActualColumnNames對此的影響可以查看完整文檔。

3.?<columnOverride>?元素

該元素可選，可以配置多個。

該元素從將某些屬性默認計算的值更改為指定的值。

該元素有一個必選屬性:

column:要重寫的列名。

該元素有多個可選屬性：

·property:要使用的Java屬性的名稱。如果沒有指定，MBG會根據列名生成。例如，如果一個表的一列名為STRT_DTE，MBG會根據<table>的useActualColumnNames屬性生成STRT_DTE或strtDte。

·javaType:該列屬性值為完全限定的Java類型。如果需要，這可以覆蓋由JavaTypeResolver計算出的類型。對某些數據庫來說，這是必要的用來處理**“奇怪的”**數據庫類型（例如MySql的unsigned bigint類型需要映射為java.lang.Object)。

·jdbcType:該列的JDBC類型(INTEGER, DECIMAL, NUMERIC, VARCHAR等等)。如果需要，這可以覆蓋由JavaTypeResolver計算出的類型。對某些數據庫來說，這是必要的用來處理怪異的JDBC驅動 (例如DB2的LONGVARCHAR類型需要為iBATIS 映射為VARCHAR)。

·typeHandler:用戶定義的需要用來處理這列的類型處理器。它必須是一個繼承iBATIS的·TypeHandler類或TypeHandlerCallback接口（該接口很容易繼承）的全限定的類名。如果沒有指定或者是空白，iBATIS會用默認的類型處理器來處理類型。**重要**:MBG不會校驗這個類型處理器是否存在或者可用。 MGB只是簡單的將這個值插入到生成的SQL映射的配置文件中。

·delimitedColumnName:指定是否應在生成的SQL的列名稱上增加**分隔符**。如果列的名稱中包含空格，MGB會自動添加**分隔符**，所以這個重寫只有當列名需要強制為一個合適的名字或者列名是數據庫中的保留字時是必要的。

配置示例：

4.?<ignoreColumn>?元素

該元素可選，可以配置多個。

該元素可以用來屏蔽不需要生成的列。

該元素有一個必選屬性：

column:要忽略的列名。

該元素還有一個可選屬性：

delimitedColumnName:匹配列名的時候是否區分大小寫。如果為true則區分。默認值為false，不區分大小寫。

5.TK?mapper專用代碼生成器

使用Java編碼方式運行MBG

加入依賴

<dependency><groupId>tk.mybatis</groupId><artifactId>mapper</artifactId><version>4.0.0</version> </dependency>

通用 Mapper 專用代碼生成器生成的 Model 會在原有基礎上增加 @Table,@Id,@Column 等注解，方便自動會數據庫字段進行映射。

Java代碼很容易：

Java代碼

package com.jbdp.generator; import org.mybatis.generator.api.MyBatisGenerator; import org.mybatis.generator.config.Configuration; import org.mybatis.generator.config.xml.ConfigurationParser; import org.mybatis.generator.internal.DefaultShellCallback; import java.io.InputStream; import java.util.ArrayList; import java.util.List;public class Generator {public static void main(String[] args) throws Exception {// TODO Auto-generated method stubList<String> warnings = new ArrayList<String>();boolean overwrite = true;ConfigurationParser cp = new ConfigurationParser(warnings);Configuration config = ?cp.parseConfiguration(getResourceAsStream("generator/generatorConfig.xml"));DefaultShellCallback callback = new DefaultShellCallback(overwrite);MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);myBatisGenerator.generate(null);for (String warning : warnings) {System.out.println(warning);}} }

這段代碼容易，最主要的一個內容是"generatorConfig.xml",我們應該如何配置該類,下面是一個generatorConfig.xml的例子.

Xml配置

<generatorConfiguration>
????<context id="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat">
????????<property name="javaFileEncoding" value="UTF-8"/>
????????<property name="useMapperCommentGenerator" value="false"/>

????????<plugin type="tk.mybatis.mapper.generator.MapperPlugin">
????????????<property name="mappers" value="tk.mybatis.mapper.common.Mapper"/>
????????????<property name="caseSensitive" value="true"/>
????????????<property name="forceAnnotation" value="true"/>
????????????<property name="beginningDelimiter" value="`"/>
????????????<property name="endingDelimiter" value="`"/>
????????</plugin>

????????<jdbcConnection driverClass="org.hsqldb.jdbcDriver"
????????????????????????connectionURL="jdbc:hsqldb:mem:generator"
????????????????????????userId="sa"
????????????????????????password="">
????????</jdbcConnection>

????????
????????<javaModelGenerator targetPackage="test.model"
????????????????????????????targetProject="generator/src/test/java"/>

????????<table tableName="user_info">
????????????<generatedKey column="id" sqlStatement="JDBC"/>
????????</table>

????????<table tableName="country">
????????????<generatedKey column="id" sqlStatement="JDBC"/>
????????</table>

????</context>

</generatorConfiguration>

MapperPlugin配置

和一般的配置相比，這里只是多了一個插件的配置：

<plugin type="tk.mybatis.mapper.generator.MapperPlugin">
????<property name="mappers" value="tk.mybatis.mapper.common.Mapper"/>
????<property name="caseSensitive" value="true"/>
????<property name="forceAnnotation" value="true"/>
????<property name="beginningDelimiter" value="`"/>
????<property name="endingDelimiter" value="`"/>

</plugin>

這里最關鍵的參數就是?mappers，配置后生成的 Mapper 接口都會自動繼承上改接口，如果你定義了一個自己的基礎接口，例如：

package xxx.base; import tk.mybatis.mapper.common.Mapper;import tk.mybatis.mapper.common.MySqlMapper; /*** 繼承自己的MyMapper*/public interface MyMapper<T> extends Mapper<T>, MySqlMapper<T> {//TODO//FIXME 特別注意，該接口不能被掃描到，否則會出錯 }

在配置插件時，可以配置為：

其他參數的含義：

·caseSensitive 是否區分大小寫，默認值?false。如果數據庫區分大小寫，這里就需要配置為?true，這樣當表名為?USER?時，會生成?@Table(name = "USER")?注解，否則使用小寫?user?時會找不到表。

·forceAnnotation 是否強制生成注解，默認?false，如果設置為?true，不管數據庫名和字段名是否一致，都會生成注解（包含?@Table?和?@Column）。

·beginningDelimiter 和 endingDelimiter 開始和結束分隔符，對于有關鍵字的情況下適用。

·useMapperCommentGenerator 是否使用通用 Mapper 提供的注釋工具，默認?true?使用，這樣在生成代碼時會包含字段的注釋（目前只有 mysql 和 oracle 支持），設置?false后會用默認的，或者你可以配置自己的注釋插件。

·generateColumnConsts 在生成的 model中，增加字段名的常量，便于使用 Example 拼接查詢條件的時候使用。

·lombok 增加 model 代碼生成時，可以直接生成 lombok 的?@Getter@Setter@ToString@Accessors(chain = true)?四類注解，使用者在插件配置項中增加?<property name="lombok" value="Getter,Setter,ToString,Accessors"/>?即可生成對應包含注解的 model 類。

在上面<table?的配置中是針對 MySql 這種自增數據庫的，如果使用 ORACLE 序列方式，可以參考下面的配置：

SQL 中的?{1}?代表的是對應表的大寫形式，{0}?是小寫形式，這個配置生成的代碼會像下面這樣：

public class Country {@Id@GeneratedValue(strategy = GenerationType.IDENTITY,generator = "select SEQ_COUNTRY.nextval from dual")private Integer id;// 省略其他 }

這段配置介紹完了，之后運行前面的JAVA方法，就會生成對應的文件。該文件的樣式在最后貼個例子。

使用 Maven 執行MBG

這是一個例子

Maven 中的插件配置如下：

<plugins><plugin><artifactId>maven-compiler-plugin</artifactId><configuration><source>${jdk.version}</source><target>${jdk.version}</target></configuration></plugin><plugin><groupId>org.mybatis.generator</groupId><artifactId>mybatis-generator-maven-plugin</artifactId><version>1.3.6</version><configuration><configurationFile>${basedir}/src/main/resources/generator/generatorConfig.xml</configurationFile><overwrite>true</overwrite><verbose>true</verbose></configuration><dependencies><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>5.1.29</version></dependency><dependency><groupId>tk.mybatis</groupId><artifactId>mapper</artifactId><version>4.0.0</version></dependency></dependencies></plugin> </plugins>

在插件中配置了配置文件的路徑，覆蓋和輸出詳細日志三個參數。

除此之外需要特別注意的是?<dependencies>，MBG 配置中用到的所有外部代碼都必須通過依賴方式配置在這里，否則運行時會提示找不到對應的類而報錯。這里有兩個必須的依賴，一個是 JDBC 驅動，另一個是 Mapper 的插件。

下面看配置文件generatorConfig.xml：

<!DOCTYPE generatorConfiguration
????????PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
????????"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
????<properties resource="config.properties"/>

????<context id="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat">
????????<property name="beginningDelimiter" value="`"/>
????????<property name="endingDelimiter" value="`"/>

????????<plugin type="tk.mybatis.mapper.generator.MapperPlugin">
????????????<property name="mappers" value="tk.mybatis.mapper.common.Mapper"/>
????????????<property name="caseSensitive" value="true"/>
????????</plugin>

????????<jdbcConnection driverClass="${jdbc.driverClass}"
????????????????????????connectionURL="${jdbc.url}"
????????????????????????userId="${jdbc.user}"
????????????????????????password="${jdbc.password}">
????????</jdbcConnection>

????????<javaModelGenerator targetPackage="com.isea533.mybatis.model"
????????????????????????????targetProject="src/main/java"/>

????????<sqlMapGenerator targetPackage="mapper"
?????????????????????????targetProject="src/main/resources"/>

????????<javaClientGenerator targetPackage="com.isea533.mybatis.mapper"
?????????????????????????????targetProject="src/main/java"
?????????????????????????????type="XMLMAPPER"/>

????????<table tableName="user_info">
????????????<generatedKey column="id" sqlStatement="JDBC"/>
????????</table>

????</context>

</generatorConfiguration>

這里和之前相差不多，只是通過?<properties>?引入了外部屬性文件，在?<jdbcConnection>?配置時，使用的屬性文件中的參數。

運行

在 pom.xml 這一級目錄的命令行窗口執行?mvn mybatis-generator:generate即可（前提是配置了mvn）。

生成的代碼

下面是自動生成的代碼的例子，這些例子可以在Mybatis-Spring這里找到。

一、實體類Country

package com.isea533.mybatis.model; import javax.persistence.*; @Table(name = "country")public class Country {/*** 主鍵*/@Id@Column(name = "Id")@GeneratedValue(generator = "JDBC")private Integer id;/*** 名稱*/private String countryname;/*** 代碼*/private String countrycode;/*** 獲取主鍵** @return Id - 主鍵*/public Integer getId() {return id;}/*** 設置主鍵** @param id 主鍵*/public void setId(Integer id) {this.id = id;}/*** 獲取名稱** @return countryname - 名稱*/public String getCountryname() {return countryname;}/*** 設置名稱** @param countryname 名稱*/public void setCountryname(String countryname) {this.countryname = countryname;}/*** 獲取代碼** @return countrycode - 代碼*/public String getCountrycode() {return countrycode;}/*** 設置代碼** @param countrycode 代碼*/public void setCountrycode(String countrycode) {this.countrycode = countrycode;} }

可以看到這里生成的注釋是有意義的內容，注釋來源于數據庫表字段的注釋。

二、Mapper接口CountryMapper

package com.isea533.mybatis.mapper; import com.isea533.mybatis.model.Country;import tk.mybatis.mapper.common.Mapper; public interface CountryMapper extends Mapper<Country> { }

接口自動繼承配置的通用Mapper接口，自動包含泛型實體。

三、Mapper.xml文件CountryMapper.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.isea533.mybatis.mapper.CountryMapper"><resultMap id="BaseResultMap" type="com.isea533.mybatis.model.Country"><id column="Id" jdbcType="INTEGER" property="id" /><result column="countryname" jdbcType="VARCHAR" property="countryname" /><result column="countrycode" jdbcType="VARCHAR" property="countrycode" /></resultMap></mapper>

xml文件只包含了實體的resultMap映射配置

基于模板的插件TemplateFilePlugin

代碼生成器是基于 MBG 插件的，所以需要配合 MBG 使用。

<?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="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat">
??????<property name="javaFileEncoding" value="UTF-8"/>
??????
??????

??????
??????<plugin type="tk.mybatis.mapper.generator.MapperPlugin">
?????????<property name="mappers" value="tk.mybatis.mapper.common.Mapper,tk.mybatis.mapper.hsqldb.HsqldbMapper"/>
?????????<property name="caseSensitive" value="true"/>
?????????<property name="forceAnnotation" value="true"/>
?????????<property name="beginningDelimiter" value="`"/>
?????????<property name="endingDelimiter" value="`"/>
??????</plugin>

??????
??????<plugin type="tk.mybatis.mapper.generator.TemplateFilePlugin">
?????????<property name="targetProject" value="src/test/java"/>
?????????<property name="targetPackage" value="test.mapper"/>
?????????<property name="templatePath" value="generator/mapper.ftl"/>
?????????<property name="mapperSuffix" value="Dao"/>
?????????<property name="fileName" value="${tableClass.shortClassName}${mapperSuffix}.java"/>
??????</plugin>

??????<jdbcConnection driverClass="com.mysql.jdbc.Driver"
??????????????????connectionURL="jdbc:mysql://localhost:3306/test"
??????????????????userId="root"
??????????????????password="">
??????</jdbcConnection>

??????
??????<javaModelGenerator targetPackage="test.model" targetProject="./src/test/java"/>

??????<table tableName="user%">
?????????<generatedKey column="id" sqlStatement="JDBC"/>
??????</table>
???</context>
</generatorConfiguration>

在這個配置中，我們只關注?tk.mybatis.mapper.generator.TemplateFilePlugin。

下面介紹必備的屬性。

targetProject

用于指定目標項目，一般是?src/main/java?或者?src/main/resource?這樣的目錄。還可以是?src/test/java?或者?src/test/resource?這樣的目錄。

在多模塊項目中，還能通過相對路徑指定為其他的目錄，例如：

這個屬性值有一個要求，就是目錄必須存在，否則不會生成代碼!

2.?targetPackage

用于指定包的部分，雖然是這個名字，實際上就是路徑。

這個屬性指定的路徑如果不存在，就會自動創建。

這個屬性的值可以為空。

例如?mapper/admin?用于生成?mapper/admin/?目錄，或者?tk.mybatis.mapper?生成包（本質上還是目錄）。

這個屬性還有一個特殊的地方，它還支持使用模板，就和下面的?fileName?一樣，舉個簡單的使用場景。

你可能在生成前端代碼的時候，希望將表對應的 JSP 生成在自己的一個目錄中，此時可以配置為：

模板中可以用到的屬性，這里都能用，其他屬性后面會介紹。

通過這個路徑也能看出來，配置一個插件只能根據模板在一個指定位置(targetProject 和 targetPackage 決定的目錄)生成一個文件。

3.?templatePath

指定模板路徑，可以是任意能夠通過 ClassLoader 能夠獲取的位置，文件類型沒有限制。

例如示例中的?generator/test-one.ftl。

這個屬性必須指定，否則不會生成代碼!

4.?fileName

這個屬性用于指定生成文件的名字，這個值支持使用模板，例如上面的?${tableClass.shortClassName}Test.txt，具體可用的屬性會在后面介紹。

這個屬性必須指定，否則不會生成代碼!

5.?templateFormatter

這個屬性可選，默認使用基于 FreeMarker 的實現!

默認情況下，你需要添加下面的依賴：

<dependency><groupId>org.freemarker</groupId><artifactId>freemarker</artifactId><version>2.3.23</version> </dependency>

默認的實現類為：tk.mybatis.mapper.generator.formatter.FreemarkerTemplateFormatter。

這個類實現了兩個接口?TemplateFormatter, ListTemplateFormatter。

這倆接口分別對應下面?singleMode?參數值的?true?和?false。

也就是一個表生成一個文件，或者多個表生成一個文件。

對于一般情況下，都是第一種情況。但是在配置文件中，可能會用到多個表的信息。

如果你想使用其他模板引擎，可以自己實現上面的接口。

6.?singleMode

上面已經提過，默認為?true。

一個表生成一個文件時，可用屬性可以參考?generator/test-one.ftl，表的屬性在?tableClass中。

多個表生成一個文件時，可用屬性可以參考?generator/test-all.ftl，所有表的屬性在?tableClassSet?中，通過遍歷可以獲取單個的信息。

7. 其他你需要的屬性

模板中需要的特殊信息都可以通過?<property>?方法設置，在模板中直接使用這里定義的屬性名來使用，后面例子的中的?mapperSuffix?就是這種屬性。

8.可用屬性

在表和實體上可用的所有屬性如下：

特殊：targetPackage值在 ${package} 中。 當前時間： <#assign dateTime = .now> 日期：${dateTime?date} 時間：${dateTime?time} 格式化：${dateTime?string["yyyy-MM-dd HH:mm:ss"]}所有配置的屬性信息: <#list props?keys as key>${key} - ${props[key]} </#list>實體和表的信息：表名：${tableClass.tableName} 變量名：${tableClass.variableName} 小寫名：${tableClass.lowerCaseName} 類名：${tableClass.shortClassName} 全名：${tableClass.fullClassName} 包名：${tableClass.packageName}列的信息： ===================================== <#if tableClass.pkFields??>主鍵：<#list tableClass.pkFields as field>-------------------------------------列名：${field.columnName}列類型：${field.jdbcType}字段名：${field.fieldName}注釋：${field.remarks}類型包名：${field.typePackage}類型短名：${field.shortTypeName}類型全名：${field.fullTypeName}是否主鍵：${field.identity?c}是否可空：${field.nullable?c}是否為BLOB列：${field.blobColumn?c}是否為String列：${field.stringColumn?c}是否為字符串列：${field.jdbcCharacterColumn?c}是否為日期列：${field.jdbcDateColumn?c}是否為時間列：${field.jdbcTimeColumn?c}是否為序列列：${field.sequenceColumn?c}列長度：${field.length?c}列精度：${field.scale}</#list> </#if><#if tableClass.baseFields??>基礎列：<#list tableClass.baseFields as field>-------------------------------------列名：${field.columnName}列類型：${field.jdbcType}字段名：${field.fieldName}注釋：${field.remarks}類型包名：${field.typePackage}類型短名：${field.shortTypeName}類型全名：${field.fullTypeName}是否主鍵：${field.identity?c}是否可空：${field.nullable?c}是否為BLOB列：${field.blobColumn?c}是否為String列：${field.stringColumn?c}是否為字符串列：${field.jdbcCharacterColumn?c}是否為日期列：${field.jdbcDateColumn?c}是否為時間列：${field.jdbcTimeColumn?c}是否為序列列：${field.sequenceColumn?c}列長度：${field.length?c}列精度：${field.scale}</#list> </#if><#if tableClass.blobFields??>Blob列：<#list tableClass.blobFields as field>-------------------------------------列名：${field.columnName}列類型：${field.jdbcType}字段名：${field.fieldName}注釋：${field.remarks}類型包名：${field.typePackage}類型短名：${field.shortTypeName}類型全名：${field.fullTypeName}是否主鍵：${field.identity?c}是否可空：${field.nullable?c}是否為BLOB列：${field.blobColumn?c}是否為String列：${field.stringColumn?c}是否為字符串列：${field.jdbcCharacterColumn?c}是否為日期列：${field.jdbcDateColumn?c}是否為時間列：${field.jdbcTimeColumn?c}是否為序列列：${field.sequenceColumn?c}列長度：${field.length?c}列精度：${field.scale}</#list> </#if>===================================== 全部列（包含了pk,base,blob 字段，可用的屬性和上面的一樣）： <#if tableClass.allFields??>列名 - 字段名<#list tableClass.allFields as field>${field.columnName} - ${field.fieldName}</#list> </#if>

完整配置

?<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE generatorConfigurationPUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN""http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd"><generatorConfiguration><properties resource="generator/generator.properties" /><context id="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat" ?><property name="driverClass" value="${datasource.driverClassName}" /><property name="connectionURL" value="${datasource.url}" /><property name="userId" value="${datasource.username}" /><property name="password" value="${datasource.password}" /><property name="schema" value="${datasource.schema}" /><property name="beginningDelimiter" value="`" /><property name="endingDelimiter" value="`" /><property name="javaFileEncoding" value="UTF-8" /><property name="useMapperCommentGenerator" value="true" /><plugin type="tk.mybatis.mapper.generator.TemplateFilePlugin"><property name="targetProject" value="D:/Workspaces/IdeaProjects/zgcfz_generator/src/main/java"/><property name="targetPackage" value="com.jbdp.zgcfz.generator.controller" /><property name="templatePath" value="generator/test/Controller.ftl" /><property name="fileName" value="${tableClass.shortClassName}Controller.java"/><property name="fwPackage" value="${project.fwPackage}" /><property name="templateFormatter"value="tk.mybatis.mapper.generator.formatter.FreemarkerTemplateFormatter"/></plugin><plugin type="tk.mybatis.mapper.generator.TemplateFilePlugin"><property name="targetProject" value="D:/Workspaces/IdeaProjects/zgcfz_generator/src/main/java"/><property name="targetPackage" value="com.jbdp.zgcfz.generator.service" /><property name="templatePath" value="generator/test/Service.ftl" /><property name="fileName" value="${tableClass.shortClassName}Service.java"/><property name="templateFormatter"value="tk.mybatis.mapper.generator.formatter.FreemarkerTemplateFormatter"/></plugin><plugin type="tk.mybatis.mapper.generator.TemplateFilePlugin"><property name="targetProject" value="D:/Workspaces/IdeaProjects/zgcfz_generator/src/main/java"/><property name="targetPackage" value="com.jbdp.zgcfz.generator.service.impl" /><property name="templatePath" value="generator/test/ServiceImpl.ftl" /><property name="fileName" value="${tableClass.shortClassName}ServiceImpl.java"/><property name="fwPackage" value="${project.fwPackage}" /><property name="templateFormatter"value="tk.mybatis.mapper.generator.formatter.FreemarkerTemplateFormatter"/></plugin><plugin type="tk.mybatis.mapper.generator.MapperPlugin"><property name="mappers" value="com.jbdp.base.domain.mapper.BaseMapper"/><property name="caseSensitive" value="true"/><property name="forceAnnotation" value="true"/></plugin><plugin type="org.mybatis.generator.plugins.MapperAnnotationPlugin" /><jdbcConnectiondriverClass="${datasource.driverClassName}"connectionURL="${datasource.url}"userId="${datasource.username}"password="${datasource.password}"><property name="useInformationSchema" value="true"></property><property name="characterEncoding" value="UTF-8"></property></jdbcConnection><javaModelGenerator targetPackage="com.jbdp.zgcfz.generator.domain.model" targetProject="D:/Workspaces/IdeaProjects/zgcfz_generator/src/main/java" /><sqlMapGenerator targetPackage="mapper" targetProject="D:/Workspaces/IdeaProjects/zgcfz_generator/src/main/resources/mybatis" /><javaClientGenerator targetPackage="com.jbdp.zgcfz.generator.domain.mapper" targetProject="D:/Workspaces/IdeaProjects/zgcfz_generator/src/main/java" type="XMLMAPPER" /><table tableName="test"><property name="rootClass" value="com.jbdp.base.domain.model.BaseModel"/><generatedKey column="id" sqlStatement="Mysql" identity="true"/></table></context> </generatorConfiguration>

TK與mybatis-plus的區別

Tk只對dao層進行了抽取封裝,mp封裝到了service層

Tk:@Service public class TestServiceImpl extends BaseServiceImpl implements TestService {@ResourceTestMapper mapper;@Overridepublic int insert(Test input) {return mapper.insert(input);} }該Mapper extends tk的Mapper接口Mp:Service層操作public R<RPage<AccountLogListVo>> list(@Valid @ApiParam("查詢對象")AccountLogQueryDto accountLogQueryDto, @ApiParam("分頁對象")QPage qpage) {JcwlUser user = SecurityUtils.getUser();Account account = accountService.getOne(Wrappers.<Account>query().lambda().eq(Account::getUserId, user.getUserId()).eq(Account::getAccType, 1));return new R<>(new RPage<>()); }accountService?extends?mp的IService接口,其實現類extends?mp的ServiceImpl類(ServiceImpl<M extends BaseMapper<T>, T>?implements?IService),ServiceImpl類有一個baseMapper變量可以直接使用Mapper層操作public AccountVo info(JcwlUser user) {Account account = baseMapper.selectOne(Wrappers.<Account>query().lambda().eq(Account::getUserId, user.getUserId()).eq(Account::getAccType, 1));AccountVo accountVo = new AccountVo();//....return accountVo; }可以使用mp ServiceImpl類的baseMapper,也可以在自己的mapper里extends?mp的BaseMapper接口

發現bug

tk中,service接口和mapper接口新增時不能同時起名insert,要么mapper接口的insert方法注釋,要么改名

PageHelper

Tk的分頁功能可以借助PageHelper

官方下載:https://gitee.com/free/Mybatis_PageHelper

配置

Springboot引入依賴 <dependency><groupId>com.github.pagehelper</groupId><artifactId>pagehelper-spring-boot-starter</artifactId><version>1.2.13</version> </dependency>配置# 分頁配置 pagehelper:helper-dialect: mysqlreasonable: truesupport-methods-arguments: trueparams: count=countSql使用PageHelper.startPage(pageNum,pageSize);//這行是重點，表示從pageNum頁開始，每頁pageSize條數據 List<Tools> list = toolsMapper.findAll();//緊跟著第一個select方法會被分頁 PageInfo<Tools> pageInfo = new PageInfo<Tools>(list); return ServerResponse.createBySuccess("查詢成功",pageInfo);

分頁插件參數介紹

1. helperDialect ：分頁插件會自動檢測當前的數據庫鏈接，自動選擇合適的分頁方式。你可以配置helperDialect 屬性來指定分頁插件使用哪種方言。配置時，可以使用下面的縮寫值：oracle , mysql , mariadb , sqlite , hsqldb , postgresql , db2 , sqlserver , informix , h2 , sqlserver2012 , derby特別注意：使用 SqlServer2012 數據庫時，需要手動指定為 sqlserver2012 ，否則會使用 SqlServer2005 的方式進行分頁。你也可以實現 AbstractHelperDialect ，然后配置該屬性為實現類的全限定名稱即可使用自定義的實現方法。

2. offsetAsPageNum ：默認值為 false ，該參數對使用 RowBounds 作為分頁參數時有效。當該參數設置為true 時，會將 RowBounds 中的 offset 參數當成 pageNum 使用，可以用頁碼和頁面大小兩個參數進行分頁。

3. rowBoundsWithCount ：默認值為 false ，該參數對使用 RowBounds 作為分頁參數時有效。當該參數設置為 true 時，使用 RowBounds 分頁會進行 count 查詢。

4. pageSizeZero ：默認值為 false ，當該參數設置為 true 時，如果 pageSize=0 或者 RowBounds.limit =0 就會查詢出全部的結果（相當于沒有執行分頁查詢，但是返回結果仍然是 Page 類型）。

5. reasonable ：分頁合理化參數，默認值為 false 。當該參數設置為 true 時， pageNum<=0 時會查詢第一頁， pageNum>pages （超過總數時），會查詢最后一頁。默認 false 時，直接根據參數進行查詢。

6. params ：為了支持 startPage(Object params) 方法，增加了該參數來配置參數映射，用于從對象中根據屬性名取值，可以配置 pageNum,pageSize,count,pageSizeZero,reasonable ，不配置映射的用默認值，默認值為pageNum=pageNum;pageSize=pageSize;count=countSql;reasonable=reasonable;pageSizeZero=pageSizeZero。

7. supportMethodsArguments ：支持通過 Mapper 接口參數來傳遞分頁參數，默認值 false ，分頁插件會從查詢方法的參數值中，自動根據上面 params 配置的字段中取值，查找到合適的值時就會自動分頁。使用方法可以參考測試代碼中的 com.github.pagehelper.test.basic 包下的 ArgumentsMapTest 和ArgumentsObjTest 。

8. autoRuntimeDialect ：默認值為 false 。設置為 true 時，允許在運行時根據多數據源自動識別對應方言的分頁（不支持自動選擇 sqlserver2012 ，只能使用 sqlserver ），用法和注意事項參考下面的場景五。

9. closeConn ：默認值為 true 。當使用運行時動態數據源或沒有設置 helperDialect 屬性自動獲取數據庫類型時，會自動獲取一個數據庫連接，通過該屬性來設置是否關閉獲取的這個連接，默認 true 關閉，設置為false 后，不會關閉獲取的連接，這個參數的設置要根據自己選擇的數據源來決定。

參考鏈接:

https://gitee.com/free/Mapper/wikis

https://blog.csdn.net/isea533/article/details/42102297

https://blog.csdn.net/LONG_Yi_1994/article/details/94399645

https://www.jianshu.com/p/2e15823f4ac4

?

總結

以上是生活随笔為你收集整理的TK mapper与 PageHelper的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。

上一篇：【星曈科技】OpenMv笔记——利用Op
下一篇： Java项目使用阿里云平台发送短信说明