SpringBoot (八）日志配置

SpringBoot日志：Springboot内部采用的是Commons Logging 进行日志记录，但在底层为Java Util，Loggin,Log4J,Logback等日志框架提供默认配置，虽然有很多可用日志框架，一般使用SpringBoot默认的Logback即可，Logback效率更高，支持SLF4J。

1. 日志依赖：

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

注：spring-boot-starter中包含了springboot-starter-logging

2. 日志格式：

注：输出如下内容：

时间日期：精确到毫秒，可以用于排序日志级别：ERROR,WARN,INFO,DEBUG,TRACE;

进程ID: 分割符：采用---来标识日志开始部分；

线程名：方括号括起来； Logger名：通常使用源代码的类名；

日志内容：日志输出的信息

3.日志输出级别：

SpringBoot默认输出的日志级别为：INFO,WARN,ERROR;

日志级别从低到高为：TRACE<DEBUG<INFO<WARN<ERROR<FATA 若设置为WARN 则低于WARN级别的信息不会输出

如需输出更多日志可以通过以下方式开启：

命令模式配置：Java -jar app.jar -debug=true 这种命令会被SpringBoot解析，优先级最高；

资源文件配置：application.properties 配置debug=true 即可

4.输出级别配置：

所有支持的日志记录系统都可以在spring环境中设置记录级别（application.properties）

格式为：logging.level.* = LEVEL;

loggging.level :日志级别控制前缀，*为表名或loggger名；

LEVEL 选项：TRACE,DEBUG,INFO,WARN,ERROR,FATAL,OFF;

例子：logging.level.root =DEBUG root日志以DEUBG级别输出；

logging.level.com.wuxia=DEBUG com.wuxia包下的所有class以DEBUG级别输出；

#日志配置
logging.level.root=info
logging.level.org.springframework.web=debug
logging.level.org.mybatis= INFO
logging.level.com.com.fyl.navigation.dao=debug

5.日志输出位置：

默认情况下，Springboot仅将日志输出到控制台，不会写入到日志文件中去，如果除了控制台输出之外还想写日志文件，则需要在application.proterties设置logging.file或logging.path属性；

logging.file :将日志写入到指定的文件中，默认为相对路径，可以设置为绝对路径。

logging.path:将名为spring.log写入到指定的文件夹中

注：如果只配置logging.file,会在项目的当前路径下生成一个xxx.log日志文件

如果只配置logging.path,会在指定文件夹下生成一个日志文件spring.log 二者不能同时用，同时用只logging.file生效；

默认日志文件达到10MB时进行切割，产生新的日志文件：（spring.1.log,spring.2.log）；

    logging.file.max-size=10MB
    logging.file.max-history=10

6.自定义日志配置

日志文件一般在ApplcationContext创建前就初始化了，所以不是必须通过spring的配置文件控制，可以外部添加配置文件控制日志：

根据不同的日志系统，按如下规则建立配置文件名，就可以被加载：

Logback:logback-spring.xml,logback-spring.groovy,logback.xml,logback.groovy;

Log4j:log4j-spring.properties,log4j-spring.xml,log4j.properties,log4j.xml;

推荐使用带有spring的文件名作为日志文件；一般使用logback-spring.xml 作为配置文件；文件放在resources下；

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <!--定义日志文件的存储地址：-->
    <property name="LOG_HOME" value="D:/logs"></property>
    <property name="LOG_NAME" value="logs"></property>
    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter"/>

    <conversionRule conversionWord="wex"
                    converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter"/>
    <conversionRule conversionWord="wEx"
                    converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter"/>
 
    <!--定义文件输出格式-->
    <property name="FILE_LOG_PATTERN"
              value="${FILE_LOG_PATTERN:-%d{yyyy-MM-dd HH:mm:ss.SSS} ${LOG_LEVEL_PATTERN:-%5p} ${PID:- } --- [%t] %-40.40logger{39} : %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>

    <property name="CONSOLE_LOG_PATTERN"
              value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
    <!--注意：日志级别文件
                     日志记录采用分级记录，级别与日志文件名相对应，不同级别的日志信息记录到不同的日志文件中：
    -->
    <appender name="consoleLog" class="ch.qos.logback.core.ConsoleAppender">
        <layout class="ch.qos.logback.classic.PatternLayout">D
            <pattern>
                ${CONSOLE_LOG_PATTERN}
            </pattern>
        </layout>
    </appender>
    <appender name="fileInfoLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <encoder> <!--<encoder>表示对日志进行编码-->
            <pattern>${FILE_LOG_PATTERN}</pattern><!-- 日志格式 -->
            <charset>utf-8</charset><!--编码方式 -->
        </encoder>
        <file>${LOG_HOME}/${LOG_NAME}-all.log</file> <!--输出文件位置及文件名-->
        <!--日志记录器的滚动策略，按日期，大小记录-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern> <!-- 归档日志文件路径 -->
                ${LOG_HOME}/backup/${LOG_NAME}-log-all-%d{yyyy-MM-dd}.%i.log
            </fileNamePattern>
            <maxHistory>30</maxHistory><!-- 保留最近30天 -->
            <totalSizeCap>1GB</totalSizeCap><!--指定日志文件上限，到达上限删除旧文件 -->
            <cleanHistoryOnStart>true</cleanHistoryOnStart>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>5MB</maxFileSize><!-- 日志文件不超过5M,超过拆分文件 -->
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
    </appender>
    <appender name="fileErrorLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--filter为系统定义的拦截器，使用ThresholdFilter来过滤掉ERROR级别以下的日志文件不输出到文件-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERROR</level>
        </filter>
        <encoder>
            <pattern>${FILE_LOG_PATTERN}</pattern>
            <charset>utf-8</charset>
        </encoder>
        <file>${LOG_HOME}/${LOG_NAME}-error.log</file> 
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern> 
                ${LOG_HOME}/backup/${LOG_NAME}-log-error-%d{yyyy-MM-dd}.%i.log
            </fileNamePattern>
            <maxHistory>30</maxHistory>
            <totalSizeCap>1GB</totalSizeCap>
            <cleanHistoryOnStart>true</cleanHistoryOnStart>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>5MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
    </appender>
    <!-- 配置多环境日志输出：（prod:生产环境 ，test:测试环境，dev:开发环境 来定义不同日志输出)-->
    <springProfile name="prod">
        <appender-ref ref="fileInfoLog"/>
    </springProfile>
    <springProfile name="dev,test">
        <appender-ref ref="fileErrorLog"/>
    </springProfile>
    <root level="${logging.level.root}">
        <appender-ref ref="consoleLog"/>
        <appender-ref ref="fileInfoLog"/>
        <appender-ref ref="fileErrorLog"/>
    </root>
</configuration>

7.打印日志：

@Service
public class UserServiceImpl implements UserService {
    @Autowired
    private UserMapper userMapper;
    private static Logger logger= LogManager.getLogger("UserService");
    @Override
    public List<User> showUser() {
        logger.info("hello");
        List<User> users = userMapper.showUser();
        return users;
    }
}

注:每次打印日志都要写private static Logger log=LogManager.getLogger("UserService");很麻烦，可以使用lombok插件；

在类上写上注解@Slf4j：

@Service
@Slf4j
public class UserServiceImpl implements UserService {
    @Autowired
    private UserMapper userMapper;
    @Override
    public List<User> showUser() {
        log.info("hello");
        List<User> users = userMapper.showUser();
        return users;
    }
}

SpringBoot (八）日志配置

悦读