好得很程序员自学网

<tfoot draggable='sEl'></tfoot>

MybatisPlus 多租户架构(Multi-tenancy)实现详解

在进行多租户架构 (multi-tenancy) 实现之前,先了解一下相关的定义吧:

什么是多租户

多租户技术或称多重租赁技术,简称 saas ,是一种软件架构技术,是实现如何在多用户环境下(此处的多用户一般是面向企业用户)共用相同的系统或程序组件,并且可确保各用户间数据的隔离性。

简单讲:在一台服务器上运行单个应用实例,它为多个租户(客户)提供服务。从定义中我们可以理解:多租户是一种架构,目的是为了让多用户环境下使用同一套程序,且保证用户间数据隔离。那么重点就很浅显易懂了,多租户的重点就是同一套程序下实现多用户数据的隔离。

数据隔离方案

多租户在数据存储上存在三种主要的方案,分别是:

独立数据库

即一个租户一个数据库,这种方案的用户数据隔离级别最高,安全性最好,但成本较高。

优点:为不同的租户提供独立的数据库,有助于简化数据模型的扩展设计,满足不同租户的独特需求;如果出现故障,恢复数据比较简单。 缺点:增多了数据库的安装数量,随之带来维护成本和购置成本的增加。

共享数据库,独立 schema

多个或所有租户共享database,但是每个租户一个schema(也可叫做一个user)。底层库比如是:db2、oracle等,一个数据库下可以有多个schema。

优点:为安全性要求较高的租户提供了一定程度的逻辑数据隔离,并不是完全隔离;每个数据库可支持更多的租户数量。 缺点:如果出现故障,数据恢复比较困难,因为恢复数据库将牵涉到其他租户的数据;

共享数据库,共享 schema,共享数据表

即租户共享同一个database、同一个schema,但在表中增加tenantid多租户的数据字段。这是共享程度最高、隔离级别最低的模式。

简单来讲,即每插入一条数据时都需要有一个客户的标识。这样才能在同一张表中区分出不同客户的数据,这也是我们系统目前用到的(provider_id)

优点:三种方案比较,第三种方案的维护和购置成本最低,允许每个数据库支持的租户数量最多。 缺点:隔离级别最低,安全性最低,需要在设计开发时加大对安全的开发量; 数据备份和恢复最困难,需要逐表逐条备份和还原。

<!--- more --->

利用mybatisplus实现

这里我们选用了第三种方案 (共享数据库,共享 schema,共享数据表) 来实现,也就意味着,每个数据表都需要有一个租户标识 (provider_id)

现在有数据库表 (user) 如下:

 

字段名 字段类型 描述
id bigint(20) 主键
provider_id bigint(20) 服务商id
name varchar(30) 姓名

 

将 provider_id 视为租户id,用来隔离租户与租户之间的数据,如果要查询当前服务商的用户,sql大致如下:

?

1

select * from user t where t.name like '%tom%' and t.provider_id = 1 ;

试想一下,除了一些系统共用的表以外,其他租户相关的表,我们都需要不厌其烦的加上 and t.provider_id = ? 查询条件,稍不注意就会导致数据越界,数据安全问题让人担忧。

好在有了mybatisplus这个神器,可以极为方便的实现 多租户sql解析器 ,官方文档如下:

这里终于进入了正题,开始搭建一个极为简单的开发环境吧!

新建springboot环境

pom文件如下,主要集成了mybatisplus以及h2数据库(方便测试)

?

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

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

<?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>

 

   <groupid>com.wuwenze</groupid>

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

   <version> 0.0 . 1 -snapshot</version>

   <packaging>jar</packaging>

 

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

   <description>demo project for spring boot</description>

 

   <parent>

     <groupid>org.springframework.boot</groupid>

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

     <version> 2.1 . 0 .release</version>

     <relativepath/> <!-- lookup parent from repository -->

   </parent>

 

   <properties>

     <project.build.sourceencoding>utf- 8 </project.build.sourceencoding>

     <project.reporting.outputencoding>utf- 8 </project.reporting.outputencoding>

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

   </properties>

 

   <dependencies>

     <dependency>

       <groupid>org.springframework.boot</groupid>

       <artifactid>spring-boot-starter</artifactid>

     </dependency>

     <dependency>

       <groupid>org.springframework.boot</groupid>

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

       <scope>test</scope>

     </dependency>

     <dependency>

       <groupid>org.projectlombok</groupid>

       <artifactid>lombok</artifactid>

       <scope>provided</scope>

     </dependency>

     <dependency>

       <groupid>com.google.guava</groupid>

       <artifactid>guava</artifactid>

       <version> 19.0 </version>

     </dependency>

 

     <dependency>

       <groupid>com.baomidou</groupid>

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

       <version> 3.0 . 5 </version>

     </dependency>

     <dependency>

       <groupid>com.baomidou</groupid>

       <artifactid>mybatis-plus</artifactid>

       <version> 3.0 . 5 </version>

     </dependency>

     <dependency>

       <groupid>com.baomidou</groupid>

       <artifactid>mybatis-plus-generator</artifactid>

       <version> 3.0 . 5 </version>

     </dependency>

 

     <dependency>

       <groupid>com.h2database</groupid>

       <artifactid>h2</artifactid>

     </dependency>

   </dependencies>

 

   <build>

     <plugins>

       <plugin>

         <groupid>org.springframework.boot</groupid>

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

       </plugin>

     </plugins>

   </build>

