MyBatis

此模块基于 MyBatis, 扩展了一些对数据库的常规操作，以简化开发。

集成

添加依赖

xml

<dependency>
    <groupId>com.wkclz.mybatis</groupId>
    <artifactId>shrimp-cloud-mybatis</artifactId>
    <version>${lastVersion}</version>
</dependency>

配置

参照 druid-spring-boot-3-starter 与 mybatis-spring-boot-starter 配置的官方配置即可

yaml

spring:
  datasource:
    url: jdbc:mysql://host:port/schema?useUnicode=true&characterEncoding=utf8&useSSL=false&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=Asia/Shanghai
    username: username
    password: password
    driverClassName: com.mysql.cj.jdbc.Driver

核心逻辑

BaseMapper

BaseMapper 定义了单表的基本操作 (需配合代码生成器)

方法名	描述	参数	返回值
count	统计	Entity e	Long
getById	用ID查找	@Param("id") Long id	Entity
getByEntity	用 Entity 查找	Entity e	Entity
list	查询列表，不包含Blobs	Entity e	List<Entity>
insert	(选择性)插入	Entity e	Long
insertBatch	全量批量插入	@Param("list") List<Entity> es	Integer
updateAll	更新(带乐观锁)	Entity e	Integer
updateSelective	选择性更新(带乐观锁)	Entity e	Integer
updateSelectiveWithoutLock	选择性更新(不带乐观锁)	Entity e	Integer
updateBatch	批量更新(不带乐观锁)	@Param("list") List<E> es	Integer
delete	删除	Entity e	Integer

BaseService

BaseService 对 Mapper 进一步封装。同时，Service 是完成业务逻辑的主要场所。

方法名	描述	参数	返回值
count	统计	Entity e	Long
get(Long id)	用ID查找	Long id	Entity
getWithCheck(Long id)	用ID查找, 若不存在则报错	Long id	Entity
get(Entity e)	用 Entity 查找	Entity e	Entity
getWithCheck(Entity e)	用 Entity 查找, 若不存在则报错	Entity e	Entity
list	查询列表，不包含Blobs	Entity e	List<Entity>
page	查询列分页，不包含Blobs	Entity e	PageData<Entity>
insert(Entity e)	(选择性)插入	Entity e	Long
insert(List<E> es)	全量批量插入	List<E> es	Integer
updateAll	更新(带乐观锁)	Entity e	Integer
updateSelective	选择性更新(带乐观锁)	Entity e	Integer
updateSelectiveWithoutLock	选择性更新(不带乐观锁)	Entity e	Integer
update(List<E> es)	批量更新(不带乐观锁)	List<E> es	Integer
saveWithCheck	保存，无id则新增，有id则修改，带乐观锁, 选择性更新	Entity e	Entity
deleteByEntitys	批量删除	List<Entity> es	Integer
delete(Long id)	删除	Long id	Integer
deleteWithCheck(Long id)	删除，若成功，返回删除前的对象	Long id	Entity
delete(List<Long> ids)	删除	List<Long> ids	Integer
delete(Entity e)	批量删除	Entity e	Integer

实体

实体名	用途
PageData	分页数据
DataSourceInfo	数据库基本信息
TableInfo	表信息
KeyInfo	表的索引信息
ColumnQuery	字段查询的参数
ColumnInfo	字段信息
DataTypeEnum	字段类型映射枚举

配置类

全辅助配置，略过

MyBatis 插件

执行SQL过程

Mybatis执行SQL的完整过程，参考：https://www.bbsmax.com/A/B0zqre03Jv/

组件

Executor：一个 SqlSession 对应一个 Executor 对象，这个对象负责增删改查的具体操作
ParameterHandler：mybatis 提供的参数处理器, 没有过多的类关联关系, 只有一个默认的实现类
StatementHandler：StatementHandler 是 mybatis 创建 Statement 的处理器, 会负责 Statement 的创建工作, 在 JDBC 中 Statement 执行 SQL 语句时主要分为两个主要对象。一个是平常大家都知道的 Statement 和 PrepareStatement, 都是在 java.sql 包下提供的对象
ResultSetHandler：同 ParameterHandler 一致, 都只有一个默认的实现类。ResultSetHandler 作用域只有一个, 那就是负责处理 Statement 返回的结果, 根据定义返回类型进行封装返回
参考：https://zhuanlan.zhihu.com/p/186261260

拦截参数处理

java

import org.apache.ibatis.executor.parameter.ParameterHandler;
import org.apache.ibatis.plugin.*;

import java.sql.PreparedStatement;
import java.util.Properties;

@Intercepts({@Signature(type = ParameterHandler.class, method = "setParameters", args = PreparedStatement.class)})
public class MybatisParameterInterceptor implements Interceptor {

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        // 拦截参数设置
        return invocation.proceed();
    }

    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }

    @Override
    public void setProperties(Properties properties) {
    }
}

拦截查询执行

java

import org.apache.ibatis.cache.CacheKey;
import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.plugin.*;
import org.apache.ibatis.session.ResultHandler;
import org.apache.ibatis.session.RowBounds;

