文档章节

【深入浅出MyBatis系列八】SQL自动生成插件

陶邦仁
 陶邦仁
发布于 2015/12/25 09:56
字数 1552
阅读 905
收藏 7
点赞 0
评论 1

#0 系列目录#

本文提供了一种自动生成sql语句的方法,它针对的对象是有主键或唯一索引的单表,提供的操作有增、删、改、查4种。理解本文和本文的提供的代码需要有java注解的知识,因为本文是基于注解生成sql的。

#1 准备# ##1.1 为什么在StatementHandler拦截## 在SQL执行流程分析(源码篇)章节介绍了一次sqlsession的完整执行过程,从中可以知道sql的解析是在StatementHandler里完成的,所以为了重写sql需要拦截StatementHandler。

##1.2 MetaObject简介## 在实现里大量使用了MetaObject这个对象,因此有必要先介绍下它。MetaObject是Mybatis提供的一个的工具类,通过它包装一个对象后可以获取或设置该对象的原本不可访问的属性(比如那些私有属性)。它有个三个重要方法经常用到:

MetaObject forObject(Object object,ObjectFactory objectFactory, ObjectWrapperFactory objectWrapperFactory) 用于包装对象;

Object getValue(String name) 用于获取属性的值(支持OGNL的方法);

void setValue(String name, Object value) 用于设置属性的值(支持OGNL的方法);

#2 拦截器签名#

@Intercepts({@Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class})})  
public class AutoMapperInterceptor implements Interceptor {  
    ...  
}  

从签名里可以看出,要拦截的目标类型是StatementHandler(注意:type只能配置成接口类型),拦截的方法是名称为prepare参数为Connection类型的方法。

#3 intercept实现#

@Intercepts({@Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class})})  
public class AutoMapperInterceptor implements Interceptor {  
    private static final Log logger = LogFactory.getLog(AutoMapperInterceptor.class);  
    private static final ObjectFactory DEFAULT_OBJECT_FACTORY = new DefaultObjectFactory();  
    private static final ObjectWrapperFactory DEFAULT_OBJECT_WRAPPER_FACTORY = new DefaultObjectWrapperFactory();  
  
    @Override  
    public Object intercept(Invocation invocation) throws Throwable {  
        StatementHandler statementHandler = (StatementHandler) invocation.getTarget();  
        MetaObject metaStatementHandler = MetaObject.forObject(statementHandler, DEFAULT_OBJECT_FACTORY,  
                DEFAULT_OBJECT_WRAPPER_FACTORY);  
        // 分离代理对象链  
        while (metaStatementHandler.hasGetter("h")) {  
            Object object = metaStatementHandler.getValue("h");  
            metaStatementHandler = MetaObject.forObject(object, DEFAULT_OBJECT_FACTORY, DEFAULT_OBJECT_WRAPPER_FACTORY);  
        }  
        // 分离最后一个代理对象的目标类  
        while (metaStatementHandler.hasGetter("target")) {  
            Object object = metaStatementHandler.getValue("target");  
            metaStatementHandler = MetaObject.forObject(object, DEFAULT_OBJECT_FACTORY, DEFAULT_OBJECT_WRAPPER_FACTORY);  
        }  
        String originalSql = (String) metaStatementHandler.getValue("delegate.boundSql.sql");  
        Configuration configuration = (Configuration) metaStatementHandler.getValue("delegate.configuration");  
        Object parameterObject = metaStatementHandler.getValue("delegate.boundSql.parameterObject");  
        if (null == originalSql || "".equals(originalSql)) {  
            String newSql = "";  
            MappedStatement mappedStatement = (MappedStatement) metaStatementHandler  
                    .getValue("delegate.mappedStatement");  
            // 根据ID生成相应类型的sql语句(id需剔除namespace信息)  
            String id = mappedStatement.getId();  
            id = id.substring(id.lastIndexOf(".") + 1);  
            if ("insert".equals(id)) {  
                newSql = SqlBuilder.buildInsertSql(parameterObject);  
            } else if ("update".equals(id)) {  
                newSql = SqlBuilder.buildUpdateSql(parameterObject);  
            } else if ("delete".equals(id)) {  
                newSql = SqlBuilder.buildDeleteSql(parameterObject);  
            } else if ("select".equals(id)) {  
                newSql = SqlBuilder.buildSelectSql(parameterObject);  
            }  
            logger.debug("Auto generated sql:" + newSql);  
            //  
            SqlSource sqlSource = buildSqlSource(configuration, newSql, parameterObject.getClass());  
            List<ParameterMapping> parameterMappings = sqlSource.getBoundSql(parameterObject).getParameterMappings();  
            metaStatementHandler.setValue("delegate.boundSql.sql", sqlSource.getBoundSql(parameterObject).getSql());  
            metaStatementHandler.setValue("delegate.boundSql.parameterMappings", parameterMappings);  
        }  
        // 调用原始statementHandler的prepare方法  
        statementHandler = (StatementHandler) metaStatementHandler.getOriginalObject();  
        statementHandler.prepare((Connection) invocation.getArgs()[0]);  
        // 传递给下一个拦截器处理  
        return invocation.proceed();  
    }  
  
