2. 程式人生 > >springboot搭建專案之日誌AOP，支援日誌內容可配置控制（黑名單欄位不會列印或其他處理方式）

springboot搭建專案之日誌AOP，支援日誌內容可配置控制（黑名單欄位不會列印或其他處理方式）

阿新 • • 發佈：2019-01-04

一、問題描述及試用場景

在專案除錯或生產環境追查問題時，日誌檔案是我們最常用的方式。為了滿足日誌規範和方便日誌追查，一般會寫個日誌攔截AOP切面注入相關方法，列印入參，出參。但有個頭疼問題，某些引數裡包含一些敏感欄位，給予資料安全一般不允許列印，比如：使用者密碼，銀行卡卡號，手機號等等。下面就是這個問題的基本解決方案和思路。

二、解決方案思路：

在AOP增強方法中，加入黑名單概念，既如果切入點方法引數含有黑名單中的欄位名稱，則另行處理。

1.通過java反射獲取方法引數的欄位名稱及內容；

2.通過配置檔案配置黑名單資料

3.,對於類似於 foo(String name,String pwd)這類無實體引數方法需要通過jdk1.8 Parameter來實現獲取形參名。遺憾的是java8預設編譯不記錄形參，需要配置javac -parameters開啟此功能；

IDEA配置位置：settings->Build,Excution,Deployment->Compiler->Java Compiler中的javac Options裡的Additional command line parameters.


三、樣例原始碼：

package org.egg.aop;
import org.apache.commons.lang3.ArrayUtils;
import org.apache.commons.lang3.StringUtils;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;

 
import org.aspectj.lang.annotation.*;
import org.egg.utils.HideDataUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Configuration;
import org.springframework.util.CollectionUtils;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

 
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
/**
 * @author dataochen
 * @Description 高級別（取敏感資料logAop）
 * 支援實體巢狀實體，支援實體包含list,map，支援無實體多引數方法
 * 不支援含有過載方法的類
 * 如果含有過載的方法（isOverWirte=true），不支援入參的引數為空，因為入參引數為空，導致拿不到為空引數的引數型別，從而找不到對應的方法
 *
 * @date: 2017/11/7 18:42
 */
@Aspect
@Configuration
public class SuperLoggerAop {
    private static final Logger LOGGER = LoggerFactory.getLogger(SuperLoggerAop.class);
/**
     * [大小寫不敏感]日誌攔截欄位名黑名單 不列印
     */
private final String[] blackArray = {"password"};
/**
     * ##[大小寫不敏感]日誌攔截卡號級別欄位 前6後四
     */
private final String[] cardNoArray = {"cardNo", "cardNum"};
/**
     * [大小寫不敏感]日誌攔截手機號級別欄位 前三後4
     */
private final String[] phoneNumArray = {"phonenum", "phoneno", "tel"};
/**
     * 是否顯示null欄位
     */
private final Boolean isDisplayNull = true;
/**
     * 查詢方法是否含有過載方法
     */
private final Boolean isOverWirte = false;
//匹配org.egg.controller包及其子包下的所有類的所有方法
@Pointcut("execution(* org.egg.controller..*.*(..)) || execution(* org.egg.service..*.*(..))")
    public void executeService() {
    }

    /**
     * 前置通知，方法呼叫前被呼叫
     *
     * @param joinPoint
*/
@Before("executeService()")
    public void doBeforeAdvice(JoinPoint joinPoint) throws IllegalAccessException {
        StringBuilder stringBuilder = new StringBuilder("Integration Method:[");
stringBuilder.append(joinPoint.getSignature().getDeclaringTypeName()).append(".");
stringBuilder.append(joinPoint.getSignature().getName());
stringBuilder.append("],Parameters:");
Method declaredMethod = null;
        if (isOverWirte) {
            declaredMethod = getDeclaredMethod(joinPoint);
} else {
            declaredMethod = getDeclaredMethodForName(joinPoint);
}
        if (declaredMethod != null) {
//        引數值
Object[] args = joinPoint.getArgs();
Parameter[] parameters = declaredMethod.getParameters();
            if (parameters != null) {
                stringBuilder.append("[");
                for (int i = 0; i < parameters.length; i++) {
                    String s = convertLog(stringBuilder, parameters[i], args[i], false, parameters[i].getName());
                    if (StringUtils.isNotBlank(s)) {
                        stringBuilder.append(",");
}
                }
                stringBuilder.replace(stringBuilder.length() - 1, stringBuilder.length(), "]");
}
        }
        LOGGER.info(stringBuilder.toString());
}

