IT数码 购物 网址 头条 软件 日历 阅读 图书馆
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
图片批量下载器
↓批量下载图片,美女图库↓
图片自动播放器
↓图片自动播放器↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
开发: C++知识库 Java知识库 JavaScript Python PHP知识库 人工智能 区块链 大数据 移动开发 嵌入式 开发工具 数据结构与算法 开发测试 游戏开发 网络协议 系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁
 
   -> Java知识库 -> 日志系统→门面、实现技术,链路跟踪(MDC)、日志脱敏 -> 正文阅读

[Java知识库]日志系统→门面、实现技术,链路跟踪(MDC)、日志脱敏

常见日志门面和技术介绍:

门面技术
简介又日志的规范,可以近似的认为是所有日志技术需要实现的公共接口实现记录日志的技术,有的用的自己的规范接口,有的是用的公共的规范接口
常用slf4j,jcllog4j,log4j2,logback,jul
说明

jcl只有被jul所使用,slf4j被绝大多数日志框架所使用

当然只有logback是默认实现的slf4j规范,log4j和log4j2有自己的默认规范,要想实现slf4j规范需要额外的引入jar包和进行其他操作,关于他们的整合参照视频,深究工作原理参照视频参考文章


SpringBoot整合各种日志框架:

各种日志框架的整合参考视频(包括JUL、JCL,SLF4J,LogBack,Log4j,Log4j2 maven使用及SpringBoot整合,不包括Log4j,Log4j2实现Slf4j接口,如果有需要请参考视频

上述视频教程的参考demo及书面教程

建议有条件的观看视频 ,没条件的看上述的书面材料

关于各种技术(比如log4j、log4j2、logback)的配置文件详情可自行百度,下面是一些推荐网站

Log4j.properties配置文件详解

Log4j.xml配置文件详解

Log4j配置文件视频教程

log4j2.xml配置文件详解(配置教程不可用)

Log4j2.properties配置文件详解

logback配置文件详解及配置教程

logback配置文件详解及配置教程2

默认配置:

依赖于开发者选择的日志框架,这些对应的配置文件会被加载;

日志框架配置文件
Logbacklogback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy
Log4jlog4j-spring.properties, log4j-spring.xml, log4j.properties, log4j.xml
Log4j2log4j2-spring.xml, log4j2.xml
JDK(JAVA Util Logging)logging.properties

Spring Boot官方推荐优先使用带有-spring的文件名作为你的日志配置(如使用logback-spring.xml,而不是logback.xml),命名为logback-spring.xml的日志配置文件,spring boot可以为它添加一些spring boot特有的配置项,默认的命名规则,并且放在 src/main/resources 下面即可。

因为springBoot默认整合的就是logback,所以简单的使用logback,不需要加logback的配置文件,只要在yml文件中增加配置即可,具体参照视频最后两节进行学习。


SpringBoot整合log4J:

  1. springboot 默认就是使用SLF4J作为日志门面,logback作为日志实现来记录日志。
  2. SpringBoot整合log4J? 需要替换日志启动器,具体做法如下:
  3. 首先放入log4j的配置文件(properties或xml都可,下面是个简单的示例)

log4j.rootLogger=INFO,console
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.target=System.out
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=%X{requestID} - %C -%M -- %d{yyyy-MM-dd HH:mm:ss} -- %m%n
  1. 然后加入依赖
        <!--日志 start-->
        <!--log4j核心依赖-必须加-->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>
        <!--log4j实现slf4j依赖,可不加,加了之后实现slf4j接口,建议加-->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
            <version>1.7.21</version>
        </dependency>

        <!--日志end-->
  1. ?然后剔除原先的日志启动器
  • 打开类图

  • ?找到logback-classic右击选择Exclude即可

  • 打印出来的就是log4j的日志

?SpringBoot整合log4J2:

  1. springboot 默认就是使用SLF4J作为日志门面,logback作为日志实现来记录日志。

  2. SpringBoot整合JUL、JCL、log4j、logback? 见参考demo

  3. SpringBoot整合log4J2? 需要替换日志启动器,具体做法如下:

  4. Log4j2? 不建议使用properties方式??? 因为spring默认不识别log4j2的配置文件

  5. 首先放入log4j2的配置文件

  1. 然后加入依赖
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-log4j2</artifactId>
        </dependency>
  1. 然后剔除原先的日志启动器
  • 打开类图

  • 找到spring-boot-starter-logging右击选择Exclude即可

  • 打印出的日志就是按照log4J2的格式输出来的


?SpringBoot 链路跟踪技术? MDC

  1. 参考视频

  2. 参考资料

  3. MDC? 异步下的跨线程操作(参考资料1 ---参考资料2

MDC是一种链路跟踪技术,所谓的链路跟踪技术,就是可以对每一次请求的日志加以区分,底层的原理是threadLocal。具体的配置方式如下:

各种日志的配置方式见参考资料? ,但是都大差不差? ,以? log4j为例,其他的见参考资料:

首先在配置文件中加入:

在输出的日志格式加%X{s},s为MDC中的key值,如下,key值为requestID?

然后只需要在代码中加入? 该key值以及对应的value即可

?得到的日志每一次不同的请求都会标记一个reuqestID

  1. ?关于异步情况下,MDC的跨线程传输问题。
  • log4j、log4j2自身对MDC已经做了优化,所以如果springboot整合的是log4j、log4j2就不需要考虑MDC同步和异步的问题,如:

log4j线程外只加了一次,可以看到即使进行异步调用,MDC也会进行传播。?

  • ?但是springBoot 默认使用的是logBack,logBack对MDC的异步是没有经过处理的,所以当整合了logBack又进行异步操作时,需要手动的进行异步传输,参照参考资料和上述文档,

只在异步前加了一次MDC,然后日志只要是异步的,MDC就传输不到

所以,logback下需要进行异步操作,见参考资料1参考资料2?

因为在实际应用中,所有的异步都是结合线程池来做的,所以一般我们会结合?runnable来实现

?这样就简化了很多繁杂的操作。


?日志脱敏

  1. 本次日志脱敏主要是针对logBack,log4j,log4j2也可以参考

  2. 参考资料1? 和参考资料2

  3. 参考demo

简述下上述demo是怎么添加日志脱敏的,首先在 appender 标签里面添加??encoder 和?layout 标签? ,具体内容如下,完整版见上述demo:

   <!--1. 输出到控制台-->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!--此日志appender是为开发使用,只配置最底级别,控制台输出的日志级别是大于或等于此级别的日志信息-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>debug</level>
        </filter>

        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
            <layout class="com.example.demo.util.MaskingPatternLayout">
                <maskPattern>mobileNo---(mobileNo=)(\d{3})\d{4}(\d{4})---$1$2****$3</maskPattern><!--toString-->
                <maskPattern>mobileNo---("mobileNo":)("\d{3})\d{4}(\d{4})"---$1$2****$3</maskPattern><!--JSON-->
                <maskPattern>手机号---("手机号":)("\d{3})\d{4}(\d{4})"---$1$2****$3</maskPattern><!--JSON-->
                <maskPattern>idCardNo---(idCardNo=)(\w{4})\w{7,10}(\w{4})---$1$2******$3</maskPattern><!--toString-->
                <maskPattern>idCardNo---("idCardNo":)("\w{4})\w{7,10}(\w{4})"---$1$2******$3</maskPattern><!--JSON-->
                <maskPattern>name---(name=)([\u4E00-\u9FA5]{1})[\u4E00-\u9FA5]{1,}---$1$2**</maskPattern><!--toString-->
                <maskPattern>name---("name":)("[\u4E00-\u9FA5]{1})[\u4E00-\u9FA5]{1,}"---$1$2**</maskPattern><!--JSON-->
                <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
            </layout>
        </encoder>
    </appender>

然后添加相应的解析类,解析该配置文件:

package com.example.demo.util;

import ch.qos.logback.classic.PatternLayout;
import ch.qos.logback.classic.spi.ILoggingEvent;

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

public class MaskingPatternLayout extends PatternLayout {
    /*
     * 日志脱敏开关
     * */
    private static Boolean converterCanRun = Boolean.TRUE;

    /*
     * list  用来存储正则表达式以及脱敏范围
     * */
    private static List<String> regulars = new ArrayList<>();

    public void addMaskPattern(String maskPattern) {
        System.out.println(maskPattern);
        regulars.add(maskPattern);
    }

    @Override
    public String doLayout(ILoggingEvent event) {
        return maskMessage(super.doLayout(event));
    }

    private String maskMessage(String message) {
        //创建二维数组  用来存储  获取到的配置文件
        String[][] values = new String[regulars.size()][3];
        //然后依次分解 存入数组中
        for(int order = 0;order < regulars.size();order++){
            String tmp = regulars.get(order);
            //以---(英文)为分隔符  然后进行存储
            String[] regs = tmp.split("---");
            if(regs.length == 3){
                values[order] = regs;
            }

        }

        //存入二维数组后  遍历  进行正则的匹配
        if(!converterCanRun){
            return message;
        }
        for(int order = 0; order <values.length ;order++){
            if(message.contains(values[order][0])){
                Matcher matcher = Pattern.compile(values[order][1]).matcher(message);
                message = matcher.replaceAll(values[order][2]);
            }
        }
        return message;
    }
}

然后添加相应的使用类即可? :

    @RequestMapping("getUser/{id}")
    public String GetUser(@PathVariable int id, Model model) {
        logger.info("mobileNo=17855911518");
        logger.info("idCardNo=140321199606482668");
        logger.info("name=王爬爬");
        log.info("mobileNo=17855911518============idCardNo=140321199606482668=============name=王爬爬");

        Map<String, String> user = new HashMap<String, String>();
        user.put("mobileNo", "17855911518");
        user.put("手机号", "17855911518");
        user.put("idCardNo", "140321199606482668");
        user.put("name", "王爬爬");
        JSONObject userDetails = new JSONObject(user);
        logger.info("User JSON: {}", userDetails);
        User u = userService.Sel(id);
        model.addAttribute("user", u);
        logger.error("xxxxxxxxxxx" + u.toString());
        return "index";
    }

最后观察输出的日志记录:

?可以看到,所有需要加密的都已经进行加密了。


  Java知识库 最新文章
计算距离春节还有多长时间
系统开发系列 之WebService(spring框架+ma
springBoot+Cache(自定义有效时间配置)
SpringBoot整合mybatis实现增删改查、分页查
spring教程
SpringBoot+Vue实现美食交流网站的设计与实
虚拟机内存结构以及虚拟机中销毁和新建对象
SpringMVC---原理
小李同学: Java如何按多个字段分组
打印票据--java
上一篇文章      下一篇文章      查看所有文章
加:2021-08-30 11:52:17  更:2021-08-30 11:53:29 
 
开发: C++知识库 Java知识库 JavaScript Python PHP知识库 人工智能 区块链 大数据 移动开发 嵌入式 开发工具 数据结构与算法 开发测试 游戏开发 网络协议 系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁

360图书馆 购物 三丰科技 阅读网 日历 万年历 2024年11日历 -2024/11/23 13:17:53-

图片自动播放器
↓图片自动播放器↓
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
图片批量下载器
↓批量下载图片,美女图库↓
  网站联系: qq:121756557 email:121756557@qq.com  IT数码