• logback自定义appender

    1、定义appender

    1.1 logback.xml配置

    1. <?xml version="1.0" encoding="UTF-8"?>
    2. <configuration>
    3.     <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径 -->
    4.     <!-- <property name="LOG_HOME" value="d:" /> -->
    5.  
    6.     <!-- ch.qos.logback.core.ConsoleAppender 控制台输出 -->
    7.     <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
    8.         <encoder>
    9.             <pattern>[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %logger{36} - %msg%n
    10.             </pattern>
    11.         </encoder>
    12.     </appender>
    13.  
    14.  
    15.     <!-- 自定义文件输出-错误日志 -->
    16.     <appender name="ErrorFile" class="com.ybw.logback.demo.filter.LogFileAppender">
    17.         <File>${LOG_HOME:-c:/}logs/error/error.log</File>
    18.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    19.             <FileNamePattern>${LOG_HOME:-c:/}logs/error/error-%d{yyyy-MM-dd}.%i.log
    20.             </FileNamePattern>
    21.             <MaxHistory>30</MaxHistory>
    22.             <TimeBasedFileNamingAndTriggeringPolicy
    23.                     class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
    24.                 <MaxFileSize>100MB</MaxFileSize>
    25.             </TimeBasedFileNamingAndTriggeringPolicy>
    26.         </rollingPolicy>
    27.         <filter class="ch.qos.logback.classic.filter.LevelFilter"><!-- 只打印错误日志 -->
    28.             <level>ERROR</level>
    29.             <onMatch>ACCEPT</onMatch>
    30.             <onMismatch>DENY</onMismatch>
    31.         </filter>
    32.         <encoder charset="UTF-8">
    33.             <pattern>[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %logger{36} - %msg%n</pattern>
    34.         </encoder>
    35.     </appender>
    36.  
    37.  
    38.     <root level="info">
    39.         <appender-ref ref="stdout"/>
    40.         <appender-ref ref="ErrorFile"/>
    41.     </root>
    42. </configuration>

     1.2 自定义appender代码

    1. package com.ybw.logback.demo.filter;
    2.  
    3. import ch.qos.logback.core.encoder.Encoder;
    4. import ch.qos.logback.core.rolling.RollingFileAppender;
    5. import ch.qos.logback.core.spi.DeferredProcessingAware;
    6. import ch.qos.logback.core.status.ErrorStatus;
    7. import com.ybw.logback.demo.constant.fs.FSConstant;
    8. import com.ybw.logback.demo.utils.FsUtils;
    9.  
    10. import java.io.IOException;
    11.  
    12.  
    13. /**
    14.  * 自定义的appender
    15.  * 1.可以对接受到的event中的日志信息做任何操作处理
    16.  * 2.可以在同步写日志文件的时候，存入MySQL或者es
    17.  *
    18.  * @author ybw
    19.  * @version V1.0
    20.  * @className LogFileAppender
    21.  * @date 2022/9/16
    22.  **/
    23. public class LogFileAppender<E> extends RollingFileAppender<E> {
    24.  
    25.     public void setEncoder(Encoder encoder) {
    26.         //自定义的appender的父类OutputStreamAppender在启动的时候会判断是否有encoder ，无的话自定义appender启动会失败 
    27.         super.setEncoder(encoder);
    28.     }
    29.  
    30.     /**
    31.      * 覆盖父类OutputStreamAppender的日志记录功能，再这里面做日志切操作功能
    32.      *
    33.      * @param event
    34.      */
    35.     protected void subAppend(E event) {
    36.         if (this.isStarted()) {
    37.             try {
    38.                 if (event instanceof DeferredProcessingAware) {
    39.                     ((DeferredProcessingAware) event).prepareForDeferredProcessing();
    40.                 }
    41.                 //根据标签规则拿到日志字符串，这里可以再次修改日志信息
    42.                 byte[] byteArray = super.encoder.encode(event);
    43.                 //做一些日志的特殊处理
    44.                 sendFs(byteArray);
    45. //                writeMongo(...);
    46. //                writeRedis(...);
    47. //                writeMq(...);
    48.                 //写入日志文件
    49.                 writeBytes(byteArray);
    50.             } catch (IOException var3) {
    51.                 this.started = false;
    52.                 this.addStatus(new ErrorStatus("IO failure in appender", this, var3));
    53.             }
    54.         }
    55.     }
    56.  
    57.     /**
    58.      * 飞书报警
    59.      *
    60.      * @param byteArray
    61.      * @methodName: sendFs
    62.      * @return: void
    63.      * @author: ybw
    64.      * @date: 2022/9/15
    65.      **/
    66.     private void sendFs(byte[] byteArray) {
    67.         if (byteArray != null && byteArray.length != 0) {
    68.             this.lock.lock();
    69.             try {
    70.                 FsUtils.sendTextMessage(FSConstant.TextContentEnum.ERROR_LOG, new String(byteArray));
    71.             } finally {
    72.                 this.lock.unlock();
    73.             }
    74.         }
    75.     }
    76.  
    77.     private void writeBytes(byte[] byteArray) throws IOException {
    78.         if (byteArray != null && byteArray.length != 0) {
    79.             this.lock.lock();
    80.             try {
    81.                 this.getOutputStream().write(byteArray);
    82.                 if (this.isImmediateFlush()) {
    83.                     this.getOutputStream().flush();
    84.                 }
    85.             } finally {
    86.                 this.lock.unlock();
    87.             }
    88.         }
    89.     }
    90. }

    1.3 测试

    1. package com.ybw.logback.demo.custom;
    2.  
    3. import lombok.extern.slf4j.Slf4j;
    4. import org.junit.jupiter.api.Test;
    5.  
    6. /**
    7.  * @className CustomLog
    8.  * @author ybw
    9.  * @date 2022/9/15 
    10.  * @version V1.0
    11.  **/
    12. @Slf4j
    13. public class CustomLog {
    14.  
    15.     /**
    16.      *
    17.      * @methodName: print
    18.      * @return: void
    19.      * @author: ybw
    20.      * @date: 2022/9/15
    21.      **/
    22.     @Test
    23.     public void print(){
    24.         log.info("aa");
    25.         log.error("bb");
    26.     }
    27. }

    错误日志、报警内容如下：

    [ERROR] 2022-09-17 18:07:51.577 [main] c.ybw.logback.demo.custom.CustomLog - bb

    2、logback.xml变量使用-spring配置

    logback的变量作用于有三种：local，context，system

    •  local 作用域在配置文件内有效；
    •  context 作用域的有效范围延伸至 logger context；
    •  system 作用域的范围最广，整个 JVM 内都有效；

    logback 在替换变量时，首先搜索 local 变量，然后搜索 context，然后搜索 system，在spring项目中，应将变量的作用域设置为context，并交给spring控制。

    2.1 spring的配置作为变量

    application.yml

    1. server:
    2.   port: 8080
    3. spring:
    4.   application:
    5.     name: logback-online-alarm
    6.   profiles:
    7.     active: dev

    application-dev.yml

    1. #飞书
    2. fs:
    3.   bot:
    4.     webhook:
    5.       suf: /aa #测试

    logback.xml配置如下，PROFILES-ACTIVE、FS-BOT-WEBHOOK-SUF为spring配置文件中的属性

    1. <?xml version="1.0" encoding="UTF-8"?>
    2. <configuration>
    3.     <!--获取spring配置文件的变量-->
    4.     <springProperty scope="context" name="PROFILES-ACTIVE" source="spring.profiles.active" defaultValue=""/>
    5.     <springProperty scope="context" name="FS-BOT-WEBHOOK-SUF" source="fs.bot.webhook.suf" defaultValue=""/>
    6.     <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径 -->
    7.     <!-- <property name="LOG_HOME" value="d:" /> -->
    8.  
    9.     <!-- ch.qos.logback.core.ConsoleAppender 控制台输出 -->
    10.     <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
    11.         <encoder>
    12.             <pattern>[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %logger{36} - %msg%n
    13.             </pattern>
    14.         </encoder>
    15.     </appender>
    16.  
    17.  
    18.  
    19.     <!-- 所有日志输出 -->
    20.     <appender name="AllFile"
    21.               class="ch.qos.logback.core.rolling.RollingFileAppender">
    22.         <File>${LOG_HOME:-c:/}logs/all/all.log</File>
    23.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    24.             <FileNamePattern>${LOG_HOME:-c:/}logs/all/all-%d{yyyy-MM-dd}.%i.log
    25.             </FileNamePattern>
    26.             <MaxHistory>30</MaxHistory>
    27.             <TimeBasedFileNamingAndTriggeringPolicy
    28.                     class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
    29.                 <MaxFileSize>100MB</MaxFileSize>
    30.             </TimeBasedFileNamingAndTriggeringPolicy>
    31.         </rollingPolicy>
    32.         <layout class="ch.qos.logback.classic.PatternLayout">
    33.             <pattern>[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %logger{36} - %msg%n
    34.             </pattern>
    35.         </layout>
    36.     </appender>
    37.  
    38.     <!-- 自定义文件输出-错误日志 -->
    39.     <appender name="ErrorFile" class="com.ybw.logback.demo.config.LogFileAppender">
    40.         <File>${LOG_HOME:-c:/}logs/error/error.log</File>
    41.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    42.             <FileNamePattern>${LOG_HOME:-c:/}logs/error/error-%d{yyyy-MM-dd}.%i.log
    43.             </FileNamePattern>
    44.             <MaxHistory>30</MaxHistory>
    45.             <TimeBasedFileNamingAndTriggeringPolicy
    46.                     class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
    47.                 <MaxFileSize>100MB</MaxFileSize>
    48.             </TimeBasedFileNamingAndTriggeringPolicy>
    49.         </rollingPolicy>
    50.         <filter class="ch.qos.logback.classic.filter.LevelFilter"><!-- 只打印错误日志 -->
    51.             <level>ERROR</level>
    52.             <onMatch>ACCEPT</onMatch>
    53.             <onMismatch>DENY</onMismatch>
    54.         </filter>
    55.         <encoder charset="UTF-8">
    56.             <pattern>[${PROFILES-ACTIVE}] [%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %logger{36} - %msg%n</pattern>
    57.         </encoder>
    58.         <fsSuf>${FS-BOT-WEBHOOK-SUF}</fsSuf>
    59.     </appender>
    60.  
    61.  
    62.     <root level="info">
    63.         <appender-ref ref="stdout"/>
    64.         <appender-ref ref="ErrorFile"/>
    65.         <appender-ref ref="AllFile"/>
    66.     </root>
    67. </configuration>

    2.2 自定义appender代码

    1. package com.ybw.logback.demo.config;
    2.  
    3. import ch.qos.logback.core.encoder.Encoder;
    4. import ch.qos.logback.core.rolling.RollingFileAppender;
    5. import ch.qos.logback.core.spi.DeferredProcessingAware;
    6. import ch.qos.logback.core.status.ErrorStatus;
    7. import com.ybw.logback.demo.constant.fs.FSConstant;
    8. import com.ybw.logback.demo.utils.FsUtils;
    9. import lombok.Data;
    10.  
    11. import java.io.IOException;
    12.  
    13.  
    14. /**
    15.  * 自定义的appender
    16.  * 1.可以对接受到的event中的日志信息做任何操作处理
    17.  * 2.可以在同步写日志文件的时候，存入mysql或者es
    18.  *
    19.  * @author ybw
    20.  * @version V1.0
    21.  * @className LogFileAppender
    22.  * @date 2022/9/16
    23.  **/
    24. @Data
    25. public class LogFileAppender<E> extends RollingFileAppender<E> {
    26.  
    27.     private String fsSuf;
    28.  
    29.     @Override
    30.     public void setEncoder(Encoder encoder) {
    31.         //自定义的appender的父类OutputStreamAppender在启动的时候会判断是否有encoder ，无的话自定义appender启动会失败 
    32.         super.setEncoder(encoder);
    33.     }
    34.  
    35.     /**
    36.      * 覆盖父类OutputStreamAppender的日志记录功能，再这里面做日志切操作功能
    37.      *
    38.      * @param event
    39.      */
    40.     @Override
    41.     protected void subAppend(E event) {
    42.         if (this.isStarted()) {
    43.             System.out.println("fsSuf:"+fsSuf);
    44.             try {
    45.                 if (event instanceof DeferredProcessingAware) {
    46.                     ((DeferredProcessingAware) event).prepareForDeferredProcessing();
    47.                 }
    48.                 //根据标签规则拿到日志字符串，这里可以再次修改日志信息
    49.                 byte[] byteArray = super.encoder.encode(event);
    50.                 //做一些日志的特殊处理
    51.                 sendFs(byteArray);
    52. //                writeMongo(...);
    53. //                writeRedis(...);
    54. //                writeMq(...);
    55.                 //写入日志文件
    56.                 writeBytes(byteArray);
    57.             } catch (IOException var3) {
    58.                 this.started = false;
    59.                 this.addStatus(new ErrorStatus("IO failure in appender", this, var3));
    60.             }
    61.         }
    62.     }
    63.  
    64.     /**
    65.      * 飞书报警
    66.      *
    67.      * @param byteArray
    68.      * @methodName: sendFs
    69.      * @return: void
    70.      * @author: ybw
    71.      * @date: 2022/9/15
    72.      **/
    73.     private void sendFs(byte[] byteArray) {
    74.         if (byteArray != null && byteArray.length != 0) {
    75.             this.lock.lock();
    76.             try {
    77.                 FsUtils.sendTextMessage(FSConstant.TextContentEnum.ERROR_LOG, new String(byteArray));
    78.             } finally {
    79.                 this.lock.unlock();
    80.             }
    81.         }
    82.     }
    83.  
    84.     private void writeBytes(byte[] byteArray) throws IOException {
    85.         if (byteArray != null && byteArray.length != 0) {
    86.             this.lock.lock();
    87.             try {
    88.                 this.getOutputStream().write(byteArray);
    89.                 if (this.isImmediateFlush()) {
    90.                     this.getOutputStream().flush();
    91.                 }
    92.             } finally {
    93.                 this.lock.unlock();
    94.             }
    95.         }
    96.     }
    97. }
    fsSuf为logback.xml配置的属性。

    2.3 测试

    1. package com.ybw.logback.demo.controller;
    2.  
    3. import lombok.extern.slf4j.Slf4j;
    4. import org.springframework.web.bind.annotation.GetMapping;
    5. import org.springframework.web.bind.annotation.RestController;
    6.  
    7. /**
    8.  * @author ybw
    9.  * @version V1.0
    10.  * @className LogController
    11.  * @date 2022/9/16
    12.  **/
    13. @RestController
    14. @Slf4j
    15. public class LogController {
    16.  
    17.     /**
    18.      *
    19.      * @methodName: getLog
    20.      * @return: java.lang.String
    21.      * @author: ybw
    22.      * @date: 2022/9/16
    23.      **/
    24.     @GetMapping("/getLog")
    25.     public String getLog() {
    26.         log.info("aa");
    27.         log.error("bb");
    28.         return "OK";
    29.     }
    30. }

    访问接口：http://localhost:8080/getLog

    错误日志、报警内容如下：

    [dev] [ERROR] 2022-09-17 18:30:31.513 [http-nio-8080-exec-5] c.y.l.demo.controller.LogController - bb

     [dev]为spring.profiles.active。

    3、logback.xml变量使用-配置中心

    以nacos为例

    3.1 配置文件

    bootstrap.yml配置

    1. server:
    2.   port: 8080
    3. spring:
    4.   application:
    5.     name: logback-nacos
    6.   profiles:
    7.     active: dev
    8. logging:
    9.   config: classpath:logback.xml #日志配置要放在nacos配置之后

    bootstrap-dev.yml配置

    1. spring:
    2.   cloud:
    3.     nacos:
    4.       config:
    5.         server-addr: localhost:8848
    6.         username: nacos
    7.         password: nacos
    8.         namespace: nacos-config #命名空间
    9.         #        group: DEFAULT_GROUP #默认DEFAULT_GROUP
    10.         file-extension: yml #配置中心的格式，默认为properties

    配置中心

     logback.xml

    1. <?xml version="1.0" encoding="UTF-8"?>
    2. <configuration>
    3.     <!--获取spring配置文件的变量-->
    4.     <springProperty scope="context" name="PROFILES-ACTIVE" source="spring.profiles.active" defaultValue=""/>
    5.     <springProperty scope="context" name="FS-BOT-WEBHOOK-SUF" source="fs.bot.webhook.suf" defaultValue=""/>
    6.     <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径 -->
    7.     <!-- <property name="LOG_HOME" value="d:" /> -->
    8.  
    9.     <!-- ch.qos.logback.core.ConsoleAppender 控制台输出 -->
    10.     <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
    11.         <encoder>
    12.             <pattern>[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %logger{36} - %msg%n
    13.             </pattern>
    14.         </encoder>
    15.     </appender>
    16.  
    17.  
    18.  
    19.     <!-- 所有日志输出 -->
    20.     <appender name="AllFile"
    21.               class="ch.qos.logback.core.rolling.RollingFileAppender">
    22.         <File>${LOG_HOME:-c:/}logs/all/all.log</File>
    23.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    24.             <FileNamePattern>${LOG_HOME:-c:/}logs/all/all-%d{yyyy-MM-dd}.%i.log
    25.             </FileNamePattern>
    26.             <MaxHistory>30</MaxHistory>
    27.             <TimeBasedFileNamingAndTriggeringPolicy
    28.                     class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
    29.                 <MaxFileSize>100MB</MaxFileSize>
    30.             </TimeBasedFileNamingAndTriggeringPolicy>
    31.         </rollingPolicy>
    32.         <layout class="ch.qos.logback.classic.PatternLayout">
    33.             <pattern>[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %logger{36} - %msg%n
    34.             </pattern>
    35.         </layout>
    36.     </appender>
    37.  
    38.     <!-- 自定义文件输出-错误日志 -->
    39.     <appender name="ErrorFile" class="com.ybw.logback.demo.config.LogFileAppender">
    40.         <File>${LOG_HOME:-c:/}logs/error/error.log</File>
    41.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    42.             <FileNamePattern>${LOG_HOME:-c:/}logs/error/error-%d{yyyy-MM-dd}.%i.log
    43.             </FileNamePattern>
    44.             <MaxHistory>30</MaxHistory>
    45.             <TimeBasedFileNamingAndTriggeringPolicy
    46.                     class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
    47.                 <MaxFileSize>100MB</MaxFileSize>
    48.             </TimeBasedFileNamingAndTriggeringPolicy>
    49.         </rollingPolicy>
    50.         <filter class="ch.qos.logback.classic.filter.LevelFilter"><!-- 只打印错误日志 -->
    51.             <level>ERROR</level>
    52.             <onMatch>ACCEPT</onMatch>
    53.             <onMismatch>DENY</onMismatch>
    54.         </filter>
    55.         <encoder charset="UTF-8">
    56.             <pattern>[${PROFILES-ACTIVE}] [%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %logger{36} - %msg%n</pattern>
    57.         </encoder>
    58.         <fsSuf>${FS-BOT-WEBHOOK-SUF}</fsSuf>
    59.     </appender>
    60.  
    61.  
    62.     <root level="info">
    63.         <appender-ref ref="stdout"/>
    64.         <appender-ref ref="ErrorFile"/>
    65.         <appender-ref ref="AllFile"/>
    66.     </root>
    67. </configuration>

    3.2 自定义appender代码

    与2.2一致。

    3.3 测试

    与2.3一致。

    fsSuf即配置中心的属性，会打印在控制台。

    fsSuf:/aa

  • 相关阅读:
    QT day1
    【开发方案】Android 双卡设备手动搜网功能适配
    【前端工程化】webpack使用require.context批量导入模块
    快捷输入法怎么设置
    杭州跨境电商政策支持
    csdn 格式规范
    达索智能制造解决方案，敏捷电芯制造如何赋能企业竞争力 | 百世慧®
    基于数字孪生的智慧城市是如何发展的？
    为啥小扎一直醉心于元宇宙的布局？
    4.2 数据库安全性控制
  • 原文地址：https://blog.csdn.net/xixingzhe2/article/details/126898788