腳本之家服務(wù)器常用軟件

快捷導(dǎo)航

Java項目如何引入日志生成器及其日志分級

更新時間：2022年12月21日 10:04:59 作者：Amouzy

這篇文章主要介紹了Java項目引入日志生成器及其日志分級,本文結(jié)合示例代碼給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下

項目情況

maven管理依賴的spring（spring-cloud-alibaba）項目，使用idea編譯，jdk版本1.8。

為項目引入日志生成器，為方便依賴管理，決定采用Lombok自帶的Slf4j，加上logstash-logback-encoder，實現(xiàn)日志分級輸出到文件和控制臺。

依賴引入

項目pom文件里添加以下依賴，然后重新加載依賴。

        <!-- lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.24</version>
            <scope>provided</scope>
        </dependency>
        
        <!-- https://mvnrepository.com/artifact/net.logstash.logback/logstash-logback-encoder -->
        <dependency>
            <groupId>net.logstash.logback</groupId>
            <artifactId>logstash-logback-encoder</artifactId>
            <version>4.11</version>
        </dependency>

bootstrap.yml文件添加內(nèi)容

bootstrap.yml是spring cloud的配置文件，可以存在多個，在指定的bootstrap.yml文件里，添加日志相關(guān)配置。

logging:
  file:
    path: logs #content root目錄下的logs文件夾存放日志，不存在則創(chuàng)建
  level: #設(shè)置指定包下的日志級別
    com:
      alibaba:
        nacos:
          client:
            config:
              impl: warn
      example: debug
    org:
      apache:
        ibatis:
          logging:
            jdbc: debug
  pattern: # 日志輸出格式
    console:%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n

添加日志生成器配置文件

在resources文件夾下新增兩個文件logback-json.xml、logback-spring.xml。

logback-json.xml

<included>
    <property name="JSON_LOG_FILE" value="${LOG_PATH}/${LOG_NAME}.json"/>
    <property name="JSON_ROLLING_FILE_NAME_PATTERN" value="${JSON_LOG_FILE}.%d{yyyy-MM-dd}.%i" />


    <appender name="JSON_FILE"
              class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${JSON_LOG_FILE}</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <cleanHistoryOnStart>${LOG_FILE_CLEAN_HISTORY_ON_START:-false}</cleanHistoryOnStart>
            <fileNamePattern>${JSON_ROLLING_FILE_NAME_PATTERN:-${JSON_LOG_FILE}.%d{yyyy-MM-dd}.%i.gz}</fileNamePattern>
            <maxFileSize>${LOG_FILE_MAX_SIZE:-512MB}</maxFileSize>
            <maxHistory>${LOG_FILE_MAX_HISTORY:-30}</maxHistory>
            <totalSizeCap>${LOG_FILE_TOTAL_SIZE_CAP:-0}</totalSizeCap>
        </rollingPolicy>
        <encoder class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
            <providers>
                <timestamp>
                    <timeZone>UTC</timeZone>
                </timestamp>
                <pattern>
                    <pattern>
                        {
                        "serviceName": "${LOG_NAME}",
                        "level": "%level",
                        "trace": "%X{X-B3-TraceId:-}",
                        "span": "%X{X-B3-SpanId:-}",
                        "parent": "%X{X-B3-ParentSpanId:-}",
                        "thread": "%thread",
                        "class": "%logger{40}",
                        "message": "%message",
                        "exception": "%exception{10}"
                        }
                    </pattern>
                </pattern>
            </providers>
        </encoder>
    </appender>
</included>

logback-spring.xml