    @Override  
    public Object plugin(Object target) {  
        if (target instanceof StatementHandler) {  
            return Plugin.wrap(target, this);  
        } else {  
            return target;  
        }  
    }  
  
    @Override  
    public void setProperties(Properties properties) {  
  
    }  
  
    private SqlSource buildSqlSource(Configuration configuration, String originalSql,   
    Class<?> parameterType) {  
        SqlSourceBuilder builder = new SqlSourceBuilder(configuration);  
        return builder.parse(originalSql, parameterType, null);  
    }  
}

StatementHandler的默认实现类是RoutingStatementHandler,因此拦截的实际对象是它。RoutingStatementHandler的主要功能是分发,它根据配置Statement类型创建真正执行数据库操作的StatementHandler,并将其保存到delegate属性里。由于delegate是一个私有属性并且没有提供访问它的方法,因此需要借助MetaObject的帮忙。通过MetaObject的封装后我们可以轻易的获得想要的属性。

在上面的方法里有个两个循环,通过他们可以分离出原始的RoutingStatementHandler(而不是代理对象)。

有了插件帮你生成sql语句后,mapper配置文件里单表的增删改查部分就不需要再配置sql代码了,但由于插件需要通过id来生成不同类型的sql语句,因此必要的配置还是需要的,而且相应的id必须是下面的这几个(区分大小写):

<update id="update" parameterType="UserDto"></update>  
<insert id="insert" parameterType="UserDto"></insert>  
<delete id="delete" parameterType="UserDto"></delete>  
<select id="select" parameterType="UserDto" resultType="UserDto""></select>

#3 SqlBuilder# SqlBuilder的相应方法接受一个dto对象作为参数,它们根据这个对象的属性值和配置的注解生成相应的sql。

@TableMapperAnnotation(tableName = "t_user", uniqueKeyType = UniqueKeyType.Single, uniqueKey = " userid ")  
public class UserDto {  
    @FieldMapperAnnotation(dbFieldName = "userid", jdbcType = JdbcType.INTEGER)  
    private Integer userid;  
    @FieldMapperAnnotation(dbFieldName = "username", jdbcType = JdbcType.VARCHAR)  
    private String username;  
    ...  
}

这个对象包含了两种注解,一个是TableMapperAnnotation注解,它保存了表名、唯一键类型和构成唯一键的字段;另一个是FieldMapperAnnotation注解,它保存了数据库字段名和字段类型信息。这两个注解都是必须的。SqlBuilder生成sql时会用到他们,下面以生成insert语句的方法为例,其他方法类似:

