Spring Boot：Mybatis的使用_springboot使用mybatis

一.Mybatis 简介

Mybatis 初期使用比较麻烦，需要各种配置文件、实体类、Dao 层映射关联、还有一大推其它配置。当然 Mybatis 也发现了这种弊端，初期开发了generator 可以根据表结果自动生产实体类、配置文件和 Dao 层代码，可以减轻一部分开发量；后期也进行了大量的优化可以使用注解了，自动管理 Dao 层和配置文件等，发展到最顶端就是今天要讲的这种模式了，mybatis-spring-boot-starter 就是 Spring Boot + Mybatis 可以完全注解不用配置文件，也可以简单配置轻松上手。

二.mybatis-spring-boot-starter

官方说明：MyBatis Spring-Boot-Starter will help you use MyBatis with Spring Boot
其实就是 Mybatis 看 Spring Boot 这么火热也开发出一套解决方案来凑凑热闹，但这一凑确实解决了很多问题，使用起来确实顺畅了许多。mybatis-spring-boot-starter 主要有两种解决方案，一种是使用注解解决一切问题，一种是简化后的老传统。
当然任何模式都需要首先引入 mybatis-spring-boot-starter 的 pom 文件，现在最新版本是 2.0.0。

	<dependency>
		<groupId>org.mybatis.spring.boot</groupId>
		<artifactId>mybatis-spring-boot-starter</artifactId>
		<version>2.0.0</version>
	</dependency>
1
2
3
4
5

三.无配置文件注解版

1.添加相关 Maven 文件

	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<dependency>
			<groupId>org.mybatis.spring.boot</groupId>
			<artifactId>mybatis-spring-boot-starter</artifactId>
			<version>2.0.0</version>
		</dependency>
			<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
		</dependency>
	</dependencies>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

2.application.properties 添加相关配置

	mybatis.type-aliases-package=com.demo.model
	
	spring.datasource.url=jdbc:mysql://localhost:3306/test?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8&useSSL=true
	spring.datasource.username=root
	spring.datasource.password=root
	spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
1
2
3
4
5
6

Spring Boot 会自动加载 spring.datasource.* 相关配置，数据源就会自动注入到 sqlSessionFactory 中，sqlSessionFactory 会自动注入到 Mapper 中，所以你一切都不用管了，直接拿起来使用就行了。
在启动类中添加对 mapper 包扫描 @MapperScan：

	@SpringBootApplication
	@MapperScan("com.demo.mapper")
	public class MybatisAnnotationApplication {
	
		public static void main(String[] args) {
			SpringApplication.run(MybatisAnnotationApplication.class, args);
		}
	}
1
2
3
4
5
6
7
8

或者直接在 Mapper 类上面添加注解 @Mapper，建议使用上面那种，不然每个 Mapper 加个注解也挺麻烦的。

3.开发 Mapper

第三步是最关键的一块， sql 生产都在这里：

	public interface UserMapper {
		
		@Select("SELECT * FROM users")
		@Results({
			@Result(property = "userSex",  column = "user_sex", javaType = UserSexEnum.class),
			@Result(property = "nickName", column = "nick_name")
		})
		List<UserEntity> getAll();
		
		@Select("SELECT * FROM users WHERE id = #{id}")
		@Results({
			@Result(property = "userSex",  column = "user_sex", javaType = UserSexEnum.class),
			@Result(property = "nickName", column = "nick_name")
		})
		UserEntity getOne(Long id);
	
		@Insert("INSERT INTO users(userName,passWord,user_sex) VALUES(#{userName}, #{passWord}, #{userSex})")
		void insert(UserEntity user);
	
		@Update("UPDATE users SET userName=#{userName},nick_name=#{nickName} WHERE id =#{id}")
		void update(UserEntity user);
	
		@Delete("DELETE FROM users WHERE id =#{id}")
		void delete(Long id);
	
	}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

