如何使用 MyBatisPlus 輕松實現(xiàn)多租戶功能
來源：blog.csdn.net/weixin_38111957/article/details/101161660
一、引言
我先解釋一下什么叫多租戶，什么場景下使用多租戶。
多租戶是一種軟件架構(gòu)技術(shù)，在多用戶的環(huán)境下，共有同一套系統(tǒng)，并且要注意數(shù)據(jù)之間的隔離性。
舉個實際例子：小編曾經(jīng)開發(fā)過一套H5程序，這套程序應(yīng)用在不同醫(yī)院的APP上，當醫(yī)院患者下載醫(yī)院APP，并且進入相對應(yīng)的H5頁面，APP則會把用戶相關(guān)數(shù)據(jù)傳輸?shù)叫【庍@里。在傳輸?shù)臅r候需要帶上醫(yī)院標識（租戶ID），以便小編將數(shù)據(jù)進行隔離。
當不同的租戶使用同一套程序，這里就需要考慮一個數(shù)據(jù)隔離的情況。
數(shù)據(jù)隔離有三種方案：
獨立數(shù)據(jù)庫：簡單來說就是一個租戶使用一個數(shù)據(jù)庫，這種數(shù)據(jù)隔離級別最高，安全性最好，但是提高成本。 共享數(shù)據(jù)庫：隔離數(shù)據(jù)架構(gòu)：多租戶使用同一個數(shù)據(jù)褲，但是每個租戶對應(yīng)一個Schema(數(shù)據(jù)庫user)。 共享數(shù)據(jù)庫：共享數(shù)據(jù)架構(gòu)：使用同一個數(shù)據(jù)庫，同一個Schema，但是在表中增加了租戶ID的字段，這種共享數(shù)據(jù)程度最高，隔離級別最低。
二、具體實現(xiàn)
這里采用方案三，即共享數(shù)據(jù)庫，共享數(shù)據(jù)架構(gòu)，因為這種方案服務(wù)器成本最低，但是提高了開發(fā)成本。
所以MP就提供了一種多租戶的解決方案，實現(xiàn)方式是基于分頁插件進行實現(xiàn)的，具體實現(xiàn)代碼如下：
public class MyBatisPlusConfig {/*** 分頁插件** @return*/public PaginationInterceptor paginationInterceptor() {PaginationInterceptor paginationInterceptor = new PaginationInterceptor();// 創(chuàng)建SQL解析器集合List<ISqlParser> sqlParserList = new ArrayList<>();// 創(chuàng)建租戶SQL解析器TenantSqlParser tenantSqlParser = new TenantSqlParser();// 設(shè)置租戶處理器tenantSqlParser.setTenantHandler(new TenantHandler() {public Expression getTenantId() {// 設(shè)置當前租戶ID，實際情況你可以從cookie、或者緩存中拿都行return new StringValue("jiannan");}public String getTenantIdColumn() {// 對應(yīng)數(shù)據(jù)庫租戶ID的列名return "tenant_id";}public boolean doTableFilter(String tableName) {// 是否需要需要過濾某一張表/* List<String> tableNameList = Arrays.asList("sys_user");if (tableNameList.contains(tableName)){return true;}*/return false;}});sqlParserList.add(tenantSqlParser);paginationInterceptor.setSqlParserList(sqlParserList);return paginationInterceptor;}}
配置好之后，不管是查詢、新增、修改刪除方法，MP都會自動加上租戶ID的標識，測試如下：
@Testpublic void select(){List<User> users = userMapper.selectList(Wrappers.<User>lambdaQuery().eq(User::getAge, 18));users.forEach(System.out::println);}DEBUG==> Preparing: SELECT id, login_name, name, password, email, salt, sex, age, phone, user_type, status, organization_id, create_time, update_time, version, tenant_id FROM sys_user WHERE sys_user.tenant_id = 'jiannan' AND is_delete = '0' AND age = ?DEBUG==> Parameters: 18(Integer)DEBUG<== Total: 0
三、特定SQL過濾
如果在程序中，有部分SQL不需要加上租戶ID的表示，需要過濾特定的sql，可以通過如下兩種方式：
方式一：在配置分頁插件中加上配置ISqlParserFilter解析器，如果配置SQL很多，比較麻煩，不建議。
paginationInterceptor.setSqlParserFilter(new ISqlParserFilter() {public boolean doFilter(MetaObject metaObject) {MappedStatement ms = SqlParserHelper.getMappedStatement(metaObject);// 對應(yīng)Mapper、dao中的方法if("com.example.demo.mapper.UserMapper.selectList".equals(ms.getId())){return true;}return false;}});
方式二：通過租戶注解的形式，目前只能作用于Mapper的方法上。
/*** 用戶 Mapper 接口*/public interface UserMapper extends BaseMapper<User> {/*** 自定Wrapper修改** @param userWrapper 條件構(gòu)造器* @param user 修改的對象參數(shù)* @return*/@SqlParser(filter = true)int updateByMyWrapper(@Param(Constants.WRAPPER) Wrapper<User> userWrapper, @Param("user") User user);}# 開啟 SQL 解析緩存注解生效，如果你的MP版本在3.1.1及以上則不需要配置mybatis-plus:global-config:sql-parser-cache: true
現(xiàn)在各大廠內(nèi)卷的非常厲害，基于 2B 的 SaaS 系統(tǒng)正在蓬勃發(fā)展，多學(xué)一些這方面的經(jīng)驗，對職業(yè)發(fā)展多少有些幫助！
本文就講到這里，感謝大家閱讀！
推薦閱讀
IntelliJ IDEA 2022.2 正式發(fā)布：已完全支持 Spring 6 和 Spring Boot 3！ 不到 20 人的 IT 公司該去嗎？ 如何解決 Spring Cloud 下測試環(huán)境路由問題
你好，我是程序猿DD，10年開發(fā)老司機、阿里云MVP、騰訊云TVP、出過書創(chuàng)過業(yè)、國企4年互聯(lián)網(wǎng)6年。從普通開發(fā)到架構(gòu)師、再到合伙人。一路過來，給我最深的感受就是一定要不斷學(xué)習(xí)并關(guān)注前沿。只要你能堅持下來，多思考、少抱怨、勤動手，就很容易實現(xiàn)彎道超車！所以，不要問我現(xiàn)在干什么是否來得及。如果你看好一個事情，一定是堅持了才能看到希望，而不是看到希望才去堅持。相信我，只要堅持下來，你一定比現(xiàn)在更好！如果你還沒什么方向，可以先關(guān)注我，這里會經(jīng)常分享一些前沿資訊，幫你積累彎道超車的資本。