log4j2自定义动态配置日志

最新推荐文章于 2024-09-23 07:00:00 发布
最新推荐文章于 2024-09-23 07:00:00 发布
阅读量6.3k 收藏 11
点赞数 1
分类专栏： 微信公号原创 文章标签： springboot log4j2
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_39913153/article/details/90712940
版权
项目需求

1.平台日志：Spring Boot项目中接入log4j2日志，公共配置作平台日志。
2.业务日志：为了方便定位业务问题自定义动态日志，根据不同业务输出不同名称的日志文件。

思路分析

第一个需求比较容易，网上教程资料非常多，多注意细节。第二个需求网上资料就很少了，需要去看一些源码信息了解日志打印过程使用的方法，然后根据业务需求做一个公共类：用户调用工具方法输入业务名称、日志路径等参数自定义日志。下面会贴具体代码和学习资料地址。

平台日志

首先配置 pom.xml 文件，将原有的 logback 移除，改用 log4j2

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>

添加 log4j 的包

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

添加 log4j2.xml 配置文件

<?xml version="1.0" encoding="UTF-8"?>
<!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，你会看到log4j2内部各种详细输出-->
<!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
<configuration>
    <!-- 全局参数 -->
    <properties>
        <Property name="displayName">platform</Property>
        <Property name="log_path">logs/${displayName}</Property>
        <Property name="pattern">%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p %C %c{1}:%L -%m%n</Property>

    </properties>
    <!--先定义所有的appender-->
    <appenders>
        <!--这个输出控制台的配置-->
        <console name="Console" target="SYSTEM_OUT" follow="true">
            <PatternLayout>
                <pattern>${pattern}</pattern>
            </PatternLayout>
        </console>
        <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，这个也挺有用的，适合临时测试用-->
        <File name="log" fileName="logs/platform.log" append="false">
            <!-- 指定error 级别的日志 -->
            <ThresholdFilter level="ERROR" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout>
                <pattern>${pattern}</pattern>
            </PatternLayout>
        </File>
        <!-- 这个会打印出所有的info及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileInfo" fileName="${log_path}/info.log"
                     filePattern="${log_path}/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
           <Filters>
                <ThresholdFilter level="warn" onMatch="DENY" onMismatch="NEUTRAL"/>
                <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY" />
            </Filters>
            <PatternLayout>
                <pattern>${pattern}</pattern>
            </PatternLayout>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
            <DefaultRolloverStrategy max="100000"/>
        </RollingFile>
        <!--   <RollingFile name="RollingFileWarn" fileName="${log_path}/warn.log"
                        filePattern="${log_path}/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
               <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
               <PatternLayout>
                   <pattern>${pattern}</pattern>
               </PatternLayout>
               <Policies>
                   <TimeBasedTriggeringPolicy/>
                   <SizeBasedTriggeringPolicy size="100 MB"/>
               </Policies>
               &lt;!&ndash; DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件，这里设置了20 &ndash;&gt;
               <DefaultRolloverStrategy max="20"/>
           </RollingFile>-->
        <RollingFile name="RollingFileError" fileName="${log_path}/error.log"
                     filePattern="${log_path}/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout>
                <pattern>${pattern}</pattern>
            </PatternLayout>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
            <DefaultRolloverStrategy max="100000"/>
        </RollingFile>
    </appenders>
    <!--然后定义logger，只有定义了logger并引入的appender，appender才会生效-->
    <loggers>
        <!--过滤掉spring的一些无用的DEBUG信息-->
        <logger name="org.springframework" level="WARN"></logger>
        <logger name="org.hibernate" level="WARN"/>
        <!--<logger name="com.lottery" level="DEBUG"></logger>-->
        <Root level="INFO">
            <appender-ref ref="Console"/>
            <appender-ref ref="RollingFileInfo"/>
            <!--<appender-ref ref="RollingFileWarn"/>-->
            <appender-ref ref="RollingFileError"/>
        </Root>
    </loggers>
</configuration>
业务日志

直接贴代码了，根据输入的业务名称参数调用LogUtil工具方法生成不同名称的业务日志。为了规范化和方便管理，我将业务名称参数定义成枚举量，这样添加某业务日志需要去枚举类里面添加。

