SpringBoot
Posted xuweiweiwoaini
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了SpringBoot 相关的知识，希望对你有一定的参考价值。
1 日志框架的起源和发展
- 起初，大家都是使用System.out.println();语句在程序运行的时候，向控制台输出信息。这种方式有很多弊端：
- ①如果在实际部署的时候，已经都测试完毕了，不需要输出了，那么只能一行行的注释掉System.out.println();语句，很麻烦。
- ②不能随程序员的需求打印指定的日志信息，比如debug和info级别的日志信息。
- 之后，出现了日志框架，比如log4j.jar。
- 但是，随着时间的推移，log4j.jar的很多功能需要升级，以及一些底层的东西需要重写，这个时候，log4j.jar的作者就写了logback日志框架。但是，这样也是不行的，因为可能logback和slf4j的API不兼容，如果需要将原来项目中使用slf4j的jar包替换成logback，将无疑是一场噩梦。
- 或许受到JDBC思想的启发，log4j和logback日志框架的作者，写了一个接口或实现，就是slf4j，其实就是门面，而log4j.jar和logback.jar去实现slf4j.jar包。但是此时，大家应该知道的是先是出现log4j，再出现slf4j，所以如果要使用log4j，必须导入slf4j-log412.jar包（适配层）。
- 当然，门面日志有很多，比如jakarta commons logging（最后一次更新是2014年）、slf4j（一直在更新）、jboss-logging（hibernate底层使用的日志门面）。
- 日志实现也有很多，log4j（slf4j的实现）、logback（slf4j的实现）、juc（Java自带的日志实现）、log4j2（Apache提供的对log4j的增强，目前为止框架还没引入）。
- Spring的底层使用的日志框架是commons-logging，而SpringBoot底层使用的日志组件是slf4j+logback。
2 slf4j的使用
- 在以后开发的时候，日志记录方法的调用，不应该使用具体的日志实现的API，而应该使用的是日志抽象层里面的方法。
- 实例：
package com.example.demo.controller; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @RestController public class HelloController { private Logger logger = LoggerFactory.getLogger(HelloController.class); @RequestMapping(value = "/hello") public String hello(){ try { int i = 1 /0; }catch (Exception e){ logger.info(e.getMessage()); } return "Hello World"; } }
- 图示：
- 每一个日志的实现框架都有自己的配置文件。使用slf4j以后，配置文件还是做成日志实现框架自己本身的配置文件。
3 遗留问题
- 我们知道的是，SpringBoot使用的是slf4j+logback，Spring使用的是commons-loggging、hibernate使用的是jboss-logging……
- 如果需要统一日志记录，使得别的框架和我一起使用slf4j+logback组件，原理如下：
- 比如，我们当前的项目使用的是SpringBoot框架，而SpringBoot框架的底层使用的日志框架是slf4j+logback，SpringBoot框架是对Spring框架的包装，Spring框架底层依赖的框架是commons-logging日志框架，如果我们移除了commons-logging日志框架，那么Spring启动就会报错，因为Spring底层依赖的是commons-logging日志框架，那怎么办？引入jcl-over-slf4j.jar，因为这个jar包完全是commons-logging的所有类，但是实现调用的是slf4j的接口或抽象方法，而slf4j底层调用的是logback，这样就能将commons-logging日志框架提出，而不会引起底层框架出现错误。
- 总结：如果让系统中所有的日志都统一到slf4j
- ①将系统中其他的日志框架先排除出去
- ②用中间包来替换原有的日志框架
- ③我们导入slf4j的其他实现
4 SpringBoot日志关系
- spring-boot-starter的pom.xml
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </dependency>
- spring-boot-starter的依赖如下
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-autoconfigure</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-logging</artifactId>
</dependency>
- 所以，SpringBoot使用它作为自己的日志功能
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-logging</artifactId> </dependency>
- SpringBoot底层日志依赖关系：
- 总结：
- ①SpringBoot底层使用的是slf4j+logback
- ②SpringBoot也把其他的日志转换都替换成了slf4j
- ③中间的替换包？
package org.apache.commons.logging; import java.util.Hashtable; import org.apache.commons.logging.impl.SLF4JLogFactory; 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(); }
- 如果我们引入其他的框架，一定要将其他框架的默认日志以阿里移除掉。比如SpringBoot底层就是这么干的。不然，会应该两个jar包的包名和类名一样，那样就会冲突了，SpringBoot不知道到底该使用哪个（SpringBoot会迷糊的）。
<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的方式记录日志，引入其他框架的时候，只需要把这个框架依赖的日志框架排除掉即可。
5 日志关系
5.1 默认配置
- SpringBoot默认给我们配置的日志级别是info级别。
package com.example.demo; import org.junit.Test; import org.junit.runner.RunWith; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit4.SpringRunner; @RunWith(SpringRunner.class) @SpringBootTest public class DemoApplicationTests { private Logger logger = LoggerFactory.getLogger(DemoApplicationTests.class); @Test public void contextLoads() { /** * 日志的级别由低到高 * trace < debug < info < warn < error * 可以调整日志的级别，那么日志只会打印此级别以后以后的级别信息 */ logger.trace("trace级别的日志信息"); logger.debug("debug级别的日志信息"); /** * SpringBoot默认给我们使用的是info级别的日志信息 */ logger.info("info级别的日志信息"); logger.warn("warn级别的日志信息"); logger.error("error级别的日志信息"); } }
- SpringBoot修改日志的默认配置，在application.properties文件中输入如下
logging.level.com = trace
- 日志的输出格式
<!-- 日志输出格式： %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修改日志的默认配置
server.port=8085 logging.level.com = trace #如果不指定路径就在当前项目下生生成springboot.log日志 #logging.file=springboot.log #当然也可以指定绝对路径 #logging.file=c:/springboot.log #在当前磁盘的根路径下创建spring文件夹和里面的log文件夹，使用spring.log作为默认文件 logging.path=/spring/log #logging.file和logging.path二选一，如果都配置，默认使用的是logging.file，当然如果都不配置，默认显示在控制台 #在控制台输出的日志格式 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
5.2 指定配置
- 给类路径下放上每个日志框架自己的配置文件即可；SpringBoot就不适用自己的默认配置了。
- logback.xml会绕过SpringBoot，而让logback框架自动识别到。
<?xml version="1.0" encoding="UTF-8"?> <!-- scan：当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。 scanPeriod：设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒当scan为true时，此属性生效。默认的时间间隔为1分钟。 debug：当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 --> <configuration scan="false" scanPeriod="60 seconds" debug="false"> <!-- 定义日志的根目录 --> <property name="LOG_HOME" value="/app/log" /> <!-- 定义日志文件名称 --> <property name="appName" value="atguigu-springboot"></property> <!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 --> <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"> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern> </layout> </appender> <!-- 滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 --> <appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!-- 指定日志文件的名称 --> <file>${LOG_HOME}/${appName}.log</file> <!-- 当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名 TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。 --> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <!-- 滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}：按天进行日志滚动 %i：当文件大小超过maxFileSize时，按照i进行文件滚动 --> <fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern> <!-- 可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每天滚动， 且maxHistory是365，则只保存最近365天的文件，删除之前的旧文件。注意，删除旧文件是， 那些为了归档而创建的目录也会被删除。 --> <MaxHistory>365</MaxHistory> <!-- 当日志文件超过maxFileSize指定的大小是，根据上面提到的%i进行日志文件滚动 注意此处配置SizeBasedTriggeringPolicy是无法实现按文件大小进行滚动的，必须配置timeBasedFileNamingAndTriggeringPolicy --> <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>100MB</maxFileSize> </timeBasedFileNamingAndTriggeringPolicy> </rollingPolicy> <!-- 日志输出格式： --> <layout class="ch.qos.logback.classic.PatternLayout"> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern> </layout> </appender> <!-- logger主要用于存放日志对象，也可以定义日志类型、级别 name：表示匹配的logger类型前缀，也就是包的前半部分 level：要记录的日志级别，包括 TRACE < DEBUG < INFO < WARN < ERROR additivity：作用在于children-logger是否使用 rootLogger配置的appender进行输出， false：表示只用当前logger的appender-ref，true： 表示当前logger的appender-ref和rootLogger的appender-ref都有效 --> <!-- hibernate logger --> <logger name="com.xuweiwei" level="debug" /> <!-- Spring framework logger --> <logger name="org.springframework" level="debug" additivity="false"></logger> <!-- root与logger是父子关系，没有特别定义则默认为root，任何一个类只会和一个logger对应， 要么是定义的logger，要么是root，判断的关键在于找到这个logger，然后判断这个logger的appender和level。 --> <root level="info"> <appender-ref ref="stdout" /> <appender-ref ref="appLogAppender" /> </root> </configuration>
- 当然，也可以适用SpringBoot来解析日志配置，这样就可以适用SpringBoot的高级profile功能了
<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>
5.3 切换日志框架（不推荐）
- 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>
- slf4j+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>
以上是关于SpringBoot 的主要内容，如果未能解决你的问题，请参考以下文章
SpringBoot中表单提交报错“Content type ‘application/x-www-form-urlencoded；charset=UTF-8‘ not supported“(代码片段
Spring boot：thymeleaf 没有正确渲染片段