SpringBoot mybatisplus

spring boot约定优于配置的思想让我们的开发更加专注，mybatis plus让orm开发更加有效率。MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

接下来我们开始整合spring boot使用。首先创建spring boot项目工程，基于2.1.4版本具体可以参考我的GitHub。mybatis-plus模块。地址：https://github.com/UniqueDong/springboot-study

在此之前我们通过maven来管理依赖

• 拥有 Java 开发环境以及相应 IDE

• 熟悉 Spring Boot

• 熟悉 Maven

pom依赖如下所示：里面新加了dynamic-datasource-spring-boot-starter主要用来数据源动态切换，或者读写分离。

网上关于动态数据源的切换的文档有很多，核心只有两种。

1. 构建多套环境，优势是方便控制也容易集成一些简单的分布式事务，缺点是非动态同时代码量较多,配置难度大。

2. 基于spring提供原生的 AbstractRoutingDataSource ，参考一些文档自己实现切换。

如果你的数据源较少，场景不复杂，选择以上任意一种都可以。如果你需要更多特性，请尝试本动态数据源。

1. 数据源分组，适用于多种场景 纯粹多库 读写分离 一主多从 混合模式。

2. 简单集成Druid数据源监控多数据源，简单集成Mybatis-Plus简化单表，简单集成P6sy格式化sql，简单集成Jndi数据源。

3. 简化Druid和HikariCp配置，提供全局参数配置。

4. 提供自定义数据源来源(默认使用yml或properties配置)。

5. 项目启动后能动态增减数据源。

6. 使用spel动态参数解析数据源，如从session，header和参数中获取数据源。（多租户架构神器）

7. 多层数据源嵌套切换。（一个业务ServiceA调用ServiceB，ServiceB调用ServiceC，每个Service都是不同的数据源）

8. 使用正则匹配或spel表达式来切换数据源（实验性功能）。

#劣势

不能使用多数据源事务（同一个数据源下能使用事务），网上其他方案也都不能提供。

如果你需要使用到分布式事务，那么你的架构应该到了微服务化的时候了。

如果呼声强烈，项目达到800 star，作者考虑集成分布式事务。

PS: 如果您只是几个数据库但是有强烈的需求分布式事务，建议还是使用传统方式自己构建多套环境集成atomic这类，网上百度很多。

#约定

1. 本框架只做 切换数据源 这件核心的事情，并不限制你的具体操作，切换了数据源可以做任何CRUD。

2. 配置文件所有以下划线 _ 分割的数据源 首部 即为组的名称，相同组名称的数据源会放在一个组下。

3. 切换数据源即可是组名，也可是具体数据源名称，切换时默认采用负载均衡机制切换。

4. 默认的数据源名称为 master ，你可以通过spring.datasource.dynamic.primary修改。

5. 方法上的注解优先于类上注解

同时我使用了maven的module概念。将myabtis plus模块放在一个父类pom管理的工程下

所以spring boot的依赖师门使用如下方式

1. <dependencyManagement>

2. <dependencies>

3. <dependency>

4. <!-- Import dependency management from Spring Boot -->

5. <groupId>org.springframework.boot</groupId>

6. <artifactId>spring-boot-dependencies</artifactId>

7. <version>2.1.4.RELEASE</version>

8. <type>pom</type>

9. <scope>import</scope>

10. </dependency>

11. <dependency>

12. <groupId>org.projectlombok</groupId>

13. <artifactId>lombok</artifactId>

14. <version>1.18.2</version>

15. <optional>true</optional>

16. </dependency>

17. </dependencies>

18. </dependencyManagement>

1. <dependencies>

2. <dependency>

3. <groupId>org.springframework.boot</groupId>

4. <artifactId>spring-boot-starter-web</artifactId>

5. </dependency>

6.  

7. <dependency>

8. <groupId>com.baomidou</groupId>

9. <artifactId>mybatis-plus-boot-starter</artifactId>

10. <version>3.1.0</version>

11. </dependency>

12. <dependency>

13. <groupId>com.baomidou</groupId>

14. <artifactId>dynamic-datasource-spring-boot-starter</artifactId>

15. <version>2.5.4</version>

16. </dependency>

17.  

18. <dependency>

19. <groupId>mysql</groupId>

20. <artifactId>mysql-connector-java</artifactId>

21. <version>${mysql.version}</version>

22. </dependency>

23.  

24. <dependency>

25. <groupId>org.projectlombok</groupId>

26. <artifactId>lombok</artifactId>

27. <optional>true</optional>

28. </dependency>

29. <dependency>

30. <groupId>org.springframework.boot</groupId>

31. <artifactId>spring-boot-starter-test</artifactId>

32. <scope>test</scope>

33. </dependency>

34. </dependencies>

其对应的数据库 Schema 脚本如下：

``

