环境

现在IDEA创建springboot默认就是springBoot3.2.5，JDK最低要求为17

基本介绍

pom.xml

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.2.5</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    ...
     <properties>
        <java.version>17</java.version>
    </properties>
    ...
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

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

启动器

• 官方提供的场景：命名为：spring-boot-starter-*，如下：

  		<dependency>
              <groupId>org.springframework.boot</groupId>
              <artifactId>spring-boot-starter-amqp</artifactId>
          </dependency>
          <dependency>
              <groupId>org.springframework.boot</groupId>
              <artifactId>spring-boot-starter-data-redis</artifactId>
          </dependency>
          <dependency>
              <groupId>org.springframework.boot</groupId>
              <artifactId>spring-boot-starter-thymeleaf</artifactId>
          </dependency>
  

• 第三方提供场景：命名为：*-spring-boot-starter，如下：

          <dependency>
              <groupId>org.mybatis.spring.boot</groupId>
              <artifactId>mybatis-spring-boot-starter</artifactId>
              <version>2.2.2</version>
          </dependency>
  

依赖管理机制分析

为什么导入starter-web所有相关依赖都导入进来？

• 开发什么场景，导入什么场景启动器。
• maven依赖传递原则。A-B-C： A就拥有B和C
• 导入 场景启动器。 场景启动器 自动把这个场景的所有核心依赖全部导入进来
  

为什么版本号都不用写？

• 每个boot项目都有一个父项目spring-boot-starter-parent
• parent的父项目是spring-boot-dependencies
• 父项目 版本仲裁中心，把所有常见的jar的依赖版本都声明好了。
• 比如：spring-boot-starter-amqp

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

自定义版本号

• 利用maven的就近原则

  • 直接在当前项目properties标签中声明父项目用的版本属性的key

        <properties>
            <java.version>17</java.version>
            <lombok.version>1.18.22</lombok.version>
        </properties>
        ...
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>${lombok.version}</version>
            </dependency>
    

  • 直接在导入依赖的时候声明版本

            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>1.18.22</version>
            </dependency>
    

第三方的依赖

boot父项目没有管理的需要自行声明好

<!-- https://mvnrepository.com/artifact/com.alibaba/druid -->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.2.16</version>
</dependency>

总结

自动配置机制

理解

自动配置的 Tomcat、SpringMVC 等

• 导入场景，容器中就会自动配置好这个场景的核心组件。
• 以前：DispatcherServlet、ViewResolver、CharacterEncodingFilter…
• 现在：自动配置好的这些组件
• 验证：容器中有了什么组件，就具有什么功能

    public static void main(String[] args) {
        var ioc = SpringApplication.run(MainApplication.class, args);
        //1、获取容器中所有组件的名字
        String[] names = ioc.getBeanDefinitionNames();
        //2、挨个遍历：
        // dispatcherServlet、beanNameViewResolver、characterEncodingFilter、multipartResolver
        // SpringBoot把以前配置的核心组件现在都给我们自动配置好了。
        for (String name : names) {
            System.out.println(name);
        }

    }

默认的包扫描规则

• @SpringBootApplication 标注的类就是主程序类
• SpringBoot只会扫描主程序所在的包及其下面的子包，自动的component-scan功能
• 自定义扫描路径
  • @SpringBootApplication(scanBasePackages = “cn.kgc”)
  • @ComponentScan(“cn.kgc”) 直接指定扫描的路径

配置默认值

• 配置文件的所有配置项是和某个类的对象值进行一一绑定的。
• 绑定了配置文件中每一项值的类： 属性类。
• 比如：ServerProperties绑定了所有Tomcat服务器有关的配置；MultipartProperties绑定了所有文件上传相关的配置

按需加载自动配置

• 导入场景spring-boot-starter-web
• 场景启动器除了会导入相关功能依赖，导入一个spring-boot-starter，是所有starter的starter，基础核心starter
• spring-boot-starter导入了一个包 spring-boot-autoconfigure。包里面都是各种场景的AutoConfiguration自动配置类
• 虽然全场景的自动配置都在 spring-boot-autoconfigure这个包，但是不是全都开启的；导入哪个场景就开启哪个自动配置

总结

导入场景启动器、触发 spring-boot-autoconfigure这个包的自动配置生效、容器中就会具有相关场景的功能

自动配置流程

问题

1. SpringBoot怎么实现导一个starter、写一些简单配置，应用就能跑起来，我们无需关心整合
2. 为什么Tomcat的端口号可以配置在application.properties中，并且Tomcat能启动成功？
3. 导入场景后哪些自动配置能生效？
   

流程步骤