import com.lottery.enums.BusinessEnum;
import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.core.Filter;
import org.apache.logging.log4j.core.Layout;
import org.apache.logging.log4j.core.LoggerContext;
import org.apache.logging.log4j.core.appender.RollingFileAppender;
import org.apache.logging.log4j.core.appender.rolling.*;
import org.apache.logging.log4j.core.config.AppenderRef;
import org.apache.logging.log4j.core.config.Configuration;
import org.apache.logging.log4j.core.config.LoggerConfig;
import org.apache.logging.log4j.core.filter.ThresholdFilter;
import org.apache.logging.log4j.core.layout.PatternLayout;
import java.io.File;
import static org.apache.logging.log4j.core.Filter.Result.DENY;

public class LogUtil {
    /**
     * 日志打印的目录
     */
    private static final String datalogDir = "logs" + File.separator + "business";

    private static final LoggerContext ctx = (LoggerContext) LogManager.getContext(false);
    private static final Configuration config = ctx.getConfiguration();
    private static final String INFO = "info";
    private static final String ERROR = "error";


    private LogUtil() {
    }

    /**
     * 启动一个动态的logger
     */
    private static void start(String loggerName) {

        //创建一个展示的样式：PatternLayout，   还有其他的日志打印样式。
        Layout layout = PatternLayout.newBuilder()
                .withConfiguration(config).withPattern("%d{yyyy-MM-dd HH:mm:ss,SSS} %t %-5p %C %c{1}:%L -%m%n").build();

        //单个日志文件大小
        TimeBasedTriggeringPolicy tbtp = TimeBasedTriggeringPolicy.createPolicy(null, null);
        TriggeringPolicy tp = SizeBasedTriggeringPolicy.createPolicy("100 MB");// 大小分割
        CompositeTriggeringPolicy policyComposite = CompositeTriggeringPolicy.createPolicy(tbtp, tp);

        String loggerDir = datalogDir + File.separator + loggerName;
        //删除日志的条件
       /* IfFileName ifFileName = IfFileName.createNameCondition(null, loggerName + "\\.\\d{4}-\\d{2}-\\d{2}.*");
        IfLastModified ifLastModified = IfLastModified.createAgeCondition(Duration.parse("1d"));
        DeleteAction deleteAction = DeleteAction.createDeleteAction(
                loggerDir, false, 1, false, null,
                new PathCondition[]{ifLastModified, ifFileName}, null, config);
        Action[] actions = new Action[]{deleteAction};*/

        DefaultRolloverStrategy strategy = DefaultRolloverStrategy.createStrategy(
                "100000", "1", null, null, null, false, config);
        ThresholdFilter filter = ThresholdFilter.createFilter(Level.INFO, Filter.Result.ACCEPT, DENY);
        ThresholdFilter denyWarnFilter = ThresholdFilter.createFilter(Level.WARN, DENY, Filter.Result.NEUTRAL);
        RollingFileAppender appender = RollingFileAppender.newBuilder()
                .withFilter(filter)
                .withFilter(denyWarnFilter)
                .withFileName(loggerDir + "-info.log")
                .withFilePattern(datalogDir + File.separator + "${date:yyyy-MM}" + File.separator + "info-%d{yyyy-MM-dd}-" + loggerName + ".%i.log")
                .withAppend(true)
                .withStrategy(strategy)
                .withName(loggerName + INFO)
                .withPolicy(policyComposite)
                .withLayout(layout)
                .withConfiguration(config)
                .build();
        appender.start();
        config.addAppender(appender);
        ThresholdFilter filterError = ThresholdFilter.createFilter(Level.ERROR, Filter.Result.ACCEPT, DENY);
        RollingFileAppender appenderError = RollingFileAppender.newBuilder()
                .withFilter(filterError)
                .withFileName(loggerDir + "-error.log")
                .withFilePattern(datalogDir + File.separator + "${date:yyyy-MM}" + File.separator + "error-%d{yyyy-MM-dd}-" + loggerName + ".%i.log")
                .withAppend(true)
                .withStrategy(strategy)
                .withName(loggerName + ERROR)
                .withPolicy(policyComposite)
                .withLayout(layout)
                .withConfiguration(config)
                .build();
        appenderError.start();
        config.addAppender(appenderError);

        AppenderRef refInfo = AppenderRef.createAppenderRef(loggerName + INFO, null, null);
        AppenderRef refError = AppenderRef.createAppenderRef(loggerName + ERROR, null, null);
        AppenderRef[] refs = new AppenderRef[]{refInfo, refError};
        LoggerConfig loggerConfig = LoggerConfig.createLogger(false,
                Level.INFO, loggerName, "true", refs, null, config, null);
        loggerConfig.addAppender(appender, Level.INFO, null);
        loggerConfig.addAppender(appenderError, Level.ERROR, null);
        config.addLogger(loggerName, loggerConfig);
        ctx.updateLoggers();
    }