    @AfterReturning(value = "executeService()", returning = "returnValue")
    public void doAfterAdvice(JoinPoint joinPoint, Object returnValue) throws IllegalAccessException {
        StringBuilder stringBuilder = new StringBuilder("Integration result:[");
stringBuilder.append(joinPoint.getSignature().getDeclaringTypeName()).append(".");
stringBuilder.append(joinPoint.getSignature().getName());
stringBuilder.append("],Parameters:");
convertLog(stringBuilder, null, returnValue, true, "result");
LOGGER.info(stringBuilder.toString());
System.out.println("後置通知執行了!!!!");
}

    @Around("executeService()")
    public Object doAroundAdvice(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        long time = System.currentTimeMillis();
Object retVal = proceedingJoinPoint.proceed();
time = System.currentTimeMillis() - time;
StringBuilder stringBuilder = new StringBuilder("Integration performance Method:[");
stringBuilder.append(proceedingJoinPoint.getSignature().getDeclaringTypeName()).append(".");
stringBuilder.append(proceedingJoinPoint.getSignature().getName());
stringBuilder.append("],Time: ").append(time).append(" ms");
        return retVal;
}

    private String convertLog(StringBuilder stringBuilder, Parameter parameter, Object arg, Boolean isCustomClass, String fileName) {
        if (parameter != null) {
            if (arg == null || parameter.getType().equals(HttpServletRequest.class)
                    || parameter.getType().equals(HttpServletResponse.class)) {
                return "";
}
        } else {
            if (arg == null || arg instanceof HttpServletRequest
                    || arg instanceof HttpServletResponse) {
                return "";
}
        }
//                判斷是否是基礎類
//        parameter.getClass().getClassLoader()不好使
if (arg.getClass().getClassLoader() != null) {
            if (!isCustomClass) {
                stringBuilder.append(parameter.getName()).append(":[");
} else {
                stringBuilder.append("[");
}
//            父類
ArrayList<Field> fields = new ArrayList<Field>();
getFields(fields, arg);
            for (Field declaredField : fields) {
                declaredField.setAccessible(true);
Object target = null;
                try {
                    target = declaredField.get(arg);
} catch (IllegalAccessException e) {
                    e.printStackTrace();
                    return "";
}
                String targetStr = "";
                if (isDisplayNull && target == null) {
                    continue;
}
                if (target != null) {
                    if (target.getClass().getClassLoader() != null) {
                        targetStr = convertLog(new StringBuilder(), null, target, true, declaredField.getName());
} else {// list map
StringBuilder stringBuilder1 = new StringBuilder();
                        if (target instanceof List) {
                            List argList = (List) target;
stringBuilder1.append("[");
argList.forEach(argItem -> {
                                String s = convertLog(new StringBuilder(), null, argItem, true, "");
stringBuilder1.append(s);
stringBuilder1.append(",");
});
                            if (CollectionUtils.isEmpty(argList)) {
                                stringBuilder1.append("]");
} else {
                            stringBuilder1.replace(stringBuilder1.length() - 1, stringBuilder1.length(), "]");
}
                            targetStr=stringBuilder1.toString();
} else if (target instanceof Map) {
                            Map<Object, Object> argMap = (Map) target;
stringBuilder1.append("[");
argMap.entrySet().forEach(Item -> {
                                String s = convertLog(new StringBuilder(), null, Item.getValue(), true, Item.getKey().toString());
stringBuilder1.append(s);
stringBuilder1.append(",");
});
                            if (CollectionUtils.isEmpty(argMap)) {
                                stringBuilder1.append("]");
} else {
                                stringBuilder1.replace(stringBuilder1.length() - 1, stringBuilder1.length(), "]");
}
                            targetStr=stringBuilder1.toString();
} else {
                            targetStr = target.toString();
}
                    }
                } else {
                    targetStr = "null";
}
                invokeRule(stringBuilder, declaredField.getName(), targetStr);
stringBuilder.append(",");
}


            stringBuilder.replace(stringBuilder.length() - 1, stringBuilder.length(), "]");
} else {
//                    基礎類
if (arg instanceof List) {
                List argList = (List) arg;
stringBuilder.append("[");
argList.forEach(argItem -> {
                    String s = convertLog(new StringBuilder(), null, argItem, true, "");
stringBuilder.append(s);
stringBuilder.append(",");
});
                if (CollectionUtils.isEmpty(argList)) {
                    stringBuilder.append("]");
} else {
                    stringBuilder.replace(stringBuilder.length() - 1, stringBuilder.length(), "]");
}
            } else if (arg instanceof Map) {
                Map<Object, Object> argMap = (Map) arg;
stringBuilder.append("[");
argMap.entrySet().forEach(Item -> {
                    String s = convertLog(new StringBuilder(), null, Item.getValue(), true, Item.getKey().toString());
stringBuilder.append(s);
stringBuilder.append(",");
});
                if (CollectionUtils.isEmpty(argMap)) {
                    stringBuilder.append("]");
} else {
                    stringBuilder.replace(stringBuilder.length() - 1, stringBuilder.length(), "]");
}
            } else {
                invokeRule(stringBuilder, fileName, arg);
}
        }
        return stringBuilder.toString();
}