import java.util.Properties;

@Intercepts({
    @Signature(type = Executor.class,method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}),
    @Signature(type = Executor.class,method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class, CacheKey.class, BoundSql.class})
})
public class MybatisQueryInterceptor implements Interceptor {

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        // 拦截查询执行
        return invocation.proceed();
    }

    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }

    @Override
    public void setProperties(Properties properties) {
    }
}

拦截入库执行

java

import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.plugin.*;

import java.util.Properties;

@Intercepts({@Signature(type = Executor.class, method = "update", args = {MappedStatement.class, Object.class})})
public class MybatisUpdateInterceptor implements Interceptor {

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        // 拦截入库执行
        return invocation.proceed();
    }

    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }

    @Override
    public void setProperties(Properties properties) {
    }
}

拦截结果处理

java

import org.apache.ibatis.executor.resultset.ResultSetHandler;
import org.apache.ibatis.plugin.*;

import java.sql.Statement;
import java.util.Properties;

@Intercepts({@Signature(type = ResultSetHandler.class, method = "handleResultSets", args = {Statement.class})})
public class MybatisResultSetInterceptor implements Interceptor {

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        // 拦截查询结果
        return invocation.proceed();
    }

    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }

    @Override
    public void setProperties(Properties properties) {
    }
}

插件清单

插件名	描述	状态
ParameterInterceptor	参数处理插件	不好用，未启用
ParameterizeInterceptor	xx	不好用，未启用
PrepareInterceptor	xx	不好用，未启用
QueryInterceptor	SQL 在执行前，进行拦截和处理	已启用(功能与 DaoAop 有重叠，需要考虑去留问题)
SqlInjInterceptor	SQL 注入风险检测	已启用
UpdateInterceptor	SQL 执行更新方法时的拦截器	已启用，注入创建人，更新人信息

MybatisUpdateInterceptor

功能说明：

拦截 DML 语句（在拦截器中全部会被当成query 处理）
搜索请求参数的直接对象，或 List 中的对象，若继承了 BaseModel, 将做下一步处理
修改动作过程，需要附加最后更新人，最后更新时间，确保 ID 存在，
新建时追回创建人，创建时间信息，排序。
删除时校验id 存在性
乐观锁校验：结合 service 使用。强制使用乐观锁场景将校验 version 字段
将校验异常结果转换为更友好的提示

拦截其他

指定 Signature 的类型，方法，和参数。即可完成拦截拦截器执行顺序参考：https://github.com/pagehelper/Mybatis-PageHelper/blob/master/wikis/zh/Interceptor.md

Rest 方法

请求方法	URI	描述
GET	/db/table/list	获取表清单
GET	/db/column/list	获取字段清单

注意: 此接口不能默认授权给所有用户，仅可授权给指定功能

辅助类

SqlHelper SQL 解析工具

方法	用途
getTables	获取数据库表
getColumnInfos	获取数据库字段
toMapList	SQL执行返回结果集转 LinkedHashMap

JdbcHelper JDBC SQL 执行工具

方法	用途
jdbcExecutor	Sql 执行工具
jdbcQueryExecutor	Sql 查询工具
jdbcUpdateExecutor	Sql 更新工具
sqlInj	Sql 注入风险检测工具

MyBatisHelper 基于 MyBatis 的 SQL 解析工具和执行工具

方法	用途
getParams	获取满足 MyBatis 语法的 SQL 的参数
getResults	获取满足 MyBatis 语法的 SQL 中的返回列举结果集
selectList	执行 List 查询
selectListToCamel	执行 List 查询, 返回值带驼峰转换
selectPage	执行 Page 查询
selectPageToCamel	执行 Page 查询, 返回值带驼峰转换
reloadSql	将 SQL 加载到 SqlSession 中去，并返回 statement
getXmlStr	辅助拼装满足 MyBatis 语法的 XML 语句

动态数据源

初始化数据源

java

@Component
public class DynamicDataSourceInit implements DynamicDataSourceFactory {

    @Autowired
    private GenDatasourceService genDatasourceService;

    @SneakyThrows
    @Override
    public DataSource createDataSource(String key) {
        // 获取数据源并参数 map 化
        return DruidDataSourceFactory.createDataSource(map);
    }
}

使用动态数据源

java

package com.example.demo;
@Service
public class DemoService {
    @Resource
    private DemoMapper demoMapper;

    public void demo() {
        // 标识需要使用的数据源
        DynamicDataSourceHolder.set("dbCode");
        // 执行查询，会自动使用上述指定的数据源进行查询，并在完成查询之后，AOP 会自动清除 数据源标识
        demoMapper.handleSelect(param);
        // 若非经过 Aop （直接调用低层 sqlSession 的过程）情况下，需要在 finally 中清除数据源标识
        DynamicDataSourceHolder.clear();
    }
}

辅助逻辑

DaoAop

