Spring如何按業(yè)務(wù)模塊輸出日志到不同的文件詳解

更新時(shí)間：2022年05月06日 16:29:50 作者：huan1993

最近做項(xiàng)目時(shí)有一個(gè)記錄操作日志的需求,比如某個(gè)用戶(hù)進(jìn)行了查詢(xún)、刪除、修改等操作,下面這篇文章主要給大家介紹了關(guān)于Spring如何按業(yè)務(wù)模塊輸出日志到不同文件的相關(guān)資料,需要的朋友可以參考下

一、背景

在我們開(kāi)發(fā)的過(guò)程中，可能存在如下情況：

1、有些時(shí)候我們需要調(diào)用第三方的接口，一般情況下，調(diào)用接口，我們都會(huì)記錄請(qǐng)求的入?yún)⒑晚憫?yīng)的。如果我們自己系統(tǒng)的日志和第三方的日志混合到一個(gè)日志文件中，那么可能查找日志就比較麻煩了。那么我們是否可以將第三方系統(tǒng)的日志單獨(dú)放到另外的文件中呢？

2、或者有些時(shí)候我們系統(tǒng)需要進(jìn)行數(shù)據(jù)遷移，如果某條數(shù)據(jù)遷移失敗了，是否單獨(dú)放到一個(gè)日志文件中比較清晰呢？

二、需求

從上圖中可以看到我們的需求比較簡(jiǎn)單

1、系統(tǒng)啟動(dòng)日志和 login 模塊日志記錄到 springboot-spring.log 文件中。

2、第三方業(yè)務(wù)(QQ)模塊的日志記錄到 springboot-qq.log文件中。

3、第三方業(yè)務(wù)(QQ)模塊提供了一個(gè)login(loginName)方法，方法的入?yún)oginName需要記錄到springboot-qqLoginName.log文件中，模擬一、背景中提到的數(shù)據(jù)遷移失敗，記錄失敗的數(shù)據(jù)到單獨(dú)的日志文件中。

三、技術(shù)實(shí)現(xiàn)

1、采用的日志框架

此處使用logback來(lái)完成日志的記錄，因?yàn)镾pringBoot應(yīng)用程序默認(rèn)的就是采用的logback來(lái)記錄日志。

2、如果實(shí)現(xiàn)分模塊、分文件記錄日志1、編寫(xiě)appender，這個(gè)可以簡(jiǎn)單的理解日志需要輸出到哪里。

比如：

<!-- 此處定義的日志輸出到控制臺(tái) -->
<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [${PID:- }] [%thread] %-5level %logger{50}#%method:%L -%msg%n</pattern>

    </encoder>
</appender>

<!-- 此處定義日志輸出到 springboot-qq-日期.第幾個(gè).log 文件中 -->
<appender name="qqAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
        <fileNamePattern>logs/springboot-qq-%d{yyyy-MM-dd}-.%i.log</fileNamePattern>
    </rollingPolicy>
   
</appender>

2、如何實(shí)現(xiàn)模塊輸出日志

此處就需要我們來(lái)配置 logger了。logger的name屬性指定到具體的全包名，然后引用我們上面定義的appender即可。

<!-- 在QQ這個(gè)包下的日志單獨(dú)使用 qqAppender 來(lái)輸出 -->
<logger name="com.huan.springboot.qq" level="info" additivity="false">
    <appender-ref ref="qqAppender"/>
    <appender-ref ref="stdout"/>
</logger>

配置logger，logger的name為需要單獨(dú)生成文件的那個(gè)包的全包名，然后在里面引用上面定義的appender

3、如果實(shí)現(xiàn)將loginName輸出到指定的文件

其實(shí)還是使用 logger 來(lái)實(shí)現(xiàn)，logger的name需要和 LoggerFactory.getLogger("此處寫(xiě)具體logger的name的值")

注意：

此處可能有一個(gè)坑，就是可能會(huì)丟失類(lèi)名，那么我們?nèi)绾芜M(jìn)行解決呢？可以通過(guò)MDC來(lái)解決。

.... %X{CLASSNAME}#%method:%L -%msg%n

