Skip to content

zenpe/mybatis-sqlhelper

BranchesTags
 
 

Repository files navigation

MyBatis 多租户、逻辑删除、数据权限插件-SqlHelper

Maven central

如果您正在使用MyBatis，并且您的项目需要多租户、逻辑删除和数据权限、多数据源的功能建议您使用，这一定是最方便的方式，使用它对您的现有代码没有侵入，您不需要对现有代码进行任何修改。

    <dependency>
        <groupId>io.github.heykb</groupId>
        <artifactId>mybatis-sqlHelper</artifactId>
        <version>${project.version}</version>
    </dependency>

使用快照版本(及时bug修复版本)

<dependency>
    <groupId>io.github.heykb</groupId>
    <artifactId>mybatis-sqlHelper</artifactId>
    <version>3.0.0.SR1-SNAPSHOT</version>
</dependency>

<repositories>
        <repository>
            <id>sonatype-nexus-snapshots</id>
            <name>Sonatype Nexus Snapshots</name>
            <url>https://s01.oss.sonatype.org/content/repositories/snapshots/</url>
            <snapshots>
                <enabled>true</enabled>
            </snapshots>
            <releases>
                <enabled>false</enabled>
            </releases>
        </repository>
    </repositories>

特点

  • 可实现多租户
  • 可实现真实删除转逻辑删除
  • 可实现行级别和列级别权限控制（自动解析注入）
  • 简单方便开箱即用的多数据源管理和切换
  • 可插拔
  • 简单方便
  • 高效率（基于阿里 druid sql解析器）
  • 将多租户、逻辑删除与应用程序解耦，随配随用
  • 强大的字段自动注入能力（查询条件注入/插入语句注入/更新语句注入/查询列过滤），定制其他业务逻辑
  • 支持多种数据库（基于阿里 druid sql解析器）

spring 集成

  1. MyBatis SqlHelper Spring
  2. MyBatis SqlHelper Spring Boot

查看博客戳这里 👆

建议直接使用spring-boot版本MyBatis SqlHelper Spring Boot

在mybatis.xml中配置插件

<configuration>
  <plugins>
    <plugin interceptor="io.github.heykb.sqlhelper.interceptor.SqlHelperPlugin">
        <property...
    </plugin>
  </plugins>
 </configuration>

使用数据权限

数据权限专篇

使用多数据源

多数据源专篇

使用sql自动注入功能（多租户）

可用的属性

名称 类型 默认 描述 demo
enable boolean true 用于设置功能的总开关。 true
multi-tenant.enable boolean true 用于设置多租户功能开关。 true
logic-delete.enable boolean true 用于设置物理删除转逻辑删除功能开关。 true
dbType String(com.alibaba.druid.DbType) 用于设置数据库类型的参数名称，非特殊不用配置，支持自动获取 mysql
InjectColumnInfoHandler String(逗号分割的字符串数组) sql注入信息全限定类名数组。被用于反射生成注入信息对象 com.xx,io.xx
ColumnFilterInfoHandler String(逗号分割的字符串数组) 数据权限中的字段过滤信息全限定类名数组。被用于反射生成注入信息对象 com.xx,io.xx
DynamicFindInjectInfoHandler String 运行期间动态生成注入信息对象集合的全限定类名。 com.xx
DynamicFindColumnFilterHandler String 运行期间动态生成字段过滤信息对象集合的全限定类名。 com.xx

Mybatis-Sqlhelper使用自动注入

能帮你做什么？

1. 多种类型的sql动态注入能力

使用方式

首先创建注入信息类，然后在xml中使用InjectColumnInfoHandler属性配置

<plugins>
    <plugin interceptor="io.github.heykb.sqlhelper.interceptor.SqlHelperPlugin">
      <property name="InjectColumnInfoHandler"
                value="io.github.heykb.sqlhelper.primary.handlers.MyConditionInfoHandler"/>
    </plugin>
  </plugins>

CONDITION条件注入

  1. 单一条件注入， 创建类实现InjectColumnInfoHandler，如：
public class MyConditionInfoHandler implements InjectColumnInfoHandler {
    @Override
    public String getColumnName() {
        return "tenant_id";
    }
    @Override
    public String getValue() {
        return "sqlhelper";
    }
    @Override
    public String op() {
        return "=";
    }
    @Override
    public int getInjectTypes() {
        return CONDITION;
    }
    @Override
    public boolean checkCommandType(SqlCommandType commandType) {
        return true;
    }
    @Override
    public boolean checkTableName(String tableName) {
        return true;
    }

