SpringBoot集成Mybatis-Plus多租户架构实现

SELECT * FROM user WHERE tenant_id = 1;

<? xml version = "1.0" encoding = "UTF-8" ?>

< project xmlns = "http://maven.apache.org/POM/4.0.0" xmlns:xsi = "http://HdhCmsTestw3.org/2001/XMLSchema-instance"

          xsi:schemaLocation = "http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" >

     < modelVersion >4.0.0</ modelVersion >

     < parent >

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

         < artifactId >spring-boot-starter-parent</ artifactId >

         < version >2.1.7.RELEASE</ version >

         < relativePath />

     </ parent >

     < groupId >com.xd</ groupId >

     < artifactId >mybatis-plus-multi-tenancy</ artifactId >

     < version >0.0.1-SNAPSHOT</ version >

     < name >mybatis-plus-multi-tenancy</ name >

     < description >基于Spring Boot Mybatis-Plus的多租户架构</ description >

     < properties >

         < java.version >1.8</ java.version >

         < mybatis-plus.version >3.1.2</ mybatis-plus.version >

     </ properties >

     < dependencies >

         < dependency >

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

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

         </ dependency >

         <!--mysql-->

         < dependency >

             < groupId >mysql</ groupId >

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

             < scope >runtime</ scope >

         </ dependency >

         <!--lombok-->

         < dependency >

             < groupId >org.projectlombok</ groupId >

             < artifactId >lombok</ artifactId >

             < optional >true</ optional >

         </ dependency >

         <!--Mybatis-Plus依赖-->

         < dependency >

             < groupId >com.baomidou</ groupId >

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

             < version >${mybatis-plus.version}</ version >

         </ dependency >

         <!--测试相关依赖-->

         < dependency >

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

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

             < scope >test</ scope >

         </ dependency >

         < dependency >

             < groupId >junit</ groupId >

             < artifactId >junit</ artifactId >

         </ dependency >

         < dependency >

             < groupId >org.springframework</ groupId >

             < artifactId >spring-test</ artifactId >

             < version >5.2.0.M1</ version >

             < scope >compile</ scope >

         </ dependency >

         < dependency >

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

             < artifactId >spring-boot-test</ artifactId >

         </ dependency >

     </ dependencies >

     < build >

         < plugins >

             < plugin >

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

                 < artifactId >spring-boot-maven-plugin</ artifactId >

             </ plugin >

         </ plugins >

     </ build >

</ project >

# 数据源配置

spring.datasource.type=com.zaxxer.hikari.HikariDataSource

spring.datasource.hikari.minimum-idle=3

spring.datasource.hikari.maximum-pool-size=10

# 不能小于30秒，否则默认回到1800秒

spring.datasource.hikari.max-lifetime=30000

spring.datasource.hikari.connection-test-query=SELECT 1

spring.datasource.driver-class-name=com.mysql.jdbc.Driver

spring.datasource.url=jdbc:mysql://localhost:3306/multi?useUnicode=true&characterEncoding=UTF-8

spring.datasource.username=root

spring.datasource.password=root

logging.level测试数据.xd.mybatisplusmultitenancy=debug

SET NAMES utf8mb4;

SET FOREIGN_KEY_CHECKS = 0;

-- ----------------------------

-- Table structure for user

-- ----------------------------

DROP TABLE IF EXISTS ` user `;

CREATE TABLE ` user ` (

   `id` int (11) NOT NULL AUTO_INCREMENT COMMENT '主键' ,

   ` name ` varchar (30) DEFAULT NULL COMMENT '姓名' ,

   `tenant_id` int (11) NOT NULL COMMENT '多租户ID' ,

   PRIMARY KEY (`id`)

) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

SET FOREIGN_KEY_CHECKS = 1;

package com.xd.mybatisplusmultitenancy.config;

import com.baomidou.mybatisplus.extension.plugins.tenant.TenantHandler;

import lombok.extern.slf4j.Slf4j;

import net.sf.jsqlparser.expression.Expression;

import net.sf.jsqlparser.expression.LongValue;

import net.sf.jsqlparser.expression.NullValue;

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

import org.springframework.stereotype.Component;

import java.util.ArrayList;

import java.util.List;

/**

  * @Classname PreTenantHandler

  * @Description 租户处理器 -主要实现mybatis-plus https://mp.baomidou测试数据/guide/tenant.html

  * @Author Created by Lihaodong (alias:小东啊) lihaodongmail@163测试数据

  * @Date 2019-08-09 23:34

  * @Version 1.0

  */

@Slf4j

@Component

public class MyTenantHandler implements TenantHandler {

     /**

      * 多租户标识

      */

     private static final String SYSTEM_TENANT_ID = "tenant_id" ;

     /**

      * 需要过滤的表

      */

     private static final List<String> IGNORE_TENANT_TABLES = new ArrayList<>();

     @Autowired

     private MyContext apiContext;

     /**

      * 租户Id

      *

      * @return

      */

     @Override

     public Expression getTenantId() {

         // 从当前系统上下文中取出当前请求的服务商ID，通过解析器注入到SQL中。

         Long tenantId = apiContext.getCurrentTenantId();

         log.debug( "当前租户为{}" , tenantId);

         if (tenantId == null ) {

             return new NullValue();

         }

         return new LongValue(tenantId);

     }

     /**

      * 租户字段名

      *

      * @return

      */

     @Override

     public String getTenantIdColumn() {

         return SYSTEM_TENANT_ID;

     }

     /**

      * 根据表名判断是否进行过滤

      * 忽略掉一些表：如租户表（sys_tenant）本身不需要执行这样的处理

      *

      * @param tableName

      * @return

      */

