第九章 springboot源码系列-springboot主要特性

你的名字 2022-10-13 05:06 160阅读 0赞

**目录**

一、SpringBoot的定义和主要特性

1.1 定义

1.2 主要特性

二、配置文件

2.1 全局配置文件概述

2.2 配置文件详解

2.2.1 ConfigurationProperties注解方式（批量属性注入）

2.2.2 @Value属性值注入

三、springboot日志框架

3.1 日志框架介绍

3.2 统一日志框架分析

3.3 springboot整合logback

3.3.1 排除其他日志框架

3.3.2 统一框架引入替换包以及导入logback

--------------------

# 一、SpringBoot的定义和主要特性 #

## 1.1 定义 ##

SpringBoot是由Pivotal团队在2013年开始研发、2014年4月发布第一个版本的全新开源的轻量级框架。它基于Spring4.0设计，不仅继承了Spring框架原有的优秀特性，而且还通过简化配置来进一步简化了Spring应用的整个搭建和开发过程。另外SpringBoot通过集成大量的框架使得依赖包的版本冲突，以及引用的不稳定性等问题得到了很好的解决。

## 1.2 主要特性 ##

*  SpringBoot Starter：他将常用的依赖分组进行了整合，将其合并到一个依赖中，这样就可以一次性添加到项目的Maven或Gradle构建中；
 *  使编码变得简单，SpringBoot采用 JavaConfig的方式对Spring进行配置，并且提供了大量的注解，极大的提高了工作效率。
 *  自动配置：SpringBoot的自动配置特性利用了Spring对条件化配置的支持，合理地推测应用所需的bean并自动化配置他们；
 *  使部署变得简单，SpringBoot内置了三种Servlet容器，Tomcat，Jetty,undertow.我们只需要一个Java的运行环境就可以跑SpringBoot的项目了，SpringBoot的项目可以打成一个jar包。

# 二、配置文件 #

## 2.1 全局配置文件概述 ##

全局配置文件能够对一些默认配置值进行修改及自定义配置。Spring Boot使用一个application.properties或者application.yaml的文件作为全局配置文件。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2tpbmcxMzEyNw_size_16_color_FFFFFF_t_70][]

按照优先级：

1.  先去项目根目录找config文件夹下找配置文件件
2.  再去根目录下找配置文件
3.  去resources下找cofnig文件夹下找配置文件
4.  去resources下找配置文件

SpringBoot会从这四个位置全部加载主配置文件，如果高优先级中配置文件属性与低优先级配置文件不冲突的属性，则会共同存在，如果冲突了，默认使用优先读取到的。 如果我们的配置文件名字不叫application.properties或者application.yml，则可以启动时候指定配置文件。注意如果同时存在application.properties和application.yml，2.4.0之前版本，优先级properties>yaml。

## 2.2 配置文件详解 ##

我们通常可以在application.properties/yaml文件中定义Spring Boot项目的相关属性，当然，这些相关属性可以是系统属性、环境变量、命令参数等信息，也可以是自定义配置文件名称和位置。这些就不细说了，主要说一下属性注入。

使用Spring Boot全局配置文件设置属性时，如果配置属性是Spring Boot已有属性，例如服务端口server.port，那么Spring Boot内部会自动扫描并读取这些配置文件中的属性值并覆盖默认属性。如果配置的属性是用户自定义属性，例如刚刚自定义的Person实体类属性，还必须在程序中注入这些配置属性方可生效。

属性注入常用注解：

*  @Configuration：声明一个类作为配置类
 *  @Bean：声明在方法上，将方法的返回值加入Bean容器
 *  @Value：属性注入
 *  @ConfigurationProperties(prefix = "jdbc")：批量属性注入
 *  @PropertySource("classpath:/jdbc.properties")指定外部属性文件。在类上添加

### 2.2.1 ConfigurationProperties注解方式（批量属性注入） ###

@Component   //用于将Person类作为Bean注入到Spring容器中
    @ConfigurationProperties(prefix = "person") //将配置文件中以person开头的属性注入到该类
    public class Person {
     private int id;       //id
     private String name;    //名称
     private List hobby;    //爱好
     private String[] family; //家庭成员
     private Map map;
     private Pet pet;      //宠物
      // 省略属性getXX()和setXX()方法
      // 省略toString()方法
    }

prop配置方式：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2tpbmcxMzEyNw_size_16_color_FFFFFF_t_70 1][]

yaml配置方式：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2tpbmcxMzEyNw_size_16_color_FFFFFF_t_70 2][]

### 2.2.2 @Value属性值注入 ###

以配置数据源举例：

jdbc.driverClassName=com.mysql.jdbc.Driver
    jdbc.url=jdbc:mysql://127.0.0.1:3306/springboot_h
    jdbc.username=root
    jdbc.password=123

创建JdbcConfiguration类： 使用spring中的value注解对每个属性进行注入,用bean注解将返回值添加到容器中

