2. 程式人生 > >Java中關於使用logback做日誌脫敏

Java中關於使用logback做日誌脫敏

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

最近在研究如何使用logback實現日誌脫敏的工作，網上各種查，各種找，終於找到了解決的辦法。其實原理知道，就是想找一個最簡便的方法而已。那今天咱們就來聊聊如何用Logback建立自定義格式轉換符來實現日誌脫敏**

  • 脫敏類檔案
  • 配置檔案

脫敏類檔案

資料脫敏是指對某些敏感資訊通過脫敏規則進行資料的變形，實現敏感隱私資料的可靠保護。 —— [ 百度百科 ]

本文使用最簡單的脫敏方式進行資料脫敏列印，規則如下：

| 引數 | 脫敏前 | 脫敏後 |

| ——– | ——– | ——– |

| 姓名 | 李麗麗 | 李** |

| 手機號 | 13898701234 | 138****1234 |

| 身份證號 | 111111111111115762 | **************5762 |

| 銀行卡號 | 6222600890987671234 | 6222600********1234 |

具體程式碼

首先定義類：SensitiveDataConverter 繼承父類：MessageConverter


import ch.qos.logback.classic.pattern.MessageConverter;
import ch.qos.logback.classic.spi.ILoggingEvent;

import java.util.regex.Matcher;
import
 
 java.util.regex.Pattern;

/**
 * 敏感資訊脫敏處理
 * @author AAA
 */
public class SensitiveDataConverter extends MessageConverter {

    @Override
    public String convert(ILoggingEvent event){
        // 獲取原始日誌
        String oriLogMsg = event.getFormattedMessage();

        // 獲取脫敏後的日誌
        String afterLogMsg
 
 = invokeMsg(oriLogMsg);
        return afterLogMsg;
    }

    /**
     * 日誌脫敏開關
     */
    private static String converterCanRun = "true";
    /**
     * 日誌脫敏關鍵字
     */
    private static String sensitiveDataKeys = "idcard,realname,bankcard,mobile"; 

    /**
     * 處理日誌字串，返回脫敏後的字串
     * @param msg
     * @return
     */
    public String invokeMsg(final String oriMsg){
        String tempMsg = oriMsg;
        if("true".equals(converterCanRun)){
            // 處理字串
            if(sensitiveDataKeys != null && sensitiveDataKeys.length() > 0){
                String[] keysArray = sensitiveDataKeys.split(",");
                for(String key: keysArray){
                    int index= -1; 
                    do{
                        index = tempMsg.indexOf(key, index+1);
                        if(index != -1){ 
                            // 判斷key是否為單詞字元
                            if(isWordChar(tempMsg, key, index)){
                                continue;
                            }
                            // 尋找值的開始位置
                            int valueStart = getValueStartIndex(tempMsg, index + key.length());

                            // 查詢值的結束位置（逗號，分號）........................
                            int valueEnd = getValuEndEIndex(tempMsg, valueStart);

                            // 對獲取的值進行脫敏 
                            String subStr = tempMsg.substring(valueStart, valueEnd);
                            subStr = tuomin(subStr, key);
                            ///////////////////////////
                            tempMsg = tempMsg.substring(0,valueStart) + subStr + tempMsg.substring(valueEnd);
                        }
                    }while(index != -1);
                }
            }
        }
        return tempMsg;
    }


    private static Pattern pattern = Pattern.compile("[0-9a-zA-Z]");
    /**
     * 判斷從字串msg獲取的key值是否為單詞 ， index為key在msg中的索引值
     * @return
     */
    private boolean isWordChar(String msg, String key, int index){

        // 必須確定key是一個單詞............................
        if(index != 0){ // 判斷key前面一個字元
            char preCh = msg.charAt(index-1);
            Matcher match = pattern.matcher(preCh + "");
            if(match.matches()){
                return true;
            }
        }
        // 判斷key後面一個字元
        char nextCh = msg.charAt(index + key.length());
        Matcher match = pattern.matcher(nextCh + "");
        if(match.matches()){
            return true;
        }
        return false;
    }

    public static void main(String[] args) {
        String tempMsg = "{sign=f88898b2677e62f1ad54b9e330c0a27e, idcard=130333198901192762, realname=%E5%BE%90%E5%BD%A6%E5%A8%9C, key=c5d34d4c3c71cc45c88f32b4f13da887, mobile=13210141605, bankcard=6226430106137525}";
        String tempMsg1 = "{\"reason\":\"成功 \",\"result\":{\"jobid\":\"JH2131171027170837443588J6\",\"realname\":\"李哪娜\",\"bankcard\":\"6226430106137525\",\"idcard\":\"130333198901192762\",\"mobile\":\"13210141605\",\"res\":\"1\",\"message\":\"驗證成功\"},\"error_code\":0}";
        SensitiveDataConverter sc = new SensitiveDataConverter();
        System.out.println(sc.invokeMsg(tempMsg));
        System.out.println(sc.invokeMsg(tempMsg1));
    }