    @Override
    public boolean checkMapperId(String mapperId) {
        return true;
    }
}
查询语句中：
select * from user s
输出：
SELECT * FROM user s WHERE s.tenant_id = 'sqlhelper'
更新语句中：
update user set name = ? where id = ?
输出：
update user set name = ? where id = ? and user.tenant_id = 'sqlhelper'
删除语句中：
delete from user where id = ?
输出：
delete from user where id = ? and user.tenant_id = 'sqlhelper'
外连接语句中：
SELECT * FROM user u left JOIN card c ON u.id = c.user_id
输出：
SELECT *
FROM user u
	LEFT JOIN card c
	ON u.id = c.user_id
		AND c.tenant_id = sqlhelper
WHERE u.tenant_id = sqlhelper
各种子查询语句中：
SELECT * FROM (select * from user where id = 2) s
输出：
SELECT *
FROM (
	(SELECT *
	FROM user
	WHERE id = 2
		AND user.tenant_id = sqlhelper)
) s
  1. 多条件组合注入继承BinaryConditionInjectInfoHandler...

INSERT插入列注入

  1. 单一条件注入,实现InjectColumnInfoHandler，如：
public class MyInsertInfoHandler implements InjectColumnInfoHandler {
        
        @Override
        public String getColumnName() {
            return "tenant_id";
        }
        @Override
        public String getValue() {
            return "sqlhelper";
        }
    
        @Override
        public int getInjectTypes() {
            return INSERT;
        }
        @Override
        public boolean checkCommandType(SqlCommandType commandType) {
            return true;
        }
        @Override
        public boolean checkTableName(String tableName) {
            return true;
        }
};

输入：

INSERT INTO user (id, name)
VALUES ('0', 'heykb')

输出：

INSERT INTO user (id, name, tenant_id)
VALUES ('0', 'heykb', 'sqlhelper')

输入：

INSERT INTO user (id, name)
SELECT g.id, g.name
FROM user_group g
WHERE id = 1

输出：

INSERT INTO user (id, name, tenant_id)
SELECT g.id, g.name
FROM user_group g
WHERE id = 1

UPDATE更新列注入...

@Override
public int getInjectTypes() {
    return UPDATE;
}

多个

@Override
public int getInjectTypes() {
    return UPDATE|INSERT|...;
}

Mybatis-Sqlhelper使用字段隔离的多租户（数据源隔离级别参考sqlhelper多数据源配置）

能帮你做什么？

1. 自动为所有where 、join on添加租户过滤条件
2. 自动为insert语句添加租户列的插入
3. 多租户的实现也是利用sqlhelper的自动注入功能，相当于配置了CONDITIO与INSERT的两种注入

准备

使用方式

首先创建租户信息类，然后在xml中使用InjectColumnInfoHandler属性配置

<plugins>
    <plugin interceptor="io.github.heykb.sqlhelper.interceptor.SqlHelperPlugin">
      <property name="InjectColumnInfoHandler"
                value="io.github.heykb.sqlhelper.primary.handlers.SimpleTenantInfoHandler"/>
    </plugin>
  </plugins>

创建类继承TenantInfoHandler，如：

public class SimpleTenantInfoHandler extends TenantInfoHandler {

    /**
     * 设置代表租户字段名称
     * @return
     */
    @Override
    public String getTenantIdColumn() {
        return "tenant_id";
    }

    /**
     * 当前租户value获取方式。通常从线程上下文中获取用户租户信息
     * @return
     */
    @Override
    public String getTenantId() {
        // SecurityContextHolder.getContext().getAuthentication()
        return "sqlhelper";
    }

}

Mybatis-Sqlhelper使用物理删除切换逻辑删除

能帮你做什么？

1. 多种类型的sql动态注入能力

使用方式

首先创建逻辑删除信息类，然后在xml中使用InjectColumnInfoHandler属性配置

<plugins>
    <plugin interceptor="io.github.heykb.sqlhelper.interceptor.SqlHelperPlugin">
      <property name="InjectColumnInfoHandler"
                value="io.github.heykb.sqlhelper.primary.handlers.SimpleLogicDeleteInfoHandler"/>
    </plugin>
  </plugins>

创建类继承LogicDeleteInfoHandler

public class SimpleLogicDeleteInfoHandler extends LogicDeleteInfoHandler {
    @Override
    public String getDeleteSqlDemo() {
        return "UPDATE xx SET is_deleted = 'Y'";
    }

    @Override
    public String getNotDeletedValue() {
        return "'N'";
    }

    @Override
    public String getColumnName() {
        return "is_deleted";
    }

    @Override
    public boolean checkMapperId(String mapperId) {
        return !mapperId.contains("noPlugin");
    }
}

3.观察日志。

物理删除语句已经被自动转换成更新语句，并且保留了所有where条件

未完待续。。(如果你有兴趣，右上角watch该项目获得最新的动态)

参与贡献

如果你发现问题，提交issue。

如果你解决了问题，fork项目提交pull request。

联系我

QQ: 1259609102
email: 1259609102@qq.com,bigsheller08@gmail.com

About

MyBatis 多租户、逻辑删除、数据权限插件-SqlHelper

Resources

Readme
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Java 100.0%