Mybatis拦截器动态修改sql语句

自定义mybatis拦截器

import net.sf.jsqlparser.expression.Expression;
import net.sf.jsqlparser.parser.CCJsqlParserUtil;
import net.sf.jsqlparser.schema.Column;
import net.sf.jsqlparser.schema.Table;
import net.sf.jsqlparser.statement.Statement;
import net.sf.jsqlparser.statement.update.Update;
import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.Boundsql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.mapping.sqlCommandType;
import org.apache.ibatis.mapping.sqlSource;
import org.apache.ibatis.plugin.*;
import org.apache.ibatis.reflection.DefaultReflectorFactory;
import org.apache.ibatis.reflection.MetaObject;
import org.apache.ibatis.reflection.factory.DefaultObjectFactory;
import org.apache.ibatis.reflection.wrapper.DefaultObjectWrapperFactory;

import java.sql.sqlException;
import java.util.List;
import java.util.Properties;

/**
 * 自定义 Mybatis 插件，自动设置 createTime 和 updatTime 的值。
 * 拦截 update 操作（添加和修改）
 * 
 */
@Intercepts({ @Signature(type = Executor.class, method = "update", args = { MappedStatement.class, Object.class }) })
public class CustomInterceptor implements Interceptor {

    private static final String UPDATED_TIME_CAMELCASE = "updated_time";

    @Override
    public Object intercept(Invocation invocation) throws Throwable {

        String updatedColumnName = UPDATED_TIME_CAMELCASE;

        try {
            // 获取sql
            String sql = getsqlByInvocation(invocation);
            String sql2Reset = sql;

            //忽略sql中包含on conflict的情况
            if (!StringUtils.isBlank(sql2Reset) && !sql2Reset.toupperCase().contains("ON CONFLICT")) {
                try {
                    Statement statement = CCJsqlParserUtil.parse(sql);

                    if (statement instanceof Update) {
                        Update updateStatement = (Update) statement;
                        Table table = updateStatement.getTable();

                        if (table != null) {
                            List<Column> columns = updateStatement.getColumns();
                            List<Expression> expressions = updateStatement.getExpressions();
                            if (!isUpdatedTimeExists(columns, updatedColumnName)) {
                                columns.add(new Column(updatedColumnName));
                                expressions.add(CCJsqlParserUtil.parseExpression("Now()"));

                                updateStatement.setColumns(columns);
                                updateStatement.setExpressions(expressions);

                                sql2Reset = updateStatement.toString();
                            }
                        }

                    }
                } catch (Exception e) {
                    LogUtils.info("sql_parse error "+sql, e);
                }
            }

            // 包装sql后，重置到invocation中
            resetsql2Invocation(invocation, sql2Reset);

            // 返回，继续执行
            return invocation.proceed();
        } catch (Throwable e){
            LogUtils.error("sql_update_interceptor error", e);
            throw e;
        }
    }

    private boolean isUpdatedTimeExists(List<Column> columns, String updatedColumnName) {
        if (columns == null || columns.size() <= 0 ) {
            return false;
        }
        for (Column column : columns) {
            if(String.valueOf(column.getColumnName()).equalsIgnoreCase(updatedColumnName)) {
                return true;
            }
        }
        return false;
    }

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

    @Override
    public void setProperties(Properties properties) {
    }

    /**
     * 获取sql语句
     * @param invocation
     * @return
     */
    private String getsqlByInvocation(Invocation invocation) {
        final Object[] args = invocation.getArgs();
        MappedStatement ms = (MappedStatement) args[0];
        Object parameterObject = args[1];
        Boundsql boundsql = ms.getBoundsql(parameterObject);
        return boundsql.getsql();
    }

    /**
     * 包装sql后，重置到invocation中
     * @param invocation
     * @param sql
     * @throws sqlException
     */
    private void resetsql2Invocation(Invocation invocation, String sql) throws sqlException {
        final Object[] args = invocation.getArgs();
        MappedStatement statement = (MappedStatement) args[0];
        Object parameterObject = args[1];
        Boundsql boundsql = statement.getBoundsql(parameterObject);
        MappedStatement newStatement = newMappedStatement(statement, new BoundsqlsqlSource(boundsql));
        MetaObject msObject =  MetaObject.forObject(newStatement, new DefaultObjectFactory(), new DefaultObjectWrapperFactory(),new DefaultReflectorFactory());
        msObject.setValue("sqlSource.boundsql.sql", sql);
        args[0] = newStatement;
    }

    private MappedStatement newMappedStatement(MappedStatement ms, sqlSource newsqlSource) {
        MappedStatement.Builder builder =
                new MappedStatement.Builder(ms.getConfiguration(), ms.getId(), newsqlSource, ms.getsqlCommandType());
        builder.resource(ms.getResource());
        builder.fetchSize(ms.getFetchSize());
        builder.statementType(ms.getStatementType());
        builder.keyGenerator(ms.getKeyGenerator());
        if (ms.getKeyProperties() != null && ms.getKeyProperties().length != 0) {
            StringBuilder keyProperties = new StringBuilder();
            for (String keyProperty : ms.getKeyProperties()) {
                keyProperties.append(keyProperty).append(",");
            }
            keyProperties.delete(keyProperties.length() - 1, keyProperties.length());
            builder.keyProperty(keyProperties.toString());
        }
        builder.timeout(ms.getTimeout());
        builder.parameterMap(ms.getParameterMap());
        builder.resultMaps(ms.getResultMaps());
        builder.resultSetType(ms.getResultSetType());
        builder.cache(ms.getCache());
        builder.flushCacherequired(ms.isFlushCacherequired());
        builder.useCache(ms.isUseCache());

        return builder.build();
    }

    private String getoperateType(Invocation invocation) {
        final Object[] args = invocation.getArgs();
        MappedStatement ms = (MappedStatement) args[0];
        sqlCommandType commondType = ms.getsqlCommandType();
        if (commondType.compareto(sqlCommandType.SELECT) == 0) {
            return "select";
        }
        if (commondType.compareto(sqlCommandType.INSERT) == 0) {
            return "insert";
        }
        if (commondType.compareto(sqlCommandType.UPDATE) == 0) {
            return "update";
        }
        if (commondType.compareto(sqlCommandType.DELETE) == 0) {
            return "delete";
        }
        return null;
    }

    // 定义一个内部辅助类，作用是包装sql
    class BoundsqlsqlSource implements sqlSource {
        private Boundsql boundsql;
        public BoundsqlsqlSource(Boundsql boundsql) {
            this.boundsql = boundsql;
        }
        @Override
        public Boundsql getBoundsql(Object parameterObject) {
            return boundsql;
        }
    }
}

mybatis配置文件

    <plugins>
        <plugin interceptor="com.zhaopin.zhiq.mybatis.CustomInterceptor"/>
    </plugins>