02-springBoot-基础配置

基础配置

1. 日志配置

日志门面和日志实现

我们首先要区分一下,什么是日志门面(Facade)什么是日志实现,我们之前学习的JUL实际上就是一种日志实现,我们可以直接使用JUL为我们提供的日志框架来规范化打印日志,而日志门面,如Slf4j,是把不同的日志系统的实现进行了具体的抽象化,只提供了统一的日志使用接口,使用时只需要按照其提供的接口方法进行调用即可,由于它只是一个接口,并不是一个具体的可以直接单独使用的日志框架,所以最终日志的格式、记录级别、输出方式等都要通过接口绑定的具体的日志系统来实现,这些具体的日志系统就有log4j、logback、java.util.logging等,它们才实现了具体的日志系统的功能。

日志门面和日志实现就像JDBC和数据库驱动一样,一个是画大饼的,一个是真的去做饼的。
02-springBoot-基础配置_第1张图片

但是现在有一个问题就是,不同的框架可能使用了不同的日志框架,如果这个时候出现众多日志框架并存的情况,我们现在希望的是所有的框架一律使用日志门面(Slf4j)进行日志打印,这时该怎么去解决?我们不可能将其他框架依赖的日志框架替换掉,直接更换为Slf4j吧,这样显然不现实。

这时,可以采取类似于偷梁换柱的做法,只保留不同日志框架的接口和类定义等关键信息,而将实现全部定向为Slf4j调用。相当于有着和原有日志框架一样的外壳,对于其他框架来说依然可以使用对应的类进行操作,而具体如何执行,真正的内心已经是Slf4j的了。
02-springBoot-基础配置_第2张图片

所以,SpringBoot为了统一日志框架的使用,做了这些事情:

  • 直接将其他依赖以前的日志框架剔除
  • 导入对应日志框架的Slf4j中间包
  • 导入自己官方指定的日志实现,并作为Slf4j的日志实现层

在SpringBoot中打印日志信息

新建项目
02-springBoot-基础配置_第3张图片
勾选web 、lombok依赖
02-springBoot-基础配置_第4张图片

SpringBoot使用的是Slf4j作为日志门面,Logback(Logback 是log4j 框架的作者开发的新一代日志框架,它效率更高、能够适应诸多的运行环境,同时天然支持SLF4J)作为日志实现,对应的依赖为:

<dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-loggingartifactId>
dependency>

此依赖已经被包含了,所以我们如果需要打印日志,可以像这样:

@RestController
public class MainController {
    @GetMapping ("/login")
    public String login(){
        Logger logger = LoggerFactory.getLogger(MainController.class);
        logger.info("用户访问了一次登陆界面");
        return "login";
    }
}

因为我们使用了Lombok,所以直接一个注解也可以搞定哦:

@Slf4j
@RestController
public class MainController {
    @GetMapping ("/login")
    public String login(){
        log.info("用户访问了一次登陆界面");
        return "login";
    }
}

02-springBoot-基础配置_第5张图片
日志级别从低到高分为
TRACE < DEBUG < INFO < WARN < ERROR < FATAL
SpringBoot默认只会打印INFO以上级别的信息。
可以通过启动您的应用程序–debug标志来启用“调试”模式(开发的时候推荐开启),以下两种方式皆可:

在运行命令后加入–debug标志,如:$ java -jar springTest.jar --debug
在application.properties中配置debug=true,该属性置为true的时候,核心Logger(包含嵌入式容器、hibernate、spring)会输出更多内容,但是你自己应用的日志并不会输出为DEBUG级别。

1.1 配置log4j2

log4j2官网

1.2 配置logback

logback官网
指南

1.2.1简单示例

在resources下创建logback.xml文件
添加以下内容

<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%npattern>
        encoder>
    appender>

    <root level="debug">
        <appender-ref ref="STDOUT" />
    root>
configuration>

在测试类中测试日志
结果如下:

