日志框架就是为了更好的记录日志使用的,记录日志是为了我们在工作中可以更好的查找相对应的问题,也算是以中留痕操作!
以前我们刚开始学习的时候都是用 System.out.println()
去在控制台记录,怎么说呢?这种方式伴随着我们很长时间,之后我们就遇到了 断点 调试的方式,逐渐不在使用 System.out.println()
进行调试,但是你别忘记,那是一种记录不管是否有用,你都应该去记录!
**市面上的日志框架;**JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j....
日志门面 (日志的抽象层) | 日志实现 |
---|---|
|
Log4j JUL(java.util.logging) Log4j2 Logback |
SpringBoot:底层是Spring框架,Spring框架默认是用JCL;‘
SLF4J的官方网站手册
以后开发的时候,日志记录方法的调用,不应该来直接调用日志的实现类,而是调用日志抽象层里面的方法;
给系统里面导入slf4j的jar和 logback的实现jar
使用方式如下:
import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class HelloWorld { public static void main(String[] args) { Logger logger = LoggerFactory.getLogger(HelloWorld.class); logger.info("Hello World"); } } 复制代码
每一个日志的实现框架都有自己的配置文件。使用slf4j以后, 配置文件还是做成日志实现框架自己本身的配置文件;
我们接触过的框架使用的日志框架都有所不同,因此,统一日志记录,即使是别的框架和我一起统一使用slf4j进行输出?
将系统中其他日志框架先排除出去;
用中间包来替换原有的日志框架;
我们导入slf4j其他的实现;
SpringBoot使用它来做日志功能:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-logging</artifactId> </dependency> 复制代码
SpringBoot底层也是使用slf4j+logback的方式进行日志记录
SpringBoot也把其他的日志都替换成了slf4j
中间替换包?
@SuppressWarnings("rawtypes") public abstract class LogFactory { static String UNSUPPORTED_OPERATION_IN_JCL_OVER_SLF4J = "http://www.slf4j.org/codes.html#unsupported_operation_in_jcl_over_slf4j"; static LogFactory logFactory = new SLF4JLogFactory(); 复制代码
如果我们要引入其他框架? 一定要把这个框架的默认日志依赖移除掉
示例:Spring框架用的是commons-logging;
<dependency> <groupId>org.springframework</groupId> <artifactId>spring-core</artifactId> <exclusions> <exclusion> <groupId>commons-logging</groupId> <artifactId>commons-logging</artifactId> </exclusion> </exclusions> </dependency> 复制代码
pringBoot能自动适配所有的日志,而且底层使用slf4j+logback的方式记录日志,引入其他框架的时候,只需要把这个框架依赖的日志框架排除掉即可;
Spring Boot 默认给我们已经配置好了日志,测试如下:
//记录器 Logger logger = LoggerFactory.getLogger(getClass()); @Test public void contextLoads() { //System.out.println(); //日志的级别; //由低到高 trace<debug<info<warn<error //可以调整输出的日志级别;日志就只会在这个级别以以后的高级别生效 logger.trace("这是trace日志..."); logger.debug("这是debug日志..."); //SpringBoot默认给我们使用的是info级别的,没有指定级别的就用SpringBoot默认规定的级别;root级别 logger.info("这是info日志..."); logger.warn("这是warn日志..."); logger.error("这是error日志..."); } 复制代码
日志输出格式: %d表示日期时间, %thread表示线程名, %-5level:级别从左显示5个字符宽度 %logger{50} 表示logger名字最长50个字符,否则按照句点分割。 %msg:日志消息, %n是换行符 --> %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n 复制代码
logging.level.com.hanpang=trace # com.hanpang是说明的包名 #logging.path= # 不指定路径在当前项目下生成springboot.log日志 # 可以指定完整的路径; #logging.file=G:/springboot.log # 在当前磁盘的根路径下创建spring文件夹和里面的log文件夹;使用 spring.log 作为默认文件 logging.path=/spring/log # 在控制台输出的日志的格式 logging.pattern.console=%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n # 指定文件中日志输出的格式 logging.pattern.file=%d{yyyy-MM-dd} === [%thread] === %-5level === %logger{50} ==== %msg%n 复制代码
logging.file | logging.path | Example | Description |
---|---|---|---|
(none) | (none) | 只在控制台输出 | |
指定文件名 | (none) | my.log | 输出日志到my.log文件 |
(none) | 指定目录 | /var/log | 输出到指定目录的 spring.log 文件中 |
给类路径下放上每个日志框架自己的配置文件即可,SpringBoot就不使用他默认配置的了
Logging System | Customization |
---|---|
Logback | logback-spring.xml , logback-spring.groovy , logback.xml or logback.groovy |
Log4j2 | log4j2-spring.xml or log4j2.xml |
JDK (Java Util Logging) | logging.properties |
logback.xml:直接就被日志框架识别了;一般情况不推荐
(推荐)logback-spring.xml:日志框架就不直接加载日志的配置项,由SpringBoot解析日志配置,可以使用SpringBoot的高级Profile功能
<springProfile name="staging"> <!-- configuration to be enabled when the "staging" profile is active --> 可以指定某段配置只在某个环境下生效 </springProfile> 复制代码
示例代码
<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender"> <!-- 日志输出格式: %d表示日期时间, %thread表示线程名, %-5level:级别从左显示5个字符宽度 %logger{50} 表示logger名字最长50个字符,否则按照句点分割。 %msg:日志消息, %n是换行符 --> <layout class="ch.qos.logback.classic.PatternLayout"> <springProfile name="dev"> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> %-5level %logger{50} - %msg%n</pattern> </springProfile> <springProfile name="!dev"> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%n</pattern> </springProfile> </layout> </appender> 复制代码
如果使用logback.xml作为日志配置文件,还要使用profile功能,会有以下错误:
可以按照slf4j的日志适配图,进行相关的切换;
slf4j+log4j的方式,pom.xml配置如下:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <exclusions> <exclusion> <artifactId>logback-classic</artifactId> <groupId>ch.qos.logback</groupId> </exclusion> <exclusion> <artifactId>log4j-over-slf4j</artifactId> <groupId>org.slf4j</groupId> </exclusion> </exclusions> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-log4j12</artifactId> </dependency> 复制代码
如果切换为log4j2,pom.xml配置如下:
log4j2配置的参考文章
log4j2的配置说明
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <exclusions> <exclusion> <artifactId>spring-boot-starter-logging</artifactId> <groupId>org.springframework.boot</groupId> </exclusion> </exclusions> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-log4j2</artifactId> </dependency> 复制代码
在src/main/resources下面新建文件logback.xml这个也是spring boot默认的配置文件名, 如果需要自定义文件名,如:logback-test.xml需要在application.properties添加配置 ================但是,我们习惯使用logback-spring.xml========================== logging.config=classpath:logback-test.xml spring boot默认载入的相关配置文件,详见jar包;spring-boot-1.*.*.RELEASE.jar下面 org/springframework/boot/logging/logback/ 详细文件: base.xml //基础包,引用了下面所有的配置文件 console-appender.xml //控制台输出配置 defaults.xml //默认的日志文件配置 file-appender.xml //文件输出配置 复制代码
<?xml version="1.0" encoding="UTF-8"?> <configuration> <!--定义日志文件的存储地址 勿在 LogBack的配置中使用相对路径 --> <property name="LOG_HOME" value="/tmp/log" /> <!-- 控制台输出 --> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{30} - %msg%n</pattern> </encoder> </appender> <!-- 按照每天生成日志文件 --> <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <FileNamePattern>${LOG_HOME}/logs/smsismp.log.%d{yyyy-MM-dd}.log</FileNamePattern> <!--日志文件保留天数 --> <MaxHistory>30</MaxHistory> </rollingPolicy> <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> <!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符 --> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{30} - %msg%n</pattern> </encoder> <!--日志文件最大的大小 --> <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> <MaxFileSize>10MB</MaxFileSize> </triggeringPolicy> </appender> <!-- 日志输出级别 --> <root level="INFO"> <appender-ref ref="STDOUT" /> <appender-ref ref="FILE" /> </root> <!-- 定义各个包的详细路径,继承root宝的值 --> <logger name="com.hry.spring.log" level="INFO" /> <logger name="com.hry.spring" level="TRACE" /> <!-- 此值由 application.properties的spring.profiles.active=dev指定--> <springProfile name="dev"> <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径 --> <property name="LOG_HOME" value="/tmp/log" /> <logger name="org.springboot.sample" level="DEBUG" /> </springProfile> <springProfile name="pro"> <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径 --> <property name="LOG_HOME" value="/home" /> <logger name="org.springboot.sample2" level="INFO" /> </springProfile> </configuration> 复制代码
部分说明
appender name="STDOUT": 日志打印到控制台 appender name="FILE": 日志按日打印到文件中,最多保留MaxHistory天,每个文件大水为MaxFileSize encoder:定义输出格式 <root level="INFO">: 定义根logger,通过appender-ref指定前方定义的appender <logger name="com.hry.spring.log" level="INFO" />:在继承root的logger上对com.hry.spring.log包日志作特殊处理 <springProfile name="dev">: 定义profile的值,只有特定profile的情况下,此间定义的内容才启作用 application.properties 启动dev配置信息 server.port=8080 spring.profiles.active=dev spring.profiles.active指定本次启动的active的值是什么。本次是dev,则logback-spring.xml里<springProfile name="dev">的内容启作用 复制代码
import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class LogApplication { private static final Logger log = LoggerFactory.getLogger(LogApplication.class); public static void main(String[] args) { String str1 = "string1"; String str2 = "string2"; log.info("Begin Start {}...{}", str1, str2); SpringApplication.run(LogApplication.class, args); log.info("Stop ..."); } } 复制代码
<?xml version="1.0" encoding="UTF-8"?> <configuration> <include resource="org/springframework/boot/logging/logback/base.xml" /> <logger name="org.springframework.web" level="INFO"/> <logger name="org.springboot.sample" level="TRACE" /> <!-- 测试环境+开发环境. 多个使用逗号隔开. --> <springProfile name="test,dev"> <logger name="org.springframework.web" level="DEBUG"/> <logger name="org.springboot.sample" level="DEBUG" /> <logger name="com.example" level="DEBUG" /> </springProfile> <!-- 生产环境. --> <springProfile name="prod"> <logger name="org.springframework.web" level="ERROR"/> <logger name="org.springboot.sample" level="ERROR" /> <logger name="com.example" level="ERROR" /> </springProfile> </configuration> 复制代码
这里说明一下:
引入的base.xml是Spring Boot的日志系统预先定义了一些系统变量的基础配置文件
在application.properties中设置环境为prod,则只会打印error级别日志
如果在application.properties中定义了相同的配置,则application.properties的日志优先级更高
<?xml version="1.0" encoding="utf-8"?> <configuration scan="true" scanPeriod="10 seconds"> <!-- 文件输出格式 --> <property name="pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} -%5p ${PID:-} [%15.15t] %-40.40logger{39} : %m%n" /> <property name="charsetEncoding" value="UTF-8" /> <!--<PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>--> <!--控制台日志--> <appender name="console" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>${pattern}</pattern> <charset>UTF-8</charset> </encoder> </appender> <appender name="file" class="ch.qos.logback.core.FileAppender"> <file>./logback/logfile.log</file> <append>true</append> <encoder> <pattern>${pattern}</pattern> <charset>${charsetEncoding}</charset> </encoder> </appender> <appender name="dailyRollingFileAppender" class="ch.qos.logback.core.rolling.RollingFileAppender"> <File>./logback/log.log</File> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <!-- daily rollover --> <FileNamePattern>logback.%d{yyyy-MM-dd_HH}.log</FileNamePattern> <!-- keep 30 days' worth of history --> <maxHistory>7</maxHistory> </rollingPolicy> <encoder> <Pattern>${pattern}</Pattern> </encoder> </appender> <logger name="org.springframework.web" level="debug"/> <!-- show parameters for hibernate sql 专为 Hibernate 定制 --> <logger name="org.hibernate.type.descriptor.sql.BasicBinder" level="TRACE" /> <logger name="org.hibernate.type.descriptor.sql.BasicExtractor" level="DEBUG" /> <logger name="org.hibernate.SQL" level="DEBUG" /> <logger name="org.hibernate.engine.QueryParameters" level="DEBUG" /> <logger name="org.hibernate.engine.query.HQLQueryPlan" level="DEBUG" /> <!--myibatis log configure--> <logger name="com.apache.ibatis" level="TRACE"/> <logger name="java.sql.Connection" level="DEBUG"/> <logger name="java.sql.Statement" level="DEBUG"/> <logger name="java.sql.PreparedStatement" level="DEBUG"/> <root level="debug"> <appender-ref ref="console"/> <appender-ref ref="dailyRollingFileAppender"/> <appender-ref ref="file"/> </root> </configuration> 复制代码