從零開始SpringCloud Alibaba實戰（46）——springboot mybaties日志配置

前言

前面寫了三篇文章來說明了mybaties日志的配置

mybatis 攔截器列印完整sql實作

日志實作原理

mybatis 列印日志原理

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(“查找使用者”)

從零開始SpringCloud Alibaba實戰（46）——springboot mybaties日志配置

前言

springboot對mapper切面,擷取mybatis執行的sql

此處攔截器換成注解

繼續閱讀

React-Native 之項目實戰（一）

0-1 千萬級直播項目實戰線上攔截器中使用ThreadLocal失效問題排查

【SSH項目實戰】國稅協同平台-6.POI導出使用者清單

微服務項目實戰微服務

iOS音視訊AVPlayer視訊播放

177-異步通知檢查資料 java項目實戰《盈利寶》S...

165-驗簽 java項目實戰《盈利寶》SpringB...

179-測試異步通知 java項目實戰《盈利寶》Spr...

169-建立service類 java項目實戰《盈利寶...

深度學習實作缺陷檢測算法彙總

廣告點選率預測(kaggle)

List清單中比較大小

最流行的接口測試體系，從入門到項目實戰

實時聊天APP（websocket+hybridAPP）

剛接手了一個cti項目，什麼是cti呢？

學生管理系統（控制台版本）

從零開始SpringCloud Alibaba實戰（46）——springboot mybaties日志配置

前言

springboot對mapper切面,擷取mybatis執行的sql

此處攔截器換成 注解

繼續閱讀

此處攔截器換成注解