SpringBoot+Logback实现日志输出

开言

在日常项目中，我们有可能会遇到各式各样的异常错误。而排查这些异常的最有效的入口就是分析日志。所以，每一个线上的项目都必须要有一套完成的打印机制。以确保系统出问题之后可以有根可续。
本文我们将结合logback在我们的项目中添加日志打印及落地的功能。这里并不需要任何的添加依赖操作，因为Springboot其实已经有帮我们结合了logback的依赖。有兴趣的同学可以点开一下项目的parent就可以找到。

操作

logback配置文件
在resource目录里面添加一个日志配置文件。这里我把它命名为logback-spring.xml

<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <contextName>logbackcontextName>
    
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss} [%thread] %-5level %logger{36} - %msg%npattern>
        encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            
            <level>infolevel>
            
            <onMatch>ACCEPTonMatch>
            
            <onMismatch>DENYonMismatch>
        filter>
    appender>
    
    <appender name="logFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <Prudent>truePrudent>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            
            <FileNamePattern>
                logs/%d{yyyy-MM-dd}/%d{yyyy-MM-dd}.log
            FileNamePattern>
        rollingPolicy>
        <layout class="ch.qos.logback.classic.PatternLayout">
            <Pattern>
                %d{yyyy-MM-dd HH:mm:ss} -%msg%n
            Pattern>
        layout>
    appender>

    <root level="info">
        <appender-ref ref="console"/>
        <appender-ref ref="logFile"/>
    root>
configuration>

修改yml配置
springboot在yml里面提供了详细的log配置。但由于我们最后使用xml的方式，所以这里我们只需要把配置信息指定到我们刚刚的xml文件即可。

server:
  port: 8080
logging:
  config: classpath:logback-spring.xml

添加log打印
添加log打印有两种，第一种就是引入lombok使用注解。但由于lombok的使用会对项目以后升级带来步方便性。所以我选择传统的方式

private final Logger logger = LoggerFactory.getLogger(BaseController.class);

最终就会得到类似这样的代码来打印我们需要的log。

@RestController
@Controller
public class BaseController {

    private final Logger logger = LoggerFactory.getLogger(BaseController.class);

    @GetMapping("/hello/{name}")
    public APIResultBody sayHello(@PathVariable("name") String name){

        logger.info("input: {}",name);

        String result = "Hello " + name + ", here is base boot.";

        if("error".equals(name)){
            throw new SysException(HttpExceptionCode.SERVER_BUSY);
        }

        return APIResultBody.success(result);
    }

}

结果

最后，我们的log引入就成功了。这里给大家看一下添加后的项目结构。当我们启动项目之后，就可以看到多了一个logs目录，里面存放着当天的日志。


这里给个小提醒，因为这个修改会造成项目内多一个目录。而这个目录我们不需要上传到代码仓库上的。所以记得在.gitignore文件里添加如下代码，以忽略这个文件。

### log ###
logs/

附录

课题目录：https://blog.csdn.net/turkeym4/article/details/106761043
项目地址：https://gitee.com/turkeymz/baseboot