@Configuration
    public class JdbcConfiguration {
      @Value("${jdbc.url}")
      String url;
      @Value("${jdbc.driverClassName}")
      String driverClassName;
      @Value("${jdbc.username}")
      String username;
      @Value("${jdbc.password}")
      String password;
      @Bean
      public DataSource dataSource() {
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setUrl(url);
        dataSource.setDriverClassName(driverClassName);
        dataSource.setUsername(username);
        dataSource.setPassword(password);
        return dataSource;
     }
    }

# 三、springboot日志框架 #

## 3.1 日志框架介绍 ##

市面上常见的日志框架有很多，比如：JCL、SLF4J、Jboss-logging、jUL、log4j、log4j2、logback等等，我们该如何选择呢？  
通常情况下，日志是由一个抽象层+实现层的组合来搭建的。Spring 框架选择使用了 JCL 作为默认日志输出。而 Spring Boot 默认选择了 SLF4J 结合 LogBack。

![20210706114925916.png][]

## 3.2 统一日志框架分析 ##

一般情况下，在项目中存在着各种不同的第三方 jar ，且它们的日志选择也可能不尽相同，显然这样是不利于我们使用的，那么如果我们想为项目设置统一的日志框架该怎么办呢？

SLF4J 作为一个日志的抽象层，可以很好的整合各类实现。

下图是 SLF4J 结合各种日志框架的官方示例，从图中可以清晰的看出 SLF4J API 永远作为日志的门面，直接应用与应用程序中。我们发现有些日志框架直接实现了SLF4J ，比如logback，有的是通过SLF4J 的适配器进行调用下层的实现。但是具体的实现层日志框架都有自己的配置文件，所以在使用 SLF4j 之后，配置文件还是要使用实现日志框架的配置文件。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2tpbmcxMzEyNw_size_16_color_FFFFFF_t_70 3][]

统一日志框架使用步骤归纳如下：

1.  排除系统中的其他日志框架。
2.  使用中间包替换要替换的日志框架。
3.  导入我们选择的 SLF4J 实现。

## 3.3 springboot整合logback ##

我们知道，springboot应用的是sl4j+logback的日志框架，而Spring用的是commons logging日志框架，springbot是如何进行日志框架兼容的呢，我们可以按照上面步骤进行源码查看分析，是否符合3.2的步骤。

### 3.3.1 排除其他日志框架 ###

在 Spring Boot 的 Maven 依赖里可以清楚的看到 Spring Boot 排除了其他日志框架。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2tpbmcxMzEyNw_size_16_color_FFFFFF_t_70 4][]

### 3.3.2 统一框架引入替换包以及导入logback ###

Spring Boot 是使用了 SLF4J+logback 的日志框架组合，查看 Spring Boot 项目的 Maven 依赖关系可以看到 Spring Boot 的核心启动器 spring-boot-starter 引入了 spring-boot-starter-logging。而 spring-boot-starter-logging 的 Maven 依赖主要引入了 logback-classic (包含了日志框Logback的实现)，log4j-to-slf4j (在 log4j 日志框架作者开发此框架的时候还没有想到使用日志抽象层进行开发，因此出现了 log4j 向 slf4j 转换的工具)，jul-to-slf4j ( Java 自带的日志框架转换为 slf4j)。

<dependencies>
      <dependency>
       <groupId>ch.qos.logback</groupId>
       <artifactId>logback-classic</artifactId>
       <version>1.2.3</version>
       <scope>compile</scope>
      </dependency>
      <dependency>
       <groupId>org.apache.logging.log4j</groupId>
       <artifactId>log4j-to-slf4j</artifactId>
       <version>2.13.3</version>
       <scope>compile</scope>
      </dependency>
      <dependency>
       <groupId>org.slf4j</groupId>
       <artifactId>jul-to-slf4j</artifactId>
       <version>1.7.30</version>
       <scope>compile</scope>
      </dependency>
     </dependencies>

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2tpbmcxMzEyNw_size_16_color_FFFFFF_t_70]: /images/20221005/cc8fa96787c8404ba92d6da6b61eefcf.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2tpbmcxMzEyNw_size_16_color_FFFFFF_t_70 1]: /images/20221005/6878989aedca42d0adcc304e6899e08a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2tpbmcxMzEyNw_size_16_color_FFFFFF_t_70 2]: /images/20221005/be07e723d4b7449fae0d3be1854a44df.png
[20210706114925916.png]: /images/20221005/4c14e347317c402eb6592cfc158baf10.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2tpbmcxMzEyNw_size_16_color_FFFFFF_t_70 3]: /images/20221005/4d26f113f76d4da6ae9b60a1ecb16106.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2tpbmcxMzEyNw_size_16_color_FFFFFF_t_70 4]: /images/20221005/5bd1d6f89b94409cbad3dd0c67f1e243.png