02-springBoot-基础配置_第6张图片

和JUL一样,Logback也能实现定制化,我们可以编写对应的配置文件,SpringBoot推荐将配置文件名称命名为

logback-spring.xml表示这是SpringBoot下Logback专用的配置,可以使用SpringBoot 的高级Profile功能,它的内容类似于这样:


<configuration>
    
configuration>

最外层由configuration包裹,一旦编写,那么就会替换默认的配置,所以如果内部什么都不写的话,那么会导致我们的SpringBoot项目没有配置任何日志输出方式,控制台也不会打印日志。

我们接着来看如何配置一个控制台日志打印,我们可以直接导入并使用SpringBoot为我们预设好的日志格式,在org/springframework/boot/logging/logback/defaults.xml中已经帮我们把日志的输出格式定义好了,我们只需要设置对应的appender即可:


<configuration>
    
    <include resource="org/springframework/boot/logging/logback/defaults.xml" />

    
    
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}pattern>
            <charset>${CONSOLE_LOG_CHARSET}charset>
        encoder>
    appender>

    
    <root level="INFO">
        <appender-ref ref="CONSOLE"/>
    root>
configuration>

配置完成后,我们发现控制台已经可以正常打印日志信息了。

接着我们来看看如何开启文件打印,我们只需要配置一个对应的Appender即可:


<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <encoder>
        <pattern>${FILE_LOG_PATTERN}pattern>
        <charset>${FILE_LOG_CHARSET}charset>
    encoder>
    
    <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
        
        <FileNamePattern>log/%d{yyyy-MM-dd}-spring-%i.logFileNamePattern>
        
        <cleanHistoryOnStart>truecleanHistoryOnStart>
        
        <maxHistory>7maxHistory>
        
        <maxFileSize>10MBmaxFileSize>
    rollingPolicy>
appender>


<root level="INFO">
    <appender-ref ref="CONSOLE"/>
    <appender-ref ref="FILE"/>
root>

配置完成后,我们可以看到日志文件也能自动生成了。

我们也可以魔改官方提供的日志格式,官方文档:https://logback.qos.ch/manual/layouts.html

这里需要提及的是MDC机制,Logback内置的日志字段还是比较少,如果我们需要打印有关业务的更多的内容,包括自定义的一些数据,需要借助logback MDC机制,MDC为“Mapped Diagnostic Context”(映射诊断上下文),即将一些运行时的上下文数据通过logback打印出来;此时我们需要借助org.sl4j.MDC类。

比如我们现在需要记录是哪个用户访问我们网站的日志,只要是此用户访问我们网站,都会在日志中携带该用户的ID,我们希望每条日志中都携带这样一段信息文本,而官方提供的字段无法实现此功能,这时就需要使用MDC机制:

@Slf4j
@Controller
public class MainController {

    @RequestMapping("/login")
    public String login(HttpServletRequest request){
        MDC.put("reqId",  request.getSession().getId());
        log.info("有人访问了一次登陆界面");
        return "login";
    }
}

通过这种方式,我们就可以向日志中传入自定义参数了,我们日志中添加这样一个占位符%X{键值},名字保持一致:

 %clr([%X{reqId}]){faint} 

这样当我们向MDC中添加信息后,只要是当前线程(本质是ThreadLocal实现)下输出的日志,都会自动替换占位符。

自定义Banner

我们在之前发现,实际上Banner部分和日志部分是独立的,SpringBoot启动后,会先打印Banner部分,那么这个Banner部分是否可以自定义呢?答案是可以的。

我们可以直接来配置文件所在目录下创建一个名为banner.txt的文本文档,内容随便你:

//                          _ooOoo_                               //
//                         o8888888o                              //
//                         88" . "88                              //
//                         (| ^_^ |)                              //
//                         O\  =  /O                              //
//                      ____/`---'\____                           //
//                    .'  \\|     |//  `.                         //
//                   /  \\|||  :  |||//  \                        //
//                  /  _||||| -:- |||||-  \                       //
//                  |   | \\\  -  /// |   |                       //
//                  | \_|  ''\---/''  |   |                       //
//                  \  .-\__  `-`  ___/-. /                       //
//                ___`. .'  /--.--\  `. . ___                     //
//              ."" '<  `.___\_<|>_/___.'  >'"".                  //
//            | | :  `- \`.;`\ _ /`;.`/ - ` : | |                 //
//            \  \ `-.   \_ __\ /__ _/   .-` /  /                 //
//      ========`-.____`-.___\_____/___.-`____.-'========         //
//                           `=---='                              //
//      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^        //
//             佛祖保佑          永无BUG         永不修改             //

可以使用在线生成网站进行生成自己的个性Banner:https://www.bootschool.net/ascii

我们甚至还可以使用颜色代码来为文本切换颜色:

${AnsiColor.BRIGHT_GREEN}  //绿色

也可以获取一些常用的变量信息:

${AnsiColor.YELLOW} 当前 Spring Boot 版本:${spring-boot.version}

::: note
优先使用log4j2,详见
:::

2. application.properties

src/main/resources目录下,Spring Boot提供了一个名为application.properties的全局配置文件,可对一些默认配置的配置值进行修改。

application.properties中可配置所有官方属性

2.1 自定义属性值

Spring Boot允许我们在application.properties下自定义一些属性,比如:

hanwu.blog.name=hanwu's blog
hanwu.blog.title=Spring Boot

定义一个BlogProperties Bean,通过@Value(“${属性名}”)来加载配置文件中的属性值:

@Component
@Data
public class BlogProperties {
	
    @Value("${hanwu.blog.name}")
    private String name;
    
    @Value("${hanwu.blog.title}")
    private String title;
}

编写IndexController,注入该Bean:

@RestController
public class IndexController {
    @Resource
    private BlogProperties blogProperties;
    @GetMapping("/")
    String index(){
        return blogProperties.getName()+"——"+blogProperties.getTitle();
    }

}

02-springBoot-基础配置_第7张图片

2.2 自定义属性类

在属性非常多的情况下,也可以定义一个和配置文件对应的Bean

@ConfigurationProperties(prefix="hanwu.blog")
public class ConfigBean {
    private String name;
    private String title;
    // get,set略
}

除此之外还需在Spring Boot入口类加上注解@EnableConfigurationProperties({ConfigBean.class})来启用该配置:
之后便可在IndexController中注入该Bean使用了:

在application.properties配置文件中,各个属性可以相互引用,如下:

mrbird.blog.name=mrbird's blog
mrbird.blog.title=Spring Boot
mrbird.blog.wholeTitle=${mrbird.blog.name}--${mrbird.blog.title}

2.3通过命令行设置属性值

在运行Spring Boot jar文件时,可以使用命令java -jar xxx.jar --server.port=8081来改变端口的值。

如果不想项目的配置被命令行修改,可以在入口文件的main方法中进行如下设置:

public static void main(String[] args) {
    SpringApplication app = new SpringApplication(Application.class);
    app.setAddCommandLineProperties(false);
    app.run(args);
}

2.4多环境Profile配置

Profile用来针对不同的环境下使用不同的配置文件,多环境配置文件必须以application-{profile}.properties的格式命,其中{profile}为环境标识。比如定义两个配置文件:

application-dev.properties:开发环境

server.port=8080

application-prod.properties:生产环境

server.port=8081

至于哪个具体的配置文件会被加载,需要在application.properties文件中通过spring.profiles.active属性来设置,其值对应{profile}值。

如:spring.profiles.active=dev就会加载application-dev.properties配置文件内容。可以在运行jar文件的时候使用命令java -jar xxx.jar --spring.profiles.active={profile}切换不同的环境配置。

你可能感兴趣的:(springboot,spring,boot,java,spring)