SpringBoot、SpringMVC集成logback日志

水深无声 2022-01-20 15:09 420阅读 0赞

日志主要分为：trace<debug<info<warn<error五种，级别为由低到高

  • trace：主要为程序的追踪，判断程序执行到哪步
  • debug：调试使用的日志输出
  • info：输出一些信息帮助了解程序运行状态
  • warn：程序发出一些警告信息
  • error：程序出错时发出的信息

常用的日志主要分为两种：logback和log4j，都是基于sl4j开发演变而来的，logback更方便使用的人更多，配置里面会有很多坑（生成日志路径…）帮大家避免一下。

前言

项目中我引用lombok包的@Slf4j注解，所以需要输入日志类中不需要再加

  1. Logger log= LoggerFactory.getLogger(getClass());

如果我们没有使用lombok包需要添加代码为：

  1. public class SpringbootApplicationTests { 
  3.     Logger log= LoggerFactory.getLogger(getClass());
  5.     public void loggerInfo() { 
  6.         log.trace("这是trace");
  7.         log.debug("这是debug");
  8.         log.info("这是info");
  9.         log.warn("这是warn");
  10.         log.error("这是error");
  11.     }
  12. }

logback.xml内容

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出 -->
  3. <!-- scan:当此属性设置为true时，配置文档如果发生改变，将会被重新加载，默认值为true -->
  4. <!-- scanPeriod:设置监测配置文档是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。 当scan为true时，此属性生效。默认的时间间隔为1分钟。 -->
  5. <!-- debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 -->
  6. <configuration scan="true" scanPeriod="60 seconds" debug="false">
  7.     <contextName>logback</contextName>
  9.     <!-- name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义后，可以使“${}”来使用变量。 -->
  10.     <property name="log.path" value="logs"/>
  12.     <!--0. 日志格式和颜色渲染 -->
  13.     <!-- 彩色日志依赖的渲染类 -->
  14.     <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter"/>
  15.     <conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter"/>
  16.     <conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter"/>
  17.     <!-- 彩色日志格式 -->
  18.     <property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
  20.     <!--1. 输出到控制台-->
  21.     <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
  22.         <!--此日志appender是为开发使用，只配置最底级别，控制台输出的日志级别是大于或等于此级别的日志信息-->
  23.         <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
  24.             <level>debug</level>
  25.         </filter>
  26.         <encoder>
  27.             <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
  28.             <!-- 设置字符集 -->
  29.             <charset>UTF-8</charset>
  30.         </encoder>
  31.     </appender>
  33.     <!--2. 输出到文档-->
  34.     <!-- 2.1 level为 DEBUG 日志，时间滚动输出 -->
  35.     <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  36.         <!-- 正在记录的日志文档的路径及文档名 -->
  37.         <file>${log.path}/debug.log</file>
  38.         <!--日志文档输出格式-->
  39.         <encoder>
  40.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
  41.             <charset>UTF-8</charset>
  42.         </encoder>
  43.         <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
  44.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  45.             <!-- 日志归档 -->
  46.             <fileNamePattern>${log.path}/debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  47.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  48.                 <maxFileSize>100MB</maxFileSize>
  49.             </timeBasedFileNamingAndTriggeringPolicy>
  50.             <!--日志文档保留天数-->
  51.             <maxHistory>15</maxHistory>
  52.         </rollingPolicy>
  53.         <!-- 此日志文档只记录debug级别的 -->
  54.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  55.             <level>debug</level>
  56.             <onMatch>ACCEPT</onMatch>
  57.             <onMismatch>DENY</onMismatch>
  58.         </filter>
  59.     </appender>
  61.     <!-- 2.2 level为 INFO 日志，时间滚动输出 -->
  62.     <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  63.         <!-- 正在记录的日志文档的路径及文档名 -->
  64.         <file>${log.path}/info.log</file>
  65.         <!--日志文档输出格式-->
  66.         <encoder>
  67.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
  68.             <charset>UTF-8</charset>
  69.         </encoder>
  70.         <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
  71.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  72.             <!-- 每天日志归档路径以及格式 -->
  73.             <fileNamePattern>${log.path}/info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  74.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  75.                 <maxFileSize>100MB</maxFileSize>
  76.             </timeBasedFileNamingAndTriggeringPolicy>
  77.             <!--日志文档保留天数-->
  78.             <maxHistory>15</maxHistory>
  79.         </rollingPolicy>
  80.         <!-- 此日志文档只记录info级别的 -->
  81.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  82.             <level>info</level>
  83.             <onMatch>ACCEPT</onMatch>
  84.             <onMismatch>DENY</onMismatch>
  85.         </filter>
  86.     </appender>
  88.     <!-- 2.3 level为 WARN 日志，时间滚动输出 -->
  89.     <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  90.         <!-- 正在记录的日志文档的路径及文档名 -->
  91.         <file>${log.path}/warn.log</file>
  92.         <!--日志文档输出格式-->
  93.         <encoder>
  94.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
  95.             <charset>UTF-8</charset>
  96.         </encoder>
  97.         <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
  98.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  99.             <fileNamePattern>${log.path}/warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  100.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  101.                 <maxFileSize>100MB</maxFileSize>
  102.             </timeBasedFileNamingAndTriggeringPolicy>
  103.             <!--日志文档保留天数-->
  104.             <maxHistory>15</maxHistory>
  105.         </rollingPolicy>
  106.         <!-- 此日志文档只记录warn级别的 -->
  107.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  108.             <level>warn</level>
  109.             <onMatch>ACCEPT</onMatch>
  110.             <onMismatch>DENY</onMismatch>
  111.         </filter>
  112.     </appender>
  114.     <!-- 2.4 level为 ERROR 日志，时间滚动输出 -->
  115.     <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  116.         <!-- 正在记录的日志文档的路径及文档名 -->
  117.         <file>${log.path}/error.log</file>
  118.         <!--日志文档输出格式-->
  119.         <encoder>
  120.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
  121.             <charset>UTF-8</charset>
  122.         </encoder>
  123.         <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
  124.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  125.             <fileNamePattern>${log.path}/error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  126.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  127.                 <maxFileSize>100MB</maxFileSize>
  128.             </timeBasedFileNamingAndTriggeringPolicy>
  129.             <!--日志文档保留天数-->
  130.             <maxHistory>15</maxHistory>
  131.         </rollingPolicy>
  132.         <!-- 此日志文档只记录ERROR级别的 -->
  133.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  134.             <level>ERROR</level>
  135.             <onMatch>ACCEPT</onMatch>
  136.             <onMismatch>DENY</onMismatch>
  137.         </filter>
  138.     </appender>
  140.     <!-- <appender name="LOGSTASH" class="net.logstash.logback.appender.LogstashTcpSockerAppender">-->
  141.     <!-- <destination></destination>-->
  142.     <!-- </appender>-->
  144.     <!-- <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"/> -->
  146.     <!-- 使用mybatis的时候，sql语句是debug下才会打印，而这里我们只配置了info，所以想要查看sql语句的话，有以下两种操作： 第一种把<root level="info">改成<root level="DEBUG">这样就会打印sql，不过这样日志那边会出现很多其他消息 第二种就是单独给dao下目录配置debug模式，代码如下，这样配置sql语句会打印，其他还是正常info级别： 【logging.level.org.mybatis=debug logging.level.dao=debug】 -->
  148.     <!-- root节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性 level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF， 不能设置为INHERITED或者同义词NULL。默认是DEBUG 可以包含零个或多个元素，标识这个appender将会添加到这个logger。 -->
  150.     <!-- 4. 最终的策略 -->
  151.     <!-- 4.1 开发环境:打印控制台-->
  152.     <springProfile name="dev">
  153.         <logger name="com" level="debug"/>
  154.     </springProfile>
  156.     <root level="info">
  157.         <appender-ref ref="CONSOLE"/>
  158.         <appender-ref ref="DEBUG_FILE"/>
  159.         <appender-ref ref="INFO_FILE"/>
  160.         <appender-ref ref="WARN_FILE"/>
  161.         <appender-ref ref="ERROR_FILE"/>
  162.     </root>
  164.     <!-- 4.2 生产环境:输出到文档 <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> -->
  166. </configuration>

