前言
前面写了三篇文章来说明了mybaties日志的配置
mybatis 拦截器打印完整sql实现
日志实现原理
mybatis 打印日志原理
mybaties日志追加到文件中
mybaties日志追加到文件中
不管是拦截器拦截实现sql打印展示到日志中，还是sql语句单独写到文件中，都有一个缺点，拦截器会拦截命名空间下所有的mapper打印日志，有好多sql语句对我们来说很没必要，但还是会打印出来，写到日志中也同理打印sql语句太多，很难找，有没有一种办法，让打印的sql语句可控呢？
springboot对mapper切面,获取mybatis执行的sql
输入接口地址,能查询出他调用了哪些sql,因此才有了本文章
采用切面方式,代码如下
ServiceAspect
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.session.SqlSessionFactory;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import javax.annotation.Resource;
import javax.servlet.http.HttpServletRequest;
import java.util.Objects;
/**
* @program: industry
* @description:
**/
@Aspect
@Component
@Slf4j
public class ServiceAspect {
/**
* Pointcut定义切点
* public修饰符的 返回值任意 com.cy.controller包下面的任意类的任意方法任意参数
*/
@Pointcut("execution(public * com.kx.core.dao..*(..))")
public void log(){
}
@Autowired
private SqlSessionFactory sqlSessionFactory;
// @Resource
// private SqlSessionFactoryBean sqlSessionFactoryBean;
@Before("log()")
public void doBefore(JoinPoint joinPoint){
// System.out.println("进入切面方法执行前...");
// ServletRequestAttributes sra = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
// if (!Objects.isNull(sra) && !Objects.isNull(sra.getRequest())){
// HttpServletRequest request = sra.getRequest();
// System.out.println("url: " + request.getRequestURI());
// System.out.println("method: "+request.getMethod()); //post or get? or ?
// System.out.println("class.method: " + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
// System.out.println("args: "+joinPoint.getArgs());
// }
//
// System.out.println("切面结束...");
//kx_parse_mapper id,url,mapperName,mapperMethod,controllerName,cMethod,cMethodNotes
//kx_parse_mapperxml id,xml_name,xml_method(对应标签id 要排除resultMap标签),p_xml_method(父标签id,此id指的是标签id属性),xml_content
}
@After("log()")
public void doAfter(JoinPoint joinPoint){
// System.out.println("进入切面方法执行后...");
//
// ServletRequestAttributes sra = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
// if (!Objects.isNull(sra) && !Objects.isNull(sra.getRequest())){
// HttpServletRequest request = sra.getRequest();
// System.out.println("url: " + request.getRequestURI());
// System.out.println("method: "+request.getMethod()); //post or get? or ?
// System.out.println("class.method: " + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
// System.out.println("args: "+joinPoint.getArgs());
// }
//
// System.out.println("切面结束...");
//kx_parse_mapper id,url,mapperName,mapperMethod,controllerName,cMethod,cMethodNotes
//kx_parse_mapperxml id,xml_name,xml_method(对应标签id 要排除resultMap标签),p_xml_method(父标签id,此id指的是标签id属性),xml_content
}
//环绕通知
@Around("log()")
public Object around(ProceedingJoinPoint pjp) throws Throwable{
System.out.println("++++++++++环绕通知开始+++++++++++");
//1.从redis中获取主数据库，若获取不到直接退出，否则判断当前数据源是会否为主，若不为主，则切换到主数据源
//2.调用目标方法
ServletRequestAttributes sra = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
if (!Objects.isNull(sra) && !Objects.isNull(sra.getRequest())){
HttpServletRequest request = sra.getRequest();
System.out.println("url: " + request.getRequestURI());
System.out.println("method: "+request.getMethod()); //post or get? or ?
System.out.println("class.method: " + pjp.getSignature().getDeclaringTypeName() + "." + pjp.getSignature().getName());
System.out.println("args: "+pjp.getArgs());
}
Object proceed = pjp.proceed();
//3.获取SQL
String sql = SqlUtils.getMybatisSql(pjp, sqlSessionFactory);
System.out.println("##################################################"+sql+"$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$");
System.out.println("++++++++++环绕通知结束+++++++++++");
return proceed;
}
}
SqlUtils.java
import com.sun.deploy.util.ArrayUtil;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.mapping.ParameterMapping;
import org.apache.ibatis.reflection.MetaObject;
import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.type.TypeHandlerRegistry;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.reflect.MethodSignature;
import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
import java.text.DateFormat;
import java.util.*;
public class SqlUtils {
/**
* 获取aop中的SQL语句
* @param pjp
* @param sqlSessionFactory
* @return
* @throws IllegalAccessException
*/
public static String getMybatisSql(ProceedingJoinPoint pjp, SqlSessionFactory sqlSessionFactory) throws IllegalAccessException {
Map<String,Object> map = new HashMap<>();
//1.获取namespace+methdoName
MethodSignature signature = (MethodSignature) pjp.getSignature();
Method method = signature.getMethod();
String namespace = method.getDeclaringClass().getName();
String methodName = method.getName();
//2.根据namespace+methdoName获取相对应的MappedStatement
Configuration configuration = sqlSessionFactory.getConfiguration();
MappedStatement mappedStatement = configuration.getMappedStatement(namespace+"."+methodName);
// //3.获取方法参数列表名
// Parameter[] parameters = method.getParameters();
//4.形参和实参的映射
Object[] objects = pjp.getArgs(); //获取实参
Annotation[][] parameterAnnotations = method.getParameterAnnotations();
for (int i = 0;i<parameterAnnotations.length;i++){
Object object = objects[i];
if (parameterAnnotations[i].length == 0){ //说明该参数没有注解，此时该参数可能是实体类，也可能是Map，也可能只是单参数
if (object.getClass().getClassLoader() == null && object instanceof Map){
map.putAll((Map<? extends String, ?>) object);
System.out.println("该对象为Map");
}else{//形参为自定义实体类
map.putAll(objectToMap(object));
System.out.println("该对象为用户自定义的对象");
}
}else{//说明该参数有注解，且必须为@Param
for (Annotation annotation : parameterAnnotations[i]){
if (annotation instanceof Param){
map.put(((Param) annotation).value(),object);
}
}
}
}
//5.获取boundSql
BoundSql boundSql = mappedStatement.getBoundSql(map);
return showSql(configuration,boundSql);
}
/**
* 解析BoundSql，生成不含占位符的SQL语句
* @param configuration
* @param boundSql
* @return
*/
private 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();
String[] s = metaObject.getObjectWrapper().getGetterNames();
s.toString();
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;
}
/**
* 若为字符串或者日期类型，则在参数两边添加''
* @param obj
* @return
*/
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;
}
/**
* 获取利用反射获取类里面的值和名称
*
* @param obj
* @return
* @throws IllegalAccessException
*/
private static Map<String, Object> objectToMap(Object obj) throws IllegalAccessException {
Map<String, Object> map = new HashMap<>();
Class<?> clazz = obj.getClass();
System.out.println(clazz);
for (Field field : clazz.getDeclaredFields()) {
field.setAccessible(true);
String fieldName = field.getName();
Object value = field.get(obj);
map.put(fieldName, value);
}
return map;
}
}
此处拦截器换成 注解
自定义日志注解 SysSqlLog
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface SysSqlLog{
/**
* 日志内容
* @return {String}
*/
String value();
}
日志切面修改
@Pointcut("@annotation(com.study.logging.annotation.SysSqlLog)")
public void logPointCut() {
}
在需要进行日志收集的方法上添加@SysLog注解
@SysSqlLog(“查找用户”)
8963
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