• 1. 导入starter-web：导入了web开发场景
  • 1.1 场景启动器导入了相关场景的所有依赖：starter-json、starter-tomcat、springmvc
  • 1.2 每个场景启动器都引入了一个spring-boot-starter，核心场景启动器。
  • 1.3 核心场景启动器引入了spring-boot-autoconfigure包。
  • 1.4 spring-boot-autoconfigure里面囊括了所有场景的所有配置。
  • 1.5 只要这个包下的所有类都能生效，那么相当于SpringBoot官方写好的整合功能就生效了。
  • 1.6 SpringBoot默认却扫描不到 spring-boot-autoconfigure下写好的所有配置类。（这些配置类给我们做了整合操作），默认只扫描主程序所在的包。
• 2. 主程序：@SpringBootApplication
  • 2.1 @SpringBootApplication由三个注解组成@SpringBootConfiguration、@EnableAutoConfiguratio、@ComponentScan
  • 2.2 SpringBoot默认只能扫描自己主程序所在的包及其下面的子包，扫描不到 spring-boot-autoconfigure包中官方写好的配置类
  • 2.3 @EnableAutoConfiguration：SpringBoot 开启自动配置的核心。
    • 2.3.1 是由@Import(AutoConfigurationImportSelector.class)提供功能：批量给容器中导入组件。
    • 2.3.2 SpringBoot启动会默认加载 142个配置类。
    • 2.3.3 这142个配置类来自于spring-boot-autoconfigure下 META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件指定的
      ○ 项目启动的时候利用 @Import 批量导入组件机制把 autoconfigure 包下的142 xxxxAutoConfiguration类导入进来（自动配置类）
      ○ 虽然导入了142个自动配置类
  • 2.4 按需生效：
    • 并不是这142个自动配置类都能生效
    • 每一个自动配置类，都有条件注解@ConditionalOnxxx，只有条件成立，才能生效
• 3. xxxxAutoConfiguration自动配置类
  • 3.1 给容器中使用@Bean 放一堆组件。
  • 3.2 每个自动配置类都可能有这个注解@EnableConfigurationProperties(ServerProperties.class)，用来把配置文件中配的指定前缀的属性值封装到 xxxProperties属性类中
  • 3.3 以Tomcat为例：把服务器的所有配置都是以server开头的。配置都封装到了属性类中。
  • 3.4 给容器中放的所有组件的一些核心参数，都来自于xxxProperties。xxxProperties都是和配置文件绑定。
    只需要改配置文件的值，核心组件的底层参数都能修改
• 4. 写业务，全程无需关心各种整合（底层这些整合写好了，而且也生效了）

流程总结

1. 导入starter，就会导入autoconfigure包。
2. autoconfigure 包里面 有一个文件 META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports,里面指定的所有启动要加载的自动配置类
3. @EnableAutoConfiguration 会自动的把上面文件里面写的所有自动配置类都导入进来。xxxAutoConfiguration 是有条件注解进行按需加载
4. xxxAutoConfiguration给容器中导入一堆组件，组件都是从 xxxProperties中提取属性值
5. xxxProperties又是和配置文件进行了绑定

导入starter、修改配置文件，就能修改底层行为

总结起来：自动配置原理

导入starter --> 生效xxxxAutoConfiguration --> 组件 --> xxxProperties --> 配置文件

核心技能

常用注解

组件注册

• @Configuration、@SpringBootConfiguration
• @Bean、@Scope
• @Controller、 @Service、@Repository、@Component
• @Import
• @ComponentScan

使用

1. @Configuration 编写一个配置类
2. 在配置类中，自定义方法给容器中注册组件。配合@Bean
3. 或使用@Import 导入第三方的组件

条件注解

如果注解指定的条件成立，则触发指定行为

• @ConditionalOnXxx
• @ConditionalOnClass：如果类路径中存在这个类，则触发指定行为
• @ConditionalOnMissingClass：如果类路径中不存在这个类，则触发指定行为
• @ConditionalOnBean：如果容器中存在这个Bean（组件），则触发指定行为
• @ConditionalOnMissingBean：如果容器中不存在这个Bean（组件），则触发指定行为，使用场景：
  • 如果存在FastsqlException这个类，给容器中放一个Cat组件，名cat01，
  • 否则，就给容器中放一个Dog组件，名dog01
  • 如果系统中有dog01这个组件，就给容器中放一个 User组件，名zhangsan
  • 否则，就放一个User，名叫lisi
