Mybatis Plus数据权限插件
在MyBatis Plus(MBP)中实现SQL拦截器进行权限控制,可以遵循以下步骤:
1.定义权限模型:如同标准MyBatis,首先要定义权限模型,包括角色、权限、用户以及数据权限。这些概念可以映射到数据库表结构,如role、permission、user、user_role(用户与角色关联表)、data_scope(数据范围表)等。
2.创建自定义SQL拦截器:实现com.baomidou.mybatisplus.extension.plugins.InterceptorHandler接口(MBP 3.x版本)或com.baomidou.mybatisplus.core.interceptor.AbstractInterceptor(MBP 4.x及以上版本),并使用MBP提供的API来修改SQL。详细代码如下:
package com.baomidou.mybatisplus.extension.plugins.inner; import java.sql.Connection; import java.sql.SQLException; import java.util.List; import org.apache.ibatis.executor.Executor; import org.apache.ibatis.executor.statement.StatementHandler; import org.apache.ibatis.mapping.BoundSql; import org.apache.ibatis.mapping.MappedStatement; import org.apache.ibatis.mapping.SqlCommandType; import org.apache.ibatis.session.ResultHandler; import org.apache.ibatis.session.RowBounds; import com.baomidou.mybatisplus.core.plugins.InterceptorIgnoreHelper; import com.baomidou.mybatisplus.core.toolkit.CollectionUtils; import com.baomidou.mybatisplus.core.toolkit.PluginUtils; import com.baomidou.mybatisplus.extension.plugins.handler.DataPermissionHandler; import com.baomidou.mybatisplus.extension.plugins.handler.MultiDataPermissionHandler; import lombok.AllArgsConstructor; import lombok.Data; import lombok.EqualsAndHashCode; import lombok.NoArgsConstructor; import lombok.ToString; import net.sf.jsqlparser.expression.Expression; import net.sf.jsqlparser.schema.Table; import net.sf.jsqlparser.statement.delete.Delete; import net.sf.jsqlparser.statement.select.PlainSelect; import net.sf.jsqlparser.statement.select.Select; import net.sf.jsqlparser.statement.select.SetOperationList; import net.sf.jsqlparser.statement.select.WithItem; import net.sf.jsqlparser.statement.update.Update; /** * 数据权限处理器 * * @author hubin * @since 3.5.2 */ @Data @NoArgsConstructor @AllArgsConstructor @ToString(callSuper = true) @EqualsAndHashCode(callSuper = true) @SuppressWarnings({"rawtypes"}) public class DataPermissionInterceptor extends BaseMultiTableInnerInterceptor implements InnerInterceptor { private DataPermissionHandler dataPermissionHandler; @SuppressWarnings("RedundantThrows") @Override public void beforeQuery(Executor executor, MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) throws SQLException { if (InterceptorIgnoreHelper.willIgnoreDataPermission(ms.getId())) { return; } PluginUtils.MPBoundSql mpBs = PluginUtils.mpBoundSql(boundSql); mpBs.sql(parserSingle(mpBs.sql(), ms.getId())); } @Override public void beforePrepare(StatementHandler sh, Connection connection, Integer transactionTimeout) { PluginUtils.MPStatementHandler mpSh = PluginUtils.mpStatementHandler(sh); MappedStatement ms = mpSh.mappedStatement(); SqlCommandType sct = ms.getSqlCommandType(); if (sct == SqlCommandType.UPDATE || sct == SqlCommandType.DELETE) { if (InterceptorIgnoreHelper.willIgnoreDataPermission(ms.getId())) { return; } PluginUtils.MPBoundSql mpBs = mpSh.mPBoundSql(); mpBs.sql(parserMulti(mpBs.sql(), ms.getId())); } } @Override protected void processSelect(Select select, int index, String sql, Object obj) { if (dataPermissionHandler == null) { return; } if (dataPermissionHandler instanceof MultiDataPermissionHandler) { // 参照 com.baomidou.mybatisplus.extension.plugins.inner.TenantLineInnerInterceptor.processSelect 做的修改 final String whereSegment = (String) obj; processSelectBody(select, whereSegment); List<WithItem> withItemsList = select.getWithItemsList(); if (!CollectionUtils.isEmpty(withItemsList)) { withItemsList.forEach(withItem -> processSelectBody(withItem, whereSegment)); } } else { // 兼容原来的旧版 DataPermissionHandler 场景 if (select instanceof PlainSelect) { this.setWhere((PlainSelect) select, (String) obj); } else if (select instanceof SetOperationList) { SetOperationList setOperationList = (SetOperationList) select; List<Select> selectBodyList = setOperationList.getSelects(); selectBodyList.forEach(s -> this.setWhere((PlainSelect) s, (String) obj)); } } } /** * 设置 where 条件 * * @param plainSelect 查询对象 * @param whereSegment 查询条件片段 */ protected void setWhere(PlainSelect plainSelect, String whereSegment) { if (dataPermissionHandler == null) { return; } // 兼容旧版的数据权限处理 final Expression sqlSegment = dataPermissionHandler.getSqlSegment(plainSelect.getWhere(), whereSegment); if (null != sqlSegment) { plainSelect.setWhere(sqlSegment); } } /** * update 语句处理 */ @Override protected void processUpdate(Update update, int index, String sql, Object obj) { final Expression sqlSegment = getUpdateOrDeleteExpression(update.getTable(), update.getWhere(), (String) obj); if (null != sqlSegment) { update.setWhere(sqlSegment); } } /** * delete 语句处理 */ @Override protected void processDelete(Delete delete, int index, String sql, Object obj) { final Expression sqlSegment = getUpdateOrDeleteExpression(delete.getTable(), delete.getWhere(), (String) obj); if (null != sqlSegment) { delete.setWhere(sqlSegment); } } protected Expression getUpdateOrDeleteExpression(final Table table, final Expression where, final String whereSegment) { if (dataPermissionHandler == null) { return null; } if (dataPermissionHandler instanceof MultiDataPermissionHandler) { return andExpression(table, where, whereSegment); } else { // 兼容旧版的数据权限处理 return dataPermissionHandler.getSqlSegment(where, whereSegment); } } @Override public Expression buildTableExpression(final Table table, final Expression where, final String whereSegment) { if (dataPermissionHandler == null) { return null; } // 只有新版数据权限处理器才会执行到这里 final MultiDataPermissionHandler handler = (MultiDataPermissionHandler) dataPermissionHandler; return handler.getSqlSegment(table, where, whereSegment); } }
3.注册拦截器:
在Spring Boot环境中,通常在配置类中通过MybatisPlusInterceptor注册自定义的拦截器:
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor; import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor; import com.baomidou.mybatisplus.extension.plugins.inner.TenantLineInnerInterceptor; import com.example.DataScopeInterceptor; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration public class MyBatisPlusConfig { @Bean public MybatisPlusInterceptor mybatisPlusInterceptor() { MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor(); // 可能已经存在的其他内置拦截器 interceptor.addInnerInterceptor(new PaginationInnerInterceptor()); interceptor.addInnerInterceptor(new TenantLineInnerInterceptor()); // 添加自定义的权限控制拦截器 interceptor.addInnerInterceptor(new DataPermissionInterceptor()); return interceptor; } }
确保这个配置类被Spring Boot扫描到。如果使用XML配置方式,可以在mybatis-plus-config.xml中添加拦截器。
4. 实现权限服务:
如同标准MyBatis,需要一个权限服务(或使用现有框架提供的服务)来提供获取用户角色、权限、数据范围等信息的方法,供拦截器和其他业务逻辑使用。这通常包括用户登录验证、角色权限分配、数据权限管理等功能。
完成以上步骤后,重启应用,自定义的SQL拦截器应该生效,会在运行时根据用户的角色和数据权限动态修改SQL查询,实现数据访问的权限控制。记得结合实际业务需求调整数据权限模型、拦截器逻辑以及权限服务的设计与实现。如果使用的是MBP 4.x及以上版本,请参考对应版本的官方文档和API进行适配。
原文链接: https://www.yukx.com/spring/article/details/2510.html 优科学习网Mybatis Plus数据权限插件
-
项目中,有些函数需要处理某个服务的返回结果,而在对函数单元测试的时候,又不能启动那些服务,这里就可以利用Mockito工具,其中有如下三种注解:@InjectMocks:创建一个实例,简单的说是这个Mock可以调用真实代码的方法,其余用@Mock(或@Spy)注解创建的mock将被注入到用该实例中。
-
雪花算法(Snowflake)是由Twitter开发的一种分布式ID生成算法,旨在为分布式系统提供一种简单而有效的方式,以生成全局唯一、有序且可排序的64位整数ID。这种ID通常用作数据库记录的主键或其他需要唯一标识符的场景。雪花算法生成的64位ID结构如下:最高位(第64位):固定为0,因为64位
-
在HTML中,如果你想让一个输入框(input元素)不可编辑,你可以通过设置其readonly属性来实现。示例如下:input type="text" value="此处内容不可编辑" readonly在上述代码中,readonly属性使得用户无法修改输入框中的内容。另外,如果你希望输入框完全不可交
-
ASP.NET教程ASP.NET又称为ASP+,基于.NETFramework的Web开发平台,是微软公司推出的新一代脚本语言。ASP.NET是一个使用HTML、CSS、JavaScript和服务器脚本创建网页和网站的开发框架。ASP.NET支持三种不一样的开发模式:WebPages(Web页面)、
-
C# 判断判断结构要求程序员指定一个或多个要评估或测试的条件,以及条件为真时要执行的语句(必需的)和条件为假时要执行的语句(可选的)。下面是大多数编程语言中典型的判断结构的通常形式:判断语句C#提供了以下类型的判断语句。点击链接查看每个语句的细节。语句描述if语句一个 if语句 由一个布尔表达式后跟
-
C#循环有的时候,可能需要多次执行同一块代码。通常情况下,语句是顺序执行的:函数中的第一个语句先执行,接着是第二个语句,依此类推。编程语言提供了允许更为复杂的执行路径的多种控制结构。循环语句允许我们多次执行一个语句或语句组,下面是大多数编程语言中循环语句的通常形式:循环类型C#提供了以下几种循环类型