     @Override

     public boolean doTableFilter(String tableName) {

         return IGNORE_TENANT_TABLES.stream().anyMatch((e) -> e.equalsIgnoreCase(tableName));

     }

}

package com.xd.mybatisplusmultitenancy.config;

import com.baomidou.mybatisplus.core.parser.ISqlParser;

import com.baomidou.mybatisplus.extension.parsers.BlockAttackSqlParser;

import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;

import com.baomidou.mybatisplus.extension.plugins.PerformanceInterceptor;

import com.baomidou.mybatisplus.extension.plugins.tenant.TenantHandler;

import com.baomidou.mybatisplus.extension.plugins.tenant.TenantSqlParser;

import org.mybatis.spring.annotation.MapperScan;

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

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

import net.sf.jsqlparser.expression.Expression;

import net.sf.jsqlparser.expression.LongValue;

import java.util.ArrayList;

import java.util.List;

/**

  * @Classname MybatisPlusConfig

  * @Description TODO

  * @Author Created by Lihaodong (alias:小东啊) lihaodongmail@163测试数据

  * @Date 2019-08-09 22:44

  * @Version 1.0

  */

@Configuration

@MapperScan ( "com.xd.mybatisplusmultitenancy.mapper" )

public class MybatisPlusConfig {

     @Autowired

     private MyTenantHandler myTenantHandler;

     @Bean

     public PaginationInterceptor paginationInterceptor() {

         PaginationInterceptor paginationInterceptor = new PaginationInterceptor();

         // SQL解析处理拦截：增加租户处理回调。

         List<ISqlParser> sqlParserList = new ArrayList<>();

         // 攻击 SQL 阻断解析器、加入解析链

         sqlParserList.add( new BlockAttackSqlParser());

         // 多租户拦截

         TenantSqlParser tenantSqlParser = new TenantSqlParser();

         tenantSqlParser.setTenantHandler(myTenantHandler);

         sqlParserList.add(tenantSqlParser);

         paginationInterceptor.setSqlParserList(sqlParserList);

         return paginationInterceptor;

     }

     /**

      * 性能分析拦截器，不建议生产使用

      * 用来观察 SQL 执行情况及执行时长

      */

     @Bean (name = "performanceInterceptor" )

     public PerformanceInterceptor performanceInterceptor() {

         return new PerformanceInterceptor();

     }

}

package com.xd.mybatisplusmultitenancy.config;

import org.springframework.stereotype.Component;

import java.util.Map;

import java.util.concurrent.ConcurrentHashMap;

/**

  * @Classname ApiContext

  * @Description 当前系统的上下文

  * @Author Created by Lihaodong (alias:小东啊) lihaodongmail@163测试数据

  * @Date 2019-08-09 22:47

  * @Version 1.0

  */

@Component

public class MyContext {

     private static final String KEY_CURRENT_TENANT_ID = "KEY_CURRENT_PROVIDER_ID" ;

     private static final Map<String, Object> M_CONTEXT = new ConcurrentHashMap<>();

     public void setCurrentTenantId(Long tenantId) {

         M_CONTEXT.put(KEY_CURRENT_TENANT_ID, tenantId);

     }

     public Long getCurrentTenantId() {

         return (Long) M_CONTEXT.get(KEY_CURRENT_TENANT_ID);

     }

}

package com.xd.mybatisplusmultitenancy.test;

import com.baomidou.mybatisplus.core.toolkit.Wrappers;

import com.xd.mybatisplusmultitenancy.MybatisPlusMultiTenancyApplication;

import com.xd.mybatisplusmultitenancy.config.MyContext;

import com.xd.mybatisplusmultitenancy.entity.User;

import com.xd.mybatisplusmultitenancy.mapper.UserMapper;

import lombok.extern.slf4j.Slf4j;

import org.junit.Assert;

import org.junit.Before;

import org.junit.FixMethodOrder;

import org.junit.Test;

import org.junit.runner.RunWith;

import org.junit.runners.MethodSorters;

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

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

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

import java.sql.Wrapper;

/**

  * @Classname MybatisPlusMultiTenancyApplicationTests

  * @Description TODO

  * @Author Created by Lihaodong (alias:小东啊) lihaodongmail@163测试数据

  * @Date 2019-08-09 22:50

  * @Version 1.0

  */

@Slf4j

@RunWith (SpringRunner. class )

@FixMethodOrder (MethodSorters.JVM)

@SpringBootTest (classes = MybatisPlusMultiTenancyApplication. class )

public class MybatisPlusMultiTenancyApplicationTests {

     @Autowired

     private MyContext apiContext;

     @Autowired

     private UserMapper userMapper;

     /**

      * 模拟当前系统的多租户Id

      */

     @Before

     public void before() {

         // 在上下文中设置当前多租户id

         apiContext.setCurrentTenantId(1L);

     }

     @Test

     public void insert() {

         // 新增数据

         User user = new User().setName( "小明" );

         //判断一个条件是true还是false

         Assert.assertTrue(userMapper.insert(user) > 0 );

         user = userMapper.selectById(user.getId());

         log.info( "插入数据:{}" , user);

         // 判断是否相等

         Assert.assertEquals(apiContext.getCurrentTenantId(), user.getTenantId());

     }

     @Test

     public void selectList() {

         userMapper.selectList( null ).forEach((e) -> {

             log.info( "查询数据{}" , e);

             Assert.assertEquals(apiContext.getCurrentTenantId(), e.getTenantId());

         });

     }

}