• @ConditionalOnBean（value=组件类型，name=组件名字）：判断容器中是否有这个类型的组件，并且名字是指定的值
• @ConditionalOnRepositoryType (org.springframework.boot.autoconfigure.data)
• @ConditionalOnDefaultWebSecurity (org.springframework.boot.autoconfigure.security)
• @ConditionalOnSingleCandidate (org.springframework.boot.autoconfigure.condition)
• @ConditionalOnWebApplication (org.springframework.boot.autoconfigure.condition)
• @ConditionalOnWarDeployment (org.springframework.boot.autoconfigure.condition)
• @ConditionalOnJndi (org.springframework.boot.autoconfigure.condition)
• @ConditionalOnResource (org.springframework.boot.autoconfigure.condition)
• @ConditionalOnExpression (org.springframework.boot.autoconfigure.condition)
• @ConditionalOnClass (org.springframework.boot.autoconfigure.condition)
• @ConditionalOnEnabledResourceChain (org.springframework.boot.autoconfigure.web)
• @ConditionalOnMissingClass (org.springframework.boot.autoconfigure.condition)
• @ConditionalOnNotWebApplication (org.springframework.boot.autoconfigure.condition)
• @ConditionalOnProperty (org.springframework.boot.autoconfigure.condition)
• @ConditionalOnCloudPlatform (org.springframework.boot.autoconfigure.condition)
• @ConditionalOnBean (org.springframework.boot.autoconfigure.condition)
• @ConditionalOnMissingBean (org.springframework.boot.autoconfigure.condition)
• @ConditionalOnMissingFilterBean (org.springframework.boot.autoconfigure.web.servlet)
• @Profile (org.springframework.context.annotation)
• @ConditionalOnInitializedRestarter (org.springframework.boot.devtools.restart)
• @ConditionalOnGraphQlSchema (org.springframework.boot.autoconfigure.graphql)
• @ConditionalOnJava (org.springframework.boot.autoconfigure.condition)

属性绑定

• @ConfigurationProperties： 声明组件的属性和配置文件哪些前缀开始项进行绑定
• @EnableConfigurationProperties：快速注册注解：
  • SpringBoot默认只扫描自己主程序所在的包。
  • 如果导入第三方包，即使组件上标注了@Component、@ConfigurationProperties 注解，也没用。
  • 因为组件都扫描不进来，此时使用这个注解就可以快速进行属性绑定并把组件注册进容器
• 将容器中任意组件（Bean）的属性值和配置文件的配置项的值进行绑定
  • 给容器中注册组件（@Component、@Bean）
  • 使用@ConfigurationProperties 声明组件和配置文件的哪些配置项进行绑定

YAML配置文件

基本语法

• 大小写敏感
• 使用缩进表示层级关系，k: v，使用空格分割k,v
• 缩进时不允许使用Tab键，只允许使用空格。换行
• 缩进的空格数目不重要，只要相同层级的元素左侧对齐即可
• #表示注释，从这个字符一直到行尾，都会被解析器忽略。
• 支持写法：
  • 对象：键值对的集合，如：映射（map）/ 哈希（hash） / 字典（dictionary）
  • 数组：一组按次序排列的值，如：序列（sequence） / 列表（list）
  • 字面量：单个的、不可再分的值，如：字符串、数字、bool、日期

@Component
@ConfigurationProperties(prefix = "person") //和配置文件person前缀的所有配置进行绑定
@Data //自动生成JavaBean属性的getter/setter
//@NoArgsConstructor //自动生成无参构造器
//@AllArgsConstructor //自动生成全参构造器
public class Person {
    private String name;
    private Integer age;
    private Date birthDay;
    private Boolean like;
    private Child child; //嵌套对象
    private List<Dog> dogs; //数组（里面是对象）
    private Map<String,Cat> cats; //表示Map
}

@Data
public class Dog {
    private String name;
    private Integer age;
}

@Data
public class Child {
    private String name;
    private Integer age;
    private Date birthDay;
    private List<String> text; //数组
}

@Data
public class Cat {
    private String name;
    private Integer age;
}

person:
  name: 张三
  age: 18
  birthDay: 1996/12/12 12:12:12
  like: true
  child:
    name: 李四
    age: 20
    birthDay: 1997/11/11
    text: ["abc","def"]
  dogs:
    - name: 旺财
      age: 3
    - name: 来福
      age: 2
  cats:
    c1:
      name: 橘座
      age: 3
    c2: {name: 三花,age: 2} #对象也可用{}表示

日志配置

说明

1. Spring使用commons-logging作为内部日志，但底层日志实现是开放的。可对接其他日志框架。
   a. spring5及以后 commons-logging被spring直接自己写了。
2. 支持 jul，log4j2,logback。SpringBoot 提供了默认的控制台输出配置，也可以配置输出为文件。
3. logback是默认使用的。
4. 虽然日志框架很多，但是我们不用担心，使用 SpringBoot 的默认配置就能工作的很好。