MDC.put("CLASSNAME", QQService.class.getName());
qqLoginName.info("登錄用戶(hù):[{}]", loginName);

即xml中使用%X{CLASSNAME}，在java代碼中使用MDC存入CLASSNAME的值。

四、代碼實(shí)現(xiàn)

1、編寫(xiě)xml日志文件

1、編寫(xiě)appender

1、輸出日志到控制臺(tái)

<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [${PID:- }] [%thread] %-5level %logger{50}#%method:%L -%msg%n</pattern>
        <charset>UTF-8</charset>
    </encoder>
</appender>

2、編寫(xiě)login模板的日志

<appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>logs/springboot-spring-%d{yyyy-MM-dd}-.%i.log</fileNamePattern>
            <maxHistory>7</maxHistory>
            <maxFileSize>1MB</maxFileSize>
            <totalSizeCap>2GB</totalSizeCap>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [${PID:- }] [%thread] %-5level %logger{50}#%method:%L -%msg%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

3、編寫(xiě)qq模板的日志

<appender name="qqAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>logs/springboot-qq-%d{yyyy-MM-dd}-.%i.log</fileNamePattern>
            <maxHistory>7</maxHistory>
            <maxFileSize>1MB</maxFileSize>
            <totalSizeCap>2GB</totalSizeCap>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [${PID:- }] [%thread] %-5level %logger{50}#%method:%L -%msg%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

4、編寫(xiě)qq模塊loginName單獨(dú)輸出到文件的日志

<appender name="qqLoginNameAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>logs/springboot-qqLoginName-%d{yyyy-MM-dd}-.%i.log</fileNamePattern>
            <maxHistory>7</maxHistory>
            <maxFileSize>1MB</maxFileSize>
            <totalSizeCap>2GB</totalSizeCap>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [${PID:- }] [%thread] %-5level %X{CLASSNAME}#%method:%L -%msg%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

2、配置日志輸出到具體位置

1、配置login模塊

<root level="INFO">
    <appender-ref ref="stdout"/>
    <appender-ref ref="file"/>
</root>

login模塊屬于我們自己的系統(tǒng)模塊，此處使用 root標(biāo)簽來(lái)配置。

2、配置qq模塊

<!-- 在QQ這個(gè)包下的日志單獨(dú)使用 qqAppender 來(lái)輸出 -->
<logger name="com.huan.springboot.qq" level="info" additivity="false">
    <appender-ref ref="qqAppender"/>
    <appender-ref ref="stdout"/>
</logger>

此處name的值直接指定到了qq的全包名路徑。

3、配置loginName單獨(dú)輸出到文

<!-- 將所有的QQ登錄名防止在另外的文件中 -->
<logger name="qqLoginName" level="info" additivity="false">
    <appender-ref ref="qqLoginNameAppender"/>
    <appender-ref ref="stdout"/>
</logger>

2、編寫(xiě)QQ模塊的代碼

@Component
public class QQService {

    private static final Logger log = LoggerFactory.getLogger(QQService.class);

    // getLogger("qqLoginName") 里的 qqLoginName 需要和 logback-spring.xml 中 logger的name一致，才會(huì)應(yīng)用
    private static final Logger qqLoginName = LoggerFactory.getLogger("qqLoginName");

    public void login(String loginName) {
        log.info("QQ業(yè)務(wù): 用戶(hù):[{}]開(kāi)始使用QQ來(lái)登錄系統(tǒng)", loginName);

        MDC.put("CLASSNAME", QQService.class.getName());
        qqLoginName.info("登錄用戶(hù):[{}]", loginName);
    }
}

3、編寫(xiě)login模塊的代碼

@RestController
public class LoginController {

    private static final Logger log = LoggerFactory.getLogger(LoginController.class);

    @Resource
    private QQService qqService;

    @GetMapping("login/{loginName}")
    public String login(@PathVariable("loginName") String loginName) {
        log.info("自己業(yè)務(wù)：用戶(hù):[{}]進(jìn)行登錄", loginName);
        qqService.login(loginName);
        return "ok";
    }
}