public static String buildInsertSql(Object object) throws Exception {  
    if (null == object) {  
        throw new RuntimeException("Sorry,I refuse to build sql for a null object!");  
    }  
    Map dtoFieldMap = PropertyUtils.describe(object);  
    // 从参数对象里提取注解信息  
    TableMapper tableMapper = buildTableMapper(object.getClass());  
    // 从表注解里获取表名等信息  
    TableMapperAnnotation tma = (TableMapperAnnotation) tableMapper.getTableMapperAnnotation();  
    String tableName = tma.tableName();  
    StringBuffer tableSql = new StringBuffer();  
    StringBuffer valueSql = new StringBuffer();  
  
    tableSql.append("insert into ").append(tableName).append("(");  
    valueSql.append("values(");  
  
    boolean allFieldNull = true;  
    // 根据字段注解和属性值联合生成sql语句  
    for (String dbFieldName : tableMapper.getFieldMapperCache().keySet()) {  
        FieldMapper fieldMapper = tableMapper.getFieldMapperCache().get(dbFieldName);  
        String fieldName = fieldMapper.getFieldName();  
        Object value = dtoFieldMap.get(fieldName);  
        // 由于要根据字段对象值是否为空来判断是否将字段加入到sql语句中,因此DTO对象的属性不能是简单类型,反而必须是封装类型  
        if (value == null) {  
            continue;  
        }  
        allFieldNull = false;  
        tableSql.append(dbFieldName).append(",");  
        valueSql.append("#{").append(fieldName).append(",").append("jdbcType=")  
                .append(fieldMapper.getJdbcType().toString()).append("},");  
    }  
    if (allFieldNull) {  
        throw new RuntimeException("Are you joking? Object " + object.getClass().getName()  
                + "'s all fields are null, how can i build sql for it?!");  
    }  
    tableSql.delete(tableSql.lastIndexOf(","), tableSql.lastIndexOf(",") + 1);  
    valueSql.delete(valueSql.lastIndexOf(","), valueSql.lastIndexOf(",") + 1);  
    return tableSql.append(") ").append(valueSql).append(")").toString();  
}

#4 plugin实现#

public Object plugin(Object target) {  
    // 当目标类是StatementHandler类型时,才包装目标类,否者直接返回目标本身,减少目标被代理的  
    // 次数  
    if (target instanceof StatementHandler) {  
        return Plugin.wrap(target, this);  
    } else {  
        return target;  
    }  
}

© 著作权归作者所有

共有 人打赏支持
陶邦仁
粉丝 1569
博文 420
码字总数 1483822
作品 0
海淀
技术主管
加载中

评论(1)

writeademo
writeademo
没看懂
深入浅出MyBatis_Index

深入浅出MyBatis系列 【深入浅出MyBatis系列一】MyBatis入门 【深入浅出MyBatis系列二】配置简介(MyBatis源码篇) 【深入浅出MyBatis系列三】Mapper映射文件配置 【深入浅出MyBatis系列四】...

陶邦仁
2015/12/22
932
0
【深入浅出MyBatis系列九】改造Cache插件

深入浅出MyBatis系列 【深入浅出MyBatis系列一】MyBatis入门 【深入浅出MyBatis系列二】配置简介(MyBatis源码篇) 【深入浅出MyBatis系列三】Mapper映射文件配置 【深入浅出MyBatis系列四】...

陶邦仁
2015/12/25
624
0
【深入浅出MyBatis系列七】分页插件

深入浅出MyBatis系列 【深入浅出MyBatis系列一】MyBatis入门 【深入浅出MyBatis系列二】配置简介(MyBatis源码篇) 【深入浅出MyBatis系列三】Mapper映射文件配置 【深入浅出MyBatis系列四】...

陶邦仁
2015/12/24
1K
1
【深入浅出MyBatis系列一】MyBatis入门

深入浅出MyBatis系列 【深入浅出MyBatis系列一】MyBatis入门 【深入浅出MyBatis系列二】配置简介(MyBatis源码篇) 【深入浅出MyBatis系列三】Mapper映射文件配置 【深入浅出MyBatis系列四】...

陶邦仁
2015/12/22
4.1K
0
【深入浅出MyBatis系列三】Mapper映射文件配置

深入浅出MyBatis系列 【深入浅出MyBatis系列一】MyBatis入门 【深入浅出MyBatis系列二】配置简介(MyBatis源码篇) 【深入浅出MyBatis系列三】Mapper映射文件配置 【深入浅出MyBatis系列四】...

陶邦仁
2015/12/22
2.2K
1
【深入浅出MyBatis系列四】强大的动态SQL

深入浅出MyBatis系列 【深入浅出MyBatis系列一】MyBatis入门 【深入浅出MyBatis系列二】配置简介(MyBatis源码篇) 【深入浅出MyBatis系列三】Mapper映射文件配置 【深入浅出MyBatis系列四】...

陶邦仁
2015/12/22
1K
0
深入浅出MyBatis-快速入门

深入浅出MyBatis-快速入门 深入浅出MyBatis-Configuration 深入浅出MyBatis-MapperBuilder 深入浅出MyBatis-Sqlsession 深入浅出Mybatis-插件原理 深入浅出Mybatis-分页 深入浅出Mybatis-sql...