    /**
     * 獲取增強方法
     *
     * @param joinPoint
* @return
*/
private Method getDeclaredMethod(JoinPoint joinPoint) {
        ArrayList<Class> classes = new ArrayList<>();
        if (joinPoint.getArgs() != null) {
            for (Object o : joinPoint.getArgs()) {
                if (o instanceof HttpServletRequest) {
                    classes.add(HttpServletRequest.class);
} else if (o instanceof HttpServletResponse) {
                    classes.add(HttpServletResponse.class);
} else if (o instanceof List) {
                    classes.add(List.class);
} else if (o instanceof Map) {
                    classes.add(Map.class);
} else {
                    // FIXME: 2017/11/29  請求中的引數a如果為空，就無法獲取a的類名了，導致全不能用了
classes.add(o.getClass());
}
            }
        }

        try {
            Method declaredMethod = joinPoint.getTarget().getClass().getDeclaredMethod(joinPoint.getSignature().getName(), classes.toArray(new Class[classes.size()]));
            return declaredMethod;
} catch (NoSuchMethodException e) {
            e.printStackTrace();
            return null;
}
    }

    /**
     * 獲取增強方法
     * 不用引數
     *
     * @param joinPoint
* @return
*/
private Method getDeclaredMethodForName(JoinPoint joinPoint) {
        try {
            Method[] methods = joinPoint.getTarget().getClass().getMethods();
Method declaredMethod = null;
            if (methods != null) {
                for (Method method : methods) {
                    if (method.getName().equals(joinPoint.getSignature().getName())) {
                        declaredMethod = method;
}
                }
            }
            return declaredMethod;
} catch (Exception e) {
            e.printStackTrace();
            return null;
}
    }

    /**
     * 執行規則
     *
     * @param stringBuilder
* @param parameterName
* @param arg
*/
private void invokeRule(StringBuilder stringBuilder, String parameterName, Object arg) {
        if (arg == null) {
            return;
}
        stringBuilder.append(parameterName).append(":");
        if (ArrayUtils.contains(blackArray, parameterName)) {
            stringBuilder.append("***");
} else if (ArrayUtils.contains(cardNoArray, parameterName)) {
            stringBuilder.append(HideDataUtil.hideCardNo(arg.toString()));
} else if (ArrayUtils.contains(phoneNumArray, parameterName)) {
            stringBuilder.append(HideDataUtil.hidePhoneNo(arg.toString()));
} else {
            stringBuilder.append(arg);
}
    }

    /**
     * 遞迴獲取arg對的所有屬性
     *
     * @param fields
* @param arg
*/
//    private void getFields(ArrayList<Field> fields, Class arg) {
//        if (!arg.getSuperclass().equals(Object.class)) {
//            getFields(fields,arg.getSuperclass());
//            List<Field> fields1 = Arrays.asList(arg.getDeclaredFields());
//            fields.addAll(fields1);
//        } else {
//            List<Field> fields1 = Arrays.asList(arg.getDeclaredFields());
//            fields.addAll(fields1);
//        }
//    }
private void getFields(ArrayList<Field> fields, Object arg) {
        Class tempClass = arg.getClass();
        while (!tempClass.equals(Object.class)) {
            List<Field> fields1 = Arrays.asList(tempClass.getDeclaredFields());
fields.addAll(fields1);
tempClass = tempClass.getSuperclass();
}
    }

}