    /**
     * 獲取value值的開始位置
     * @param msg 要查詢的字串
     * @param valueStart 查詢的開始位置
     * @return
     */
    private int getValueStartIndex(String msg, int valueStart ){
        // 尋找值的開始位置.................................
        do{
            char ch = msg.charAt(valueStart);
            if(ch == ':' || ch == '='){ // key與 value的分隔符
                valueStart ++;
                ch = msg.charAt(valueStart);
                if(ch == '"'){
                    valueStart ++;
                }
                break;    // 找到值的開始位置
            }else{
                valueStart ++;
            }
        }while(true);
        return valueStart;
    }

    /**
     * 獲取value值的結束位置
     * @return
     */
    private int getValuEndEIndex(String msg,int valueEnd){
        do{
            if(valueEnd == msg.length()){
                break;
            }
            char ch = msg.charAt(valueEnd);

            if(ch == '"'){ // 引號時，判斷下一個值是結束，分號還是逗號決定是否為值的結束
                if(valueEnd+1 == msg.length()){
                    break;
                }
                char nextCh = msg.charAt(valueEnd+1);
                if(nextCh ==';' || nextCh == ','){
                    // 去掉前面的 \  處理這種形式的資料
                    while(valueEnd>0 ){
                        char preCh = msg.charAt(valueEnd-1);
                        if(preCh != '\\'){
                            break;
                        }
                        valueEnd--;
                    }
                    break;
                }else{
                    valueEnd ++;
                }
            }else if (ch ==';' || ch == ',' || ch == '}'){
                break;
            }else{
                valueEnd ++;
            }

        }while(true);
        return valueEnd;
    }

    private String tuomin(String submsg, String key){
        // idcard：身份證號, realname：姓名, bankcard：銀行卡號, mobile：手機號
        if("idcard".equals(key)){
            return SensitiveInfoUtils.idCardNum(submsg);
        }
        if("realname".equals(key)){
            return SensitiveInfoUtils.chineseName(submsg);
        }
        if("bankcard".equals(key)){
            return SensitiveInfoUtils.bankCard(submsg);
        }
        if("mobile".equals(key)){
            return SensitiveInfoUtils.mobilePhone(submsg);
        }
        return "";
    }
}

import org.apache.commons.lang.StringUtils;

public class SensitiveInfoUtils {

    /**
     * [姓名] 只顯示第一個漢字，其他隱藏為星號<例子：李**>
     * 
     * @param fullName
     * @return
     */
    public static String chineseName(String fullName) {
        if (StringUtils.isBlank(fullName)) {
            return "";
        }
        String name = StringUtils.left(fullName, 1);
        return StringUtils.rightPad(name, StringUtils.length(fullName), "*");
    }

    /**
     * [身份證號] 顯示最後四位，其他隱藏。共計18位或者15位。<例子：*************5762>
     * 
     * @param idCardNum
     * @return
     */
    public static String idCardNum(String idCardNum) {
        if (StringUtils.isBlank(idCardNum)) {
            return "";
        }
        String num = StringUtils.right(idCardNum, 4);
        return StringUtils.leftPad(num, StringUtils.length(idCardNum), "*");
    }

    /**
     * [手機號碼] 前三位，後四位，其他隱藏<例子:138******1234>
     * 
     * @param num
     * @return
     */
    public static String mobilePhone(String num) {
        if (StringUtils.isBlank(num)) {
            return "";
        }
        return StringUtils.left(num, 3).concat(StringUtils.removeStart(StringUtils.leftPad(StringUtils.right(num, 4),StringUtils.length(num), "*"), "***"));
    }

    /**
     * [銀行卡號] 前六位，後四位，其他用星號隱藏每位1個星號<例子:6222600**********1234>
     * 
     * @param cardNum
     * @return
     */
    public static String bankCard(String cardNum) {
        if (StringUtils.isBlank(cardNum)) {
            return "";
        }
        return StringUtils.left(cardNum, 6).concat(StringUtils.removeStart(StringUtils.leftPad(StringUtils.right(cardNum, 4), StringUtils.length(cardNum), "*"), "******"));
    }
}

配置檔案

程式碼部分完成之後，我們需要在locback.xml配置檔案中增加一行配置：

