摘要：通用是為了解決使用中的基本操作，使用它可以很方便的進行開發，可以節省開發人員大量的時間。當該參數設置為時，時會查詢第一頁，超過總數時，會查詢最后一頁。

SpringBoot 是為了簡化 Spring 應用的創建、運行、調試、部署等一系列問題而誕生的產物，自動裝配的特性讓我們可以更好的關注業務本身而不是外部的XML配置，我們只需遵循規范，引入相關的依賴就可以輕易的搭建出一個 WEB 工程

在一起來學SpringBoot | 第七篇：整合Mybatis一文中，我們介紹了Mybatis這款優秀的框架，順便提及了民間大神開發的兩款插件（通用Mapper、PageHelper），從此告別簡單CURD代碼的編寫....

以下兩款插件作者均是同一個人，如果你想深入了解Mybatis以及插件開發可以購買作者的書籍

京東： https://item.jd.com/12103309.html

當當： http://product.dangdang.com/25098208.html

分頁插件

GIT地址： https://github.com/pagehelper/Mybatis-PageHelper

在沒有分頁插件之前，寫一個分頁需要兩條SQL語句，一條查詢一條統計，然后才能計算出頁碼，這樣的代碼冗余而又枯燥，更重要的一點是數據庫遷移，眾所周知不同的數據庫分頁寫法是不同的，而Mybatis不同于Hibernate的是它只提供動態SQL和結果集映射。值得慶幸的是，它雖然沒有為分頁提供良好的解決方案，但卻提供了Interceptor以供開發者自己擴展，這也是這款分頁插件的由來....

通用Mapper

GIT地址： https://gitee.com/free/Mapper

通用 Mapper 是一個可以實現任意 MyBatis 通用方法的框架，項目提供了常規的增刪改查操作以及 Example 相關的單表操作。通用 Mapper 是為了解決 MyBatis 使用中 90% 的基本操作，使用它可以很方便的進行開發，可以節省開發人員大量的時間。

在 pom.xml 中添加通用Mapper與分頁插件的依賴包

    tk.mybatis
    mapper-spring-boot-starter
    2.0.2



    com.github.pagehelper
    pagehelper-spring-boot-starter
    1.2.5



    mysql
    mysql-connector-java



    org.springframework.boot
    spring-boot-starter-web



    org.springframework.boot
    spring-boot-starter-test
    test