为了更接近生产我特地将 user_sex、nick_name 两个属性在数据库加了下划线和实体类属性名不一致，另外 user_sex 使用了枚举。
@Select 是查询类的注解，所有的查询均使用这个
@Result 修饰返回的结果集，关联实体类属性和数据库字段一一对应，如果实体类属性和数据库属性名保持一致，就不需要这个属性来修饰。
@Insert 插入数据库使用，直接传入实体类会自动解析属性到对应的值
@Update 负责修改，也可以直接传入对象
@delete 负责删除
了解更多属性参考这里
注意，使用#符号和$符号的不同：

	// This example creates a prepared statement, something like select * from teacher where name = ?;
	@Select("Select * from teacher where name = #{name}")
	Teacher selectTeachForGivenName(@Param("name") String name);
	
	// This example creates n inlined statement, something like select * from teacher where name = 'someName';
	@Select("Select * from teacher where name = '${name}'")
	Teacher selectTeachForGivenName(@Param("name") String name);
1
2
3
4
5
6
7

4.使用

上面三步就基本完成了相关 Mapper 层开发，使用的时候当作普通的类注入进入就可以了。

	@RunWith(SpringRunner.class)
	@SpringBootTest
	public class UserMapperTest {
	
		@Autowired
		private UserMapper userMapper;
	
		@Test
		public void testInsert() throws Exception {
			userMapper.insert(new User("aa1", "a123456", UserSexEnum.MAN));
			userMapper.insert(new User("bb1", "b123456", UserSexEnum.WOMAN));
			userMapper.insert(new User("cc1", "b123456", UserSexEnum.WOMAN));
	
			Assert.assertEquals(3, userMapper.getAll().size());
		}
	
		@Test
		public void testQuery() throws Exception {
			List<User> users = userMapper.getAll();
			System.out.println(users.toString());
		}	
		
		@Test
		public void testUpdate() throws Exception {
			User user = userMapper.getOne(30l);
			System.out.println(user.toString());
			user.setNickName("neo");
			userMapper.update(user);
			Assert.assertTrue(("neo".equals(userMapper.getOne(30l).getNickName())));
		}
	}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

四.极简 xml 版本

极简 xml 版本保持映射文件的老传统，接口层只需要定义空方法，系统会自动根据方法名在映射文件中找对应的 sql。

1.配置

