SpringBoot核心配置和日志

目录

 

一、SpringBoot的配置文件

目录

一、SpringBoot的配置文件

1.YAML的使用

2.@Value注入数据

3.JSR303数据校验配置文件注入的值

4.加载指定配置文件

5.@ImportResource 使用xml配置

6.Profile多环境支持

二、SpringBoot日志配置

1.默认日志配置

2.修改日志文件生成路径

3.修改日志输出的格式

4.日志底层分析

5.自定义日志配置

6.使用 Profile 特殊配置


一、SpringBoot的配置文件

  • Spring Boot 使用一个全局配置文件,放置在 src/main/resources 目录或类路径的 /config下,有两种格式:
    • application.properties
    • application.yml
  • 配置文件的作用:修改 Spring Boot 自动配置的默认值

1.YAML的使用

YAML基本语法

  • key: value 表示一对键值对(冒号后面必须要有空格) 
  • 使用空格缩进表示层级关系 
  • 左侧缩进的空格数目不重要,只要同一层级的元素左侧对齐即可 
  • key 与 value 大小写敏感
    server:
      port: 8888 #修改端口
      contextPath: /hello  #修改上下文路径

  • 字符串默认不用加上引号

    • " "双引号转义特殊字符,如:name: "aaa \n bbb" 输出 aaa 换行 bbb

    • ' '单引号不会转义特殊字符当作一个普通的字符串输出,如:name: 'aaa \n bbb' 输出 aaa \n bbb

 yaml 配置文件注入数据

编写javabean类

/*
* @ConfigurationProperties将配置文件中对应的属性值映射到这个组件类中
* prefix="emp" :配置文件中的前缀名
*/
@Component
@ConfigurationProperties(prefix = "emp")
public class Emp {
    private String name;
    private int age;
    private Date birthday;
    private double salary;
    private Map map;

    get()/set()...
}

编写application.yml配置文件

emp:
  name: 张三 #有中文先设置编码,防止乱码(Settings->File Encodings)
  age: 20
  salary: 10000
  map:
    key1: 0
    key2: 2

 

2.@Value注入数据

@Component
//@ConfigurationProperties(prefix = "emp")
public class Emp {

    @Value(value = "${emp.name}")
    private String name;
    @Value("#{2*10}")
    private int age;
    @Value("#{3*100}")
    private double salary;
}

打印测试

@RunWith(SpringRunner.class)
@SpringBootTest
class SpringBoot02ConfigApplicationTests {
    @Autowired
    Emp emp;
    @Test
    void contextLoads() {
        System.out.println(emp);
    }
}

@Value 与 @ConfigurationProperties 获取值的差异

 

3.JSR303数据校验配置文件注入的值

使用场景:校验是否为合法的邮箱地址

1.使用@ConfigurationProperties(prefix="emp")将配置文件中对应属性值映射到组件类中,prefix配置文件中的前缀名

#application.properties

emp:
  name: 张三
  email: 123

2.添加@Validated数据校验注解

// Email是这个包下面的类
import javax.validation.constraints.Email;

@Component
@ConfigurationProperties(prefix = "emp") 
@Validated
public class Emp {
    private String name;
    @Email
    private String email;
}

 

4.加载指定配置文件

@PropertySource加载局部配置文件

@ConfifigurationProperties 默认从全局配置文件 (application.properties或application.yml) 中获取值 , 所有配置数据写在全局配置文件中,显得太臃肿了, 可将它们抽取出来,放到其他局部配置文件中
 
1. 将全局配置文件中的 emp 相关配置数据 抽取 到 resources/ emp.properties 文件中
emp.name=李四
emp.age=20
emp.salary=23000
emp.map.key1=value1 
emp.map.key2=value2
2. @PropertySource :加载指定的配置文件 ; value 属性是数组类型 , 用于指定文件位置
@PropertySource(value = {"classpath:emp.properties"})
@Component
public class Emp {
    String name;
    Integer age;
    double salary;
    Map<String, String> map;
}

 

5.@ImportResource 使用xml配置

SpringBoot提倡零配置, 即无xml配置,但是在实际开发中,可能有一些特殊要求必须使用 xml 配置,这时我们可以通过 Spring 提供的 @ImportResource 来加载 xml 配置文件

@ImportResource :加载Spring的xml配置文件内容加载到容器中使用

@ImportResource(locations={"classpath:spring.xml"})
@SpringBootApplication
public class SpringBootTestConfigApplication{
    public static void main(String[] args){
        SpringApplication.run(SpringBootTestConfigApplication.class, args);
    }
}

 

6.Profile多环境支持

Profile是Spring用来针对不同的环境要求,提供不同的配置支持,全局Profile配置使用的文件名可以是application-{profile}.properties / application-{profile}.ym,如:

  • application-dev.properties
  • application-pro.properties

在application.properties激活指定Profile:

spring.profiles.active=dev #表示使用application-dev.properties配置文件

 

二、SpringBoot日志配置

1.默认日志配置

SpringBoot采用了 slf4j(日志抽象层) + logback(日志实现) 的组合形式,Spring Boot也提供对JUL、log4j2、Logback提供

@SpringBootTest
public class SpringBootLoggingApplicationTests {
    //日志记录器 
    Logger logger = LoggerFactory.getLogger(getClass()); 