在 application.properties 文件中分別添加上數據庫、Mybatis、通用Mapper、PageHelper的屬性配置，這里只提供了常見場景的配置，更全的配置可以參考上文所述的文文檔(#^.^#)

spring.datasource.url=jdbc:mysql://localhost:3306/chapter7?useUnicode=true&characterEncoding=UTF-8&zeroDateTimeBehavior=convertToNull&allowMultiQueries=true&useSSL=false
spring.datasource.password=root
spring.datasource.username=root
# 如果想看到mybatis日志需要做如下配置
logging.level.com.battcn=DEBUG
########## Mybatis 自身配置 ##########
mybatis.mapper-locations=classpath:com/battcn/mapper/*.xml
mybatis.type-aliases-package=com.battcn.entity
# 駝峰命名規范 如：數據庫字段是  order_id 那么 實體字段就要寫成 orderId
mybatis.configuration.map-underscore-to-camel-case=true
########## 通用Mapper ##########
# 主鍵自增回寫方法,默認值MYSQL,詳細說明請看文檔
mapper.identity=MYSQL
mapper.mappers=tk.mybatis.mapper.common.BaseMapper
# 設置 insert 和 update 中，是否判斷字符串類型!=""
mapper.not-empty=true
# 枚舉按簡單類型處理
mapper.enum-as-simple-type=true
########## 分頁插件 ##########
pagehelper.helper-dialect=mysql
pagehelper.params=count=countSql
pagehelper.reasonable=false
pagehelper.support-methods-arguments=true

通用Mapper

mapper.enum-as-simple-type： 枚舉按簡單類型處理，如果有枚舉字段則需要加上該配置才會做映射

mapper.not-empty： 設置以后，會去判斷 insert 和 update 中符串類型!=""

分頁插件

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

support-methods-arguments： 支持通過 Mapper 接口參數來傳遞分頁參數，默認值false，分頁插件會從查詢方法的參數值中，自動根據上面 params 配置的字段中取值，查找到合適的值時就會自動分頁。

注意事項

由于 mybatis.mapper-locations=classpath:com/battcn/mapper/*.xml配置的在java package中，而Spring Boot默認只打入java package -> *.java，所以我們需要給pom.xml文件添加如下內容

    
        
            src/main/resources
        
        
            src/main/java
            
                **/*.xml
            
            true
        
    
    
        
            org.springframework.boot
            spring-boot-maven-plugin
        
    

完成基本配置后，接下來進行具體的編碼操作。

創建一張 t_user 的表

CREATE TABLE `t_user` (
  `id` int(8) NOT NULL AUTO_INCREMENT COMMENT "主鍵自增",
  `username` varchar(50) NOT NULL COMMENT "用戶名",
  `password` varchar(50) NOT NULL COMMENT "密碼",
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT="用戶表";

通用Mapper采用了JPA規范包中的注解，這種的設計避免了重復造輪子，更是讓Spring Data Jpa的應用可以輕松切換到Mybatis

package com.battcn.entity;

import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;
import java.io.Serializable;

/**
 * @author Levin
 * @since 2018/5/10 0007
 */
@Table(name = "t_user")
public class User implements Serializable {

    private static final long serialVersionUID = 8655851615465363473L;

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String username;
    private String password;
    // TODO  省略get set
}

為了更好的讓熟悉它，此處模擬了一個自定義的SQL，可以發現使用 通用Mapper 后并不會破壞原有代碼結構

UserMapper

繼承 BaseMapper 就可以了，這點是不是有點類似 JpaRepository，同時也可以根據自己需要擴展出更適合自己項目的BaseMapper，它的靈活也是眾多開發者喜愛的因素之一

package com.battcn.mapper;

import com.battcn.entity.User;
import org.apache.ibatis.annotations.Mapper;
import tk.mybatis.mapper.common.BaseMapper;

/**
 * t_user 操作，繼承 BaseMapper 就可以了，是不是有點類似 JpaRepository
 *
 * @author Levin
 * @since 2018/5/10 0007
 */
@Mapper
public interface UserMapper extends BaseMapper {

    /**
     * 根據用戶名統計（TODO 假設它是一個很復雜的SQL）
     *
     * @param username 用戶名
     * @return 統計結果
     */
    int countByUsername(String username);
}

UserMapper 映射文件

  
      SELECT count(1) FROM t_user WHERE username = #{username}
  

完成數據訪問層接口后，編寫一個junit測試類來檢驗代碼的正確性。

package com.battcn;

import com.battcn.entity.User;
import com.battcn.mapper.UserMapper;
import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

import java.util.List;

/**
 * @author Levin
 */
@RunWith(SpringRunner.class)
@SpringBootTest
public class Chapter7ApplicationTests {

    private static final Logger log = LoggerFactory.getLogger(Chapter7ApplicationTests.class);

    @Autowired
    private UserMapper userMapper;

    @Test
    public void test1() throws Exception {
        final User user1 = new User("u1", "p1");
        final User user2 = new User("u1", "p2");
        final User user3 = new User("u3", "p3");
        userMapper.insertSelective(user1);
        log.info("[user1回寫主鍵] - [{}]", user1.getId());
        userMapper.insertSelective(user2);
        log.info("[user2回寫主鍵] - [{}]", user2.getId());
        userMapper.insertSelective(user3);
        log.info("[user3回寫主鍵] - [{}]", user3.getId());
        final int count = userMapper.countByUsername("u1");
        log.info("[調用自己寫的SQL] - [{}]", count);

        // TODO 模擬分頁
        userMapper.insertSelective(new User("u1", "p1"));
        userMapper.insertSelective(new User("u1", "p1"));
        userMapper.insertSelective(new User("u1", "p1"));
        userMapper.insertSelective(new User("u1", "p1"));
        userMapper.insertSelective(new User("u1", "p1"));
        userMapper.insertSelective(new User("u1", "p1"));
        userMapper.insertSelective(new User("u1", "p1"));
        userMapper.insertSelective(new User("u1", "p1"));
        userMapper.insertSelective(new User("u1", "p1"));
        userMapper.insertSelective(new User("u1", "p1"));
        // TODO 分頁 + 排序 this.userMapper.selectAll() 這一句就是我們需要寫的查詢，有了這兩款插件無縫切換各種數據庫
        final PageInfo