mybatis拦截器打印sql且通过自定义注解获取sql开发人信息

「爱情、让人受尽委屈。」 2022-06-01 05:35 162阅读 0赞

![SouthEast][]

mybatis-config.xml:

*SqlInterceptor.java*

import java.text.DateFormat;
    import java.util.Date;
    import java.util.List;
    import java.util.Locale;
    import java.util.Properties;
    
    import org.apache.ibatis.executor.Executor;
    import org.apache.ibatis.mapping.BoundSql;
    import org.apache.ibatis.mapping.MappedStatement;
    import org.apache.ibatis.mapping.ParameterMapping;
    import org.apache.ibatis.plugin.Interceptor;
    import org.apache.ibatis.plugin.Intercepts;
    import org.apache.ibatis.plugin.Invocation;
    import org.apache.ibatis.plugin.Plugin;
    import org.apache.ibatis.plugin.Signature;
    import org.apache.ibatis.reflection.MetaObject;
    import org.apache.ibatis.session.Configuration;
    import org.apache.ibatis.session.ResultHandler;
    import org.apache.ibatis.session.RowBounds;
    import org.apache.ibatis.type.TypeHandlerRegistry;
    
    import com.ardo.common.utils.ArdoCusUtil;
    
    /**
    * mybatis打印sql 用于在后台打印执行的sql，在applicationContext.xml中的<bean
    * id="sqlSessionFactory" 标签中添加：<property name="configLocation"
    * value="classpath:mybatis-config.xml" /> 即可打印sql语句 此方法仅用于开发调试，配置之后请勿提交
    */
    
    @Intercepts( { @Signature(type = Executor.class, method = "update", args = { MappedStatement.class, Object.class }), @Signature(type = Executor.class, method = "query", args = { MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class }) })
    public class SqlInterceptor implements Interceptor {
    
    	private Properties properties;
    
    	public Object intercept(Invocation invocation) throws Throwable {
    		MappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0];
    		Object parameter = null;
    		if (invocation.getArgs().length > 1) {
    			parameter = invocation.getArgs()[1];
    		}
    		String sqlId = mappedStatement.getId();
    		BoundSql boundSql = mappedStatement.getBoundSql(parameter);
    		Configuration configuration = mappedStatement.getConfiguration();
    		Object returnValue = null;
    		returnValue = invocation.proceed();
    		String sql = getSql(configuration, boundSql, sqlId);
    		System.err.println(ArdoCusUtil.methodTools(sqlId)+"SQL打印====>>>>>>：" + sql);
    		return returnValue;
    	}
    
    	/**
    	* sql执行的具体位置与sql的拼接
    	* */
    	public static String getSql(Configuration configuration, BoundSql boundSql, String sqlId) {
    		String sql = showSql(configuration, boundSql);
    		StringBuilder str = new StringBuilder(600);
    		str.append(sqlId);
    		str.append(":");
    		str.append(sql);
    		return str.toString();
    	}
    
    	/**
    	* 拼接sql中的所有参数
    	* */
    	private static String getParameterValue(Object obj) {
    		String value = null;
    		if (obj instanceof String) {
    			value = "'" + obj.toString() + "'";
    		} else if (obj instanceof Date) {
    			DateFormat formatter = DateFormat.getDateTimeInstance(DateFormat.DEFAULT, DateFormat.DEFAULT, Locale.CHINA);
    			value = "'" + formatter.format(new Date()) + "'";
    		} else {
    			if (obj != null) {
    				value = obj.toString();
    			} else {
    				value = "";
    			}
    		}
    		return value;
    	}
    
    	/**
    	* 解析sql
    	* */
    	public static String showSql(Configuration configuration, BoundSql boundSql) {
    		Object parameterObject = boundSql.getParameterObject();
    		List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();
    		String sql = boundSql.getSql().replaceAll("[\\s]+", " ");
    		if (parameterMappings.size() > 0 && parameterObject != null) {
    			TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry();
    			if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {
    				sql = sql.replaceFirst("\\?", getParameterValue(parameterObject));
    
    	} else {
    		MetaObject metaObject = configuration.newMetaObject(parameterObject);
    		for (ParameterMapping parameterMapping : parameterMappings) {
    			String propertyName = parameterMapping.getProperty();
    			if (metaObject.hasGetter(propertyName)) {
    				Object obj = metaObject.getValue(propertyName);
    				sql = sql.replaceFirst("\\?", getParameterValue(obj));
    			} else if (boundSql.hasAdditionalParameter(propertyName)) {
    				Object obj = boundSql.getAdditionalParameter(propertyName);
    				sql = sql.replaceFirst("\\?", getParameterValue(obj));
    			}
    		}
    	}
    	}
    	return sql;
    	}
    
    	public Object plugin(Object target) {
    		return Plugin.wrap(target, this);
    	}
    
    	public void setProperties(Properties properties0) {
    		this.properties = properties0;
    	}
    }

注解配置的dao

@MethodInfo(author = "ardo", comments = "查询XX功能方法", date = "2017-01-11", revision = 1)
    	public List<Bean> findPara(@Param("id")String id,@Param("name")String name);

MethodInfo参考上篇文章【自定义注解】

[SouthEast]: /images/20220601/0cbf572c85784898ad725d26dcde2066.png