Spring Boot 集成Mybatis

转载：https://blog.csdn.net/cl_andywin/article/details/53790558

Spring Boot 提供了JDBC与JPA的支持，由于本人比较喜欢用Mybatis，所以基本上都是用的Mybatis其余的都很少用，也算是对Mybatis的偏爱吧，下面说说Spring Boot怎么跟Mybatis集成开发。

首先创建工程

      创建工程名称为：springboot-mybatis，创建完后如下图：

1.使用mybatis-spring集成

       （1）在pom.xml中添加Spring Boot、Mybatis以及mysql驱动包的依赖，添加后代码如下：

[html]  view plain  copy

1. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
2.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">  
3.     <modelVersion>4.0.0</modelVersion>  
4.     <groupId>com.chengli</groupId>  
5.     <artifactId>springboot-mybatis</artifactId>  
6.     <version>0.0.1-SNAPSHOT</version>  
7.     <packaging>jar</packaging>  
8.     <name>springboot-mybatis</name>  
9.     <url>http://maven.apache.org</url>  
10.     <parent>  
11.         <groupId>org.springframework.boot</groupId>  
12.         <artifactId>spring-boot-starter-parent</artifactId>  
13.         <version>1.4.2.RELEASE</version>  
14.     </parent>  
15.     <properties>  
16.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>  
17.         <java.version>1.8</java.version>  
18.     </properties>  
19.     <dependencies>  
20.         <dependency>  
21.             <groupId>org.springframework.boot</groupId>  
22.             <artifactId>spring-boot-starter-web</artifactId>  
23.         </dependency>  
24.         <dependency>  
25.             <groupId>org.springframework.boot</groupId>  
26.             <artifactId>spring-boot-starter-jdbc</artifactId>  
27.         </dependency>  
28.         <dependency>  
29.             <groupId>org.mybatis</groupId>  
30.             <artifactId>mybatis</artifactId>  
31.             <version>3.4.1</version>  
32.         </dependency>  
33.         <dependency>  
34.             <groupId>org.mybatis</groupId>  
35.             <artifactId>mybatis-spring</artifactId>  
36.             <version>1.3.0</version>  
37.         </dependency>  
38.         <dependency>  
39.             <groupId>mysql</groupId>  
40.             <artifactId>mysql-connector-java</artifactId>  
41.         </dependency>  
42.     </dependencies>  
43. </project>  

       注意：记得选择项目Update Project，不然会改变不了哦。

      （2）新建application.properties文件，在文件加入以下内容：

[plain]  view plain  copy

1. spring.datasource.driver-class-name=com.mysql.jdbc.Driver  
2. spring.datasource.url=jdbc:mysql://localhost:3306/springboot?useUnicode=true&characterEncoding=utf8  
3. spring.datasource.username=root  
4. spring.datasource.password=root  

       注意：以上内容是我本地的数据库，可根据你实际的情况进行修改。

      （3）新建Mybatis的config类，代码如下：

[java]  view plain  copy