    /**
     * 使用完之后记得调用此方法关闭动态创建的logger，避免内存不够用或者文件打开太多
     */
    public static void stop(BusinessEnum businessEnum) {
        String loggerName = businessEnum.getMessage();
        synchronized (config) {
            config.getAppender(loggerName + INFO).stop();
            config.getAppender(loggerName + ERROR).stop();
            config.getLoggerConfig(loggerName).removeAppender(loggerName + INFO);
            config.getLoggerConfig(loggerName).removeAppender(loggerName + ERROR);
            config.removeLogger(loggerName);
            ctx.updateLoggers();
        }
    }

    /**
     * 获取Logger
     */
    public static Logger getLogger(BusinessEnum lotteryType) {
        String loggerName = lotteryType.getMessage();
        synchronized (config) {
            if (!config.getLoggers().containsKey(loggerName)) {
                start(loggerName);
            }
        }
        return LogManager.getLogger(loggerName);
    }
}
//  LotteryType 是一个枚举类，用来获取不同名称的日志，做业务分割

代码动态配置

1. 系统逻辑日志
 private static Logger log = LogManager.getLogger(BranchController.class);// 传入类class
 
2.自定义业务日志
private static Logger log = LogUtil.getLogger(LotteryType.FIVE);// lottryType为业务名称枚举，根据需求添加

代码中具体使用

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

private static Logger log = LogManager.getLogger(CapitalDetailService.class);
  
  
log.info("日志信息")
参考资料

日志工具现状调研
Log4j2官方文档
Log4j2官方文档翻译

更多文章

log4j2自定义动态配置日志
开关配置springboot定时任务
重复请求的幂等接口设计的思考（一）
三年程序员的第一篇公号文章
自动化远程登陆操作和传输文件（scp ssh expect)

长按二维码关注，阅读我的程序员故事