SpringBoot

  • 引用pom依赖

    1.     <dependency>
    2.         <groupId>org.springframework.boot</groupId>
    3.         <artifactId>spring-boot-starter-logging</artifactId>
    4.     </dependency>

  • 通过配置文件使用日志文件

    日志配置

    不指定路径在当前项目下生成日志，值为：G:/springboot.log在G盘下生成

    logging.file=springboot.log

    当前磁盘的根路径创建spring/log文件夹，使用spring.log作为默认文件

    logging.path=/spring/log

    logging.file和logging.path不能同时使用，否则不起作用，一般使用logging.file

    控制台输出日志格式 日期时间，线程名 级别 全类名50个字符 消息和换行

    logging.pattern.console=%d{ yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{ 50} - %msg%n

    指定文件中输出日志格式

    logging.pattern.file=%d{ yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{ 50} - %msg%n

  • 使用logback.xml
    把logback.xml放到resources目录下即可
    如果logback.xml位置或名称有变量需要加：

    logging:
    config: classpath:文件名称.xml

日志文件相对保存路径设置可分以下三种：

  • value=”log”输入在项目文件夹下
  • value=”/log”输入在项目文件夹下
  • value=”。。/log”输入在项目上一次文件夹下

SpringMVC

  • 引用pom依赖

    1.     <dependency>
    2.         <groupId>log4j</groupId>
    3.         <artifactId>log4j</artifactId>
    4.         <version>1.2.17</version>
    5.     </dependency>
    6.     <dependency>
    7.         <groupId>ch.qos.logback</groupId>
    8.         <artifactId>logback-core</artifactId>
    9.         <version>1.2.3</version>
    10.     </dependency>
    11.     <dependency>
    12.         <groupId>ch.qos.logback</groupId>
    13.         <artifactId>logback-classic</artifactId>
    14.         <version>1.2.3</version>
    15.     </dependency>

  • 使用logback.xml
    把logback.xml放到resources目录下即可

日志文件相对保存路径设置可分以下三种：

  • value=”log”表示保存到程序运行目录，在tomcat中为bin目录
  • value=”/log”表示保存到系统目录，比如你的项目运行在D盘，这个就在D盘的根目录下。
  • value=”。。/log”表示保存到程序运行目录的父目录，tomacat运行时，有一个logs的目录，最好配置时，加上自己应用名称，以做区分。

关于logback.xml的命名问题

在我们启动tomacat后，会看到日志中有一段内容，如下 ：
在这里插入图片描述
可以看到，logback在加载配置时，会先去找名为logback-test.xml，然后找logback.groovy,最后找logback.xml，如果找到就会应用我们的配置。如果未找到，就默认配置。
如果我们不想用logback.xml这个名称，例如使用logback-spring.xml，我们可以在项目的web.xml里面配置
pom文件引用

  1. <dependency>
  2.             <groupId>org.logback-extensions</groupId>
  3.             <artifactId>logback-ext-spring</artifactId>
  4.             <version>0.1.4</version>
  5.         </dependency>

web.xml

  1. <context-param>
  2.         <param-name>logbackConfigLocation</param-name>
  3.         <param-value>classpath:logback-spring.xml</param-value>
  4.     </context-param>
  5.     <listener>
  6.         <listener-class>ch.qos.logback.ext.spring.web.LogbackConfigListener</listener-class>
  7.     </listener>

发表评论

表情：
评论列表 （有 0 条评论，420人围观）

还没有评论，来说两句吧...

相关阅读

    相关 logback日志

    没有使用logback,只使用了Simple Logging Facade for Java (SLF4J) Java的简单日志记录外观（SLF4J）可作为各种日志记录框架

    电玩女神电玩女神/ 0 赞/ 31 阅读