前言
上篇我們介紹了Spring Boot對傳統(tǒng)JdbcTemplate的集成，這次換一下，介紹下Spring Boot中如何集成MyBatis。這里分別介紹注解方式以及XML方式的整合。喜歡哪種方式自己選擇。
正文
項目框架還是跟上一篇一樣使用Spring Boot的ace后端模板，你可以基于它來跟著博主一起來調(diào)整代碼，如果沒看過上一篇，那就下載本篇源碼研究吧。
跟上篇一樣先添加基礎(chǔ)的依賴和數(shù)據(jù)源。
添加依賴
這里需要添加mybatis-spring-boot-starter依賴跟mysql依賴
<!--最新版本，匹配spring Boot1.5 or higher-->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.3.0</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
這里不引入spring-boot-starter-jdbc依賴，是由于mybatis-spring-boot-starter中已經(jīng)包含了此依賴。
博主開始整理的時候發(fā)現(xiàn)mybatis-spring-boot-starter有新版本了，這里就集成最新的，匹配Spring Boot1.5版本。
MyBatis-Spring-Boot-Starter依賴將會提供如下：
- 自動檢測現(xiàn)有的DataSource
- 將創(chuàng)建并注冊SqlSessionFactory的實例，該實例使用SqlSessionFactoryBean將該DataSource作為輸入進行傳遞
- 將創(chuàng)建并注冊從SqlSessionFactory中獲取的SqlSessionTemplate的實例。
- 自動掃描您的mappers，將它們鏈接到SqlSessionTemplate并將其注冊到Spring上下文，以便將它們注入到您的bean中。
就是說，使用了該Starter之后，只需要定義一個DataSource即可（application.properties中可配置），它會自動創(chuàng)建使用該DataSource的SqlSessionFactoryBean以及SqlSessionTemplate。會自動掃描你的Mappers，連接到SqlSessionTemplate，并注冊到Spring上下文中。
數(shù)據(jù)源配置
在src/main/resources/application.properties中配置數(shù)據(jù)源信息。
spring.datasource.url = jdbc:mysql://localhost:3306/spring?useUnicode=true&characterEncoding=utf-8
spring.datasource.username = root
spring.datasource.password = root
spring.datasource.driver-class-name = com.mysql.jdbc.Driver
自定義數(shù)據(jù)源
Spring Boot默認(rèn)使用tomcat-jdbc數(shù)據(jù)源，如果你想使用其他的數(shù)據(jù)源，比如這里使用了阿里巴巴的數(shù)據(jù)池管理,除了在application.properties配置數(shù)據(jù)源之外，你應(yīng)該額外添加以下依賴：
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.0.19</version>
</dependency>
修改Application.java
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
@Autowired
private Environment env;
//destroy-method="close"的作用是當(dāng)數(shù)據(jù)庫連接不使用的時候,就把該連接重新放到數(shù)據(jù)池中,方便下次使用調(diào)用.
@Bean(destroyMethod = "close")
public DataSource dataSource() {
DruidDataSource dataSource = new DruidDataSource();
dataSource.setUrl(env.getProperty("spring.datasource.url"));
dataSource.setUsername(env.getProperty("spring.datasource.username"));//用戶名
dataSource.setPassword(env.getProperty("spring.datasource.password"));//密碼
dataSource.setDriverClassName(env.getProperty("spring.datasource.driver-class-name"));
dataSource.setInitialSize(2);//初始化時建立物理連接的個數(shù)
dataSource.setMaxActive(20);//最大連接池數(shù)量
dataSource.setMinIdle(0);//最小連接池數(shù)量
dataSource.setMaxWait(60000);//獲取連接時最大等待時間，單位毫秒。
dataSource.setValidationQuery("SELECT 1");//用來檢測連接是否有效的sql
dataSource.setTestOnBorrow(false);//申請連接時執(zhí)行validationQuery檢測連接是否有效
dataSource.setTestWhileIdle(true);//建議配置為true，不影響性能，并且保證安全性。
dataSource.setPoolPreparedStatements(false);//是否緩存preparedStatement，也就是PSCache
return dataSource;
}
}
ok這樣就算自己配置了一個DataSource，Spring Boot會智能地選擇我們自己配置的這個DataSource實例。
腳本初始化
CREATE DATABASE /*!32312 IF NOT EXISTS*/`spring` /*!40100 DEFAULT CHARACTER SET utf8 */;
USE `spring`;
DROP TABLE IF EXISTS `learn_resource`;
CREATE TABLE `learn_resource` (
`id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'ID',
`author` varchar(20) DEFAULT NULL COMMENT '作者',
`title` varchar(100) DEFAULT NULL COMMENT '描述',
`url` varchar(100) DEFAULT NULL COMMENT '地址鏈接',
PRIMARY KEY (`id`)
) ENGINE=MyISAM AUTO_INCREMENT=1029 DEFAULT CHARSET=utf8;
insert into `learn_resource`(`id`,`author`,`title`,`url`) values (999,'官方SpriongBoot例子','官方SpriongBoot例子','https://github.com/spring-projects/spring-boot/tree/master/spring-boot-samples');
insert into `learn_resource`(`id`,`author`,`title`,`url`) values (1000,'龍果學(xué)院','Spring Boot 教程系列學(xué)習(xí)','http://www.roncoo.com/article/detail/124661');
insert into `learn_resource`(`id`,`author`,`title`,`url`) values (1001,'嘟嘟MD獨立博客','Spring Boot干貨系列','http://tengj.top/');
insert into `learn_resource`(`id`,`author`,`title`,`url`) values (1002,'后端編程嘟','Spring Boot視頻教程','http://www.toutiao.com/m1559096720023553/');
注解方式跟XML配置方式共同的模塊編碼
不管是注解方式還是XML配置的方式，以下代碼模塊都是一樣的
實體對象
public class LearnResouce {
private Long id;
private String author;
private String title;
private String url;
// SET和GET方法
}
Controller層
/** 教程頁面
* Created by tengj on 2017/3/13.
*/
@Controller
@RequestMapping("/learn")
public class LearnController {
@Autowired
private LearnService learnService;
private Logger logger = LoggerFactory.getLogger(this.getClass());
@RequestMapping("")
public String learn(){
return "learn-resource";
}
@RequestMapping(value = "/queryLeanList",method = RequestMethod.POST,produces="application/json;charset=UTF-8")
@ResponseBody
public void queryLearnList(HttpServletRequest request ,HttpServletResponse response){
String page = request.getParameter("page"); // 取得當(dāng)前頁數(shù),注意這是jqgrid自身的參數(shù)
String rows = request.getParameter("rows"); // 取得每頁顯示行數(shù)，,注意這是jqgrid自身的參數(shù)
String author = request.getParameter("author");
String title = request.getParameter("title");
Map<String,Object> params = new HashMap<String,Object>();
params.put("page", page);
params.put("rows", rows);
params.put("author", author);
params.put("title", title);
List<LearnResouce> learnList=learnService.queryLearnResouceList(params);
PageInfo<LearnResouce> pageInfo =new PageInfo<LearnResouce>(learnList);
JSONObject jo=new JSONObject();
jo.put("rows", learnList);
jo.put("total", pageInfo.getPages());//總頁數(shù)
jo.put("records",pageInfo.getTotal());//查詢出的總記錄數(shù)
ServletUtil.createSuccessResponse(200, jo, response);
}
/**
* 新添教程
* @param request
* @param response
*/
@RequestMapping(value = "/add",method = RequestMethod.POST)
public void addLearn(HttpServletRequest request , HttpServletResponse response){
JSONObject result=new JSONObject();
String author = request.getParameter("author");
String title = request.getParameter("title");
String url = request.getParameter("url");
if(StringUtil.isNull(author)){
result.put("message","作者不能為空!");
result.put("flag",false);
ServletUtil.createSuccessResponse(200, result, response);
return;
}
if(StringUtil.isNull(title)){
result.put("message","教程名稱不能為空!");
result.put("flag",false);
ServletUtil.createSuccessResponse(200, result, response);
return;
}
if(StringUtil.isNull(url)){
result.put("message","地址不能為空!");
result.put("flag",false);
ServletUtil.createSuccessResponse(200, result, response);
return;
}
LearnResouce learnResouce = new LearnResouce();
learnResouce.setAuthor(author);
learnResouce.setTitle(title);
learnResouce.setUrl(url);
int index=learnService.add(learnResouce);
if(index>0){
result.put("message","教程信息添加成功!");
result.put("flag",true);
}else{
result.put("message","教程信息添加失敗!");
result.put("flag",false);
}
ServletUtil.createSuccessResponse(200, result, response);
}
/**
* 修改教程
* @param request
* @param response
*/
@RequestMapping(value = "/update",method = RequestMethod.POST)
public void updateLearn(HttpServletRequest request , HttpServletResponse response){
JSONObject result=new JSONObject();
String id = request.getParameter("id");
LearnResouce learnResouce=learnService.queryLearnResouceById(Long.valueOf(id));
String author = request.getParameter("author");
String title = request.getParameter("title");
String url = request.getParameter("url");
if(StringUtil.isNull(author)){
result.put("message","作者不能為空!");
result.put("flag",false);
ServletUtil.createSuccessResponse(200, result, response);
return;
}
if(StringUtil.isNull(title)){
result.put("message","教程名稱不能為空!");
result.put("flag",false);
ServletUtil.createSuccessResponse(200, result, response);
return;
}
if(StringUtil.isNull(url)){
result.put("message","地址不能為空!");
result.put("flag",false);
ServletUtil.createSuccessResponse(200, result, response);
return;
}
learnResouce.setAuthor(author);
learnResouce.setTitle(title);
learnResouce.setUrl(url);
int index=learnService.update(learnResouce);
System.out.println("修改結(jié)果="+index);
if(index>0){
result.put("message","教程信息修改成功!");
result.put("flag",true);
}else{
result.put("message","教程信息修改失敗!");
result.put("flag",false);
}
ServletUtil.createSuccessResponse(200, result, response);
}
/**
* 刪除教程
* @param request
* @param response
*/
@RequestMapping(value="/delete",method = RequestMethod.POST)
@ResponseBody
public void deleteUser(HttpServletRequest request ,HttpServletResponse response){
String ids = request.getParameter("ids");
System.out.println("ids==="+ids);
JSONObject result = new JSONObject();
//刪除操作
int index = learnService.deleteByIds(ids.split(","));
if(index>0){
result.put("message","教程信息刪除成功!");
result.put("flag",true);
}else{
result.put("message","教程信息刪除失敗!");
result.put("flag",false);
}
ServletUtil.createSuccessResponse(200, result, response);
}
}
Service層
package com.dudu.service;
public interface LearnService {
int add(LearnResouce learnResouce);
int update(LearnResouce learnResouce);
int deleteByIds(String[] ids);
LearnResouce queryLearnResouceById(Long learnResouce);
List<LearnResouce> queryLearnResouceList(Map<String, Object> params);
}
實現(xiàn)類
package com.dudu.service.impl;
/**
* Created by tengj on 2017/4/7.
*/
@Service
public class LearnServiceImpl implements LearnService {
@Autowired
LearnMapper learnMapper;
@Override
public int add(LearnResouce learnResouce) {
return this.learnMapper.add(learnResouce);
}
@Override
public int update(LearnResouce learnResouce) {
return this.learnMapper.update(learnResouce);
}
@Override
public int deleteByIds(String[] ids) {
return this.learnMapper.deleteByIds(ids);
}
@Override
public LearnResouce queryLearnResouceById(Long id) {
return this.learnMapper.queryLearnResouceById(id);
}
@Override
public List<LearnResouce> queryLearnResouceList(Map<String,Object> params) {
PageHelper.startPage(Integer.parseInt(params.get("page").toString()), Integer.parseInt(params.get("rows").toString()));
return this.learnMapper.queryLearnResouceList(params);
}
}
Mybatis集成
接下來，我們分別來介紹下注解方式以及XML配置方式。
方案一：注解方式
Mybatis注解的方式好簡單，只要定義一個dao接口，然后sql語句通過注解寫在接口方法上。最后給這個接口添加@Mapper注解或者在啟動類上添加@MapperScan("com.dudu.dao")注解都行。
如下：
package com.dudu.dao;
/**
* Created by tengj on 2017/4/22.
* Component注解不添加也沒事，只是不加service那邊引入LearnMapper會有錯誤提示，但不影響
*/
@Component
@Mapper
public interface LearnMapper {
@Insert("insert into learn_resource(author, title,url) values(#{author},#{title},#{url})")
int add(LearnResouce learnResouce);
@Update("update learn_resource set author=#{author},title=#{title},url=#{url} where id = #{id}")
int update(LearnResouce learnResouce);
@DeleteProvider(type = LearnSqlBuilder.class, method = "deleteByids")
int deleteByIds(@Param("ids") String[] ids);
@Select("select * from learn_resource where id = #{id}")
@Results(id = "learnMap", value = {
@Result(column = "id", property = "id", javaType = Long.class),
@Result(property = "author", column = "author", javaType = String.class),
@Result(property = "title", column = "title", javaType = String.class)
})
LearnResouce queryLearnResouceById(@Param("id") Long id);
@SelectProvider(type = LearnSqlBuilder.class, method = "queryLearnResouceByParams")
List<LearnResouce> queryLearnResouceList(Map<String, Object> params);
class LearnSqlBuilder {
public String queryLearnResouceByParams(final Map<String, Object> params) {
StringBuffer sql =new StringBuffer();
sql.append("select * from learn_resource where 1=1");
if(!StringUtil.isNull((String)params.get("author"))){
sql.append(" and author like '%").append((String)params.get("author")).append("%'");
}
if(!StringUtil.isNull((String)params.get("title"))){
sql.append(" and title like '%").append((String)params.get("title")).append("%'");
}
System.out.println("查詢sql=="+sql.toString());
return sql.toString();
}
//刪除的方法
public String deleteByids(@Param("ids") final String[] ids){
StringBuffer sql =new StringBuffer();
sql.append("DELETE FROM learn_resource WHERE id in(");
for (int i=0;i<ids.length;i++){
if(i==ids.length-1){
sql.append(ids[i]);
}else{
sql.append(ids[i]).append(",");
}
}
sql.append(")");
return sql.toString();
}
}
}
需要注意的是，簡單的語句只需要使用@Insert、@Update、@Delete、@Select這4個注解即可，但是有些復(fù)雜點需要動態(tài)SQL語句，就比如上面方法中根據(jù)查詢條件是否有值來動態(tài)添加sql的，就需要使用@InsertProvider、@UpdateProvider、@DeleteProvider、@SelectProvider等注解。
這些可選的 SQL 注解允許你指定一個類名和一個方法在執(zhí)行時來返回運行 允許創(chuàng)建動態(tài) 的 SQL。 基于執(zhí)行的映射語句, MyBatis 會實例化這個類,然后執(zhí)行由 provider 指定的方法. 該方法可以有選擇地接受參數(shù)對象.(In MyBatis 3.4 or later, it's allow multiple parameters) 屬性: type,method。type 屬性是類。method 屬性是方法名。 注意: 這節(jié)之后是對 類的 討論,它可以幫助你以干凈,容于閱讀 的方式來構(gòu)建動態(tài) SQL。
方案二：XML配置方式
xml配置方式保持映射文件的老傳統(tǒng)，優(yōu)化主要體現(xiàn)在不需要實現(xiàn)dao的是實現(xiàn)層，系統(tǒng)會自動根據(jù)方法名在映射文件中找對應(yīng)的sql，具體操作如下：
編寫Dao層的代碼
新建LearnMapper接口，無需具體實現(xiàn)類。
package com.dudu.dao;
@Mapper
public interface LearnMapper {
int add(LearnResouce learnResouce);
int update(LearnResouce learnResouce);
int deleteByIds(String[] ids);
LearnResouce queryLearnResouceById(Long id);
public List<LearnResouce> queryLearnResouceList(Map<String, Object> params);
}
修改application.properties 配置文件
#指定bean所在包
mybatis.type-aliases-package=com.dudu.domain
#指定映射文件
mybatis.mapperLocations=classpath:mapper/*.xml
添加LearnMapper的映射文件
在src/main/resources目錄下新建一個mapper目錄，在mapper目錄下新建LearnMapper.xml文件。
通過mapper標(biāo)簽中的namespace屬性指定對應(yīng)的dao映射，這里指向LearnMapper。
<?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.dudu.dao.LearnMapper">
<resultMap id="baseResultMap" type="com.dudu.domain.LearnResouce">
<id column="id" property="id" jdbcType="BIGINT" />
<result column="author" property="author" jdbcType="VARCHAR"/>
<result column="title" property="title" jdbcType="VARCHAR"/>
<result column="url" property="url" jdbcType="VARCHAR"/>
</resultMap>
<sql id="baseColumnList" >
id, author, title,url
</sql>
<select id="queryLearnResouceList" resultMap="baseResultMap" parameterType="java.util.HashMap">
select
<include refid="baseColumnList" />
from learn_resource
<where>
1 = 1
<if test="author!= null and author !=''">
AND author like CONCAT(CONCAT('%',#{author,jdbcType=VARCHAR}),'%')
</if>
<if test="title != null and title !=''">
AND title like CONCAT(CONCAT('%',#{title,jdbcType=VARCHAR}),'%')
</if>
</where>
</select>
<select id="queryLearnResouceById" resultMap="baseResultMap" parameterType="java.lang.Long">
SELECT
<include refid="baseColumnList" />
FROM learn_resource
WHERE id = #{id}
</select>
<insert id="add" parameterType="com.dudu.domain.LearnResouce" >
INSERT INTO learn_resource (author, title,url) VALUES (#{author}, #{title}, #{url})
</insert>
<update id="update" parameterType="com.dudu.domain.LearnResouce" >
UPDATE learn_resource SET author = #{author},title = #{title},url = #{url} WHERE id = #{id}
</update>
<delete id="deleteByIds" parameterType="java.lang.String" >
DELETE FROM learn_resource WHERE id in
<foreach item="idItem" collection="array" open="(" separator="," close=")">
#{idItem}
</foreach>
</delete>
</mapper>
更多mybatis數(shù)據(jù)訪問操作的使用請參考：mybatis官方中文參考文檔
分頁插件
上面我有使用到物理分頁插件pagehelper，用法還算簡單，配置如下
pom.xml中添加依賴
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper-spring-boot-starter</artifactId>
<version>1.1.0</version>
</dependency>
然后你只需在查詢list之前使用PageHelper.startPage(int pageNum, int pageSize)方法即可。pageNum是第幾頁，pageSize是每頁多少條。
@Override
public List<LearnResouce> queryLearnResouceList(Map<String,Object> params) {
PageHelper.startPage(Integer.parseInt(params.get("page").toString()), Integer.parseInt(params.get("rows").toString()));
return this.learnMapper.queryLearnResouceList(params);
}
分頁插件PageHelper項目地址： https://github.com/pagehelper/Mybatis-PageHelper
最終項目效果如下,增刪改查分頁一個都不少：
總結(jié)
到此為止，Spring Boot與Mybatis的初步整合就完成了，項目不僅整合了bootstrap模板框架，還包含了登錄、攔截器、日志框架logback等前面介紹的功能。麻雀雖小，五臟俱全。
想要查看更多Spring Boot干貨教程,可前往：Spring Boot干貨系列總綱
源碼下載
(￣︶￣)↗[相關(guān)示例完整代碼]
- chapter9==》Spring Boot干貨系列：（九）數(shù)據(jù)存儲篇-SQL關(guān)系型數(shù)據(jù)庫之MyBatis-注解方式
- chapter9-2==》Spring Boot干貨系列：（九）數(shù)據(jù)存儲篇-SQL關(guān)系型數(shù)據(jù)庫之MyBatis-XML配置方式
想要ace模板源碼的話，在博主公眾號回復(fù)關(guān)鍵字：ace
一直覺得自己寫的不是技術(shù)，而是情懷，一篇篇文章是自己這一路走來的痕跡。靠專業(yè)技能的成功是最具可復(fù)制性的，希望我的這條路能讓你少走彎路，希望我能幫你抹去知識的蒙塵，希望我能幫你理清知識的脈絡(luò)，希望未來技術(shù)之巔上有你也有我。
