当前位置：首页 > news >正文

01-SpringBoot3快速入门

news 2024/11/26 5:26:17

快速体验

场景：浏览器发送/hello请求，返回"Hello,Spring Boot 3!"

1. 开发流程

1、创建一个空项目
2、创建一个Maven项目

3、pom文件导入spring-boot-starter-parent

<!-- 所有springboot项目都必须继承自 spring-boot-starter-parent -->
<parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>3.3.5</version>
</parent>

4、导入场景

<dependencies><!-- web开发的场景启动器 --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency>
</dependencies>

5、主程序

@SpringBootApplication //这是一个SpringBoot应用
public class MainApplication {public static void main(String[] args) {SpringApplication.run(MainApplication.class,args);}
}

6、业务

@RestController
public class HelloController {@GetMapping("/hello")public String hello() {return "Hello,Spring Boot 3!";}
}

7、测试

默认启动访问： http://localhost:8080/hello

8、打包

<!-- SpringBoot应用打包插件 -->
<build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId></plugin></plugins>
</build>

mvn clean package把项目打成可执行的jar包
java -jar Quick_Experience-1.0-SNAPSHOT.jar启动项目

2.特性小结

1. 简化整合

导入相关的场景（pom依赖），就拥有相关的功能
默认支持的所有场景：官网地址
- 官方提供的场景：命名为：spring-boot-starter-*
- 第三方提供场景：命名为：*-spring-boot-starter

2. 简化开发

无需编写任何配置，直接开发业务

3. 简化配置

application.properties:

集中式管理配置，只需要修改这个文件就行。
配置基本都有默认值。
能写的所有配置都在：官网地址。

3. Spring Initializr 创建向导

一键创建好整个项目结构

在这里插入图片描述

应用分析

1. 依赖管理机制

为什么导入spring-boot-starter-web所有相关依赖都导入进来？
- 开发什么场景，导入什么场景启动器
- maven依赖传递原则。A-B-C： A就拥有B和C
- 导入场景启动器。场景启动器自动把这个场景的所有核心依赖全部导入进来
为什么版本号都不用写？
- 每个boot项目都有一个父项目spring-boot-starter-parent
- parent的父项目是spring-boot-dependencies
- 父项目版本仲裁中心，把所有常见的jar的依赖版本都声明好了
自定义版本号
- 利用maven的就近原则
- 直接在导入依赖的时候声明版本
第三方的jar包
- boot父项目没有管理的需要自行声明好

在这里插入图片描述

2. 自动配置机制

1. 初步理解

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

