首页 > 资讯 > 后端开发 > Python >基于MybatisPlus插件TenantLineInnerInterceptor实现多租户功能

222

分享到

基于MybatisPlus插件TenantLineInnerInterceptor实现多租户功能

2024-04-02 19:04:59 222人浏览薄情痞子

Python 官方文档：入门教程 => 点击学习

摘要

多租户技术的基本概念：多租户技术（英语：multi-tenancy technology）或称多重租赁技术，是一种软件架构技术，它是在探讨与实现如何于多用户的环境下共用相同的系统或

多租户技术的基本概念：

多租户技术（英语：multi-tenancy technology）或称多重租赁技术，是一种软件架构技术，它是在探讨与实现如何于多用户的环境下共用相同的系统或程序组件，并且仍可确保各用户间数据的隔离性。
在云计算的加持之下，多租户技术被广为运用于开发云各式服务，不论是IaaS，PaaS还是SaaS，都可以看到多租户技术的影子。
前面介绍过gitEgg框架与数据库交互使用了mybatis增强工具Mybatis-Plus，Mybatis-Plus提供了TenantLineInnerInterceptor租户处理器来实现多租户功能，其原理就是Mybatis-Plus实现了自定义Mybatis拦截器（Interceptor），在需要执行的sql后面自动添加租户的查询条件，实际和分页插件，数据权限拦截器是同样的实现方式。

简而言之多租户技术就是可以让一套系统通过配置给不同的客户提供服务，每个客户看到的数据都是属于自己的，就好像每个客户都拥有自己一套独立完善的系统。

下面是在GitEgg系统的应用配置：

1、在gitegg-platfORM-mybatis工程下新建多租户组件配置文件TenantProperties.java和TenantConfig.java，TenantProperties.java用于系统读取配置文件，这里会在Nacos配置中心设置多组户的具体配置信息，TenantConfig.java是插件需要读取的配置有三个配置项：
TenantId租户ID、TenantIdColumn多租户的字段名、ignoreTable不需要多租户隔离的表。
TenantProperties.java:


package com.gitegg.platform.mybatis.props;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;

import java.util.List;


@Data
@Configuration
@ConfigurationProperties(prefix = "tenant")
public class TenantProperties {

    
    private Boolean enable;

    
    private String column;

    
    private List<string> exclusionTable;

}

TenantConfig.java：


package com.gitegg.platform.mybatis.config;

import com.baomidou.mybatisplus.extension.plugins.handler.TenantLineHandler;
import com.baomidou.mybatisplus.extension.plugins.inner.TenantLineInnerInterceptor;
import com.gitegg.platform.boot.util.GitEggAuthUtils;
import com.gitegg.platform.mybatis.props.TenantProperties;
import lombok.RequiredArgsConstructor;
import net.sf.jsqlparser.expression.Expression;
import net.sf.jsqlparser.expression.NullValue;
import net.sf.jsqlparser.expression.StringValue;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.AutoConfigureBefore;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;



@Configuration
@RequiredArgsConstructor(onConstructor_ = @Autowired)
@AutoConfigureBefore(MybatisPlusConfig.class)
public class TenantConfig {

	private final TenantProperties tenantProperties;

	
	@Bean
	public TenantLineInnerInterceptor tenantLineInnerInterceptor() {
		return new TenantLineInnerInterceptor(new TenantLineHandler() {
			
			@Override
			public Expression getTenantId() {
				String tenant = GitEggAuthUtils.getTenantId();
				if (tenant != null) {
					return new StringValue(GitEggAuthUtils.getTenantId());
				}
				return new NullValue();
			}

			
			@Override
			public String getTenantIdColumn() {
				return tenantProperties.getColumn();
			}

			
			@Override
			public boolean ignoreTable(String tableName) {
				return tenantProperties.getExclusionTable().stream().anyMatch(
						(t) -> t.equalsIgnoreCase(tableName)
				);
			}
		});
	}
}

2、可在工程下新建application.yml，配置将来需要在Nacos上配置的信息：