当数据库操作是 Select 时，将所有参数进行过滤，去除参数前后的空内容，若去除后，无真实内容，将置为 null
若是多数据源，在完成 Dao 执行后，将清空线程变量，防止对后续的 sql 动作千万影响
对 OrderBy 参数进行检测，若存在注入风险，将拦截。同时，规范化 OrderBy 参数

查询参数的 "" 自动处理成 null, 可简化 mybatis xml 的 if 判断

拦截 Mapper 注解，在第一次进入此 AOP 时，获取所有 mappedStatement，并筛选出 DQL,DML 操作。为后续操作提供参照
对于 DQL 语句，确认参数是否继承了BaseModel，若有继承，截取参数进行分析
查询参数包含 "" 时，将其置为 null, 以简化 xml 动态语法的编写
order by 条件，需要使用 ${} 方式拼接，在此处校验注入风险。
对 order by 的内容做驼峰转换处理，增强对 order by 参数的兼容度
给 keyword 关键词加上前后百分号处理，方便使用过程直接 LIKE
对 dateRangeType 字段转换成确切的时间范围 timeFrom, timeTo 两个字段，方便在数据库中直接使用
乐观锁控制
更新人，更新时间，修改人，修改时间处理【需要 cas 将用户信息放到 ThreadLocal 中】

PageQuery

xml 只写 list 查询，java 中一句话完成分页查询

java

@Service
public class DemoService {

    @Autowired
    private DemoTypesMapper demoTypesMapper;

    public PageData selectPage(DemoTypes demoTypes){
        return PageQuery.page(demoTypes, demoTypesMapper::list);
    }

}

分页查询封装对象
入参：查询参数; List 查询接口
出参: 已经完成分页的对象
实现: 利用 PageHelper 完成分页查询，再转换查询结果
list 查询接口，只需要定义正常的 list 查询即可，无需关心分页相关参数
注意:
- 复杂分页场景，此分页工具可能不支持。同时自行写 sql 可能会有更好的性能体验。
- 简单单表的自动分页，sql 优化器可以自动帮忙优化，在外面包一层count 对性能影响非常小
- 在多表关联场景，关联条件，查询条件可能存在业务逻辑，优化器可能判断无法优化，从而影响查询性能。此时需要自行考虑优化 sql
- MyBatis-Plus 的自动分页，会对sql 语法树进行分析，移除一些从技术角度能移除的条件，再进行 count。此处夸一下 MyBatis-Plus。但仍然无法解决所有场景
- 若性能要求极致，可能还要考虑分页进行过程中扫描数据量的变化，以及不稳定排序等因素，故在某些场景，需要自定义分页
MyBatis-Plus 是个好工具，但此处还是没有引入

弃用原因：

加入 MyBatis-Plus 增加了好多包，包体积增大
MyBatis-Plus 的使用，仍然需要多行代码，达不到自己想要的极简（一行代码）
MyBatis-Plus 自行拦截了 MappedStatement, 在此基础上，又自行做了责任链来完成自身逻辑。对已有的拦截器逻辑可能造成影响【可解决】
MyBatis-Plus 的 Wrapper 封装，会脱离对象属性，导致自定义的 Interceptor 难以捕捉参数进行处理【可解决，难度指数极大】
MyBatis-Plus 使用了大量的自定义父类，使得自行扩展逻辑开发非常困难
自己已经开发出一套自动化 CRUD 的套件了。虽然支持场景没那么丰富，但使用极端简

什么时候再选用：

MyBatis-Plus 可以不用自己写一套CRUD套件。集成相当简单
MyBatis-Plus 维护者非常多，也有丰富的特性，如多数据源【自己的框架也搞了多数据源啊】
广大开发者掌握 MyBatis-Plus 的人非常多，存在即是合理

MyBatis ​

集成 ​

添加依赖 ​

配置 ​

核心逻辑 ​

BaseMapper ​

BaseService ​

实体 ​

配置类 ​

MyBatis 插件 ​

执行SQL过程 ​

组件 ​

拦截参数处理 ​

拦截查询执行 ​

拦截入库执行 ​

拦截结果处理 ​

插件清单 ​

MybatisUpdateInterceptor ​

拦截其他 ​

Rest 方法 ​

辅助类 ​

SqlHelper SQL 解析工具 ​

JdbcHelper JDBC SQL 执行工具 ​

MyBatisHelper 基于 MyBatis 的 SQL 解析工具和执行工具 ​

动态数据源 ​

辅助逻辑 ​

DaoAop ​

PageQuery ​

MyBatis

集成

添加依赖

配置

核心逻辑

BaseMapper

BaseService

实体

配置类

MyBatis 插件

执行SQL过程

组件

拦截参数处理

拦截查询执行

拦截入库执行

拦截结果处理

插件清单

MybatisUpdateInterceptor

拦截其他

Rest 方法

辅助类

SqlHelper SQL 解析工具

JdbcHelper JDBC SQL 执行工具

MyBatisHelper 基于 MyBatis 的 SQL 解析工具和执行工具

动态数据源

辅助逻辑

DaoAop

PageQuery