Spring boot學習（五）Spring boot整合Mybatis Generator以及PageHelper
前言
在以前的博客中介紹了Spring boot整合Mybatis以及Druid，本篇博客主要介紹如何在Spring boot中整合Mybatis的逆向工程Mybatis Generator如下簡稱爲MBG,以及實際項目中十分方便簡單的物理分頁插件PageHelper,使用這些插件能極大的減輕咱們的開發過程那些簡單重複的過程，本篇博客在項目已經整合了Mybatis的基礎上進行，沒有整合Mybatis的朋友能夠參考 Spring boot整合Mybatis。php
文章首發於我的博客:【www.xiongfrblog.cn】html
整合MBG
爲何使用MBG
使用過Mybatis的朋友應該都知道，在使用以前咱們須要根據數據庫表的狀況在項目中建立出對應的實體類，sql語句接口層，XML文件等，這一系列的操做是很是簡單的，但又是必不可少的，耗時耗力還沒什麼養分，若是數據庫的表足夠多的時候還要手動建立這些內容，那對程序員來講簡直是一種折磨，因此在實際的開發過程當中MBG是很是有必要的，下面咱們就詳細介紹如何在Spring boot項目中配置MBG。java
在pom.xml中添加MBG插件
在<plugins></plugins>標籤中添加以下內容：mysql
<!-- Mybatis Generator插件 -->
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.2</version>
<configuration>
<!-- 配置文件的位置 -->
<configurationFile>src/main/resources/generator/generatorConfig.xml</configurationFile>
<!-- 容許移動生成的文件 -->
<verbose>true</verbose>
<!-- 是否覆蓋，true表示會替換生成的Java文件，false則不覆蓋 -->
<overwrite>true</overwrite>
</configuration>
<executions>
<execution>
<id>Generate MyBatis Artifacts</id>
<goals>
<goal>generate</goal>
</goals>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.2</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.6</version>
</dependency>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.0</version>
</dependency>
</dependencies>
</plugin>
複製代碼
其中configurationFile：MBG配置文件的位置能夠根據本身的實際狀況改寫。git
注意：如上所示，咱們在插件內還添加了mysql，mybatis的依賴項，這兩項依賴咱們在項目的依賴項裏已經添加過了，可是這裏還須要再添加一次，我在配置這裏的時候若是這裏不添加執行插件的時候就會報錯。程序員
添加generatorConfig.xml配置文件
這一步是咱們生成實體類等的關鍵，全部的規則都是在這個配置文件裏配置的。 首先在src/main/resources目錄下建立generator目錄，在該目錄下建立generatorConfig.xml配置文件，內容以下：github
<?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>
<!-- 導入配置文件 -->
<properties resource="application.properties"/>
<!-- defaultModelType="flat" s設置複合主鍵時不單獨爲主鍵建立實體 -->
<context id="MySql" defaultModelType="flat" targetRuntime="MyBatis3Simple">
<property name="javaFileEncoding" value="UTF-8"/>
<!-- 當表名或者字段名爲SQL關鍵字的時候，能夠設置該屬性爲true，MBG會自動給表名或字段名添加分隔符(反單引號) -->
<property name="autoDelimitKeywords" value="true"/>
<!-- 因爲beginningDelimiter和endingDelimiter的默認值爲雙引號(")，在Mysql中不能這麼寫，因此還要將這兩個默認值改成反單引號(`)， -->
<property name="beginningDelimiter" value="`"/>
<property name="endingDelimiter" value="`"/>
<!-- 生成的POJO實現java.io.Serializable接口 -->
<plugin type="org.mybatis.generator.plugins.SerializablePlugin" />
<!--註釋-->
<commentGenerator>
<!-- 阻止生成註釋 -->
<property name="suppressAllComments" value="true"/>
<!-- 註釋裏不添加日期 -->
<property name="suppressDate" value="true"/>
</commentGenerator>
<!-- 數據庫鏈接，直接經過${}讀取application.properties裏的配置 -->
<jdbcConnection driverClass="${spring.datasource.driverClassName}" connectionURL="${spring.datasource.url}" userId="${spring.datasource.username}" password="${spring.datasource.password}"/>
<!-- 生成POJO對象，並將類放到com.web.springbootmybatis.entity包下 -->
<javaModelGenerator targetPackage="com.web.springboot.entity" targetProject="src/main/java"></javaModelGenerator>
<!-- 生成mapper xml文件，並放到resources下的mapper文件夾下 -->
<sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources"></sqlMapGenerator>
<!-- 生成mapper xml對應dao接口，放到com.web.springbootmybatis.dao包下-->
<javaClientGenerator targetPackage="com.web.springboot.dao" targetProject="src/main/java" type="XMLMAPPER"></javaClientGenerator>
<!-- table標籤能夠有多個，至少一個，tableName指定表名，可使用_和%通配符，我這裏的配置代表匹配全部的表 -->
<table tableName="%">
<!-- 是否只生成POJO對象 -->
<property name="modelOnly" value="false"/>
<!-- 插入一條數據時，將id映射到實體類中 -->
<generatedKey column="id" sqlStatement="Mysql"/>
</table>
</context>
</generatorConfiguration>
複製代碼
上面的配置是最經常使用的配置，注意使用的時候包名，數據庫鏈接等某些配置須要根據本身的實際狀況改寫，通常使用這個就已經能夠了，若是有其餘的特別的需求能夠參考這篇博客，裏邊講解了該配置文件全部標籤，屬性的意思，解釋的很是清楚，想要深刻了解的朋友請移步【傳送門】web
執行插件
- 在
eclipse中，右鍵項目-->Run As-->Maven build...-->在Goals中填寫命令mybatis-generator:generate,點擊Run便可。 - 在命令行中運行，須要切換到項目
pom.xml文件所在的目錄，運行命令mvn mybatis-generator:generate便可。
執行完以後會發現項目中已經創好了相應的類以及接口文件，項目結構圖：spring
實體類demo：sql
package com.web.springboot.entity;
import java.io.Serializable;
public class SysUser implements Serializable {
private Integer id;
private String usercode;
private String username;
private String password;
private String salt;
private String locked;
private static final long serialVersionUID = 1L;
//省略getter.setter方法
}
複製代碼
sql接口demo：
package com.web.springboot.dao;
import com.web.springboot.entity.SysUser;
import java.util.List;
public interface SysUserMapper {
int deleteByPrimaryKey(Integer id);
int insert(SysUser record);
SysUser selectByPrimaryKey(Integer id);
List<SysUser> selectAll();
int updateByPrimaryKey(SysUser record);
}
複製代碼
xml文件demo：
<?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.web.springboot.dao.SysUserMapper" >
<resultMap id="BaseResultMap" type="com.web.springboot.entity.SysUser" >
<id column="id" property="id" jdbcType="INTEGER" />
<result column="usercode" property="usercode" jdbcType="VARCHAR" />
<result column="username" property="username" jdbcType="VARCHAR" />
<result column="password" property="password" jdbcType="VARCHAR" />
<result column="salt" property="salt" jdbcType="VARCHAR" />
<result column="locked" property="locked" jdbcType="CHAR" />
</resultMap>
<delete id="deleteByPrimaryKey" parameterType="java.lang.Integer" >
delete from sys_user
where id = #{id,jdbcType=INTEGER}
</delete>
<insert id="insert" parameterType="com.web.springboot.entity.SysUser" >
<selectKey resultType="java.lang.Integer" keyProperty="id" order="BEFORE" >
SELECT LAST_INSERT_ID()
</selectKey>
insert into sys_user (id, usercode, username,
`password`, salt, locked
)
values (#{id,jdbcType=INTEGER}, #{usercode,jdbcType=VARCHAR}, #{username,jdbcType=VARCHAR},
#{password,jdbcType=VARCHAR}, #{salt,jdbcType=VARCHAR}, #{locked,jdbcType=CHAR}
)
</insert>
<update id="updateByPrimaryKey" parameterType="com.web.springboot.entity.SysUser" >
update sys_user
set usercode = #{usercode,jdbcType=VARCHAR},
username = #{username,jdbcType=VARCHAR},
`password` = #{password,jdbcType=VARCHAR},
salt = #{salt,jdbcType=VARCHAR},
locked = #{locked,jdbcType=CHAR}
where id = #{id,jdbcType=INTEGER}
</update>
<select id="selectByPrimaryKey" resultMap="BaseResultMap" parameterType="java.lang.Integer" >
select id, usercode, username, `password`, salt, locked
from sys_user
where id = #{id,jdbcType=INTEGER}
</select>
<select id="selectAll" resultMap="BaseResultMap" >
select id, usercode, username, `password`, salt, locked
from sys_user
</select>
</mapper>
複製代碼
我使用過的就這兩種，親測可行，還有其餘的方式，具體請參考官方文檔【傳送門】
配置中的一些常見錯誤及解決方式
-
pom.xml文件中添加完插件以後報錯以下：Plugin execution not covered by lifecycle configuration: org.mybatis.generator:mybatis-generator-maven-plugin:1.3.2:generate (execution: Generate MyBatis Artifacts, phase: generate-sources) 複製代碼解決方式：在
<plugins>標籤外再套一個<pluginManagement>標籤,以下：<build> <pluginManagement> <plugins> <plugin> ... </plugin> <plugin> ... </plugin> .... </plugins> </pluginManagement> </build> 複製代碼若是還沒解決能夠參照這裏【傳送門】
-
執行插件的時候失敗並報錯以下：
這一類錯誤出現的最多，解決的辦法也不是惟一的，我根據本身的踩坑以及網上的資料提供兩個大的方向。
解決方式：
- 插件版本問題，能夠網上搜索換一個版本試試。
generatorConfig.xml裏邊有錯誤，好比變量名不對，包名不對等，仔細檢查每每有驚喜。
整合PageHelper
PageHelper是一款很是簡單的分頁插件，只須要兩行代碼便可，不須要咱們本身編寫sql語句，自動幫咱們實現，很是好用,下面開始介紹Spring boot整合PageHelper。
添加依賴
首先在pom.xml文件中添加依賴，以下：
<!-- springboot分頁插件 -->
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper-spring-boot-starter</artifactId>
<!-- 特別注意版本問題 -->
<version>1.2.3</version>
</dependency>
複製代碼
添加這個依賴以後，咱們其實不須要再添加mybatis-spring-boot-starter的依賴了，由於pagehelper-spring-boot-starter已經將其包含在其中了。
配置文件中添加配置
在aiilication.properties文件中添加以下內容：
#pageHelper配置
pagehelper.helperDialect=mysql
pagehelper.reasonable=true
pagehelper.params=count=countSql
pagehelper.supportMethodsArguments=true
複製代碼
這裏簡單介紹下幾個參數的意思，網上的教程廣泛沒寫，這裏介紹下：
helperDialect:配置使用哪一種數據庫語言，不配置的話pageHelper也會自動檢測,我這裏使用的mysql。reasonable:配置分頁參數合理化功能，默認是false。啓用合理化時，若是pageNum<1會查詢第一頁，若是pageNum>總頁數會查詢最後一頁； 禁用合理化時，若是pageNum<1或pageNum>總頁數會返回空數據。params:爲了支持startPage(Object params)方法，增長了該參數來配置參數映射，用於從對象中根據屬性名取值， 能夠配置pageNum,pageSize,count,pageSizeZero,reasonable，不配置映射的用默認值，默認值爲pageNum=pageNum;pageSize=pageSize;count=countSql;reasonable=reasonable;pageSizeZero=pageSizeZero。supportMethodsArguments:支持經過Mapper接口參數來傳遞分頁參數，默認值false，分頁插件會從查詢方法的參數值中，自動根據上面params配置的字段中取值，查找到合適的值時就會自動分頁。
更多參數的介紹請移步【傳送門】
代碼中使用
通過上面的介紹使用MBG已經爲咱們建立好了實體類，sql接口以及xml文件，如今咱們須要建立service層，這裏咱們利用泛型知識先建立一個service層的基類接口IBaseService.java，以後全部的service接口都繼承這個基類接口,這在實際的項目中是頗有必要的，減小重複不必的操做，代碼以下：
package com.web.springboot.service;
import java.util.List;
/** * @author Promise * @createTime 2019年1月20日 下午8:24:40 * @description service接口層基類，包含基本的 CRUD操做。 */
public interface IBaseService<T> {
/** * 根據主鍵刪除 * @param id * @return */
int deleteByPrimaryKey(Object id);
/** * 新增一條記錄 * @param entity * @return */
int insert(T entity);
/** * 根據主鍵查詢 * @param id * @return */
T selectByPrimaryKey(Object id);
/** * 查詢所有記錄 * @return */
List<T> selectAll();
/** * 根據主鍵修改數據 * @param entity * @return */
int updateByPrimaryKey(T entity);
}
複製代碼
該基類接口定義了基本的CRUD操做，我這裏寫的比較簡單，實際中徹底能夠根據本身的需求完善。
而後建立ISysUserService.java接口，繼承該基類接口，並定義兩個咱們驗證pageHelper的方法：
package com.web.springboot.service;
import java.util.List;
import com.github.pagehelper.PageInfo;
import com.web.springboot.entity.SysUser;
/** * @author Promise * @createTime 2019年1月20日 下午8:31:09 * @description */
public interface ISysUserService extends IBaseService<SysUser>{
List<SysUser> findAllByPage(int pageNum, int pageSize);
PageInfo<SysUser> findAllByPage2(int pageNum, int pageSize);
}
複製代碼
findAllByPage:實現簡單的分頁，返回所需對象的list集合,其中參數pageNum表明當前頁，pageSize表明每頁多少條數據。findAllByPage2:實現簡單的分頁，返回PageInfo<T>對象，包括所需對象的list集合，還包括數據庫總記錄數，總頁數，當前頁，下一頁等諸多信息,其中參數pageNum表明當前頁，pageSize表明每頁多少條數據。
能夠根據項目實際須要選擇使用哪種方法。
接口實現類SysUserServiceImpl.java，代碼以下：
package com.web.springboot.service.impl;
import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;
import com.web.springboot.dao.SysUserMapper;
import com.web.springboot.entity.SysUser;
import com.web.springboot.service.ISysUserService;
/** * @author Promise * @createTime 2019年1月20日 下午8:31:50 * @description */
@Service("sysUserService")
public class SysUserServiceImpl implements ISysUserService{
@Autowired
private SysUserMapper sysUserMapper;
@Override
public int deleteByPrimaryKey(Object id) {
// TODO Auto-generated method stub
return 0;
}
@Override
public int insert(SysUser entity) {
// TODO Auto-generated method stub
return 0;
}
@Override
public SysUser selectByPrimaryKey(Object id) {
// TODO Auto-generated method stub
return sysUserMapper.selectByPrimaryKey((Integer)id);
}
@Override
public List<SysUser> selectAll() {
// TODO Auto-generated method stub
return null;
}
@Override
public int updateByPrimaryKey(SysUser entity) {
// TODO Auto-generated method stub
return 0;
}
@Override
public List<SysUser> findAllByPage(int pageNum, int pageSize) {
// TODO Auto-generated method stub
PageHelper.startPage(pageNum, pageSize);
List<SysUser> lists = sysUserMapper.selectAll();
return lists;
}
@Override
public PageInfo<SysUser> findAllByPage2(int pageNum, int pageSize) {
// TODO Auto-generated method stub
PageHelper.startPage(pageNum, pageSize);
List<SysUser> lists = sysUserMapper.selectAll();
PageInfo<SysUser> pageInfo = new PageInfo<SysUser>(lists);
return pageInfo;
}
}
複製代碼
能夠看到該類中實現了咱們在基類接口IBaseService.java以及ISysUSerService.java裏邊定義的全部方法，這裏咱們先重點關注findAllByPage(int pageNum, int pageSize)方法中的
PageHelper.startPage(pageNum, pageSize);
List<SysUser> lists = sysUserMapper.selectAll();
複製代碼
這段代碼，第一句使用了咱們的分頁插件，就這一句便可，須要注意的是查詢語句必須緊跟這一句，且只能使用一次，意思就是若是還有一個分頁查詢須要再定義一次PageHelper.startPage(pageNum, pageSize)。
再來講findAllByPage2(int pageNum, int pageSize)方法，只比上邊的方法多一句話，且返回結果不同
PageInfo<SysUser> pageInfo = new PageInfo<SysUser>(lists);
複製代碼
固然，PageHelper還有其它的多種使用方式，上面的方式要想保證正確性必需要查詢代碼緊跟分頁代碼才行，須要程序員去控制，這就增長了出現錯誤的概率，因此這裏再介紹一種更爲安全的方式--ISelect 接口方式：
findAllByPage(int pageNum, int pageSize)改版：
@Override
public List<SysUser> findAllByPage(int pageNum, int pageSize) {
//這種寫法須要jdk8 lambda用法
Page<SysUser> page = PageHelper.startPage(pageNum, pageSize).doSelectPage(()-> sysUserMapper.selectAll());
//若是是低版本的jdk,則使用以下寫法（兩種寫法根據本身jdk版本二選一）
Page<SysUser> page = PageHelper.startPage(pageNum, pageSize).doSelectPage(new ISelect() {
@Override
public void doSelect() {
sysUserMapper.selectAll();
}
});
return page;
}
複製代碼
看到這裏有的朋友或許會發現咱們返回的是一個
Page<SysUser>對象，而方法定義的是一個List<SysUser>對象，這裏我直接貼出PageHelper中該方法定義的源碼你們就一目瞭然了：
public class Page<E> extends ArrayList<E> implements Closeable {
//爲了避免佔過多的篇幅，這裏只貼出方法定義的源碼，想要了解具體內容請自行查看源碼。
//能夠看到該方法繼承了ArrayList<T>這也是咱們能夠直接返回Page<SysUser>的緣由。
}
複製代碼
findAllByPage2(int pageNum, int pageSize)改版：
@Override
public PageInfo<SysUser> findAllByPage2(int pageNum, int pageSize) {
//這種寫法須要jdk8 lambda用法
PageInfo<SysUser> pageInfo = PageHelper.startPage(pageNum, pageSize).doSelectPageInfo(()-> sysUserMapper.selectAll());
//若是是低版本的jdk,則使用以下寫法（兩種寫法根據本身jdk版本二選一）
PageInfo<SysUser> pageInfo = PageHelper.startPage(pageNum, pageSize).doSelectPageInfo(new ISelect() {
@Override
public void doSelect() {
sysUserMapper.selectAll();
}
});
return pageInfo;
}
複製代碼
這裏就給出這兩種使用PageHelper的方法了，想要了解更多請移步【傳送門】
接下來建立測試控制器TestController.java,以下：
package com.web.springboot.controller;
import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import com.github.pagehelper.PageInfo;
import com.web.springboot.entity.SysUser;
import com.web.springboot.service.ISysUserService;
/** * @author Promise * @createTime 2019年1月20日 下午8:21:02 * @description */
@RestController
public class TestController {
@Autowired
private ISysUserService sysUserService;
@RequestMapping("/users/{pageNum}/{pageSize}")
public Object getAllUser(@PathVariable int pageNum, @PathVariable int pageSize) {
List<SysUser> lists=sysUserService.findAllByPage(pageNum, pageSize);
return lists;
}
@RequestMapping("/users2/{pageNum}/{pageSize}")
public Object getAllUser2(@PathVariable int pageNum, @PathVariable int pageSize) {
PageInfo<SysUser> pageInfo=sysUserService.findAllByPage2(pageNum, pageSize);
return pageInfo;
}
}
複製代碼
好了，代碼就編寫完成了！
驗證分頁
在這以前，咱們須要在數據中準備一些數據，這裏先貼上個人數據庫數據狀況，實際以自身的數據庫數據爲準：
啓動項目，瀏覽器訪問localhost:8080/users/1/2，表示訪問第一頁，每頁兩條數據，結果以下：
對比數據庫，數據返回正確，接下來訪問localhost:8080/user2/1/2,結果以下：
發現json數據沒有格式，不利於咱們查看，可使用在線json格式轉化工具格式化內容以下：
{
"pageNum": 1,
"pageSize": 2,
"size": 2,
"startRow": 1,
"endRow": 2,
"total": 6,
"pages": 3,
"list": [{
"id": 1,
"usercode": "Promise",
"username": "eran",
"password": "123456",
"salt": null,
"locked": "0"
}, {
"id": 2,
"usercode": "Promise2",
"username": "eran",
"password": "123456",
"salt": null,
"locked": "0"
}],
"prePage": 0,
"nextPage": 2,
"isFirstPage": true,
"isLastPage": false,
"hasPreviousPage": false,
"hasNextPage": true,
"navigatePages": 8,
"navigatepageNums": [1, 2, 3],
"navigateFirstPage": 1,
"navigateLastPage": 3,
"lastPage": 3,
"firstPage": 1
}
複製代碼
能夠發現返回了不少有用的內容，這裏就不一一介紹了，字段都淺顯易懂，實際開發中咱們能夠根據須要選擇使用哪一種方式。
結語
關於Spring boot整合MBG以及pageHelper的內容就到這裏了，下篇博客見。bye~
相關文章
- 1. Spring Boot-整合Mybatis(五)
- 2. Spring Boot + Mybatis + Pagehelper+Swagger2整合
- 3. Spring boot && Mybatis 整合
- 4. spring boot 整合mybatis-generator
- 5. Spring boot學習（三） Spring boot整合mybatis
- 6. Spring Boot 整合 PageHelper
- 7. spring boot mybatis 整合教程
- 8. Spring boot 整合 Mybatis
- 9. Spring Boot 整合 MyBatis
- 10. Spring Boot 整合MyBatis
- 更多相關文章...
- • MyBatis與Spring的整合步驟 - MyBatis教程
- • MyBatis與Spring的整合實例 - MyBatis教程
- • Tomcat學習筆記（史上最全tomcat學習筆記）
- • Spring Cloud 微服務實戰(三) - 服務註冊與發現
相關標籤/搜索
每日一句
-
每一个你不满意的现在，都有一个你没有努力的曾经。
最新文章
- 1. Window下Ribbit MQ安裝
- 2. Linux下Redis安裝及集羣搭建
- 3. shiny搭建網站填坑戰略
- 4. Mysql8.0.22安裝與配置詳細教程
- 5. Hadoop安裝及配置
- 6. Python爬蟲初學筆記
- 7. 部署LVS-Keepalived高可用集羣
- 8. keepalived+mysql高可用集羣
- 9. jenkins 公鑰配置
- 10. HA實用詳解
歡迎關注本站公眾號,獲取更多信息
相關文章
- 1. Spring Boot-整合Mybatis(五)
- 2. Spring Boot + Mybatis + Pagehelper+Swagger2整合
- 3. Spring boot && Mybatis 整合
- 4. spring boot 整合mybatis-generator
- 5. Spring boot學習（三） Spring boot整合mybatis
- 6. Spring Boot 整合 PageHelper
- 7. spring boot mybatis 整合教程
- 8. Spring boot 整合 Mybatis
- 9. Spring Boot 整合 MyBatis
- 10. Spring Boot 整合MyBatis