书单推荐:成为Java顶级程序员架构师 ,这20来本(高薪)必看点击获取
一、业务需求
在项目开发和运维过程中需要通过日志来分析问题,解决问题以保证项目的正常运行。通过SpringBoot自带的日志管理相对比较简单,已无法满足日常的运维需求,需要对日志文件进行分时分类管理,刚好通过学习接触到了logback日志系统。因此便决定将其加入到项目框架之中。
二、logback简介
至于简介,可自行网上查阅相关文档文献,这里不做详细描述,毕竟不是本文主要目的。只需理解它很好的实现了slf4j,是log4j的再发展即可。
三、具体实施方案(仅供参考)
1、引入依赖包
其实不需要引入任何依赖,Spring Boot 都为我们做好了(不得不感叹技术的强大与发展之快,不管是好是坏,可以很好的提高开发效率)。
2、配置文件
特别说明:这里logback.xml不是在默认的 src/main/resources 目录下因此需要在application.properties里配置路径,由于项目是通过Spring Cloud Config管理的配置文件,但是配置内容都一样,只需在配置文件中加入以下配置即可:
logging.config=classpath:log/logback.xml
说明:定义日志输出位置、文件大小、保存时间和日志级别
logback.path=.
logback.maxFileSize=50MB
logback.maxHistory=30
logback.level=INFO
2.2 xml文件
\src\main\resources\log\logback.xml
说明:可看文件中注释,根据需求做相应调整。
<?xml version="1.0" encoding="UTF-8"?> <!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果设置为WARN,则低于WARN的信息都不会输出 --> <!-- scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true --> <!-- scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。 --> <!-- debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。 --> <configuration scan="true" scanPeriod="10 seconds"> <property resource="log/logback.properties" /> <!--输出到控制台--> <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"> <!--此日志appender是为开发使用,只配置最底级别,控制台输出的日志级别是大于或等于此级别的日志信息--> <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> <level>info</level> </filter> <encoder> <!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度,%line:行号,%msg:日志消息,%n是换行符--> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level [%logger{50}] - %msg%n</pattern> <!-- 设置字符集 --> <charset>UTF-8</charset> </encoder> </appender> <!--输出到文件--> <!-- 时间滚动输出 level为 ${logback.level} 日志 --> <appender name="STDOUT" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!-- 正在记录的日志文件的路径及文件名 --> <file>${logback.path}/log_${logback.level}.log</file> <!--日志文件输出格式--> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level [%logger{50}] - %msg%n</pattern> <charset>UTF-8</charset> <!-- 设置字符集 --> </encoder> <!-- 日志记录器的滚动策略,按日期,按大小记录 --> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <!-- 日志归档 --> <fileNamePattern>${logback.path}/${logback.level}/log-${logback.level}-%d{yyyy-MM-dd}.%i.log</fileNamePattern> <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>${logback.maxFileSize}</maxFileSize> </timeBasedFileNamingAndTriggeringPolicy> <!--日志文件保留天数--> <maxHistory>${logback.maxHistory}</maxHistory> </rollingPolicy> <!-- 此日志文件只记录${logback.level}级别的 --> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>${logback.level}</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <!-- <logger>用来设置某一个包或者具体的某一个类的日志打印级别、 以及指定<appender>。<logger>仅有一个name属性, 一个可选的level和一个可选的addtivity属性。 name:用来指定受此logger约束的某一个包或者具体的某一个类。 level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF, 还有一个特俗值INHERITED或者同义词NULL,代表强制执行上级的级别。 如果未设置此属性,那么当前logger将会继承上级的级别。 addtivity:是否向上级logger传递打印信息。默认是true。 --> <!--<logger name="org.springframework.web" level="info"/> <logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/>--> <!-- root节点是必选节点,用来指定最基础的日志输出级别,只有一个level属性 level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF, 不能设置为INHERITED或者同义词NULL。默认是DEBUG 可以包含零个或多个元素,标识这个appender将会添加到这个logger。 --> <root level="${logback.level}"> <appender-ref ref="CONSOLE" /> <appender-ref ref="STDOUT" /> </root> <!--开发环境:打印控制台--> <!-- <springProfile name="dev"> <logger name="team.biteeny" level="debug"/> </springProfile>--> <!--生产环境:输出到文件--> <!--<springProfile name="pro">--> <!--<root level="info">--> <!--<appender-ref ref="CONSOLE" />--> <!--<appender-ref ref="DEBUG_FILE" />--> <!--<appender-ref ref="INFO_FILE" />--> <!--<appender-ref ref="ERROR_FILE" />--> <!--<appender-ref ref="WARN_FILE" />--> <!--</root>--> <!--</springProfile>--> </configuration>
通过以上步骤即可完成logback日志系统的简单集成,可以做到分时分文件大小以及备份保留时间等日志的输出管理。
如果想需要调试输出一些日志信息,只需在相应的类中加入类代码即可:
private static final Logger log = LoggerFactory.getLogger(ClassName.class);
// 需要输出的日志位置
log.info("日志信息");
log.error("日志信息");
……