<conversionRule conversionWord="msg" converterClass="com.api.filter.SensitiveDataConverter"> </conversionRule>

詳細如下:

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- Logback預設配置的採用的步驟 -->
    <!-- 1. 嘗試在 classpath 下查詢檔案 logback-test.xml； -->
    <!-- 2. 如果檔案不存在，則查詢檔案 logback.xml； -->
    <!-- 3. 如果兩個檔案都不存在，logback 用 BasicConfigurator 自動對自己進行配置，這會導致記錄輸出到控制檯。 -->

    <!-- 本機環境中只會載入該配置檔案，部署伺服器時請刪除本檔案 -->

    <conversionRule conversionWord="msg" converterClass="com.api.filter.SensitiveDataConverter"> </conversionRule>
    <!-- 輸出控制檯 -->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <target>System.out</target>
        <encoder>
            <Pattern><![CDATA[ [%-5level] [%d{yyyy-MM-dd HH:mm:ss.SSS}] [%t] [%logger.%method:%line] -- %msg%n ]]></Pattern>
        </encoder>
    </appender> 

    <!-- 時間滾動輸出日誌 -->
    <appender name="file—info" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>D:/logs/aaaa.log</file>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>D:/logs/aaaa.%d{yyyy-MM-dd}.log</fileNamePattern>
        </rollingPolicy>
        <encoder>
            <pattern><![CDATA[ [%-5level] [%d{yyyy-MM-dd HH:mm:ss.SSS}] [%t] [%logger.%method:%line] -- %msg%n ]]></pattern>
        </encoder>
    </appender>

    <logger name="dfpay-auto" additivity="false">
        <appender-ref ref="INFO_FILE" />
    </logger>

    <root level="INFO">
        <appender-ref ref="console" />
    </root>
</configuration>

然後就可以執行程式碼，輸出結果：

{sign=f88898b2677e62f1ad54b9e330c0a27e, idcard=*********2762, realname=%*********************, key=c5d34d4c3c71cc45c88f32b4f13da887, mobile=132****1605, bankcard=622643******7525}
{“reason”:”成功 “,”result”:{“jobid”:”JH2131171027170837443588J6”,”realname”:”李**”,”bankcard”:”622643******7525”,”idcard”:”**************2762”,”mobile”:”132****1605”,”res”:”1”,”message”:”驗證成功”},”error_code”:0}

目錄：

結束語

  1. 程式碼很簡單，說白了就是利用logback的Converter，自定義日誌格式轉換符，然後繼承ClassicConverter就可以了 ，當然了還有其他的實現方式，這裡就不多寫了。
  2. 文章有不對的地方歡迎大家指正，共同進步，謝謝！！

相關推薦

Java中關於使用logback做日誌脫敏

最近在研究如何使用logback實現日誌脫敏的工作，網上各種查，各種找，終於找到了解決的辦法。其實原理知道，就是想找一個最簡便的方法而已。那今天咱們就來聊聊如何用Logback建立自定義格式轉換符來實現日誌脫敏** 脫敏類檔案 配置檔案 脫敏類檔

java 日誌脫敏框架 sensitive，優雅的打印脫敏日誌

pub name void string maven 工具 exceptio context 系統 問題 為了保證用戶的信息安全，敏感信息需要脫敏。 項目開發過程中，每次處理敏感信息的日誌問題感覺很麻煩，大部分都是用工具類單獨處理，不利於以後統一管理，很不優雅。 於是，就寫

java 日誌脫敏框架 sensitive，優雅的列印脫敏日誌

問題 為了保證使用者的資訊保安，敏感資訊需要脫敏。專案開發過程中，每次處理敏感資訊的日誌問題感覺很麻煩，大部分都是用工具類單獨處理，不利於以後統一管理，很不優雅。於是，就寫了一個基於 java 註解的日誌脫敏工具。 github sensitive 專案介紹 日誌脫敏是常見的安全需求。普通的

java 日誌脫敏框架 sensitive-新版本0.0.2-深度拷貝，屬性為物件和集合的支援

專案介紹 日誌脫敏是常見的安全需求。普通的基於工具類方法的方式，對程式碼的***性太強。編寫起來又特別麻煩。 本專案提供基於註解的方式，並且內建了常見的脫敏方式，便於開發。 使用者也可以基於自己的實際需要，自定義註解。 特性 基於註解的日誌脫敏 可以自定義策略實現，策略生效條件

java 日誌脫敏框架 sensitive-新版本0.0.2-深度拷貝，屬性為對象和集合的支持