tenant:
  # 是否开启租户模式
  enable: true
  # 需要排除的多租户的表
  exclusionTable:
    - "t_sys_district"
    - "oauth_client_details"
  # 租户字段名称
  column: tenant_id

3、修改MybatisPlusConfig.java，把多租户过滤器加载进来使其生效：


package com.gitegg.platform.mybatis.config;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.BlockAttackInnerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.OptimisticLockerInnerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.TenantLineInnerInterceptor;
import com.gitegg.platform.mybatis.props.TenantProperties;
import lombok.RequiredArgsConstructor;
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;

@Configuration
@RequiredArgsConstructor(onConstructor_ = @Autowired)
@MapperScan("com.gitegg.**.mapper.**")
public class MybatisPlusConfig {

    private final TenantLineInnerInterceptor tenantLineInnerInterceptor;

    private final TenantProperties tenantProperties;

    
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {

        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();

        //多租户插件
        if (tenantProperties.getEnable()) {
            interceptor.addInnerInterceptor(tenantLineInnerInterceptor);
        }

        //分页插件
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.Mysql));

        //防止全表更新与删除插件: BlockAttackInnerInterceptor
        BlockAttackInnerInterceptor blockAttackInnerInterceptor = new BlockAttackInnerInterceptor();
        interceptor.addInnerInterceptor(blockAttackInnerInterceptor);

        return interceptor;
    }

    
    @Bean
    public OptimisticLockerInnerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInnerInterceptor();
    }

}

4、在GitEggAuthUtils方法中新增获取租户信息的公共方法，租户信息在Gateway进行转发时进行设置，后面会说明如何讲租户信息设置到Header中:


package com.gitegg.platform.boot.util;

import cn.hutool.JSON.JSONUtil;
import com.gitegg.platform.base.constant.AuthConstant;
import com.gitegg.platform.base.domain.GitEggUser;
import org.springframework.util.StringUtils;

import javax.servlet.Http.httpservletRequest;
import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;

public class GitEggAuthUtils {

    
    public static GitEggUser getCurrentUser() {
        HttpServletRequest request = GitEggWEBUtils.getRequest();
        if (request == null) {
            return null;
        }
        try {
            String user = request.getHeader(AuthConstant.HEADER_USER);
            if (StringUtils.isEmpty(user))
            {
                return null;
            }
            String userStr = URLDecoder.decode(user,"UTF-8");
            GitEggUser gitEggUser = JSONUtil.toBean(userStr, GitEggUser.class);
            return gitEggUser;
        } catch (UnsupportedEncodingException e) {
            e.printStackTrace();
            return null;
        }

    }

    
    public static String getTenantId() {
        HttpServletRequest request = GitEggWebUtils.getRequest();
        if (request == null) {
            return null;
        }
        try {
            String tenantId = request.getHeader(AuthConstant.TENANT_ID);
            String user = request.getHeader(AuthConstant.HEADER_USER);
            //如果请求头中的tenantId为空，那么尝试是否能够从登陆用户中去获取租户id
            if (StringUtils.isEmpty(tenantId) && !StringUtils.isEmpty(user))
            {
                String userStr = URLDecoder.decode(user,"UTF-8");
                GitEggUser gitEggUser = JSONUtil.toBean(userStr, GitEggUser.class);
                if (null != gitEggUser)
                {
                    tenantId = gitEggUser.getTenantId();
                }
            }
            return tenantId;
        } catch (UnsupportedEncodingException e) {
            e.printStackTrace();
            return null;
        }

    }
}

5、GitEgg-Cloud工程中gitegg-gateway子工程的AuthGlobalFilter增加设置TenantId的过滤方法


  String tenantId = exchange.getRequest().getHeaders().getFirst(AuthConstant.TENANT_ID);

        String token = exchange.getRequest().getHeaders().getFirst(AuthConstant.Jwt_TOKEN_HEADER);

        if (StrUtil.isEmpty(tenantId) && StrUtil.isEmpty(token)) {
            return chain.filter(exchange);
        }

        Map<string, string=""> addHeaders = new HashMap<>();

        // 如果系统配置已开启租户模式，设置tenantId
        if (enable && StrUtil.isEmpty(tenantId)) {
            addHeaders.put(AuthConstant.TENANT_ID, tenantId);
        }