</project>

数据源配置(application.yml)

?

1

2

3

4

5

6

7

8

9

10

11

12

spring:

  datasource:

   driver- class -name: org.h2.driver

   schema: classpath:db/schema.sql

   data: classpath:db/data.sql

   url: jdbc:h2:mem:test

   username: root

   password: test

 

logging:

  level:

   com.wuwenze.mybatisplusmultitenancy: debug

对应的h2数据库初始化schema文件

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

#schema.sql

drop table if exists user;

create table user

(

   id bigint( 20 ) not null comment '主键' ,

   provider_id bigint( 20 ) not null comment '服务商id' ,

   name varchar( 30 ) null default null comment '姓名' ,

   primary key (id)

);

 

 

#data.sql

insert into user (id, provider_id, name) values ( 1 , 1 , 'tony老师' );

insert into user (id, provider_id, name) values ( 2 , 1 , 'william老师' );

insert into user (id, provider_id, name) values ( 3 , 2 , '路人甲' );

insert into user (id, provider_id, name) values ( 4 , 2 , '路人乙' );

insert into user (id, provider_id, name) values ( 5 , 2 , '路人丙' );

insert into user (id, provider_id, name) values ( 6 , 2 , '路人丁' );

mybatisplus config

基础环境搭建完成,现在开始配置mybatisplus多租户相关的实现。

1) 核心配置:tenantsqlparser

?

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

@configuration

@mapperscan ( "com.wuwenze.mybatisplusmultitenancy.mapper" )

public class mybatisplusconfig {

 

   private static final string system_tenant_id = "provider_id" ;

   private static final list<string> ignore_tenant_tables = lists.newarraylist( "provider" );

 

   @autowired

   private apicontext apicontext;

 

   @bean

   public paginationinterceptor paginationinterceptor() {

     paginationinterceptor paginationinterceptor = new paginationinterceptor();

 

     // sql解析处理拦截:增加租户处理回调。

     tenantsqlparser tenantsqlparser = new tenantsqlparser()

         .settenanthandler( new tenanthandler() {

 

           @override

           public expression gettenantid() {

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

             long currentproviderid = apicontext.getcurrentproviderid();

             if ( null == currentproviderid) {

               throw new runtimeexception( "#1129 getcurrentproviderid error." );

             }

             return new longvalue(currentproviderid);

           }

 

           @override

           public string gettenantidcolumn() {

             return system_tenant_id;

           }

 

           @override

           public boolean dotablefilter(string tablename) {

             // 忽略掉一些表:如租户表(provider)本身不需要执行这样的处理。

             return ignore_tenant_tables.stream().anymatch((e) -> e.equalsignorecase(tablename));

           }

         });

     paginationinterceptor.setsqlparserlist(lists.newarraylist(tenantsqlparser));

     return paginationinterceptor;

   }

 

   @bean (name = "performanceinterceptor" )

   public performanceinterceptor performanceinterceptor() {

     return new performanceinterceptor();

   }

}

2) apicontext

?

1

2

3

4

5

6

7

8

9

10

11

12

13

@component

public class apicontext {

   private static final string key_current_provider_id = "key_current_provider_id" ;

   private static final map<string, object> mcontext = maps.newconcurrentmap();

 

   public void setcurrentproviderid( long providerid) {

     mcontext.put(key_current_provider_id, providerid);

   }

 

   public long getcurrentproviderid() {

     return ( long ) mcontext.get(key_current_provider_id);

   }

}

3) entity、mapper

?

1

2

3

4

5

6

7

8

9

10

11

12

@data

@tostring

@accessors (chain = true )

public class user {

   private long id;

   private long providerid;

   private string name;

}

 

public interface usermapper extends basemapper<user> {

 

}

单元测试

com.wuwenze.mybatisplusmultitenancy.mybatisplusmultitenancyapplicationtests

?

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

@slf4j

@runwith (springrunner. class )

@fixmethodorder (methodsorters.jvm)

@springboottest (classes = mybatisplusmultitenancyapplication. class )

public class mybatisplusmultitenancyapplicationtests {

 

 

   @autowired

   private apicontext apicontext;

 

   @autowired

   private usermapper usermapper;

 

   @before

