SpringBoot使用slf4j日志并输出到文件中的操作方法
作者:99年的可乐
slf4j日志(3月11日)
再使用前,先了解一下介绍,否则你也不会用!
1、日志级别
- SLF4J将日志分为trace、debug、info、warn、error五个级别,每个级别对应记录不同的日志,对应不同的使用场景。
- 日志级别从低到高分为
TRACE < DEBUG < INFO < WARN < ERROR < FATAL
如果设置为
WARN
,则低于WARN
的信息都不会输出一般设置为
DEBUG
就够用了,看具体的业务需求,开发时设置成 trace 方便定位问题,在生产环境上,将这个日志级别再设置成 error 级别即可。
trace
trace是最低优先级的日志,一般用来追踪详细的程序运行流,比如程序的运行过程中,运行到了哪一个方法,进入了哪一条分支。通过trace程序的运行流程,可以判断程序是否按照期望的逻辑在运行。举个例子,有以下代码段。
public class Car{ //点火 public void fire(){ log.trace("fire") ... }
debug
debug是比trace高一级别的日志,该级别的日志就是用来debug用的。这类日志往往用在判断是否有出现bug的场景,且往往记录了代码运行的详细信息,比如方法调用传入的参数信息。
假设运行的过程中出现了问题,为了定位问题的原因,可以使用debug级别的日志来记录档位,通过记录运行时传入的gear来判断是不是因为档位输入错误而导致Car起步失败。
//挂档 public void gear(int gear){ log.trace("gear") //记录档位 log.debug(gear) ... }
info
info比debug高一级别,用来记录程序运行的一些关键信息,它不像trace那样记录程序运行的整个流程,也不像debug那样为了解决问题而记录详细的信息。
info记录的是整个系统的运行信息,比如系统运行到了哪一个阶段,到达了哪一个状态。还是以车启动为例子,将启动的代码修改如下。
public void static main(String[] args){ Car car = new Car(); car.fire(); car.clutch(); car.gear(1); car.looseBrake(); log.info("car is ready to run faster !"); } 可以看到,运行完looseBrake方法之后,使用info记录了车的状态,车已经完成了起步了,可以踩油门加速了。
warn
warn比info的级别更高,用来记录一些警告信息。警告信息表示,程序进入了一个特殊的状态,在该状态下程序可以继续运行,但是不建议让程序进入该状态,因为该状态可能导致结果出现问题
车启动的过程中如果以大于1档起步,就使用warn记录警告,告诉调用者不推荐这样使用,实际上2档起步也是可以的,但可能会出问题
//挂档 public void gear(int gear){ log.trace("gear") //记录档位 log.debug(gear) if(gear > 1){ log.warn("gear "+ gear +" is too high !") } ... }
error
error级别的日志是最高优先级了,用来记录运行时的错误信息,表示程序运行过程中出现了需要被解决的问题,往往是一些异常。使用error日志的时候,一般会将详细的异常出现的原因记录。
public void static main(String[] args){ Car car = new Car(); try{ car.fire(); car.clutch(); car.gear(1); car.looseBrake(); }catch(Exception e){ log.error("run failed !",e.getCause()) } log.info("car is ready to run faster !"); }
2、spring boot使用 日志接口介绍
SpringBoot 在所有内部日志中使用Commons Logging,但是默认配置也提供了对常用日志的支持,如:Java Util Logging,Log4J, Log4J2和Logback。每种Logger都可以通过配置使用控制台或者文件输出日志内容。
SLF4J类似于Commons Logging,也是一个日志接口,而Logback类似于Log4j,是一个日志的实现。
根据不同的日志系统,你可以按如下规则组织配置文件名,就能被正确加载:
Spring Boot官方推荐使用带有
-spring
的文件名作为你的日志配置(如logback-spring.xml,而不是logback.xml),命名为logback-spring.xml的日志配置文件,spring boot可以为它添加一些spring boot特有的配置项(下面会提到)。默认的命名规则,并且放在
src/main/resources
下面即可
- Logback:logback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy
- Log4j:log4j-spring.properties, log4j-spring.xml, log4j.properties, log4j.xml
- Log4j2:log4j2-spring.xml, log4j2.xml
- JDK (Java Util Logging):logging.properties
引入依赖
spring-boot-starter
这个包就自带了 logging
的依赖包,SpringBoot会默认使用 logback
作为日志框架,在生成springboot项目的时候可以直接勾选logback,那么就可以直接使用logback了。手动添加的话,建议使用slf4j+logback,后面项目更容易维护:
<dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </dependency>
日志配置类介绍
如下配置将:
- 在根目录
applog
中每天生成一个文件夹,并生成一个天级别的日志文件。 - Logger标签:作为日志的记录器,把它关联到应用的对应的context上后,主要用于存放日志对象,也可以定义日志类型、级别。
- Appender主要用于指定日志输出的目的地,目的地可以是控制台、文件、远程套接字服务器、 MySQL、PostreSQL、 Oracle和其他数据库、 JMS和远程UNIX Syslog守护-进程等。
- Layout 负责把事件转换成字符串,格式化的日志信息的输出
logback-spring.xml,放在 src/main/resources
下面
<?xml version="1.0" encoding="UTF-8"?> <configuration scan="true" scanPeriod="60 seconds" debug="false"> <contextName>logback</contextName> <!--输出到控制台--> <appender name="console" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>%d{HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern> </encoder> </appender> <!--按天生成日志,即一天只生成一个文件夹和一个日志文件--> <appender name="logFile" class="ch.qos.logback.core.rolling.RollingFileAppender"> <Prudent>true</Prudent> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <FileNamePattern> applog/%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> <!-- logger节点,可选节点,作用是指明具体的包或类的日志输出级别, 以及要使用的<appender>(可以把<appender>理解为一个日志模板)。 addtivity:非必写属性,是否向上级loger传递打印信息。默认是true--> <logger name="com.framework.job" additivity="false"> <appender-ref ref="console"/> <appender-ref ref="logFile"/> </logger> <!--项目的整体的日志打印级别为info--> <root level="info"> <appender-ref ref="console"/> <appender-ref ref="logFile"/> </root> </configuration>
日志级别单独配置
在application.yml使用以下方式,可以单独设置每个包下的日志记录级别,其中file属性可有可无
logging: file: applog/sys.log level: com: leshangju: prism: auth: dao: debug usershop: dao: debug loginuser: dao: debug
application.properties
logging.level.com.framework.job : info
测试结果
@Slf4j public class MyJob extends QuartzJobBean { @Override protected void executeInternal(JobExecutionContext context) throws JobExecutionException { System.out.println("启动定时任务 My Job:" + LocalDateTime.now()); log.trace("进入了myjob任务"); try { Thread.sleep(3000); log.trace("睡了3秒"); } catch (InterruptedException e) { e.printStackTrace(); } log.info("结束任务!"); System.out.println("end My Job:" + LocalDateTime.now()); } }
控制台:
根目录生成文件:
slf4j,logback,log4j的区别
slf4j(Simple logging Facade for Java) 简单日志门面,日志系统的实现进行了具体的抽象化,只提供了统一的日志使用接口,没有任何日志实现,只有一个jar包(slf4j-api.jar)。
log4j和logback是具体的日志框架。这两个日志框是同一个作者开发,后者性能更高。
logbak直接实现slf4j接口,性能更高
springboot默认日子框架为logback
到此这篇关于SpringBoot使用slf4j日志并输出到文件中的文章就介绍到这了,更多相关SpringBoot slf4j日志输出到文件内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!