ive print name 自己 null iss array 使用註解 util 項目介紹 日誌脫敏是常見的安全需求。普通的基於工具類方法的方式，對代碼的***性太強。編寫起來又特別麻煩。 本項目提供基於註解的方式，並且內置了常見的脫敏方式，便於開發。 用戶也可以基於自

java中常用的日誌框架-logback和log4j

本文主要記錄 一下博主對sl4j和log4j&logback關係的理解及後面兩種日誌框架的配置和區別 三者之間的關係 三者之間的關係：sl4j是介面，log4j和logback是實現 如下圖 logback是直接實現了sl4j，而log4

關於實現log4j2日誌脫敏的一種方案

情景 最近公司嚴格要求日誌脫敏，對於敏感欄位，諸如身份證號、手機號、銀行卡號等使用者資訊進行掩碼，保證日誌中沒有明文。 專案程式碼中列印日誌的地方形如： logger.info("idCard:{},phone:{},mobile:{},name:{}

2：自定義註解日誌脫敏（半原創）

import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import j

Java中byte做&0xff運算的原因及解析

Java中byte資料使用到&0xff的原因及解析 第一種情況：signed/unsigned之間的轉化 java中，除了char是unsigned 兩個位元組，用來表達UTF-16，此外byte/short/int/long都是signed

java中使用log4j日誌檔案,讀取配置檔案的方式

publicvoid init() {//該方法必須在所有log4j使用前呼叫 最好時初始化時就呼叫執行 載入好配置                           Properties props =new Properties();//建立一個系統引數物件  

java 日誌的數據脫敏

public 隱藏 信息 nbsp phone ide hang *** 號碼 思路 1。在 model層進行處理，直接重寫get方法，在寫一個getPlain 獲取明文方法。(缺點：數據庫寫入和json序列化傳遞時使用的都是密文) 　　2.利用 日誌組件過濾 特定的key

java 中使用logback日誌，並實現日誌按天分類壓縮儲存。

以maven專案作為構建工具為例，首先引入使用logback需要的3個依賴，需要注意使用logback是需要引入slf4j-api的，因為logback是基於slf4j的 <!--logback--> <dependency> <groupId>ch.qo

Java中多環境Logback配置與ELK日誌傳送

Java中多環境Logback配置與ELK日誌傳送   一、專案基於SpringBoot實現，引入SpringBoot相關庫後，本文還要講上傳到ELK的Logstash，所以需要在pom.xml中加入： <!-- https://mvnre

資料脫敏——基於Java自定義註解實現日誌欄位脫敏

　　上文說了資料過敏主要有兩個思路：第一個就是在序列化實體之前先把需要脫敏的欄位進行處理，之後正常序列化；第二個就是在實體序列化的時候，對要脫敏的欄位進行處理。 脫敏實現思路 　　這裡探討第一種方法，用基於自定義註解的方式實現日誌脫敏。 　　要對

Java Web中使用logback輸出日誌檔案的路徑問題

一個軟體的日誌有多重要，相信當軟體出問題，你一行一行去找的時候才會意識到，Clean code, clean logs中提出了10個建議來有效的使用日誌。 從我自己的經驗上來看，從根本不會考慮日誌問題，到使用System.out.println()，再到使用s

java webproject中logback換配置文件的路徑

tro try gpo rip doc work scan match -a 本人小站點： http://51kxd.com/ 歡迎大家不開心的時候訪問訪問，調節一下心情 web.xml中配置： <!-- windows log

java中StringBuilder為單線程做的，StringBuffer相反

stringbu [] run lee 沒有 auth stub b- ati //沒有sycronized修飾method,是線程不安全的,--StringBuffer來彌補這個缺點，但速度就慢了 並沒有測試出來：： 1 /** 2 * 3 */ 4 p

JAVA中使用log4j及slf4j進行日誌輸出的方法

cto 所在 inf 官方 pat etl 註意 actor 結果 　　JAVA中輸出日誌比較常用的是log4j，這裏講下log4j的配置和使用方法，以及slf4j的使用。 一、下載log4j的架包，並導入項目中，如下： 二、創建log4j.prope

Java中的日誌——Java.util.logging、log4j、commons-logging

mark svg pen xtra pat sstream ogg package ice Java中給項目程序添加log主要有三種方式，一使用JDK中的java.util.logging包，一種是log4j，一種是commons-logging。其中log4j和co

JAVA中的異常處理及日誌(log4j為例)的使用

ble 包括 啟動 fatal try-catch stat 異常捕獲 資源 大於 Java的異常 1.Java中所有異常和錯誤的基類：Throwable 　　　　Throwable error 　　　　　　 Exception 　　　　　　（檢查時異常）（運行時