在進行多租戶架構(multi-tenancy)實現之前，先了解一下相關的定義吧：
什么是多租戶
多租戶技術或稱多重租賃技術，簡稱saas，是一種軟件架構技術，是實現如何在多用戶環(huán)境下（此處的多用戶一般是面向企業(yè)用戶）共用相同的系統(tǒng)或程序組件，并且可確保各用戶間數據的隔離性。
簡單講：在一臺服務器上運行單個應用實例，它為多個租戶（客戶）提供服務。從定義中我們可以理解：多租戶是一種架構，目的是為了讓多用戶環(huán)境下使用同一套程序，且保證用戶間數據隔離。那么重點就很淺顯易懂了，多租戶的重點就是同一套程序下實現多用戶數據的隔離。
數據隔離方案
多租戶在數據存儲上存在三種主要的方案，分別是：
獨立數據庫
即一個租戶一個數據庫，這種方案的用戶數據隔離級別最高，安全性最好，但成本較高。
- 優(yōu)點：為不同的租戶提供獨立的數據庫，有助于簡化數據模型的擴展設計，滿足不同租戶的獨特需求；如果出現故障，恢復數據比較簡單。
- 缺點：增多了數據庫的安裝數量，隨之帶來維護成本和購置成本的增加。
共享數據庫，獨立 schema
多個或所有租戶共享database，但是每個租戶一個schema（也可叫做一個user）。底層庫比如是：db2、oracle等，一個數據庫下可以有多個schema。
- 優(yōu)點：為安全性要求較高的租戶提供了一定程度的邏輯數據隔離，并不是完全隔離；每個數據庫可支持更多的租戶數量。
- 缺點：如果出現故障，數據恢復比較困難，因為恢復數據庫將牽涉到其他租戶的數據；
共享數據庫，共享 schema，共享數據表
即租戶共享同一個database、同一個schema，但在表中增加tenantid多租戶的數據字段。這是共享程度最高、隔離級別最低的模式。
簡單來講，即每插入一條數據時都需要有一個客戶的標識。這樣才能在同一張表中區(qū)分出不同客戶的數據，這也是我們系統(tǒng)目前用到的(provider_id)
- 優(yōu)點：三種方案比較，第三種方案的維護和購置成本最低，允許每個數據庫支持的租戶數量最多。
- 缺點：隔離級別最低，安全性最低，需要在設計開發(fā)時加大對安全的開發(fā)量； 數據備份和恢復最困難，需要逐表逐條備份和還原。
<!--- 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; |
試想一下，除了一些系統(tǒng)共用的表以外，其他租戶相關的表，我們都需要不厭其煩的加上and t.provider_id = ?查詢條件，稍不注意就會導致數據越界，數據安全問題讓人擔憂。
好在有了mybatisplus這個神器，可以極為方便的實現多租戶sql解析器，官方文檔如下：
這里終于進入了正題，開始搭建一個極為簡單的開發(fā)環(huán)境吧!
新建springboot環(huán)境
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://www.w3.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: testlogging: 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.sqldrop 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.sqlinsert 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
基礎環(huán)境搭建完成，現在開始配置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() { // 從當前系統(tǒng)上下文中取出當前請求的服務商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）本身不需要執(zhí)行這樣的處理。 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
|
@componentpublic 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.insertexecute 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: 12018-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.selectbyidexecute 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.selectlistexecute sql：select id, provider_id, name from user where user.provider_id = 12018-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: 32018-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老師) |
從打印的日志不難看出，這個方案相當完美，僅需簡單的配置，讓開發(fā)者完全忽略了(provider_id)字段的存在，同時又最大程度的保證了數據的安全性，可謂是一舉兩得！
以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持服務器之家。
原文鏈接：https://segmentfault.com/a/1190000017197768
