环境&工具 | 版本(or later) |
---|---|
SpringBoot | 3.0.5+ |
IDEA | 2021.2.1+ |
Java | 17+ |
Maven | 3.5+ |
Tomcat | 10.0+ |
Servlet | 5.0+ |
GraalVM | Community 22.3+ |
Native Build Tools | 0.9.19+ |
SpringBoot 帮我们简单、快速地创建一个独立的、生产级别的 Spring 应用(说明:SpringBoot底层是Spring)
大多数 SpringBoot 应用只需要编写少量配置即可快速整合 Spring 平台以及第三方技术
特性:
快速创建
独立 Spring 应用
嵌入
Tomcat、Jetty or Undertow(无需部署 war 包)【Servlet容器】
starter
,简化应用整合
重点:按需自动配置
Spring 以及 第三方库
生产级特性
:如 监控指标、健康检查、外部化配置等
无xml
总结:简化开发,简化配置,简化整合,简化部署,简化监控,简化运维。
场景:浏览器发送 /hello请求,返回"Hello,Spring Boot 3!"
这里我们创建一个空项目spring-boot-3,然后新建子项目boot3-01-demo,并在父工程导入springboot的依赖。
<parent>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-parentartifactId>
<version>3.1.1version>
parent>
场景启动器
<dependencies>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-webartifactId>
dependency>
dependencies>
创建boot包,写主程序
我的SpringMVC笔记,看Restful和@ResponceBody部分
//@Controller
//@ResponseBody
@RestController
public class HelloController {
@GetMapping("/hello")
public String hello(){
return "Hellom Spring Boot 3 !";
}
}
然后在boot包内写controller包下写HelloController。
springboot的包扫描逻辑是只扫描主程序当前包及其子包
@RestController
public class HelloController {
@GetMapping("/hello")
public String hello(){
return "Hello,Spring Boot 3!";
}
}
默认启动访问: localhost:8080
<build>
<plugins>
<plugin>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-maven-pluginartifactId>
plugin>
plugins>
build>
mvn clean package
把项目打成可执行的jar包
java -jar demo.jar
启动项目
如果卡住可能是cmd
控制台打开了快速编辑模式
导入相关的场景,拥有相关的功能。场景启动器
默认支持的所有场景 (官方)
:官方给的场景列表
● 官方提供的场景:命名为:spring-boot-starter-*
● 第三方提供场景:命名为:*-spring-boot-starter
场景一导入,万物皆就绪
无需编写任何配置,直接开发业务
application.properties:
● 集中式管理配置。只需要修改这个文件就行 。
● 配置基本都有默认值
● 能写的所有配置都在: 官方提供的各种配置的默认值和可配置的参数列表
打包为可执行的jar包。
linux服务器上有java环境。
修改配置(外部放一个application.properties文件)、监控、健康检查。
…
思考:
1、为什么导入starter-web
所有相关依赖都导入进来?
2、为什么版本号都不用写?
每个boot项目都有一个父项目spring-boot-starter-parent
parent的父项目是spring-boot-dependencies
父项目 版本仲裁中心,把所有常见的jar的依赖版本都声明好了。
比如:mysql-connector-j
3、自定义版本号(如果不想使用官方的
)
4、第三方的jar包
<dependency>
<groupId>com.alibabagroupId>
<artifactId>druidartifactId>
<version>1.2.16version>
dependency>
public static void main(String[] args) {
//java10: 局部变量类型的自动推断
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
标注的类就是主程序类component-scan
功能,在此包之外,哪怕写了MVC的组件
注解也无法扫描存入IOC容器之中如果非要放在默认之外,需要给注解加内容配置
)
@SpringBootApplication(scanBasePackages = "com.fanxy")
@ComponentScan("com.fanxy")
直接指定扫描的路径,这是因为上面的 @SpringBootApplication 注解包含内嵌了三个注解:@SpringBootConfiguration,@EnableAutoConfiguration,@ComponentScanServerProperties
)ServerProperties
绑定了所有Tomcat服务器有关的配置MultipartProperties
绑定了所有文件上传相关的配置spring-boot-starter-web
spring-boot-starter
,是所有starter
的starter
,基础核心starterspring-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开发场景
starter-json
、starter-tomcat
、springmvc
spring-boot-starter
,核心场景启动器。spring-boot-autoconfigure
包。spring-boot-autoconfigure
里面囊括了所有场景的所有配置。spring-boot-autoconfigure
下写好的所有配置类。(这些配置类给我们做了整合操作),默认只扫描主程序所在的包。但利用下面主程序的注解就做到了导入。2、
主程序:@SpringBootApplication
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(
excludeFilters = {@Filter(
type = FilterType.CUSTOM,
classes = {TypeExcludeFilter.class}
), @Filter(
type = FilterType.CUSTOM,
classes = {AutoConfigurationExcludeFilter.class}
)}
)
public @interface SpringBootApplication {---------}
@SpringBootApplication
由三个注解组成@SpringBootConfiguration
、@EnableAutoConfiguration
、@ComponentScan
spring-boot-autoconfigure
包中官方写好的配置类@EnableAutoConfiguration
:SpringBoot 开启自动配置的核心。@Import
导入下面的类,这个类的作用其实是批量导入组件,@import
将指定的类或配置文件导入到当前类中,可以用于导入其他类的定义、配置文件等,但不会将其加入到IOC容器中。这个类内部的方法还获取了一些注册信息,其实调试发现就是主程序所在的包的路径,故帮助我们扫描主程序所在的包和子包路径下所有组件@Import(AutoConfigurationImportSelector.class)
提供功能:批量给容器中导入组件。利用getAutoConfigurationEntry(annotationMetadata)
;给容器中批量导入一些组件List configurations = getCandidateConfigurations(annotationMetadata, attributes)
获取到所有需要导入到容器中的配置类 Map> loadSpringFactories(@Nullable ClassLoader classLoader)
;得到所有的组件META-INF/spring.factories
位置来加载一个文件。META-INF/spring.factories
位置的文件spring-boot-autoconfigure-x.x.x.RELEASE.jar
包里面也有META-INF/spring.factories
最新版本springboot其实换了文件路径——>来自于spring-boot-autoconfigure
下 META-INF/spring/
org.springframework.boot.autoconfigure.AutoConfiguration.imports
**上面的主程序自带的注解会排除一些
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
属性类中,而一些组件如Tomcat
,内置了带默认值的构造函数,所以带有默认值。而这个自动配置类中有一些定制化器类
,如果带有@Bean
注解,他们的构造函数可能会带有参数 ServerProperties serverProperties
,带有@Bean
注解的类的形参如果容器已经有了相同类型的对象,会自动放入赋值
● 3、以 Tomcat
为例:把服务器的所有配置都是以server
开头的。配置都封装到了属性类中。
● 4、给容器中放的所有组件的一些核心参数,都来自于xxxProperties。xxxProperties都是和配置文件绑定(这些类都通过@EnableConfigurationProperties(xxxx)
注解把前缀修饰)
● 只需要改配置文件的值,核心组件的底层参数都能修改
4、
写业务,全程无需关心各种整合(底层这些整合写好了,而且也生效了)
核心流程总结:
1、导入starter
,就会导入autoconfigure
包。
2、autoconfigure
包里面 有一个文件 META-INF/spring/
org.springframework.boot.autoconfigure.AutoConfiguration.imports
,里面指定的所有启动要加载的自动配置类
3、@EnableAutoConfiguration
会自动的把上面文件里面写的所有自动配置类都导入进来。xxxAutoConfiguration 是有条件注解进行按需加载
4、符合需求条件的情况下xxxAutoConfiguration
给容器中导入一堆组件,组件都是从 xxxProperties
中提取属性值
5、xxxProperties
又是和配置文件进行了绑定
效果:导入starter
、修改配置文件,就能修改底层行为。
框架的框架、底层基于Spring。能调整每一个场景的底层行为。100%项目一定会用到底层自定义
摄影:
导入starter
--> 生效xxxxAutoConfiguration --> 组件
--> xxxProperties --> 配置文件
普通开发:导入starter
,Controller、Service、Mapper、偶尔修改配置文件
高级开发:自定义组件、自定义配置、自定义starter
核心:
● 这个场景自动配置导入了哪些组件,我们能不能Autowired进来使用
● 能不能通过修改配置改变组件的一些默认参数
● 需不需要自己完全定义这个组件
● 场景定制化
最佳实战:
spring-boot-starter-data-redis
AutoConfiguration
就是这个场景的自动配置类@EnableConfigurationProperties(RedisProperties.class)
RedisAutoConfiguration
给容器中放了 StringRedisTemplate
StringRedisTemplate
StringRedisTemplate
SpringBoot摒弃XML配置方式,改为全注解驱动
@Configuration、@SpringBootConfiguration
@Bean、@Scope
@Controller、 @Service、@Repository、@Component
@Import
@ComponentScan
以前的步骤:通过spring配置文件,如果纯xml配置,需要写Bean对象,唯一标识id,全类名,然后通过set注入或者其他注入方式注入默认属性值
现在的步骤:
1、@Configuration
编写一个配置类(配置类其实也会被存入IOC容器
,可以通过ctrl + 左键点击这个注解发现内嵌了@Component
注解)。其实也可以使用上面的@SpringBootConfiguration
注解,本质其实一样,所以Spring相关的核心配置使用SpringBoot的,而通用配置使用默认的
2、在配置类中,自定义方法给容器中注册组件。配合@Bean
。如果是第三方的我们直接根据类型,写入为配置类的方法,返回它的类型,然后直接return new出来的对象
2.1、@Configuration
注解spring 5.2
以后多了属性 proxyBeanMethods
,可以设置为true
或者false
,默认为true
(效果代表:是不是代理Bean
的方法),如果为true
说明为代理对象调用方法,我们在获取这个对象的时候,会从容器检查有没有这个类的对象,有就拿,没有就创建 (保持组件单实例
)。主要用于解决组件依赖问题。当不更改这个值,组件在配置类配置依赖可以直接通过set
方法然后传入配置类的其他组件的注入方法(即带有@Bean
的方法)。我们不想有这种依赖关系,设置成false
就是轻量级模式。测试设置为false
对于单个Bean
从容器获取多次还是单实例的,但依赖的情况下,Bean
内部其他的Bean
就不是ioc容器
的那个了,而是一个新new
的。
3、或使用@Import
导入第三方的组件(可以写在组件类(@Conponent,@Controller等)或者配置类上面,与配置类的注解放在一起
),在括号中写对应类的 .class
字节码文件(默认value值,不用写属性,且是一个数组(可以一次导入多个组件到容器
))。或者我们可以使用全类名(推荐
:其实不管怎么样默认ioc容器注入的组件的id名称仍是全类名。因为我们开发过程中可能会修改依赖,而如果导入IOC的时候如果删掉之前一些现在用不到的依赖,这种情况下,本身靠字符串的全类名不会引起报错,但是使用字节码文件的时候不存在这个类会大面积报错),对应name属性
如果注解指定的条件成立,则触发指定行为 能写在配置类,写了组件注解的类或者是配置类内部的@Bean方法上
@ConditionalOnXxx
@ConditionalOnClass:如果类路径中存在这个类,则触发指定行为
@ConditionalOnMissingClass:如果类路径中不存在这个类,则触发指定行为
@ConditionalOnBean:如果容器中存在这个Bean(组件),则触发指定行为
@ConditionalOnMissingBean:如果容器中不存在这个Bean(组件),则触发指定行为
场景:
● 如果存在FastsqlException
这个类,给容器中放一个Cat
组件,名cat01,
● 否则,就给容器中放一个Dog
组件,名dog01
● 如果系统中有dog01
这个组件,就给容器中放一个 User组件,名zhangsan
● 否则,就放一个User,名叫lisi
自定义去实现Condition
接口,然后自己写规则
@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: 声明组件的属性和配置文件哪些前缀开始项进行绑定,可以写在组件Bean上,也可以写到配置类中的配置Bean的方法上
@ConfigurationProperties
结合@Component
,配置类内无需写任何方法@Bean
结合@ConfigurationProperties
,配置类外不用写任何注解方法② : @EnableConfigurationProperties:快速注册注解(这是写于配置类上的注解,使用@Import注解导入的Bean不会进行属性绑定)
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Scope {
@AliasFor("scopeName")
String value() default "";
@AliasFor("value")
String scopeName() default "";
ScopedProxyMode proxyMode() default ScopedProxyMode.DEFAULT;
}
scopeName
scopeName是为了声明Bean的作用域,在Spring4.2版本以前,有singleton
, prototype
两种模式,4.2之后新加了web作用域(request
, session
, globalsession
)。
singleton
:单例模式,顾名思义即Spring IOC容器对于一个Bean,只会有一个共享的Bean实例。这一个单一的实例会被存储到单例缓存(singleton cache)中,当有请求或者是引用时,IOC容器都会返回存储在singleton cache的同一个实例。
prototype
:多实例模式,即当每次客户端向容器获取Bean的时候,IOC容器都会新建一个实例并返回。与单例不同的是,在IOC容器启动的时候并不会创建Bean的实例,并且在有请求创建Bean实例之后也不会管理该实例的生命周期,而是由客户端自行处理。
request
:web应用针对每一次HTTP请求都会创建一个新的Bean实例,且该实例仅在该次HTTP请求有效。
session
:针对每一个session会创建一个Bean实例,且生命周期为该session有效期间。
globalsession
:仅基于portlet的web应用才有意义,否则可以当作session使用。
这五种scopeName的使用方法 (也可以直接写对应的字符串,无视大小写)
@Scope(scopeName = ConfigurableBeanFactory.SCOPE_SINGLETON)
@Scope(scopeName = ConfigurableBeanFactory.SCOPE_PROTOTYPE)
@Scope(scopeName = WebApplicationContext.SCOPE_REQUEST)
@Scope(scopeName = WebApplicationContext.SCOPE_SESSION)
@Scope(scopeName = "globalSession")
ScopeProxyMode
proxyMode
表明了@Scope
注解的Bean是否需要代理。
DEFAULT
:proxyMode的默认值,一般情况下等同于NO,即不需要动态代理。NO
:不需要动态代理,即返回的是Bean的实例对象。INTERFACES
:代理的对象是一个接口,即@Scope的作用对象是接口,这种情况是基于jdk实现的动态代理。TARGET_CLASS
:代理的对象是一个类,即@Scope的作用对象是一个类,是以生成目标类扩展的方式创建代理,基于CGLib实现动态代理。 我的Spring6笔记,可以复习动态代理的知识@Scope(proxyMode = ScopedProxyMode.DEFAULT)
@Scope(proxyMode = ScopedProxyMode.NO)
@Scope(proxyMode = ScopedProxyMode.INTERFACES)
@Scope(proxyMode = ScopedProxyMode.TARGET_CLASS)
如果想把别的xml
文件的配置也导入,不想重新手写配置类和注解,可以直接在配置类或者组件类上写@ImportResource("classpath:/xxxxxx.xml")
可以把xml
的配置文件的组件导入IOC
容器
@Import
注解提供了三种用法
@Import
一个普通类 spring会将该类加载到spring容器
中,需要有无参构造器
@Import
一个类,该类实现了ImportBeanDefinitionRegistrar
接口,在重写的registerBeanDefinitions
方法里面,能拿到BeanDefinitionRegistry bd
的注册器,能手工往beanDefinitionMap
中注册 beanDefinition
,这种方式注册既能进行复杂的判断,也能对Bean进行生命周期和名字更改等功能@Import
一个类 该类实现了ImportSelector
重写selectImports
方法该方法返回了String[]
数组的对象,数组里面的类都会注入到spring容器
当中@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
@Documented
@Repeatable(ComponentScans.class)
public @interface ComponentScan {
@AliasFor("basePackages")
String[] value() default {};
@AliasFor("value")
String[] basePackages() default {};
Class<?>[] basePackageClasses() default {};
Class<? extends BeanNameGenerator> nameGenerator() default BeanNameGenerator.class;
Class<? extends ScopeMetadataResolver> scopeResolver() default AnnotationScopeMetadataResolver.class;
ScopedProxyMode scopedProxy() default ScopedProxyMode.DEFAULT;
String resourcePattern() default "**/*.class";
boolean useDefaultFilters() default true;
Filter[] includeFilters() default {};
Filter[] excludeFilters() default {};
boolean lazyInit() default false;
@Retention(RetentionPolicy.RUNTIME)
@Target({})
public @interface Filter {
FilterType type() default FilterType.ANNOTATION;
@AliasFor("classes")
Class<?>[] value() default {};
@AliasFor("value")
Class<?>[] classes() default {};
String[] pattern() default {};
}
}
首先它的value值对应要扫描的包名,可以是一个数组,放入要扫描的包名。
可以填入一个数组,类型为@Filter注解数组,可以排除要扫描的包。可以按注解,或者是类的类型,或者是正则排除【几乎不用】,或者是AspectJ语法【几乎不用】,
type=FilterType.ASSUGNABLE_TYPE
按类型排除
如我们不扫描@Controller
注解的类和@Service
注解的类
这里我测试发现排除这个注解,并不会把衍生的@RestController
注解的组件排除注册
@ComponentScan(excludeFilters = {
@ComponentScan.Filter(type = FilterType.ANNOTATION, classes = {ComponentScan.class,Service.class})
})
需要进行设置属性关闭默认扫描规则useDefaultFilters = false
用法和上面没有什么区别
定义一个类,实现TypeFilter
接口,实现它的方法
第一个参数metadataReader
:可以通过它获取正在扫描的类的信息:如注解,类的信息,类的资源信息。
进一步比如类名,可以用如className.contains("xxx")
的方法去判断是否名字包含字符【其实本质不如用上面的正则】
第二个参数metadataReaderFactory
可以获得其他的容器组件的信息
使用的时候,只需要@Filter(type=FilterType.CUSTOM,classes={MyFilter})
指定使用我们的过滤规则
public class MyFilter implements TypeFilter {
@Override
public boolean match(MetadataReader metadataReader, MetadataReaderFactory metadataReaderFactory) throws IOException {
return false;
}
}
可以给配置类中加载的Bean上加,即便是单实例Bean,也可以实现懒加载,ioc创建不加载,第一次获取才加载
这里可以参考Spring6学习部分的笔记,大同小异,就是实现FactoryBean
接口,然后重写方法,主要是补充:
首先,通过配置类注册@Bean
返回工厂Bean
类,得到的仍是我们实现类,不是工厂。(这里已经知道了)
补充:要是想从ioc获得工厂而不是这个实现类,getBean方法输入Bean名称字符串
,在字符串前面加 &
符号。
Bean以前在基于xml方式的配置的方法中,我们可以在xml配置参数。
而springBoot或者说注解的spring中,我们可以在@Bean
通过同名的参数指定方法名。这些方法很重要,我们可以在一些数据源初始化的时候把很多信息注入进去。
别忘了多实例Bean
是懒加载,而且每次返回不同的Bean
,同时容器也不帮你管理这个Bean
,容器哪怕销毁
,也不会
调用这个Bean
的destroy
,只是可以帮你创建
,单实例被单例池引用,spring容器销毁即销毁,多实例在虚拟机GC时销毁
InitializingBean
和DisposableBean
接口同时也可以不用这个注解,通过实现InitializingBean
接口重写初始化方法,通过实现DisposableBean
接口重写销毁方法。
来自JDK非Spring
】@PostConstruct
:在Bean
创建完成并属性赋值之后,执行初始化方法
@PreDestroy
:在容器销毁之前执行销毁方法
BeanPostProcessor
【它也是个组件需要注册】具体的生命周期过程
实现BeanPostProcessor
接口并重写前置方法和后置方法
在Bean
的初始化前后进行一些操作。
bean后置处理器不是单独针对某一个bean生效,而是针对IOC容器中所有bean都会执行。
方法会获得Object
类型的Bean
实例,它的返回值是可以对参数获得的Bean
,你可以进行包装或者是直接返回
至于源码部分可以看雷神的讲解,总而言之就是底层构建ioc容器的时候,在刷新12大步的时候,会给容器注入Bean,而经历Set
属性赋值之后,会for循环遍历所有后置处理器
,依次执行后置处理器的前置方法。
Spring底层用它完成了很多事情,可以利用Idea去看看它的实现类,比如之前Spring学过的一个接口,如果想给Bean
对象获取ioc
容器也很简单,实现ApplicationContextAware
接口会默认让重写一个set方法,我们设置一个ApplicationContext
类的属性,即可在后置处理器方法实现的过程中,调用postProcessBeforeInitialization
方法给Bean
对象注入进去。
如还有一个AutowireAnnotationBeanPostProcessor
类,它就是容器帮我们进行自动装配的。可以说很多的Spring行为在底层都是基于这个后置处理器完成的
使用这个注解标注在我们的Bean
类的字段属性上,可以进行赋值。
使用这个注解在配置类上可以读取外部配置文件读取到环境变量中。
@PropertySource
用于指定外部属性文件的位置,可以将属性文件中的属性值注入到Spring Bean
中。它通常与@Value
注解一起使用,将属性文件中的值注入到单个属性
中。
@ConfigurationProperties
用于将属性文件中的值绑定到一个Java对象
上。它可以将属性文件中的多个属性值
注入到一个Java对象
中。与@Value
注解不同,@ConfigurationProperties
可以将属性文件中的值注入到多个属性中。
详情见之前的Spring笔记
这里补充一下一些原理:AutowiredAnnotationBeanPostProcessor
在Bean
的生命周期中的后置处理器的前置方法,进行注入。同时如果组件只有一个有参构造器,不需要任何注解标注,就能从容器获取嵌套的内部组件
注册多个相同类型的Bean
,用@Autowired
,想要指定只能通过@Qualifier
,通过名字指定注入哪个,因为@Autowired
是根据类型注入的,但是这么太麻烦了,我们可以在注入的组件的注入注解上再写一个@Primary
,即可完成注入的情况,如果发现多个同类型的组件,优先把这个注入。同时这两个是可以一起使用的。@Qualifier注解的优先级高于@Primary注解。也就是说,当一个接口有多个实现类时,如果使用了@Qualifier注解指定了要注入哪个实现类,那么即使有一个实现类被标记了@Primary注解,也不会被优先选择。
@Resource
默认byName注入,没有指定name时把属性名当做name,根据name找不到时,才会byType注入。byType注入时,某种类型的Bean只能有一个。但是不支持Spring
的@Primary
功能和@Autowired
的默认值
功能和required=false
功能
想用@Inject
需要专门maven依赖,和@Autowired
功能一样,支持@Primary
了,但是还是不支持@Autowired的默认值
功能和required=false
功能
所以我们不必这种时候写@Autowired
注解,如果容器不存在参数写的类型的组件,IDea能识别到,并标识红色波浪号。
类似给Bean注入ioc容器,实现ApplicationContextAware
接口重写set方法即可,其他组件类似。本质其实底层是靠对应的xxxxxxxProcessor
后置处理器的postProcessorBeforeInitialization方法
实现的
这里后面的Springboot篇章讲了
这里讲讲通过代码的方式,直接通过ioc
容器的getEnvironment().setActiveProfiles("xxx", "xxxx"...)
可以一次设置单个或多个激活的环境。
痛点:SpringBoot 集中化管理配置,application.properties
问题:配置多以后难阅读和修改,层级结构辨识度不高
YAML 是 “YAML Ain’t a Markup Language”(YAML 不是一种标记语言)。在开发的这种语言时,YAML 的意思其实是:“Yet Another Markup Language”(是另一种标记语言)。
.yaml
或 .yml
作为文件后缀支持的写法:
@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;
}
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: 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} #对象也可用{}表示
|
开头,大文本写在下层,保留文本格式,换行符正确显示>
开头,大文本写在下层,折叠换行符---
可以把多个yaml文档合并在一个文档中,每个文档区依然认为内容独立,方便阅读简化JavaBean 开发。自动生成构造器、getter/setter、自动生成Builder模式等
<dependency>
<groupId>org.projectlombokgroupId>
<artifactId>lombokartifactId>
<scope>compilescope>
dependency>
使用@Data
等注解
Lombok注解大全
规范:项目开发不要编写
System.out.println()
,应该用日志
记录信息
日志门面 | 日志实现 (没有对应关系) |
---|---|
JCL(Jakarta Commons Logging) | Log4j |
SLF4j(Simple Logging Facade for Java) | JUL(java.util.logging) |
jboss-logging | Log4j2 |
Logback |
感兴趣日志框架关系与起源可参考:SpringBoot2雷神视频 视频 21~27集
commons-logging
作为内部日志,但底层日志实现是开放的。可对接其他日志框架。jul
,log4j2
,logback
。SpringBoot 提供了默认的控制台输出配置,也可以配置输出为文件。logback
是默认使用的。SpringBoot怎么把日志默认配置好的
1、每个starter
场景,都会导入一个核心场景spring-boot-starter
2、核心场景引入了日志的所用功能spring-boot-starter-logging
3、默认使用了logback + slf4j
组合作为默认底层日志
4、日志是系统一启动就要用
,xxxAutoConfiguration
是系统启动好了以后放好的组件,后来用的。
5、日志是利用监听器机制配置好的。ApplicationListener
。
6、日志所有的配置都可以通过修改配置文件实现。以logging
开始的所有配置。
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]
默认输出格式:
ERROR, WARN, INFO, DEBUG,
or TRACE
.(其实在cmd里面,我们使用jps命令可以看到当前所有的java进程)
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}
可在配置文件通过logging修改为:'%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread] %logger{15} ===> %msg%n'
-5
代表左对齐五个字符
%logger
代表当前类
%n
换行
Logger logger = LoggerFactory.getLogger(getClass());
或者使用Lombok的@Slf4j注解
ALL,TRACE, DEBUG, INFO, WARN, ERROR,FATAL,OFF
;
INFO
application.properties/yaml
中配置logging.level.=
指定日志级别,其中
可以指定包名,或者是下面的rootlevel
可取值范围:TRACE, DEBUG, INFO, WARN, ERROR, FATAL, or OFF
,定义在 LogLevel
类中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 预定义两个组
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 |
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为准,和path的值没有任何关系 |
归档:每天的日志单独存到一个文档中。
切割:每个文件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.max-file-size |
存档前,每个日志文件的最大大小(默认值:10MB ) |
logging.logback.rollingpolicy.total-size-cap |
日志文件被删除之前,可以容纳的最大大小(默认值:0B )。设置1GB则磁盘存储超过 1GB 日志后就会删除旧日志文件 |
logging.logback.rollingpolicy.max-history |
日志文件保存的最大天数(默认值:7 ). |
通常我们配置 application.properties
就够了。当然也可以自定义。比如:
日志系统 | 自定义 |
---|---|
Logback | logback-spring.xml, logback-spring.groovy, logback.xml, or logback.groovy |
Log4j2 | log4j2-spring.xml or log4j2.xml |
JDK (Java Util Logging) | logging.properties |
如果可能,我们建议您在日志配置中使用-spring
变量(例如,logback-spring.xml
而不是 logback.xml
)。如果您使用标准配置文件,spring 无法完全控制日志初始化。
最佳实战:自己要写配置,配置文件名加上 xx-spring.xml
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-webartifactId>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starterartifactId>
<exclusions>
<exclusion>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-loggingartifactId>
exclusion>
exclusions>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-log4j2artifactId>
dependency>
log4j2支持yaml和json格式的配置文件
格式 | 依赖 | 文件名 |
---|---|---|
YAML | com.fasterxml.jackson.core:jackson-databind + com.fasterxml.jackson.dataformat:jackson-dataformat-yaml | log4j2.yaml + log4j2.yml |
JSON | com.fasterxml.jackson.core:jackson-databind | log4j2.json + log4j2.jsn |
application.properties
配置文件,就可以调整日志的所有行为。如果不够,可以编写日志框架自己的配置文件放在类路径下就行,比如logback-spring.xml
,log4j2-spring.xml
spring6的当时学习链接可作为补充
AOP(Aspect Oriented Programming)是一种设计思想,是软件设计领域中的面向切面编程,它是面向对象编程的一种补充和完善,它以通过预编译方式和运行期动态代理方式实现,在不修改源代码的情况下,给程序动态统一添加额外功能的一种技术。 利用AOP可以对业务逻辑的各个部分进行隔离,从而使得业务逻辑各部分之间的耦合度降低,提高程序的可重用性,同时提高了开发的效率。
@Before
注解标识,在被代理的目标方法前执行@AfterReturning
注解标识,在被代理的目标方法成功结束后执行(寿终正寝)@AfterThrowing
注解标识,在被代理的目标方法异常结束后执行(死于非命)@After注解标识
,在被代理的目标方法最终结束后执行(盖棺定论)@Around注解标识
,使用try…catch…finally
结构围绕整个被代理的目标方法,包括上面四种通知对应的所有位置。我们手动推动目标方法运行(joinPoint.procced()
)一旦给切面类写切入方法,形参如果有JoinPoint joinPoint
必须放在第一位
Springboot
想要使用的话需要引入依赖
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-aopartifactId>
dependency>
基于注解驱动的情况下,需要给注入切面类的配置文件写注解@EnableAspectJAutoProxy
在Spring Boot
中,默认情况下,如果您的项目中存在AOP
相关的依赖和切面类,Spring Boot会自动开启AOP
功能,不需要显式地使用@EnableAspectJAutoProxy
注解。
使用AOP实现代理之后,通过getBean方法获取的对象,它的类没有变成代理类的类,这是因为Spring AOP采用的是基于代理的AOP实现方式,而不是基于字节码的AOP实现方式。
在基于代理的AOP实现方式中,Spring会为目标对象创建一个代理对象,代理对象和目标对象实现了相同的接口,并且代理对象中持有了目标对象的引用。当我们使用getBean方法获取目标对象时,Spring会将代理对象返回给我们,而不是目标对象本身。这个代理对象会拦截我们调用目标对象的方法,并在执行目标对象的方法前后执行一些额外的逻辑,从而实现AOP的功能。
因此,虽然我们通过getBean方法获取的对象看起来和原来的目标对象一样,但实际上它是一个代理对象,并且在调用它的方法时会执行AOP逻辑。如果想要获取代理对象的类,可以通过调用代理对象的getClass()方法来获取。
默认情况下,Spring AOP会将代理类放入IOC容器中,而不会将原始类的对象放入容器中。也就是说,如果你使用getBean()方法获取一个被AOP代理的对象,实际上获取的是代理类的实例对象,而不是原始类的实例对象。
如果你需要将原始类的对象放入IOC容器中,可以使用AspectJ风格的AOP实现方式,并在配置中将proxyTargetClass属性设置为false。这样做会导致Spring不再使用基于代理的AOP实现方式,而是使用基于AspectJ的AOP实现方式,从而可以将原始类的对象放入IOC容器中。
总之,Spring AOP可以将代理类和原始类的对象都放入IOC容器中,但具体如何配置取决于你的需求。
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import({AspectJAutoProxyRegistrar.class})
public @interface EnableAspectJAutoProxy {
boolean proxyTargetClass() default false;
boolean exposeProxy() default false;
}
它给容器导入了组件AspectJAutoProxyRegistrar.class
这个组件实现了ImportBeanDefinitionRegistrar
,可以跳回上面复习@Import
的四种导入,实现这个接口可以自定义导入组件
利用它自定义给容器注入了一个Bean
internalAutoProxyCreator=AnnotationAwareAspectJAutoProxyCreator
基于注解驱动的AspectJ
的切面代理创造器
class AspectJAutoProxyRegistrar implements ImportBeanDefinitionRegistrar {}
它的继承关系很复杂,主要关注祖宗接口有一个后置处理器的接口(在Bean
初始化前后做事情),还有一个BeanFactoryAware
接口,那就说明它能自动装配BeanFactory
不懂就去看视频吧
ioc
容器refresh()
刷新容器registerBeanPostProcessors(beanFactory)
注册Bean
的后置处理器,方便拦截Bean
的创建
ioc
容器已经定义了的需要创建对象的所有BeanPostProcessor
【为什么已经有了定义的后置处理器其实来源于第一步传入配置类的时候,@EnableAspectJAutoProxy
注解已经通过上面说的@Import
把后置处理器】BeanPostProcessor
,同时对他们分类放入了不同容器,如是否实现Ordered
接口可以排序之类的PriorityOrdered
接口的BeanPostProcessor
Ordered
接口的BeanPostProcessor
BeanPostProcessor
,实际上就是创建BeanPostProcessor
对象保存在容器中,创建internalAutoProxyCreator
的BeanPostProcessor
【AnnotationAwareAspectJAutoProxyCreator
】
Bean
的实例populateBean
:给Bean
的各种属性赋值initializeBean
:初始化Bean
【Bean
后置处理器就是在这前后行动的】
invokeAwareMethods()
:处理Aware
接口的方法回调applyBeanPostProcessorsBeforeInitialiization
应用后置处理器的前置方法invokeInitMethods()
执行自定义的初始化方法,在此期间将前面说的工厂初始化并注入容器了applyBeanPostProcessorsAfterInitialiization
应用后置处理器的后置方法BeanPostProcessor(AnnotationAwareAspectJAutoProxyCreator)
创建成功BeanPostProcessor
注册到BeanFactory
中AnnotationAwareAspectJAutoProxyCreator
的过程】BeanFactory
的初始化工作后,接着来到了IOC
容器的refresh
的新的大步finishBeanFactoryInitialization(beanFactory)
,注册单实例Bean
Bean
依次创建对象getBean(beanName)
-> getBean -> doGetBean -> getSingleton()
Bean
Spring实现单实例的原则:通过缓存机制
】createBean()
AnnotationAwareAspectJAutoProxyCreator
会在任何Bean
创建之前先尝试返回Bean
的实例
resolveBeforeInstantiation(beanName, mbdToUse)
解析后置处理器前置方法,希望后置处理器能在此返回一个代理对象,如果能返回就返回,如果不能就到下一步。【后置处理器是在Bean对象创建完成初始化前后调用的】【而InstantiationAwareBeanPostProcessor
是在创建Bean
实例之前就先尝试用后置处理器返回对象】doCreateBean(beanName, mbdToUse, args)
真正的创建一个Bean
实例,和3.6流程一致总而言之,就是通过注入一个特别的【后置处理器】,专门在【普通Bean】实例化之前,拦截它们的创建,先尝试用它试着去创建
AnnotationAwareAspectJAutoProxyCreator
【InstantiationAwareBeanPostProcessor
】的作用:
Bean
创建之前,调用postProcessBeforeInstantiation()
方法
Bean
是否在adviseBeans
中(保存了所有需要增强的Bean
)Bean
是否是基础类型的Advice,Pointcut,Advisor,AopInfrastructureBean
或者看看是否是切面类。判断方法无非就是通过类型或者是注解之类的反射原理List candidateAdvisors
】每一个封装的通知方法的增强器是InstantialtionModelAwarePointcutAdvisor
。判断每个增强器是否是AAspectJPointcutAdvisor
类型;返回truefalse
postProcessAfterInitialization
有需要的情况下包装return wrapIfNecessary(bean,beanName,cacheKey)
Bean
所有的增强器【通知方法】
Bean
到advisedBeans
中Bean
需要增强,创建它的代理对象
获取所有增强器【通知方法】
proxyFactory
CglibAopProxy.intercept()
拦截目标方法的执行CglibMethodInvocation
对象,并调用mi.proceed()
方法,这个方法返回一个Object对象,会处理这个返回值这个执行顺序Spring5.3之后变了,先异常或返回,最后是后置
@EnableAspectJAutoProxy
在配置类开启AOP功能【springboot中隐式开启】@EnableAspectJAutoProxy
会给容器注入一个组件AnnotationAwareAspectJAutoProxtyCreator
,这是一个后置处理器refresh()
】
registerBeanPostProcessors()
注册后置处理器,创建AnnotationAwareAspectJAutoProxtyCreator
finishBeanFactoryInitialization()
初始化剩下的单实例Bean
AnnotationAwareAspectJAutoProxtyCreator
拦截组件的创建过程Advisor
),给业务逻辑组件创建代理对象CglibAopProxy.intercept()
MethodInterceptor
)