SpringBoot怎么把日志默认配置好的

1. 每个starter场景，都会导入一个核心场景spring-boot-starter
2. 核心场景引入了日志的所用功能spring-boot-starter-logging
3. 默认使用了logback + slf4j 组合作为默认底层日志
4. 日志是系统一启动就要用，xxxAutoConfiguration是系统启动好了以后放好的组件，后来用的。
5. 日志是利用监听器机制配置好的。ApplicationListener。
6. 日志所有的配置都可以通过修改配置文件实现。以logging开始的所有配置

日志格式

默认输出格式：

• 时间和日期：毫秒级精度
• 日志级别：ERROR, WARN, INFO, DEBUG, or TRACE.
• 进程 ID
• —： 消息分割符
• 线程名： 使用[]包含
• Logger 名： 通常是产生日志的类名
• 消息： 日志记录的内容

注意： logback 没有FATAL级别，对应的是ERROR

默认值：参照：spring-boot包additional-spring-configuration-metadata.json文件
默认输出格式值：

%clr(%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd'T'HH:mm:ss.SSSXXX}}){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}

可修改为：'%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread] %logger{15} ===> %msg%n'

记录日志

Logger logger = LoggerFactory.getLogger(getClass());
//或者使用Lombok的@Slf4j注解

日志级别

• 由低到高：ALL,TRACE, DEBUG, INFO, WARN, ERROR,FATAL,OFF；
• 只会打印指定级别及以上级别的日志

日志级别	说明
ALL	打印所有日志
TRACE	追踪框架详细流程日志，一般不使用
DEBUG	开发调试细节日志
INFO	关键、感兴趣信息日志
WARN	警告但不是错误的信息日志，比如：版本过时
ERROR	业务错误日志，比如出现各种异常
FATAL	致命错误日志，比如jvm系统崩溃
OFF	关闭所有日志记录

• 不指定级别的所有类，都使用root指定的级别作为默认级别
• SpringBoot日志默认级别是 INFO

使用

1. 在application.properties/yaml中配置logging.level.<logger-name>=<level>指定日志级别
2. level可取值范围：TRACE, DEBUG, INFO, WARN, ERROR, FATAL, or OFF，定义在 LogLevel类中
3. root 的logger-name叫root，可以配置logging.level.root=warn，代表所有未指定日志级别都使用 root 的 warn 级别

日志分组

比较有用的技巧是：将相关的logger分组在一起，统一配置。SpringBoot 也支持。比如：Tomcat 相关的日志统一设置

logging.group.tomcat=org.apache.catalina,org.apache.coyote,org.apache.tomcat
logging.level.tomcat=trace

SpringBoot 预定义两个组

• web：org.springframework.core.codec, org.springframework.http, org.springframework.web, org.springframework.boot.actuate.endpoint.web, org.springframework.boot.web.servlet.ServletContextInitializerBeans
• sql：org.springframework.jdbc.core, org.hibernate.SQL, org.jooq.tools.LoggerListener

文件输出

SpringBoot 默认只把日志写在控制台，如果想额外记录到文件，可以在application.properties中添加logging.file.name or logging.file.path配置项

文件归档与滚动切割

解释

• 归档：每天的日志单独存到一个文档中。
• 切割：每个文件10MB，超过大小切割成另外一个文件。

使用

1. 每天的日志应该独立分割出来存档。如果使用logback（SpringBoot 默认整合），可以通过application.properties/yaml文件指定日志滚动规则。
2. 如果是其他日志系统，需要自行配置（添加log4j2.xml或log4j2-spring.xml）
3. 支持的滚动规则设置如下
   

自定义配置

• 如果可能，我们建议您在日志配置中使用-spring 变量（例如，logback-spring.xml 而不是 logback.xml）。
• 如果使用标准配置文件，spring 无法完全控制日志初始化。
• 建议：自己要写配置，配置文件名加上 xx-spring.xml

切换日志组合

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

• log4j2支持yaml和json格式的配置文件
  

总结

1. 导入任何第三方框架，先排除它的日志包，因为Boot底层控制好了日志
2. 修改 application.properties 配置文件，就可以调整日志的所有行为。如果不够，可以编写日志框架自己的配置文件放在类路径下就行，比如logback-spring.xml，log4j2-spring.xml
3. 如需对接专业日志系统，也只需要把 logback 记录的日志灌倒 kafka之类的中间件，这和SpringBoot没关系，都是日志框架自己的配置，修改配置文件即可
4. 业务中使用slf4j-api记录日志