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

陶邦仁 发布于 2015/12/25 09:56

原文链接

系列目录

本文提供了一种自动生成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;  
    }  
}

© 著作权归作者所有

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,530评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 86,403评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,120评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,770评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,758评论 5 367
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,649评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,021评论 3 398
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,675评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,931评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,659评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,751评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,410评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,004评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,969评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,042评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,493评论 2 343

推荐阅读更多精彩内容