springboot相对路径新建文件 springboot配置日志相对路径

转载

mob64ca1411a6fc 2024-03-16 01:11:23

文章标签 springboot相对路径新建文件 Spring Boot学习 System 日志文件活动文件 文章分类 架构后端开发

1 介绍

SpringBoot内部集成了LogBack日志依赖，SpringBoot默认使用LogBack记录日志信息

1.1 新建logback.xml文件

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
    <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
    <property name="LOG_HOME" value="./logs" />
    <!-- 控制台输出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <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{50} - %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}/runtime.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{50} - %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>


</configuration>

1.2 类中使用日志

@RestController
@RequestMapping("/demo")
public class DemoController {


    private final static Logger log = LoggerFactory.getLogger(DemoController.class);

    @Autowired
    private DemoService demoService;

    @Autowired
    private MemInfoConfig1 memInfoConfig1;

    @Autowired
    private MemInfoConfig2 memInfoConfig2;

    @Autowired
    private MemInfoConfig3 memInfoConfig3;

    @Autowired
    private Environment env;

    @RequestMapping("/index")
    public String Index(){
        log.info("log日志");
        log.debug("log debug 日志");
        log.error("log error 日志");
        System.out.println(memInfoConfig1.getName());
        System.out.println(memInfoConfig1.getSex());
        System.out.println(memInfoConfig1.getAddress());
        System.out.println(memInfoConfig2.getName());
        System.out.println(memInfoConfig2.getSex());
        System.out.println(memInfoConfig2.getAddress());
        System.out.println(memInfoConfig3.getName());
        System.out.println(memInfoConfig3.getSex());
        System.out.println(memInfoConfig3.getAddress());
        System.out.println(env.getProperty("member.info.name"));
        System.out.println(env.getProperty("member.info.sex"));
        System.out.println(env.getProperty("member.info.address"));
        return demoService.demoIndex();
    }
}

打印日志信息

2019-08-23 13:29:34.490 [http-nio-8080-exec-1] INFO  com.springboot.demo.controller.DemoController - log日志  
2019-08-23 13:29:34.490 [http-nio-8080-exec-1] DEBUG com.springboot.demo.controller.DemoController - log debug 日志  
2019-08-23 13:29:34.490 [http-nio-8080-exec-1] ERROR com.springboot.demo.controller.DemoController - log error 日志

2 LogBack配置详解

2.1 根节点包含的属性：

scan：
此属性设置为true时，配置文件发生改变，将会被重新加载，默认为true
scanPeriod:
设置检测配置文件是否有修改的时间间隔，默认时间间隔是1分钟
debug:
此属性设置为true时，将打印logback内部日志信息，默认值为false。

<configuration scan="true" scanPeriod="60 seconds" debug="false">  
      <!-- 其他配置省略-->  
</configuration>

2.2 设置变量

用来定义变量值的标签，有两个属性，name和value；其中name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。

2.3 设置loger

<configuration>   
   
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
    <!-- encoder 默认配置为PatternLayoutEncoder -->   
    <encoder>   
      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>   
    </encoder>   
  </appender>   
   
  <root level="INFO">             
    <appender-ref ref="STDOUT" />   
  </root>     
     
 </configuration>

其中appender的配置表示打印到控制台(稍后详细讲解appender )；

将root的打印级别设置为“INFO”，指定了名字为“STDOUT”的appender。

是的子节点，是负责写日志的组件。

有两个必要属性name和class。name指定appender名称，class指定appender的全限定名。

ConsoleAppender:

把日志添加到控制台，有以下子节点：

：对日志进行格式化。（具体参数稍后讲解）

：字符串 System.out 或者 System.err ，默认 System.out ；

FileAppender:

把日志添加到文件，有以下子节点：

：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。

：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。

：对记录事件进行格式化。（具体参数稍后讲解）

：如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是 false。

<configuration>  
  
  <appender name="FILE" class="ch.qos.logback.core.FileAppender">  
    <file>testFile.log</file>  
    <append>true</append>  
    <encoder>  
      <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>  
    </encoder>  
  </appender>  
          
  <root level="DEBUG">  
    <appender-ref ref="FILE" />  
  </root>  
</configuration>

RollingFileAppender:

滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件。有以下子节点：

：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。

：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。

：对记录事件进行格式化。（具体参数稍后讲解）

:当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名。

: 告知 RollingFileAppender 合适激活滚动。

：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制，1不支持也不允许文件压缩，2不能设置file属性，必须留空。

rollingPolicy：
:

必要节点，包含文件名及“%d”转换符， “%d”可以包含一个java.text.SimpleDateFormat指定的时间格式，如：%d{yyyy-MM}。如果直接使用 %d，默认格式是 yyyy-MM-dd。RollingFileAppender 的file字节点可有可无，通过设置file，可以为活动文件和归档文件指定不同位置，当前日志总是记录到file指定的文件（活动文件），活动文件的名字不会改变；如果没设置file，活动文件的名字会根据fileNamePattern 的值，每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。

可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每个月滚动，且是6，则只保存最近6个月的文件，删除之前的旧文件。注意，删除旧文件是，那些为了归档而创建的目录也会被删除。

triggeringPolicy:
:这是活动文件的大小，默认值是10MB。

例如：每天生成一个日志文件，保存30天的日志文件。

<configuration>   
  <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">   
      
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">   
      <fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>   
      <maxHistory>30</maxHistory>    
    </rollingPolicy>   
   
    <encoder>   
      <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>   
    </encoder>   
  </appender>    
   
  <root level="DEBUG">   
    <appender-ref ref="FILE" />   
  </root>   
</configuration>

本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。