pom 文件和上个版本一样，只是 application.properties 新增以下配置：

	mybatis.config-location=classpath:mybatis/mybatis-config.xml
	mybatis.mapper-locations=classpath:mybatis/mapper/*.xml
1
2

指定了 Mybatis 基础配置文件和实体类映射文件的地址。
mybatis-config.xml 配置：

	<configuration>
		<typeAliases>
			<typeAlias alias="Integer" type="java.lang.Integer" />
			<typeAlias alias="Long" type="java.lang.Long" />
			<typeAlias alias="HashMap" type="java.util.HashMap" />
			<typeAlias alias="LinkedHashMap" type="java.util.LinkedHashMap" />
			<typeAlias alias="ArrayList" type="java.util.ArrayList" />
			<typeAlias alias="LinkedList" type="java.util.LinkedList" />
		</typeAliases>
	</configuration>
1
2
3
4
5
6
7
8
9
10

这里也可以添加一些 Mybatis 基础的配置。

2.添加 User 的映射文件

	<mapper namespace="com.neo.mapper.UserMapper" >
	    <resultMap id="BaseResultMap" type="com.neo.entity.UserEntity" >
	        <id column="id" property="id" jdbcType="BIGINT" />
	        <result column="userName" property="userName" jdbcType="VARCHAR" />
	        <result column="passWord" property="passWord" jdbcType="VARCHAR" />
	        <result column="user_sex" property="userSex" javaType="com.neo.enums.UserSexEnum"/>
	        <result column="nick_name" property="nickName" jdbcType="VARCHAR" />
	    </resultMap>
	    
	    <sql id="Base_Column_List" >
	        id, userName, passWord, user_sex, nick_name
	    </sql>
	
	    <select id="getAll" resultMap="BaseResultMap"  >
	       SELECT 
	       <include refid="Base_Column_List" />
		   FROM users
	    </select>
	
	    <select id="getOne" parameterType="java.lang.Long" resultMap="BaseResultMap" >
	        SELECT 
	       <include refid="Base_Column_List" />
		   FROM users
		   WHERE id = #{id}
	    </select>
	
	    <insert id="insert" parameterType="com.neo.entity.UserEntity" >
	       INSERT INTO 
	       		users
	       		(userName,passWord,user_sex) 
	       	VALUES
	       		(#{userName}, #{passWord}, #{userSex})
	    </insert>
	    
	    <update id="update" parameterType="com.neo.entity.UserEntity" >
	       UPDATE 
	       		users 
	       SET 
	       	<if test="userName != null">userName = #{userName},</if>
	       	<if test="passWord != null">passWord = #{passWord},</if>
	       	nick_name = #{nickName}
	       WHERE 
	       		id = #{id}
	    </update>
	    
	    <delete id="delete" parameterType="java.lang.Long" >
	       DELETE FROM
	       		 users 
	       WHERE 
	       		 id =#{id}
	    </delete>
	</mapper>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

其实就是把上个版本中 Mapper 的 sql 搬到了这里的 xml 中了。

3.编写 Mapper 层的代码

	public interface UserMapper {
		
		List<UserEntity> getAll();
		
		UserEntity getOne(Long id);
	
		void insert(UserEntity user);
	
		void update(UserEntity user);
	
		void delete(Long id);
	
	}
1
2
3
4
5
6
7
8
9
10
11
12
13

五.多数据源解决方案

我们以 Mybatis xml 版本为例，给大家展示如何如何配置多数据源。

1.配置文件

pom 包就不贴了，比较简单，该依赖的就依赖，主要是数据库这边的配置：

	mybatis.config-location=classpath:mybatis/mybatis-config.xml
	
	spring.datasource.test1.jdbc-url=jdbc:mysql://localhost:3306/test1?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8&useSSL=true
	spring.datasource.test1.username=root
	spring.datasource.test1.password=root
	spring.datasource.test1.driver-class-name=com.mysql.cj.jdbc.Driver
	
	spring.datasource.test2.jdbc-url=jdbc:mysql://localhost:3306/test2?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8&useSSL=true
	spring.datasource.test2.username=root
	spring.datasource.test2.password=root
	spring.datasource.test2.driver-class-name=com.mysql.cj.jdbc.Driver
1
2
3
4
5
6
7
8
9
10
11

一个 test1 库和一个 test2 库，其中 test1 位主库，在使用的过程中必须指定主库，不然会报错。

2.数据源配置

	@Configuration
	@MapperScan(basePackages = "com.demo.mapper.test1", sqlSessionTemplateRef  = "test1SqlSessionTemplate")
	public class DataSource1Config {
	
		@Bean(name = "test1DataSource")
	    @ConfigurationProperties(prefix = "spring.datasource.test1")
	    @Primary
	    public DataSource testDataSource() {
			return DataSourceBuilder.create().build();
	    }
	
	    @Bean(name = "test1SqlSessionFactory")
	    @Primary
	    public SqlSessionFactory testSqlSessionFactory(@Qualifier("test1DataSource") DataSource dataSource) throws Exception {
	        SqlSessionFactoryBean bean = new SqlSessionFactoryBean();
	        bean.setDataSource(dataSource);
	        bean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mybatis/mapper/test1/*.xml"));
	        return bean.getObject();
	    }
	
	    @Bean(name = "test1TransactionManager")
	    @Primary
	    public DataSourceTransactionManager testTransactionManager(@Qualifier("test1DataSource") DataSource dataSource) {
	        return new DataSourceTransactionManager(dataSource);
	    }
	
	    @Bean(name = "test1SqlSessionTemplate")
	    @Primary
	    public SqlSessionTemplate testSqlSessionTemplate(@Qualifier("test1SqlSessionFactory") SqlSessionFactory sqlSessionFactory) throws Exception {
	        return new SqlSessionTemplate(sqlSessionFactory);
	    }
	}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

最关键的地方就是这块了，一层一层注入，首先创建 DataSource，然后创建 SqlSessionFactory 再创建事务，最后包装到 SqlSessionTemplate 中。其中需要指定分库的 mapper 文件地址，以及分库 dao 层代码。

@MapperScan(basePackages = "com.demo.mapper.test1", sqlSessionTemplateRef  = "test1SqlSessionTemplate")
1

这块的注解就是指明了扫描 dao 层，并且给 dao 层注入指定的 SqlSessionTemplate。所有@Bean都需要按照命名指定正确。

3.dao 层和 xml 层

dao 层和 xml 需要按照库来分在不同的目录，比如：test1 库 dao 层在 com.demo.mapper.test1 包下，test2 库在com.demo.mapper.test2 包下。

	public interface User1Mapper {
		List<UserEntity> getAll();
		UserEntity getOne(Long id);
		void insert(UserEntity user);
		void update(UserEntity user);
		void delete(Long id);
	}
1
2
3
4
5
6
7

xml 层：

	<mapper namespace="com.neo.mapper.test1.User1Mapper" >
	    <resultMap id="BaseResultMap" type="com.neo.model.User" >
			<id column="id" property="id" jdbcType="BIGINT" />
	        <result column="userName" property="userName" jdbcType="VARCHAR" />
	        <result column="passWord" property="passWord" jdbcType="VARCHAR" />
	        <result column="user_sex" property="userSex" javaType="com.neo.enums.UserSexEnum"/>
	        <result column="nick_name" property="nickName" jdbcType="VARCHAR" />
		</resultMap>
	    
	    <sql id="Base_Column_List" >
			id, userName, passWord, user_sex, nick_name
	    </sql>
	
	    <select id="getAll" resultMap="BaseResultMap"  >
			SELECT 
				<include refid="Base_Column_List" />
			FROM users
	    </select>
	
	    <select id="getOne" parameterType="java.lang.Long" resultMap="BaseResultMap" >
			SELECT 
				<include refid="Base_Column_List" />
			FROM users
			WHERE id = #{id}
	    </select>
	
	    <insert id="insert" parameterType="com.neo.model.User" >
			INSERT INTO 
				users
				(userName,passWord,user_sex) 
			VALUES
				(#{userName}, #{passWord}, #{userSex})
	    </insert>
	    
	    <update id="update" parameterType="com.neo.model.User" >
			UPDATE 
				users 
			SET 
				<if test="userName != null">userName = #{userName},</if>
				<if test="passWord != null">passWord = #{passWord},</if>
				nick_name = #{nickName}
			WHERE 
				id = #{id}
	    </update>
	    
	    <delete id="delete" parameterType="java.lang.Long" >
			DELETE FROM
				users 
			WHERE 
				id =#{id}
		</delete>
		
	</mapper>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

4.测试

测试可以使用 SpringBootTest，也可以放到 Controller 中，这里只贴 Controller 层的使用：

	@RestController
	public class UserController {
	
		@Autowired
	    private User1Mapper user1Mapper;
	
		@Autowired
		private User2Mapper user2Mapper;
		
		@RequestMapping("/getUsers")
		public List<UserEntity> getUsers() {
			List<UserEntity> users=user1Mapper.getAll();
			return users;
		}
		
	    @RequestMapping("/getUser")
	    public UserEntity getUser(Long id) {
	    	UserEntity user=user2Mapper.getOne(id);
	        return user;
	    }
	    
	    @RequestMapping("/add")
	    public void save(UserEntity user) {
	        user2Mapper.insert(user);
	    }
	    
	    @RequestMapping(value="update")
	    public void update(UserEntity user) {
	        user2Mapper.update(user);
	    }
	    
	    @RequestMapping(value="/delete/{id}")
	    public void delete(@PathVariable("id") Long id) {
	        user1Mapper.delete(id);
	    }
	    
	}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

六.如何选择

两种模式各有特点，注解版适合简单快速的模式，其实像现在流行的这种微服务模式，一个微服务就会对应一个自已的数据库，多表连接查询的需求会大大的降低，会越来越适合这种模式。
老传统模式比较适合大型项目，可以灵活的动态生成 sql ，方便调整 sql ，也有痛痛快快，洋洋洒洒的写 sql 的感觉。

参考文章：http://www.ityouknow.com/springboot/2016/11/06/spring-boot-mybatis.html
http://www.ityouknow.com/springboot/2016/11/25/spring-boot-multi-mybatis.html