<?xml version="1.0" encoding="UTF-8" ?>
<configuration scan="true" scanPeriod="60 seconds">

    <springProperty scope="context" name="LOG_NAME" source="spring.application.name"/>
    <springProperty scope="context" name="LOG_PATH" source="logging.file.path"/>


    <!-- 日志屬性配置 -->
    <property name="LOG_FILE" value="${LOG_PATH}/${LOG_NAME}.log"/>
    <property name="LOG_FILE_CLEAN_HISTORY_ON_START" value="false" />
    <property name="ROLLING_FILE_NAME_PATTERN" value="${LOG_FILE}.%d{yyyy-MM-dd}.%i" />
    <property name="LOG_FILE_MAX_SIZE" value="512MB" />
    <property name="LOG_FILE_MAX_HISTORY" value="30" />


    <!--引入默認(rèn)的一些設(shè)置-->
    <include resource="logback-json.xml" />


    <contextName>${LOG_NAME}</contextName>
    <appender name="consoleLog" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化輸出（配色）：%d表示日期，%thread表示線程名，%-5level：級別從左顯示5個字符寬度%msg：日志消息，%n是換行符-->
            <pattern>%boldMagenta(%d{yyyy-MM-dd HH:mm:ss}) %green([%thread]) %highlight(%-5level) %cyan(%logger{50}) - %msg %n</pattern>
        </encoder>
    </appender>


    <!--根據(jù)日志級別分離日志，分別輸出到不同的文件-->
    <appender name="debugLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>debug</level>
        </filter>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>
                %d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n
            </pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!--滾動策略-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--按時間保存日志 修改格式可以按小時、按天、月來保存-->
            <fileNamePattern>${LOG_PATH}/${LOG_NAME}-debug.%d{yyyy-MM-dd}.log</fileNamePattern>
            <!--保存時長-->
            <MaxHistory>${LOG_FILE_MAX_HISTORY}</MaxHistory>
            <!--文件大小-->
            <totalSizeCap>${LOG_FILE_MAX_SIZE}</totalSizeCap>
        </rollingPolicy>
    </appender>


    <!--根據(jù)日志級別分離日志，分別輸出到不同的文件-->
    <appender name="infoLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level>
        </filter>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>
                %d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n
            </pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!--滾動策略-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--按時間保存日志 修改格式可以按小時、按天、月來保存-->
            <fileNamePattern>${LOG_PATH}/${LOG_NAME}-info.%d{yyyy-MM-dd}.log</fileNamePattern>
            <!--保存時長-->
            <MaxHistory>${LOG_FILE_MAX_HISTORY}</MaxHistory>
            <!--文件大小-->
            <totalSizeCap>${LOG_FILE_MAX_SIZE}</totalSizeCap>
        </rollingPolicy>
    </appender>


    <appender name="errorLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERROR</level>
        </filter>
        <encoder>
            <pattern>
                %d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n
            </pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!--滾動策略-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--路徑-->
            <fileNamePattern>${LOG_PATH}/${LOG_NAME}-error.%d{yyyy-MM-dd}.log</fileNamePattern>
            <!--保存時長-->
            <MaxHistory>${LOG_FILE_MAX_HISTORY}</MaxHistory>
            <!--文件大小-->
            <totalSizeCap>${LOG_FILE_MAX_SIZE}</totalSizeCap>
        </rollingPolicy>
    </appender>


    <springProfile name="local">
        <root level="debug">
            <appender-ref ref="consoleLog"/>
        </root>
    </springProfile>


    <springProfile name="dev">
        <root level="info">
            <appender-ref ref="consoleLog"/>
            <appender-ref ref="infoLog"/>
            <appender-ref ref="errorLog"/>
            <appender-ref ref="JSON_FILE" />
        </root>
    </springProfile>

    <springProfile name="test">
        <root level="info">
            <appender-ref ref="infoLog"/>
            <appender-ref ref="errorLog"/>
            <appender-ref ref="JSON_FILE" />
        </root>
    </springProfile>

    <springProfile name="prod">
        <root level="info">
            <appender-ref ref="consoleLog"/>
            <appender-ref ref="infoLog"/>
            <appender-ref ref="errorLog"/>
            <appender-ref ref="JSON_FILE" />
        </root>
    </springProfile>
</configuration>

使用

if (log.isDebugEnabled()) {
    log.info("測試日志");
}

2022-12-20 16:28:54 [http-nio-8088-exec-1] INFO  com.example.interfaces.UserController - 測試日志

到此這篇關(guān)于Java項目引入日志生成器及其日志分級的文章就介紹到這了,更多相關(guān)Java項目日志分級內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章:

欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

Java項目如何引入日志生成器及其日志分級

目錄

項目情況

依賴引入

bootstrap.yml文件添加內(nèi)容

添加日志生成器配置文件

使用

相關(guān)文章

最新評論

大家感興趣的內(nèi)容

最近更新的內(nèi)容

常用在線小工具