    @Test
    public void contextLoads() { 
        //1.以下日志级别,由低到高:trace < debug < info < warn < error 
        //2. Spring Boot默认设定的是 info 级别日志,(日志默认级别也称为root级别)。可修改默认级别日志:logging.level.level=级别名 
        //3. 可以进行调整日志级别,设定某个级别后,就只打印设定的这个级别及后面高级别的日志信息,没有指定级别的就用SpringBoot默认规定的级别:root级别 
        //4. 可修改指定包的日志级别: 指定某个包下面的所有日志级别:logging.level.包名=级别名 
    
        //跟踪运行信息 
        logger.trace("这是 trace 日志信息!"); 
        //调试信息 
        logger.debug("这是 debug 日志信息!");
        //自定义信息
        logger.info("这是 info 日志信息"); 
        //警告信息:如果运行结果是不预期的值,则可以进行警告 
        logger.warn("这是 warn 日志信息"); 
        //错误信息:出现异常捕获时 
        logger.error("这是 error 日志信息");
    }
}

修改日志默认级别

# 调整日志级别: trace < debug < info < warn < error 
# com.test包下的级别 
logging.level.com.test=trace
# 设置root级别 
logging.level.root=debug

2.修改日志文件生成路径

logging.filelogging.path示例说明
(none)(none) 只在控制台输出
指定文件名(none)springboot.log输出到当前项目根路径下的 springboot.log 文件中
(none)指定目录 /springboot/log输出到当前项目所在磁盘根路径下的 /springboot/log目录中的 spring.log 文件中
指定文件名指定目录 当两个同时指定时,采用的是 logging.file 指定。
推荐使用 logging.file 设置即可,因为它可自定义文
件名

application.properties配置文件:

#输出到当前项目根路径下的springboot.log文件中
#logging.file=springboot.log 


#输出到当前项目所在磁盘根路径下的 /springboot/log目录中的spring.log文件中logging.path=springboot/log

3.修改日志输出的格式

application.properties配置文件:

# 日志输出格式说明: 
# %d 输出日期时间, 
# %thread 输出当前线程名, 
# %-5level 输出日志级别,左对齐5个字符宽度 
# %logger{50} 输出全类名最长50个字符,超过按照句点分割 
# %msg 日志信息 # %n 换行符 

# 修改控制台输出的日志格式 
logging.pattern.console=%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n 

# 修改文件中输出的日志格式 
logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss.SSS} >>> [%thread] >>> %-5level >>> %logger{50} >>> %msg%n

4.日志底层分析

springboot引用了spring-boot-starter-web依赖

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

通过spring-boot-starter-web --> spring-boot-starter -- > spring-boot-starter-logging 可以看到引入了logback的依赖

    <!--引入logback的依赖-->
    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-classic</artifactId>
      <version>1.2.3</version>
      <scope>compile</scope>
    </dependency>
    <!--log4j转slf4j-->
    <dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-to-slf4j</artifactId>
      <version>2.12.1</version>
      <scope>compile</scope>
    </dependency>
    <!--jul转slf4j-->
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>jul-to-slf4j</artifactId>
      <version>1.7.30</version>
      <scope>compile</scope>
    </dependency>
spring-boot-2.0.6.RELEASE.jar\org\springframework\boot\logging\logback\base.xml 做了日志的默认配置
 
<included>
    <!--日志格式默认规定-->
	<include resource="org/springframework/boot/logging/logback/defaults.xml" />
    <!--日志文件默认生成路径-->
	<property name="LOG_FILE" 
value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}}/spring.log}"/>
    <!--控制台日志信息默认配置-->
	<include resource="org/springframework/boot/logging/logback/console-appender.xml" />
    <!--文件中日志信息默认配置-->    
	<include resource="org/springframework/boot/logging/logback/file-appender.xml" />
    <!--日志级别默认为: info -->
	<root level="INFO">
		<appender-ref ref="CONSOLE" />
		<appender-ref ref="FILE" />
	</root>
</included>

日志文件采用滚动文件追加器

 
 

5.自定义日志配置

在类路径下,存放对应日志框架的自定义配置文件logback.xml即可,SpringBoot就不会使用它默认的日志配置文件了

<?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="/logs/log" />
    <!-- 定义日志文件名称 -->
    <property name="appName" value="spring-boot"></property>
    <!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 -->
    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <!--
			日志输出格式说明:
				    %d 		输出日期时间
				    %thread 输出当前线程名
				    %-5level  	输出日志级别,左对齐5个字符宽度
				    %logger{50} 输出全类名最长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.hzh" 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> 

6.使用 Profile 特殊配置

使用日志 Profille 特殊配置 , 可根据不同的环境激活不同的日志配置
  • 将自定义日志配置文件名 logback.xml 改为 logback-spring.xml(必须为这个命名,否则报错)
根据上面xml配置文件添加配置:
<!--类似if语句-->
<springProfile name="dev"> 
    <!--如果是开发环境,设置日志级别为debug-->
    <logger name="com.hzh" level="debug" />
</springProfile> 
<springProfile name="!dev"> 
    <!--如果不是开发环境,设置日志级别为info-->
    <logger name="com.hzh" level="info" />
</pattern>

 

 
  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 2
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值