SpringBoot 日志系统
日志框架
开发一个大型系统的简易步骤:
- system.out.println(“..”) 将关键的数据在控制台输出
- 框架记录系统的一些运行时的信息,—日志框架。
- 牛逼的功能—异步模式,自动归档等等。。。
- 进一步发展,卸掉旧得框架,并且修改之前的API,
- JDBC 数据库驱动,JDC 数据库驱动:
写一个统一的接口层: 日志门面,(日志的一个抽象层)
给项目导入具体的日志实现,之前的框架都是实现的抽象层
主流的日志框架
JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j….
日志门面(日志的抽象层):
JCL(Jakarta Commons Logging) SLF4j(Simple Logging Facade for Java) jboss-logging,
日志实现:
Log4j JUL(java.util.logging) Log4j2 Logback
Springboot :底层是Spring框架,Spring 默认框架是JCL,
SLF4J使用
1 ,如何在 系统中使用SLF4J https://www.slf4j.org
在开发的时候,日志的记录方法的调用,不应该直接调用日志的实现类,而是调用日志抽象成里面的方法。
给系统导入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 之后 ,配置文件还是做成日志实现框架自己的本身的配置文件。
遗留问题:
开发的时候,
A 系统: 可能会用到 (slf4j+logback): Spring(commons-logging默认)、Hibernate(默认:jboss-logging)、MyBatis、xxxx
如何统一 日志记录? 即使用别的框架,也统一使用 slf4j 进行输出
slf4j 日志适配图
如何实现系统所有日志统一到slf4j :
- 将系统中所有的其他日志框架先排除出去
- 用中间包来替换原有的日志框架
- 导入slf4j 的其他实现jar
springboot的日志关系
如果使用IDEA ,那么idea 有个很好的工具可以让我们可视化的查看依赖关系,在pom.xml 中右键选择diagrams —show dependencies 就可以查看
启动器:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </dependency>
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>
SpringBoot能自动适配所有的日志,而且底层使用slf4j+logback的方式记录日志,引入其他框架的时候,只需要把这个框架依赖的日志框架排除掉即可
SringBoot默认配置
SpringBoot默认帮我们配置好了日志;
//记录器 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
SpringBoot修改日志的默认配置
#设置日志的默认输出级别
logging.level.com.atguigu=trace #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 功能会报 no applicable action for [springProfile] 的错误
日志框架的切换
可以按照上面的 slf4j 的日志适配图,进行相关的切换:
slf4j + log4j 的方式:
<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 :
<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>
相关文章