四、相關jar包

其中

importorg.egg.utils.HideDataUtil;
import org.egg.utils.JsonUtil;

程式碼所用jar包maven座標：

<!-- https://mvnrepository.com/artifact/org.apache.commons/commons-lang3 -->
<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-lang3</artifactId>
    <version>3.6</version>
</dependency>

<!-- https://mvnrepository.com/artifact/org.aspectj/aspectjweaver -->
<dependency>
    <groupId>org.aspectj</groupId>
    <artifactId>aspectjweaver</artifactId>
    <version>1.8.11</version>
</dependency>

<!-- https://mvnrepository.com/artifact/org.slf4j/slf4j-api -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.25</version>
</dependency>

<!-- https://mvnrepository.com/artifact/org.springframework/spring-context -->
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-context</artifactId>
    <version>4.3.12.RELEASE</version>
</dependency>

宣告：此專案僅是拋磚引玉，內容不是特別完善。如有轉載，請註明此處。

相關推薦

springboot搭建專案之日誌AOP，支援日誌內容可配置控制（黑名單欄位不會列印或其他處理方式）

一、問題描述及試用場景 在專案除錯或生產環境追查問題時，日誌檔案是我們最常用的方式。為了滿足日誌規範和方便日誌追查，一般會寫個日誌攔截AOP切面注入相關方法，列印入參，出參。但有個頭疼問題，某些引數裡包含一些敏感欄位，給予資料安全一般不允許列印，比如：使用者密碼，銀行卡卡號

帶你逐步深入瞭解SSM框架——淘淘商城專案之框架整合，後臺系統搭建

1.  今日計劃 1、  SSM框架整合 2、  mybatis逆向工程 3、  商品列表 4、  商品列表分頁處理 2.  SSM框架整合 2.1. 後臺系統所用的技術 框架：Spring + SpringMVC +Mybatis 前端：EasyUI 資料庫：mysql

SpringBoot AOP，收集日誌、統計方法執行時長

用過Spring 的開發者都知道它有兩大核心功能，1.依賴注入（IOC、DI）、2.面向切面程式設計（AOP）。 AOP：面向切面程式設計，往往用來實現關注點的分離的技術。系統是由許多不同的元件所組成的，每一個元件各負責一塊特定功能。可以很好的整合日誌收集、許可權攔截、執行

springboot聚合專案整合redis時候，專案出現class找不到的問題

微服務之前也一直聽說過，但是一直沒有機會用。剛好，想把公司最近基於ssm的分散式專案，重構成微服務的。網上看了一些教程。話不多說就準備弄了。 整合後，發現專案一直報找不到redis對應的class檔案的問題。 解決過程： 1.1試過在manage的後臺，檢查了common的jar

電商平臺專案之——Ajax請求，服務端處理完不跳到success

1、問題描述：       最近在修改電商平臺的釋出商品頁面，釋出商品時，前端與後臺互動採用Ajax  Post請求，就這麼一個簡單的畫面，我遇到一個非常奇怪且困擾我很久的問題：       （1）商品釋出失敗（有時候能釋

idea ssm專案出現日誌中文亂碼，封裝的json中的msg欄位中文亂碼（但是json封裝的bean中的欄位不亂碼）等其他各種專案下的中文亂碼解決方案

   開頭劃重點！（敲黑板）：rebuild和mvn package的迴圈往復好幾次的操作是解決這個問題的最主要的方法！ 經過多次試驗，發現這樣做就可以正常顯示中文了 我說為什麼有時候亂碼，有時候中文正常，原來下面的這些地方都必須設定好，特別是 rebuild和m

SpringBoot搭建專案幾個小坑

WebMvcConfigurer配置類其實是Spring內部的一種配置方式，採用JavaBean的形式來代替傳統的xml配置檔案形式進行鍼對框架個性化定製。基於java-based方式的spring mvc配置，需要建立一個配置類並實現WebMvcConfigurer 介面，WebMvcC

react搭建專案之webpack4.x的相關配置及分析

       webpack一直再更新，webpack作為前端構建工具，有它 的優勢性。每次更新webpack為了讓這個工具使用起來更加方便，效能優化。在webpack3.x時，在打包壓縮時，必須得使用額外的外掛，配置雖然不是那麼麻煩有官網，但這是一個耗時耗力的事情。webp