perfectspr
2014/11/26
0
1
【深入浅出MyBatis系列六】插件原理

深入浅出MyBatis系列 【深入浅出MyBatis系列一】MyBatis入门 【深入浅出MyBatis系列二】配置简介(MyBatis源码篇) 【深入浅出MyBatis系列三】Mapper映射文件配置 【深入浅出MyBatis系列四】...

陶邦仁
2015/12/24
1K
1
【深入浅出MyBatis系列五】SQL执行流程分析(源码篇)

深入浅出MyBatis系列 【深入浅出MyBatis系列一】MyBatis入门 【深入浅出MyBatis系列二】配置简介(MyBatis源码篇) 【深入浅出MyBatis系列三】Mapper映射文件配置 【深入浅出MyBatis系列四】...

陶邦仁
2015/12/22
1K
0
【深入浅出MyBatis系列十】与Spring集成

深入浅出MyBatis系列 【深入浅出MyBatis系列一】MyBatis入门 【深入浅出MyBatis系列二】配置简介(MyBatis源码篇) 【深入浅出MyBatis系列三】Mapper映射文件配置 【深入浅出MyBatis系列四】...

陶邦仁
2015/12/25
1K
2

没有更多内容

加载失败,请刷新页面

加载更多

下一页

mysql导入导出包括函数或者存储过程

mysql导入导出包括函数或者存储过程 2012-11-16 10:12:20 0个评论 收藏 我要投稿 mysql导入导出包括函数或者存储过程 1.mysql导出整个数据库 mysqldump -h hostname -u username -p databas...

rootliu
6分钟前
0
0
Hyperledger Fabric 客户端开发一

前面介绍了hyperledger Fabric 安装, Chaincode的开发和运维, 现在来说说hyperledger fabric的客户端相关的开发。hyperledger 的客户端开发, 实际上指的是Chaincode的客户端开发。 同传统...

十一月不远
10分钟前
0
0
第18章 Linux集群架构

keepalived介绍 在这里使用keepalived来实现高可用集群,因为heartbeat在centos6上有一些问题,影响实验效果 heartbeat 切换的时候,会不是很及时——>比如:主 已经宕机了,但 从 却一直启动...

Linux学习笔记
11分钟前
0
0
awk常用的几条命令组合

前言 最近在生产上查问题,也是练就了一下awk的命令。 生产上的数据安全性要求比较高,一般要拿到测试环境都需要脱敏,但是脱敏的数据会有很多程序上的不适应。 所以有时候查询问题,查询一条...

码代码的小司机
11分钟前
0
0
python 多版本安装及切换

1.安装必要的扩展 # yum install zlib-devel bzip2-devel openssl-devel ncurses-devel sqlite-devel readline-devel tk-de 2.下载python3.7源码 # wget https://www.python.org/ftp/python......

青-争
12分钟前
0
0
看看8年阿里架构师怎样讲述Dubbo和Spring Cloud微服务架构

微服务架构是互联网很热门的话题,是互联网技术发展的必然结果。它提倡将单一应用程序划分成一组小的服务,服务之间互相协调、互相配合,为用户提供最终价值。虽然微服务架构没有公认的技术标...

Java大蜗牛
12分钟前
0
0
CDH的坑之Sqoop导出数据到MySQL

CDH的坑之Sqoop导出数据到MySQL 最近使用Sqoop从Hive导出数据到MySQL中,出现了一系列的问题,下面将这个问题记录一下,避免再度踩坑! 导出语句 sqoop export --connect jdbc:mysql://192....

星汉
15分钟前
0
0
PowerDesigner连接MySQL和逆向工程图

最近想梳理公司项目的表间关系,从项目后台管理系统的操作入手,以及代码的hibernate注解入手,都不算特别尽人意,于是最后还是鼓捣了一下PowerDesigner的逆向工程图,这样更直观一些。 想着...

Oo若离oO
16分钟前
0
0
威胁web应用安全的错误

一般绝大部分的web应用攻击都是没特定目标的大范围漏洞扫描,只有少数攻击确实是为入侵特定目标而进行的针对性尝试。这两种攻击都非常频繁,难以准确检测出来,许多网站的web应用防火墙都无法...

上树的熊
18分钟前
2
0
pypy2 install crypto error

install pycryptodome instead pip install pycryptodome

coord
22分钟前
0
0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部