   public void before() {

     // 在上下文中设置当前服务商的id

     apicontext.setcurrentproviderid(1l);

   }

 

   @test

   public void insert() {

     user user = new user().setname( "新来的tom老师" );

     assert .asserttrue(usermapper.insert(user) > 0 );

 

     user = usermapper.selectbyid(user.getid());

     log.info( "#insert user={}" , user);

 

     // 检查插入的数据是否自动填充了租户id

     assert .assertequals(apicontext.getcurrentproviderid(), user.getproviderid());

   }

 

   @test

   public void selectlist() {

     usermapper.selectlist( null ).foreach((e) -> {

       log.info( "#selectlist, e={}" , e);

       // 验证查询的数据是否超出范围

       assert .assertequals(apicontext.getcurrentproviderid(), e.getproviderid());

     });

   }

}

运行结果

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

2018 - 11 - 29 21 : 07 : 14.262 info 18688 --- [      main] .mybatisplusmultitenancyapplicationtests : started mybatisplusmultitenancyapplicationtests in 2.629 seconds (jvm running for 3.904 )

2018 - 11 - 29 21 : 07 : 14.554 debug 18688 --- [      main] c.w.m.mapper.usermapper.insert      : ==> preparing: insert into user (id, name, provider_id) values (?, ?, 1 )

2018 - 11 - 29 21 : 07 : 14.577 debug 18688 --- [      main] c.w.m.mapper.usermapper.insert      : ==> parameters: 1068129257418178562 ( long ), 新来的tom老师(string)

2018 - 11 - 29 21 : 07 : 14.577 debug 18688 --- [      main] c.w.m.mapper.usermapper.insert      : <==  updates: 1

  time: 0 ms - id:com.wuwenze.mybatisplusmultitenancy.mapper.usermapper.insert

execute sql:insert into user (id, name, provider_id) values (?, ?, 1 ) { 1 : 1068129257418178562 , 2 : stringdecode( '\u65b0\u6765\u7684tom\u8001\u5e08' )}

 

2018 - 11 - 29 21 : 07 : 14.585 debug 18688 --- [      main] c.w.m.mapper.usermapper.selectbyid    : ==> preparing: select id, provider_id, name from user where user.provider_id = 1 and id = ?

2018 - 11 - 29 21 : 07 : 14.595 debug 18688 --- [      main] c.w.m.mapper.usermapper.selectbyid    : ==> parameters: 1068129257418178562 ( long )

2018 - 11 - 29 21 : 07 : 14.614 debug 18688 --- [      main] c.w.m.mapper.usermapper.selectbyid    : <==   total: 1

2018 - 11 - 29 21 : 07 : 14.615 info 18688 --- [      main] .mybatisplusmultitenancyapplicationtests : #insert user=user(id= 1068129257418178562 , providerid= 1 , name=新来的tom老师)

  time: 19 ms - id:com.wuwenze.mybatisplusmultitenancy.mapper.usermapper.selectbyid

execute sql:select id, provider_id, name from user where user.provider_id = 1 and id = ? { 1 : 1068129257418178562 }

 

2018 - 11 - 29 21 : 07 : 14.626 debug 18688 --- [      main] c.w.m.mapper.usermapper.selectlist    : ==> preparing: select id, provider_id, name from user where user.provider_id = 1

  time: 0 ms - id:com.wuwenze.mybatisplusmultitenancy.mapper.usermapper.selectlist

execute sql:select id, provider_id, name from user where user.provider_id = 1

 

2018 - 11 - 29 21 : 07 : 14.629 debug 18688 --- [      main] c.w.m.mapper.usermapper.selectlist    : ==> parameters:

2018 - 11 - 29 21 : 07 : 14.630 debug 18688 --- [      main] c.w.m.mapper.usermapper.selectlist    : <==   total: 3

2018 - 11 - 29 21 : 07 : 14.632 info 18688 --- [      main] .mybatisplusmultitenancyapplicationtests : #selectlist, e=user(id= 1 , providerid= 1 , name=tony老师)

2018 - 11 - 29 21 : 07 : 14.632 info 18688 --- [      main] .mybatisplusmultitenancyapplicationtests : #selectlist, e=user(id= 2 , providerid= 1 , name=william老师)

2018 - 11 - 29 21 : 07 : 14.632 info 18688 --- [      main] .mybatisplusmultitenancyapplicationtests : #selectlist, e=user(id= 1068129257418178562 , providerid= 1 , name=新来的tom老师)

从打印的日志不难看出,这个方案相当完美,仅需简单的配置,让开发者完全忽略了(provider_id)字段的存在,同时又最大程度的保证了数据的安全性,可谓是一举两得!

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。

原文链接:https://segmentfault测试数据/a/1190000017197768

查看更多关于MybatisPlus 多租户架构(Multi-tenancy)实现详解的详细内容...

  阅读:22次