SpringBoot3 笔记说明:
笔记参照的是尚硅谷新版 SpringBoot3 课程的笔记,对其源码讲解的部分做了一些去除,加入了一些感觉对理解有帮助的相关的介绍和代码,希望可以帮助到大家。
一、SpringBoot3 快速入门
1、简介
引入 SpringBoot 3
1)前置知识
- Java 17
- Spring、SpringMVC、MyBatis
- Maven、IDEA
2)什么是 SpringBoot?
SpringBoot 帮助我们简单、快速的开发一个独立的、生产级别的 Spring 应用,大多数 SpringBoot 应用只需要写少量的配置即可快速的整合 Spring 平台以及第三方技术,不用再去写数量众多的配置文件。
特性
⚪ 快速的创建独立的 Spring 应用,省去了使用 smm 时写配置、启动运行的操作
⚪ 直接嵌入 Tomcat、Jetty or Undertow(无需部署 war 包),Servlet 容器
⚪ 提供可选的 starter,一键导入所需要的依赖,无需配置版本,快速的完成开发前的准备
⚪ 按照需要自动配置 Spring 以及第三方的库
⚪ 提供生产级别的特性:监控指标、健康检查、外部化配置等等
⚪ 无代码生成、无 xml 配置文件
总结:简化开发、简化配置、简化整合、简化部署、简化监控、简化运维
2、快速体验
使用浏览器发送请求,返回一个字符串
1)创建项目(使用 Spring Initializer)
Spring Initializer 可以帮助我们一键部署好 SpringBoot 项目
在新建项目中创建一个 SpringBoot 项目,注意类型选择 Maven,以及 jdk 版本的配置,如果没有 17 及以上版本的 jdk,可以使用 idea 内置的添加来下载。
在配置的界面可以自己配置需要用到的操作模块,如:SpringWeb、MyBatis 等等,但这里只需要配置 SpringWeb和简化开发的 lomcat 即可,MyBatis 需要进行额外的配置才能使用,否则会报错。
初始的项目的目录结构
2)业务实现
@Controller
public class HelloController {
@ResponseBody
@GetMapping("/h")
public String Hello() {
Logger logger = LoggerFactory.getLogger(getClass());
logger.info("h 请求进来了");
return "Hello";
}
}
注意:在默认配置下只有主程序所在的目录也就是上面的 springboot3logging01
下的文件才会被自动配置扫描,如果无法实现可以先检查自己控制器的包的位置
3)测试
默认启动访问 localhost:8080/h
,可以发现网页上出现了我们返回的语句。
4)打包
利用 Maven 的生命周期中的 package 可以实现将文件打为 jar 包。
5)相关的所需网站
SpringBoot 支持的所有场景:https://www.yuque.com/r/goto?url=https%3A%2F%2Fdocs.spring.io%2Fspring-boot%2Fdocs%2Fcurrent%2Freference%2Fhtml%2Fusing.html%23using.build-systems.starters
SpringBoot 中的配置文件能写的配置:https://www.yuque.com/r/goto?url=https%3A%2F%2Fdocs.spring.io%2Fspring-boot%2Fdocs%2Fcurrent%2Freference%2Fhtml%2Fapplication-properties.html%23appendix.application-properties
3、核心技能
常用的注解、ymal 配置文件、日志
1)常用注解
SpringBoot 摒弃了 xml 配置文件,采用全注解驱动。
-
组件注册
@Configuration、@SpringBootConfiguration@Configuration和@SpringBootConfiguration都是Spring框架中的注解,用于标记一个类作为配置类。它们的作用是相同的,都可以用来定义Bean。但是,@SpringBootConfiguration是Spring Boot框架中的注解,它继承自@Configuration注解,并且可以自动扫描所有的jar包,并将其中的自动配置类加载到Spring容器中。因此,在Spring Boot应用程序中,通常使用@SpringBootConfiguration注解来标记一个类作为配置类。
@Bean、@Scope
@Controller、 @Service、@Repository、@Component
SpringMVC 中的组件注释
@Import
@ComponentScan
-
条件注解
如果注解指定的条件成立,则触发指定行为
@ConditionalOnClass:如果类路径中存在这个类,则触发指定行为
@ConditionalOnMissingClass:如果类路径中不存在这个类,则触发指定行为
@ConditionalOnBean:如果容器中存在这个Bean(组件),则触发指定行为
@ConditionalOnMissingBean:如果容器中不存在这个Bean(组件),则触发指定行为
-
属性绑定
@ConfigurationProperties: 声明组件的属性和配置文件哪些前缀开始项进行绑定
@EnableConfigurationProperties:快速注册注解:
- 场景:SpringBoot默认只扫描自己主程序所在的包。如果导入第三方包,即使组件上标注了 @Component、@ConfigurationProperties 注解,也没用。因为组件都扫描不进来,此时使用这个注解就可以快速进行属性绑定并把组件注册进容器
将容器中任意组件(Bean)的属性值和配置文件的配置项的值进行绑定
- 1、给容器中注册组件(@Component、@Bean)
- 2、使用@ConfigurationProperties 声明组件和配置文件的哪些配置项进行绑定
@Configuration
//使用@EnableConfigurationProperties注解,将一个名为SampleProperties的配置属性类注册到Spring容器中
@EnableConfigurationProperties(SampleProperties.class)
public class AppConfig {
@Autowired
private SampleProperties sampleProperties;
public void init() {
System.out.println("Application properties: " + sampleProperties);
}
}
//用于将这个对象和配置文件中以 app 开头的属性来进行绑定
@ConfigurationProperties(prefix = "app")
public class SampleProperties {
private String name;
private int age;
// getters and setters
}
2)YMAL 配置文件
YAML 是 “YAML Ain’t a Markup Language”(YAML 不是一种标记语言)。在开发的这种语言时,YAML 的意思其实是:“Yet Another Markup Language”(是另一种标记语言)。
- 设计目标,就是方便人类读写
- 层次分明,更适合做配置文件
- 使用
.yaml
或.yml
作为文件后缀
-
基本语法
大小写敏感
使用缩进表示层级关系,k: v,使用空格分割k,v
缩进时不允许使用Tab键,只允许使用空格。换行
缩进的空格数目不重要,只要相同层级的元素左侧对齐即可
# 表示注释,从这个字符一直到行尾,都会被解析器忽略。
-
支持的写法
- 对象:键值对的集合,如:映射(map)/ 哈希(hash) / 字典(dictionary)
- 数组:一组按次序排列的值,如:序列(sequence) / 列表(list)
- 纯量:单个的、不可再分的值,如:字符串、数字、bool、日期
-
实例
person: name: 张三 age: 18 birthDay: 2010/10/10 12:12:12 like: true child: name: 李四 age: 20 birthDay: 2018/10/10 text: ["abc","def"] dogs: - name: 小黑 age: 3 - name: 小白 age: 2 cats: c1: name: 小蓝 age: 3 c2: {name: 小绿,age: 2} #对象也可用{}表示
//上述配置文件配置的类 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 }
-
细节:
符合驼峰式命名的建议写成 birth-day,
文本单引号里面添加转义字符不会实现转义,而双引号实现则会实现转义
大文本
|
开头的会保留文本格式,换行将会正确的显示>
开头的折叠换行符为空格多文档合并
使用
---
可以将多个 ymal 文件合并在一个文档中,每个文档区依然认为内容独立。
3)lombok
简化JavaBean 开发。自动生成构造器、getter/setter、自动生成Builder模式等
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<scope>compile</scope>
</dependency>
lombok 的常用注解:
Lombok 是一个 Java 工具,它可以自动生成 Java 代码,以减少手动编写代码的工作量。以下是一些 Lombok 的常用注解:
1. @Getter 和 @Setter:这两个注解用于生成访问器和修改器方法,使得 Java 对象的属性可以被外部代码访问和修改。 2. @ToString:这个注解用于生成一个返回字符串表示的 toString 方法,可以用来打印 Java 对象的信息。 3. @Data:这个注解用于生成一个类的所有字段的访问器和修改器方法,以及 toString、equals 和 hashCode 方法。 4. @AllArgsConstructor(access = PRIVATE):这个注解用于生成一个包含所有属性的构造方法,但是私有化了这个构造方法,只有在类内部才能调用这个构造方法。 5. @NoArgsConstructor(access = PRIVATE):这个注解用于生成一个无参构造方法,但是私有化了这个构造方法,只有在类内部才能调用这个构造方法。
4)日志配置
- Spring使用commons-logging作为内部日志,但底层日志实现是开放的。可对接其他日志框架。
- spring5及以后 commons-logging被spring直接自己写了。
- 支持 jul,log4j2,logback。SpringBoot 提供了默认的控制台输出配置,也可以配置输出为文件。
- logback是默认使用的。
- 虽然日志框架很多,但是我们不用担心,使用 SpringBoot 的默认配置就能工作的很好
-
日志格式
2023-03-31T13:56:17.511+08:00 INFO 4944 --- [main] o.apache.catalina.core.StandardService : Starting service [Tomcat] 2023-03-31T13:56:17.511+08:00 INFO 4944 --- [main] o.apache.catalina.core.StandardEngine : Starting Servlet engine: [Apache Tomcat/10.1.7]
-
日志级别
FINEST:最详细的日志级别,用于记录程序的详细运行信息,例如方法的入参、出参等。
FINER:用于记录程序的调试信息,例如变量的取值、方法执行的流程等。
FINE:用于记录程序的重要事件和运行状态信息,例如应用程序启动、停止、初始化等。
CONFIG:用于记录程序的配置信息,例如配置参数的错误等。
INFO:用于记录程序的正常运行信息,例如应用程序启动、停止、运行等。
WARNING:用于记录程序中的警告信息,例如方法的使用不当、配置参数的错误等。
SEVERE:用于记录程序中的严重错误信息,例如运行时错误、资源耗尽等。
ALL:最低等级的,用于打开所有日志记录 -
日志的输出格式
默认输出格式:
时间和日期:毫秒级精度
日志级别:ERROR, WARN, INFO, DEBUG, or TRACE.
进程 ID
—: 消息分割符
线程名: 使用[]包含
Logger 名: 通常是产生日志的类名
消息: 日志记录的内容
-
如何自己添加日志
// 得到一个 logger 对象 Logger logger = LoggerFactory.getLogger(getClass()); //调用 logger 封装的 info 方法 logger.info("进来了一个请求");
-
日志分组
应用场景:将相关的类分组来统一管理相关的日志类型。
logging.group.tomcat=org.apache.catalina,org.apache.coyote,org.apache.tomcat logging.level.tomcat=trace
- 利用逗号分隔开可以将这些类进行分组
-
文件输出
可以将日志文件导出出去便于管理和查看。
SpringBoot 默认只把日志写在控制台,如果想额外记录到文件,可以在application.properties中添加logging.file.name
logging.file.path 配置项name 配置选项即可以配置日志的名字也可以配置日志的地址,优先级是比 path 配置选项高的。
logging.file.name = demo.log
-
文档的切割与归档
归档:每天的日志单独存到一个文档中。
切割:每个文件10MB,超过大小切割成另外一个文件,这个最大值是可以自己指定的。
配置项 描述 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.max-file-size 存档前,每个日志文件的最大大小(默认值:10MB) logging.logback.rollingpolicy.total-size-cap 日志文件被删除之前,可以容纳的最大大小(默认值:0B)。设置1GB则磁盘存储超过 1GB 日志后就会删除旧日志文件 logging.logback.rollingpolicy.max-history 日志文件保存的最大天数(默认值:7).