6、以上为后台的多租户功能集成步骤，在实际项目开发过程中，我们需要考虑到前端页面在租户信息上的配置，实现思路，不用的租户拥有不同的域名，前端页面根据当前域名获取到对应的租户信息，并在公共请求方法设置TenantId参数，保证每次请求能够携带租户信息。


// request interceptor
request.interceptors.request.use(config => {
  const token = storage.get(ACCESS_TOKEN)
  // 如果 token 存在
  // 让每个请求携带自定义 token 请根据实际情况自行修改
  if (token) {
    config.headers['Authorization'] = token
  }
  config.headers['TenantId'] = process.env.Vue_APP_TENANT_ID
  return config
}, errorHandler)

源码地址:

Gitee: https://gitee.com/wmz1930/GitEgg

GitHub: https://github.com/wmz1930/GitEgg

到此这篇关于基于MybatisPlus插件TenantLineInnerInterceptor实现多租户功能的文章就介绍到这了,更多相关MybatisPlus多租户插件内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网！

您可能感兴趣的文档:

--结束END--

本文标题: 基于MybatisPlus插件TenantLineInnerInterceptor实现多租户功能

本文链接: https://lsjlt.com/news/158408.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

回答

如何调试操作系统的错误？
操作系统

2023-11-15发布

回答

操作系统中的I/O系统是如何实现的？
操作系统

2023-11-15发布

回答

如何实现操作系统的内存管理？
操作系统

2023-11-15发布

回答

什么是虚拟内存，它对操作系统有什么影响？
操作系统

2023-11-15发布

回答

ASP中的MVC架构和WebForms架构有什么区别和使用场景？
ASP.NET

2023-11-15发布

回答

ASP中的数据验证和数据校验有什么不同？
ASP.NET

2023-11-15发布

回答

ASP中的ADO对象和DAO对象有什么区别和使用方法？
ASP.NET

2023-11-15发布

回答

Node.js中的包管理器NPM是什么？如何使用它进行依赖管理？
node.js

2023-11-15发布

回答

Vue.js中的动态组件是什么？如何使用它来动态渲染组件？
VUE

2023-11-15发布

回答

如何使用Vue.js实现懒加载和预加载？
VUE

2023-11-15发布

基于MybatisPlus插件TenantLineInnerInterceptor实现多租户功能

多租户技术的基本概念：

下面是在GitEgg系统的应用配置：

基于MybatisPlus插件TenantLineInnerInterceptor实现多租户功能

基于MybatisPlus插件TenantLineInnerInterceptor如何实现多租户功能

详解基于MybatisPlus两步实现多租户方案

基于flutter sound插件实现录音与播放功能

Redis基于Bitmap实现用户签到功能

基于Redis位图实现用户签到功能

C#基于Socket实现多人聊天功能

基于Spring实现文件上传功能

Oracle CDB管理实现多租户管理功能

Oracle CDB管理实现多租户管理功能

基于Mybatis-plus实现多租户架构的全过程

基于PHP实现邮件实时通知功能

如何MyBatis在使用MyCat实现多租户功能

基于UIControl控件实现ios点赞功能

基于Java实现Avro文件读写功能

Java基于BIO实现文件上传功能

Android基于OkHttp实现文件上传功能

基于vue如何实现tree插件

C#如何基于Socket实现多人聊天功能

基于Java实现收发电子邮件功能

python分析数据的方法是什么

如何使用Python实现抽奖小程序

python copy函数的作用是什么

python ffmpeg模块怎么安装和使用

python进程池创建队列的方法是什么

python无法运行文件的原因有哪些

python can't open file报错怎么解决

python keyerror错误怎么解决

python字符串处理与应用的方法有哪些

python全局变量如何定义