1. DROP TABLE IF EXISTS vip_account;

2.  

3. CREATE TABLE vip_account

4. (

5. id BIGINT(20) NOT NULL COMMENT '主键ID',

6. username VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名'

7. PRIMARY KEY (id)

8. );

我们使用yaml格式的配置文件，配置如下：

1. server:

2. servlet:

3. context-path: /mybatis

4. port: 9002

5. spring:

6. application:

7. name: mybatis-plus

8. datasource:

9. # 读写分离

10. dynamic:

11. hikari:

12. driver-class-name: com.mysql.jdbc.Driver

13. datasource:

14. master:

15. username: root

16. password: 123456

17. driver-class-name: com.mysql.jdbc.Driver

18. url: jdbc:mysql://localhost:3306/vip?useUnicode=true&characterEncoding=utf8&useSSL=false

19. slave:

20. username: root

21. password: 123456

22. driver-class-name: com.mysql.jdbc.Driver

23. url: jdbc:mysql://localhost:3306/vip?useUnicode=true&characterEncoding=utf8&useSSL=false

24. # mybatis plus配置

25. mybatis-plus:

26. global-config:

27. db-config:

28. id-type: auto

29. # 定义我们的mapper.xml文件路径

30. mapper-locations: classpath:/mapper/**/*Mapper.xml

31. type-aliases-package: zero.springboot.study.mybatisplus.domain

32. configuration:

33. # 自动将数据库字段的下划线的下一个字母转驼峰，比如user_name 转为userName

34. map-underscore-to-camel-case: true

这里mybatis plus利用springboot的starter自动装配特性就帮我们配置好了。有点类似于Java的SPI机制。

创建spring boot启动类

1. @SpringBootApplication

2. public class MybatisPlusApplication {

3.  

4. public static void main(String[] args) {

5. SpringApplication.run(MybatisPlusApplication.class, args);

6. }

7.  

8. }

•  

  MybatisPlusConfig 配置告诉mybatis我们存放mapper接口所在的包

   

•  

  Mybatis plus ServiceImpl相当于BaseMapper的封装拓展

   

•  

  BaseMapper提供了单表的CRUD方便我们快速开发。

  编码时刻

  创建实体类 VipAccount（此处使用了 Lombok 简化代码）

  BaseMapper使用

  编写我们的Mapper接口类VipAccountMapper

  我们的Mapper接口只要继承mybatis plus的BaseMapper就有了基本的CRUD功能

  代码如下：

  @DS("master")标识使用的是那个数据源,该注解也可以使用在mapper的方法上标识同一个mapper不同方法使用不同的数据源，轻松实现读写分离

   

1. @DS("master")

2. publicinterfaceVipAccountMapperextendsBaseMapper<VipAccount>{

3.  

4. }

5. @Data

6. publicclassVipAccountimplementsSerializable{

7. privateLong id;

8. privateString username;

9. }

开始使用

大功告成，最后就可以愉快的使用了。跟多的mybatis plus功能特性可以参考官方文档 Mybatis Plus，这里重点是合理的整合方式，通过yaml简单配置开箱即用。使用到的SQL表数据如下

单元测试走起

1. import org.junit.Test;

2. import org.junit.runner.RunWith;

3. import org.springframework.beans.factory.annotation.Autowired;

4. import org.springframework.boot.test.context.SpringBootTest;

5. import org.springframework.test.context.junit4.SpringRunner;

6. import zero.springboot.study.mybatisplus.domain.VipAccount;

7. import zero.springboot.study.mybatisplus.mapper.master.VipAccountMapper;

8. import zero.springboot.study.mybatisplus.mapper.slave.VipAccountMapperSlave;

9. import zero.springboot.study.mybatisplus.service.vip.VipAccountServiceImpl;

10.  

11. @RunWith(SpringRunner.class)

12. @SpringBootTest(classes = MybatisPlusApplication.class)

13. public class MybatisPlusApplicationTests {

14.  

15. @Autowired

16. private VipAccountServiceImpl vipAccountService;

17.  

18. @Autowired

19. private VipAccountMapper vipAccountMapper;

20.  

21. @Autowired

22. private VipAccountMapperSlave vipAccountMapperSlave;

23.  

24. @Test

25. public void testServiceCrud() {

26. VipAccount vipAccount = new VipAccount();

27. vipAccount.setUsername("青龙");

28. vipAccountService.saveOrUpdate(vipAccount);

29. }

30.  

31. @Test

32. public void testMapperCrud() {

33.  

34. vipAccountMapper.deleteById(2);

35.  

36. VipAccount vipAccount = new VipAccount();

37. vipAccount.setUsername("青龙");

38. vipAccountMapper.insert(vipAccount);

39. VipAccount data = vipAccountMapperSlave.selectById(3);

40. System.out.println(data.toString());