梦江黎
关注
专栏目录
log4j2自定义参数动态打印到日志中，解决配置文件只能写死参数的问题
litingyu7758521的博客
08-10 1522
log4j2自定义参数动态打印到日志中，解决配置文件只能写死参数的问题
log4j（二）：动态配置日志输出路径
06-10
NULL 博文链接：https://1017401036.iteye.com/blog/2332210
Log4j自定义Appender介绍
技术博客
01-17 1329
转自 http://gemantic.iteye.com/blog/1234996 最初想要在执行一段业务逻辑的时候调用一个外部接口记录审计信息，一直找不到一个比较优雅的方式，经过讨论觉得log4j自定义的appender或许可以实现此功能。后来就了解了一下log4j的这部分。  Apache Log4j 架构  Apache Log4j是当前在J2EE和J2SE开发中用得最多的
java日志框架之Log4j
最新发布
从基础到源码解析的学习记录
09-23 3503
Log4j是Apache的一个开源项目可以控制日志信息输出到控制台文件、甚至是数据库中可以控制每一条日志的输出格式通过一个配置文件来灵活地进行配置，而不需要修改应用的代码主要由Loggers (日志记录器)、Appenders（输出控制器）和 Layout（日志格式化器）组成Loggers：控制日志的输出级别与日志是否输出Appenders：指定日志的输出方式（输出到控制台、文件等）Layout：控制日志信息的输出格式；源码默认从类路径找。
Log4j2实现不同线程不同级别日志输出到不同的文件中
weixin_34233856的博客
04-26 1111
2019独角兽企业重金招聘Python工程师标准>>> ...
log4j控制台输出所有内容_Spring Boot自定义log4j日志输出
weixin_40000702的博客
11-26 602
log4j提供了标准的日志输出，简单配置即可记录日志（参考null：Spring Boot使用AOP实现拦截器​zhuanlan.zhihu.com 8、日志记录），但使用默认Appender记录日志时，有时并不能满足我们的需求，这时我们可以自定义log4j日志输出格式。下面我们实现按日期记录日志，日志达到指定大小后重命名保存为新文件。首先新建GlobalRollingFileAppender继承...
根据系统属性、环境变量动态设置LOG4J2日志路径
xiaokanfuchen86的博客
09-04 2062
log4j
log4j2动态修改日志级别及拓展性使用详解
08-26
log4j2动态修改日志级别及拓展性使用详解 log4j2是一个流行的Java日志记录库，提供了许多强大的功能，包括动态修改日志级别和拓展性使用。下面将详细介绍log4j2动态修改日志级别及拓展性使用。 一、log4j2动态修改...
log4j自定义日志文件名及日志输出格式
01-15
Log4j是Apache提供的一款广泛使用的日志框架，它提供了丰富的配置选项，允许开发者灵活地控制日志输出。当我们面对特定项目需求，比如需要自定义日志文件名和日志输出格式时，Log4j同样提供了相应的解决方案。 首先...
log4j日志配置以及配置文件详解
10-16
Log4j作为Java领域广泛应用的日志框架，提供了强大的日志记录功能和灵活的配置。本文将深入探讨log4j的配置以及配置文件的详解。** 首先，我们要理解什么是`log4j.properties`文件。这是log4j框架的配置文件，使用...
使用log4j2实现日志数据脱敏
05-08
Log4j2是Apache软件基金会开发的日志框架Log4j的升级版，它具有更高的性能、灵活性和可配置性。Log4j2支持多种日志记录级别（如DEBUG、INFO、WARN、ERROR），并允许通过XML、JSON、YAML或纯Java配置文件进行灵活配置...
log4j2自定义日志级别，日志文件单独存储
hm073的专栏
12-12 1219
一、自定义日志级别 1、定义日志级别 import org.apache.logging.log4j.Level; import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; public class CustomLogUtils { //定义公共处理类 public Logger logger = LogManager.getLogger(this.getClass());
[Spring] log4j2.xml中如何动态加载日志文件路径
清风半夜鸣蛙
10-07 2497
注：仅仅只是针对Spring的项目，不涉及SpringBoot，SpringCloud 项目场景： 项目框架是Spring+SpringMVC+MyBatis。项目启动的时候是加载不同的配置文件然后达到不同的环境的这种效果。可以这样理解，项目中存在a.properties，b.properties，c.properties，d.properties四个配置文件，然后还有一个配置叫boot.properties文件。部署是这样的，当你要部署环境的时候，你部署a环境，那么war包中得boot.propertie
Log4j的自定义logger
Leon_Jinhai_Sun的博客
05-05 1500
自定义Logger # RootLogger配置 log4j.rootLogger = trace,console # 自定义Logger log4j.logger.com.itheima = info,file log4j.logger.org.apache = error @Test public void testCustomLogger() throws Exception { ...
在线上环境如何动态修改Log4j2的日志级别？
悠杨的专栏
11-20 1080
为了排查线上问题需要动态的调整日志级别，比如调低某些类的日志级别，打印更多的有用日志信息，方便问题的排查。对于Log4j2，动态调整日志级别有JMX和编程两种方式，推荐使用编程的方式，更灵活方便。
log4j自定义日志
qq_44109896的博客
01-06 597
log4j自定义日志，输出内容加IP地址 log4j.properties log4j.rootLogger=stdout,error,info #\u8F93\u51FA\u5230\u63A7\u5236\u53F0 log4j.appender.stdout=org.apache.log4j.ConsoleAppender log4j.appender.stdout.target=Syst...
Log4j自定义Appender输出日志内容
bird_tp的博客
02-11 4450
一、Log4j知识了解 在自定义Appende之前，我们先来简单了解下Log4j 1、Log4j是什么 Log4j是由Apache提供的日志操作包，用于帮助用户处理日志信息。 2、log4j的作用 log4j提供了方法使我们能将日志信息分级存储。其次，log4j提供了日志不同的存储方式，我们可以将日志发送到控制台，或者文件，或者数据库中等等。 3、Log4j三大组件 Logger：日志写出器，负责供客户端代码调用，用于输入日志信息。Log4j 允许开发人员定义多个Logger，每个Logger
Log4j2 使用自定义Logger， Log中打印不出类名
热门推荐
z69183787的专栏
08-29 1万+
配置文件： <RollingRandomAccessFile name="lotteryLog" fileName="${LOG_HOME}/lottery.log" filePattern="${LOG_HOME}/lottery.%d{yyyy-MM-dd}-%i.log.gz" append="true">
java log4j 自定义日志_Log4j自定义日志输出
weixin_42310348的博客
02-16 1063
前说一下业务需求：因代码当中调用了第三个接口，所以要对第三方接口单独记录日志，所以配置log4j指定此类的日志输出到指定的文件路径与文件上。不多说看源码：Java代码log4j.rootLogger=ERROR, stdout ,logfilelog4j.logger.org.apache=WARNlog4j.logger.com.opensymphony=WARNlog4j.logger.net...
Java Log4j 自定义定时打印日志及模块名配置
"Log4j定时打印日志及添加模块名配置的Java代码实例" Log4j是一个广泛使用的开源Java日志框架，由Apache软件基金会开发。它提供了灵活的日志记录功能，允许开发者控制日志信息的输出级别、格式以及存储方式。在Log4...
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值