1. package com.chengli.springboot.mybatis.config;  
2.   
3. import javax.sql.DataSource;  
4.   
5. import org.apache.ibatis.annotations.Mapper;  
6. import org.apache.ibatis.session.SqlSessionFactory;  
7. import org.mybatis.spring.SqlSessionFactoryBean;  
8. import org.mybatis.spring.annotation.MapperScan;  
9. import org.springframework.context.annotation.Bean;  
10. import org.springframework.context.annotation.Configuration;  
11. import org.springframework.core.io.support.PathMatchingResourcePatternResolver;  
12. import org.springframework.jdbc.datasource.DataSourceTransactionManager;  
13. import org.springframework.transaction.PlatformTransactionManager;  
14. import org.springframework.transaction.annotation.EnableTransactionManagement;  
15.   
16. @Configuration  
17. @MapperScan(basePackages = { "com.chengli.springboot.mybatis" },annotationClass=Mapper.class)  
18. @EnableTransactionManagement  
19. public class MybatisConfig {  
20.     @Bean  
21.     public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {  
22.         SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();  
23.         sqlSessionFactoryBean.setDataSource(dataSource);  
24.         sqlSessionFactoryBean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper/*.xml"));  
25.   
26.         return sqlSessionFactoryBean.getObject();  
27.     }  
28.   
29.     @Bean  
30.     public PlatformTransactionManager transactionManager(DataSource dataSource) {  
31.         return new DataSourceTransactionManager(dataSource);  
32.     }  
33.   
34. }  

       注意：@Configuration注解声明该类为一个配置类，@MapperScan注解用于扫描Mapper，类似Spring的@ComponentScan，这里我指定了扫描的根包，annotationClass指定使用@Mapper的注解类。setMapperLocations设置了XML路径，如果全部基于注解的话这里可以不用配置，我比较喜好将SQL放到XML中管理， 所以这里使用了XML。@EnableTransactionManagement注解开启注解事务，使用transactionManager创建了事务管理器，事务在这里不做叙述，在后面的博文中专门来讲事务。

      （4）新建用户Mapper类，代码如下：

[java]  view plain  copy

1. package com.chengli.springboot.mybatis.dao;  
2.   
3. import org.apache.ibatis.annotations.Mapper;  
4.   
5. import com.chengli.springboot.mybatis.pojo.User;  
6.   
7. @Mapper  
8. public interface UserMapper {  
9.     User selectById(Long id);  
10.   
11.     int deleteById(Long id);  
12. }  

      （5）新建用户实体，代码如下：

[java]  view plain  copy

1. package com.chengli.springboot.mybatis.pojo;  
2.   
3. public class User {  
4.     private Long id;  
5.     private String name;  
6.     private String sex;  
7.     private Integer age;  
8.   
9.     public Long getId() {  
10.         return id;  
11.     }  
12.   
13.     public void setId(Long id) {  
14.         this.id = id;  
15.     }  
16.   
17.     public String getName() {  
18.         return name;  
19.     }  
20.   
21.     public void setName(String name) {  
22.         this.name = name;  
23.     }  
24.   
25.     public String getSex() {  
26.         return sex;  
27.     }  
28.   
29.     public void setSex(String sex) {  
30.         this.sex = sex;  
31.     }  
32.   
33.     public Integer getAge() {  
34.         return age;  
35.     }  
36.   
37.     public void setAge(Integer age) {  
38.         this.age = age;  
39.     }  
40.   
41. }  

      （6）在src/main/resources下新建文件夹mapper，然后在mapper中新建UserMapper.xml，代码如下：

[html]  view plain  copy

1. <?xml version="1.0" encoding="UTF-8" ?>  
2. <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >  
3. <mapper namespace="com.chengli.springboot.mybatis.dao.UserMapper">  
4.     <resultMap id="BaseResultMap" type="com.chengli.springboot.mybatis.pojo.User">  
5.         <id column="id" property="id" jdbcType="BIGINT" />  
6.         <result column="name" property="name" jdbcType="VARCHAR" />  
7.         <result column="sex" property="sex" jdbcType="VARCHAR" />  
8.         <result column="age" property="age" jdbcType="INTEGER" />  
9.     </resultMap>  
10.   
11.     <select id="selectById" resultMap="BaseResultMap" parameterType="java.lang.Long">  
12.         select  
13.         id,name,sex,age  
14.         from user  
15.         where id = #{id,jdbcType=BIGINT}  
16.     </select>  
17.   
18.     <delete id="deleteById" parameterType="java.lang.Long">  
19.         delete from user where id = #{id,jdbcType=BIGINT}  
20.     </delete>  
21. </mapper>  

      （7）新建Service类，代码如下：

[java]  view plain  copy

1. package com.chengli.springboot.mybatis.service;  
2.   
3. import com.chengli.springboot.mybatis.pojo.User;  
4.   
5. public interface UserService {  
6.     User selectById(Long id);  
7.   
8.     void deleteById(Long id);  
9. }  
10.   
11.   
12. package com.chengli.springboot.mybatis.service.impl;  
13.   
14. import org.springframework.beans.factory.annotation.Autowired;  
15. import org.springframework.stereotype.Service;  
16. import org.springframework.transaction.annotation.Transactional;  
17.   
18. import com.chengli.springboot.mybatis.dao.UserMapper;  
19. import com.chengli.springboot.mybatis.pojo.User;  
20. import com.chengli.springboot.mybatis.service.UserService;  
21.   
22. @Service  
23. public class UserServiceImpl implements UserService {  
24.     @Autowired  
25.     private UserMapper userMapper;  
26.   
27.     @Override  
28.     public User selectById(Long id) {  
29.         return userMapper.selectById(id);  
30.     }  
31.   
32.     @Override  
33.     @Transactional  
34.     public void deleteById(Long id) {  
35.         userMapper.deleteById(id);  
36.     }  
37.   
38. }  

      （8）在来一个启动入口类

[java]  view plain  copy

1. package com.chengli.springboot.mybatis;  
2.   
3. import org.springframework.beans.factory.annotation.Autowired;  
4. import org.springframework.boot.SpringApplication;  
5. import org.springframework.boot.autoconfigure.SpringBootApplication;  
6. import org.springframework.web.bind.annotation.PathVariable;  
7. import org.springframework.web.bind.annotation.RequestMapping;  
8. import org.springframework.web.bind.annotation.RestController;  
9.   
10. import com.chengli.springboot.mybatis.service.UserService  
11. import com.chengli.springboot.mybatis.pojo.User;  
12.   
13. @SpringBootApplication  
14. @RestController  
15. public class MainConfig {  
16.     @Autowired  
17.     private UserService userService;  
18.   
19.     public static void main(String[] args) {  
20.         SpringApplication.run(MainConfig.class, args);  
21.     }  
22.   
23.     @RequestMapping("/get/user/{id}")  
24.     public User getUserById(@PathVariable Long id) {  
25.         return userService.selectById(id);  
26.     }  
27. }  

      （8）到这里就大功告成了，启动在浏览器上输入显示如下：

2.使用mybatis-spring-boot-starter集成

      使用mybatis-spring-boot-starter集成Mybatis比较简单，目前依赖的Spring Boot 1.3.3版本，使用mybatis-spring-boot-starter集成配置不灵活，不建议使用，这里就不在叙述了。

3.Mybatis添加插件

      有时候需要往Mybatis里面添加插件，例如分页啊，在上面的代码中，我们在创建SqlSessionFactoryBean的时候，就可以添加插件了，具体代码如下：

[java]  view plain  copy

1. @Bean  
2.     public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {  
3.         SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();  
4.         sqlSessionFactoryBean.setDataSource(dataSource);  
5.         sqlSessionFactoryBean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper/*.xml"));  
6.           
7.         //添加Mybatis插件，例如分页，在之类创建你插件添加进去即可，这里我就不做叙述了。  
8.         //sqlSessionFactoryBean.setPlugins(new Interceptor[]{你的插件});  
9.           
10.         return sqlSessionFactoryBean.getObject();  
11.     }  

有兴趣的朋友可以加群探讨相互学习：