SpringBoot學習筆記之JSP與freemarker支援

2、Springboot支援freemarker 1)、先在pom.xml中加入依賴 <!-- 引入freeMarker的依賴包. --> <dependency> <groupId>org.springframework.boot</groupId>

ssm框架整合AOP，實現日誌記錄功能

在ssm框架中，實現一個切面日誌功能，起碼要掌握的知識有四點： 以下是自己之前做的一個專案，希望對你們有幫助 1：先定義一個自定義註解類 @Target({METHOD, TYPE}) @Retention(RetentionPolicy.RUNTIME) @In

springboot搭建初始@SpringBootApplication無法引入，註解報錯

搭建springBoot，@SpringBootApplication無法被解析引入，註解報錯。 查閱stackoverflow，應該是springBoot的包衝突了所致。需要刪掉 repository\org\springframework\boot 目錄下的spri

haproxy 1.8版本沒有日誌輸出，參考1.7版本配置

一、問題、haproxy啟動後， 重新安裝haproxy1.8版本，配置好haproxy.cfg，可以測試到轉發效果，但是/var/log下沒有haproxy.log日誌，看不到請求連結資料以及重啟haproxy.cfg資訊 二、參考網上，修改/etc/haproxy/

GAN應用之資料生成，無監督深度學習新方法（3）

3.1 從GAN到Conditional GAN GAN的生成式模型可以擬合真實分佈，所以它可以用於偽造資料。DCGAN是第一個用全卷積網路做資料生成的，下面是它的基本結構和生成的資料。 輸入100維的噪聲，輸出64*64的影象，從mnist的訓練結果來看，

第一次使用Git上傳本地專案到github上，下載、安裝、上傳（很詳細，很全面）

我覺得學習github的人基本上已經快要脫離了小白的標籤，雖然我一直喜歡自稱為小白。對於程式設計師原來說應該都聽說過GitHub，GitHub有許多開源的的專案和一些前沿的技術。因為自己在第一次使用過Git和github時遇到過不少的坑，所以，想對第一次使用Gi

spring加強：spring aop expression支援多個表示式配置

spring aop expression支援多個表示式配置 準備： 目標類UcUserFilesService 及目標方法insert()方法、update()方法及delete()方法（紅色標註的是目標方法） package com.huajin.userserve

通用DAO之MyBatis封裝，封裝通用的增刪改查（三）

曾將釋出過倆篇關於Mybatis封裝的文章，當時曾曾承諾過當測試沒有問題後阿海會整理一下然後將原始碼釋出出來。 那麼今天正好朋友找我要一份那套mybatis封裝的原始碼，我便整理了一份，想想這麼長時間了並沒有發現什麼明顯的bug，於是決定將它發出來。 關

@SpringBootApplication : 是Sprnig Boot專案的核心註解，目的是開啟自動配置

@SpringBootApplication  : 是Sprnig Boot專案的核心註解，目的是開啟自動配置   目錄 @SpringBootApplication  : 是Sprnig Boot專案的核心註解，目的是開啟自動配置

Springboot @RequestBody + Retrofit @Body 之實體類欄位含有日期Date型別的提交方式

有時候進行引數提交時需要提交很多的引數，一個個引數寫太麻煩，則可以利用POST即兩者的註解直接實體類進行提交，他們會自動進行欄位的對映，相當於json資料格式提交，可以省很多事，但是需要注意欄位為日期Date型別時的處理。 演示程式碼： springboot

java專案到處jar包，轉成.exe可執行檔案

需要使用的工具： eclipse，exe4j，iocFx2(製作ico圖示) 具體轉換步驟分為兩步： 一、將java專案到處成jar包； 二、將匯出的jar包轉換成exe可執行檔案； 步驟一：將jav

flume 對日誌監控，和日誌資料正則清洗最後實時集中到hbase中的示例

今天學習了flume的簡單用法，順便思考了一下，對標準日誌格式的資料實時清洗和集中儲存今天介紹一下運用正則表示式對資料進行實時清洗，將資料儲存到hbase中，前面簡單的不分列的儲存，就直接貼程式碼1、運用flume的HBasesink--SimpleHbaseEventSer