# dusty-boring-mybatis-sql-validater

**Repository Path**: hongfeieleven/dusty-boring-mybatis-sql-validater

## Basic Information

- **Project Name**: dusty-boring-mybatis-sql-validater
- **Description**: 基于Springboot+Druid+Mybatis的Sql质量检查插件
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://gitee.com/hongfeieleven/dusty-boring-mybatis-sql-validater
- **GVP Project**: No

## Statistics

- **Stars**: 68
- **Forks**: 12
- **Created**: 2019-04-24
- **Last Updated**: 2024-12-04

## Categories & Tags

**Categories**: database-dev

**Tags**: None

## README

# dusty-boring-mybatis-sql-validater

#### 介绍

dusty-boring-mybatis-sql-validater是基于SpringBoot + Druid + MyBatis封装的Sql语句质量检查插件。

#### 软件架构
基于SpringBoot + Druid + MyBatis极简依赖集成。
Druid Sql解析，应用Visitor模式对所需检查sql项进行质量检查;
基于MyBatis拦截器，实现语句拦截有效阻止非法sql执行；
本地封装多种缓存（Fifo Cache,LRU Cache），提升sql解析检查效率的同时，合理规划单点jvm存储；

#### 安装教程

1. 目前仅支持源码安装

#### 使用说明

1. 参考模块: `springboot-dusty-mybatis-validator-demo`

2. 配置示例：

 ```
 ——————————————————————————————————————————————————————————————————
 —————————————————————————— sql 检查配置 ——————————————————————————
 dusty:
   validator:
     sql:
       env-profiles:
         need-check-envs:   # 需要进行sql质量检查的环境（缺省值：dev/test/rc）,可根据自身情况修改或增减item
           - dev
           - test
           - rc
           
         ignore-check-envs: # 需要忽略sql质量检查的环境（缺省值：prod）, 生产环境建议关闭sql检查，以减小生产配置损耗
           - prod
 
         enable-white-list-cache-envs: # 启用白名单的环境列表（缺省值：dev/test/rc）, 存储已校验sql
           - dev
           - test
           - rc
 
         enable-black-list-cache-envs: # 启用黑名单的环境列表（缺省值：dev/test/rc）
           - dev
           - test
           - rc
 
       my-sql-valid-items:
         enable-where-check: true      # 是否开启where检查（缺省值：true 开启）
         enable-cond-like: true        # 是否开启like查询（缺省值：true 开启）
         enableLockTable: false        # 是否允许显式锁定table（缺省值：false 关闭）
         enable-ddl: false             # 是否允许执行ddl语句  （缺省值：false 关闭）
         enableDdlDrop: false          # 是否允许执行ddl-drop语句
         enable-cond-in: true          # 是否开启in条件（缺省值：true 开启）
         enable-cond-or: true          # 是否开启or条件（缺省值：true 开启）
         enable-cond-ne: true          # 是否开启not equal （缺省值：true 开启）
         must-use-index-check: true    # 是否检查查询条件必须使用索引（缺省值：true 开启）
         # ... 更多特性查看 {@link SqlValidatorProperties}
 
—————————————————————————— sql 检查配置 ——————————————————————————
——————————————————————————————————————————————————————————————————
```

#### 其他说明