@SpringBootApplication
public class FastInitialApplication {public static void main(String[] args) {// java10:局部变量类型的自动推断var ioc = SpringApplication.run(FastInitialApplication.class, args);// 1、获取容器中所有组件的名字String[] names = ioc.getBeanDefinitionNames();// 2、遍历输出// dispatcherServlet、beanNameViewResolver、characterEncodingFilter、multipartResolver// SpringBoot把以前配置的核心组件现在都给我们自动配置好了for (String name : names) {System.out.println(name);}}}

默认的包扫描规则
- @SpringBootApplication 标注的类就是主程序类
- SpringBoot只会扫描主程序所在的包及其下面的子包
- 自定义扫描路径
  - 方式一:@SpringBootApplication(scanBasePackages = “com.liming”)
  - 方式二:@ComponentScan(“com.liming”) 直接指定扫描的路径
配置默认值
- 配置文件的所有配置项是和某个类的对象值进行一一绑定的
- 绑定了配置文件中每一项值的类叫做属性类
- 比如：
  - 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这个包的自动配置生效、容器中就会具有相关场景的功能

2. 完整流程

思考：

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

在这里插入图片描述

自动配置流程细节梳理：

1 、导入starter-web：导入了web开发场景

1、场景启动器导入了相关场景的所有依赖：starter-json、starter-tomcat、springmvc
2、每个场景启动器都引入了一个spring-boot-starter核心场景启动器
3、核心场景启动器都引入了spring-boot-autoconfigure包
4、spring-boot-autoconfigure里面包含了所有场景的所有配置
5、只要这个包下的所有类都能生效，那么相当于SpringBoot官方写好的整合功能就生效了
6、SpringBoot默认扫描不到spring-boot-autoconfigure下写好的配置类（这些配置类已经做好了整合操作），默认只扫描主程序所在的包及其子包

2、主程序：@SpringBootApplication

1、@SpringBootApplication由三个注解组成@SpringBootConfiguration、@EnableAutoConfiguratio、@ComponentScan
2、SpringBoot默认只能扫描自己主程序所在的包及其下面的子包，扫描不到spring-boot-autoconfigure包中官方写好的配置类
3、@EnableAutoConfiguration：SpringBoot 开启自动配置的核心
- 由@Import(AutoConfigurationImportSelector.class)提供功能：批量给容器中导入组件
- SpringBoot启动会默认加载 142个配置类
- 这142个配置类来自于spring-boot-autoconfigure下 META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件指定的
- 项目启动的时候利用@Import 批量导入组件机制把autoconfigure包下的142 xxxxAutoConfiguration类导入进来（自动配置类）
- 虽然导入了142个自动配置类
4、按需生效：
- 并不是这142个自动配置类都能生效
- 每一个自动配置类，都有条件注解@ConditionalOnxxx，只有条件成立，才能生效

3、xxxxAutoConfiguration自动配置类

1、给容器中使用@Bean放一堆组件
2、每个自动配置类都可能有这个注解@EnableConfigurationProperties(ServerProperties.class)，用来把配置文件中配的指定前缀的属性值封装到 xxxProperties属性类中
3、以Tomcat为例：把服务器的所有配置都是以server开头的。配置都封装到了属性类中
4、给容器中放的所有组件的一些核心参数，都来自于xxxProperties。xxxProperties都是和配置文件绑定
5、只需要改配置文件的值，核心组件的底层参数都能修改

4、写业务，全程无需关心各种整合（底层这些整合写好了，而且也生效了）

核心流程总结：

导入starter，就会导入autoconfigure包
autoconfigure 包里面有一个文件 META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports,里面指定的所有启动要加载的自动配置类
@EnableAutoConfiguration会自动的把上面文件里面写的所有自动配置类都导入进来
xxxAutoConfiguration给容器中导入一堆组件，组件都是从 xxxProperties中提取属性值
xxxProperties又是和配置文件进行了绑定
效果：导入starter、修改配置文件，就能修改底层行为

核心技能

1. 常用注解

SpringBoot摒弃XML配置方式，改为全注解驱动

1. 组件注册

配置类注解

注解名称	作用
@Configuration	标识一个类为配置类，通常用于定义Spring Bean的配置
@SpringBootConfiguration	标识一个类为Spring Boot应用的配置类，通常用于Spring Boot应用的配置

Bean定义注解

注解名称	作用
@Bean	用于方法上，表示该方法返回的对象将被注册为Spring容器中的一个Bean
@Scope	用于定义Bean的作用域，如单例（singleton）、原型（prototype）等

组件注解

注解名称	作用
@Controller	标识一个类为控制器，通常用于处理HTTP请求
@Service	标识一个类为服务层组件，通常用于业务逻辑处理
@Repository	标识一个类为数据访问层组件，通常用于数据库操作
@Component	标识一个类为Spring组件，通常用于通用组件

其他注解

注解名称	作用
@Import	用于导入其他配置类，通常用于组合多个配置类
@ComponentScan	用于指定Spring扫描组件的包路径，通常用于自动发现和注册组件

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

2. 条件注解

如果注解指定的条件成立，则触发指定行为。格式:@ConditionalOnXxx

@ConditionalOnClass：如果类路径中存在这个类，则触发指定行为
@ConditionalOnMissingClass：如果类路径中不存在这个类，则触发指定行为
@ConditionalOnBean：如果容器中存在这个Bean（组件），则触发指定行为
@ConditionalOnMissingBean：如果容器中不存在这个Bean（组件），则触发指定行为
…等等

3. 属性绑定

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

2. YAML配置文件

使用.yaml或 .yml作为文件后缀

1. 基本语法

大小写敏感
使用缩进表示层级关系，k: v，使用空格分割k,v
缩进时不允许使用Tab键，只允许使用空格。换行
缩进的空格数目不重要，只要相同层级的元素左侧对齐即可
# 表示注释，从这个字符一直到行尾，都会被解析器忽略。

2. 示例

@Component
@ConfigurationProperties(prefix = "person") //和配置文件person前缀的所有配置进行绑定
@Data 
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;
}

properties表示法

person.name=张三
person.age=18
person.birthDay=2010/10/12 12:12:12
person.like=true
person.child.name=李四
person.child.age=12
person.child.birthDay=2018/10/12
person.child.text[0]=abc
person.child.text[1]=def
person.dogs[0].name=小黑
person.dogs[0].age=3
person.dogs[1].name=小白
person.dogs[1].age=2
person.cats.c1.name=小蓝
person.cats.c1.age=3
person.cats.c2.name=小灰
person.cats.c2.age=2

yaml表示法

person:name: 张三age: 18birthDay: 2010/10/10 12:12:12like: truechild:name: 李四age: 20birthDay: 2018/10/10text: ["abc","def"]dogs:- name: 小黑age: 3- name: 小白age: 2cats:c1:name: 小蓝age: 3c2: {name: 小绿,age: 2} #对象也可用{}表示

3. 细节

birthDay 推荐写为 birth-day
文本：
- 单引号不会转义【\n 则为普通字符串显示】
- 双引号会转义【\n会显示为换行符】
大文本
- |开头，大文本写在下层，保留文本格式，换行符正确显示
- >开头，大文本写在下层，折叠换行符
多文档合并
- 使用---可以把多个yaml文档合并在一个文档中，每个文档区依然认为内容独立

3. 日志配置

规范：项目开发不要编写System.out.println()，应该用日志记录信息

1. 简介

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

2. 日志格式

2024-11-31T13:56:17.511+08:00  INFO 4944 --- [           main] o.apache.catalina.core.StandardService   : Starting service [Tomcat]
2024-11-31T13:56:17.511+08:00  INFO 4944 --- [           main] o.apache.catalina.core.StandardEngine    : Starting Servlet engine: [Apache Tomcat/10.1.7]

默认输出格式：

时间和日期：毫秒级精度
日志级别：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

3. 日志分组

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

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

SpringBoot 预定义两个组

Name	Loggers
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

4. 文件输出

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

logging.file.name	logging.file.path	示例	效果
未指定	未指定		仅控制台输出
指定	未指定	my.log	写入指定文件。可以加路径
未指定	指定	/var/log	写入指定目录，文件名为spring.log
指定	指定		以logging.file.name为准

5. 文件归档与滚动切割

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

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

配置项	描述
logging.logback.rollingpolicy.file-name-pattern	日志存档的文件名格式（默认值：${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz）
logging.logback.rollingpolicy.clean-history-on-start	应用启动时是否清除以前存档（默认值：false）
logging.logback.rollingpolicy.file-name-pattern	日志存档的文件名格式（默认值：${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz）
logging.logback.rollingpolicy.max-file-size	存档前，每个日志文件的最大大小（默认值：10MB）
logging.logback.rollingpolicy.total-size-cap	日志文件被删除之前，可以容纳的最大大小（默认值：0B）。设置1GB则磁盘存储超过 1GB 日志后就会删除旧日志文件
logging.logback.rollingpolicy.max-history	日志文件保存的最大天数(默认值：7)