一、组件注解
1、 @Component(“xxx”)
指定某个类是容器的bean, @Component(value="xx") 相当于 ,其中 value 可以不写。
用于标注类为spring容器bean的注解有四个, 主要用于区别不同的组件类,提高代码的可读性:
a、 @Component, 用于标注一个普通的bean
b、 @Controller 用于标注一个控制器类(控制层 controller)
c、 @Service 用于标注业务逻辑类(业务逻辑层 service)
d、 @Repository 用于标注DAO数据访问类 (数据访问层 dao)
对于上面四种注解的解析可能是相同的,尽量使用不同的注解提高代码可读性。
注解用于修饰类,当不写value属性值时,默认值为类名首字母小写。
2、 @Scope(“prototype”)
该注解和 @Component 这一类注解联合使用,用于标记该类的作用域,默认 singleton 。
也可以和 @Bean 一起使用,此时 @Scope 修饰一个方法。关于@Bean稍后有说明
3、 @Lazy(true)
指定bean是否延时初始化,相当于 ,默认false。@Lazy可以和@Component这一类注解联合使用修饰类,也可以和@Bean一起使用修饰方法
注 :此处初始化不是指不执行 init-method ,而是不创建bean实例和依赖注入。只有当该bean(被@Lazy修饰的类或方法)被其他bean引用(可以是自动注入的方式)或者执行getBean方法获取,才会真正的创建该bean实例,其实这也是BeanFactory的执行方式。
4、 @DepondsOn({“aa”,“bb”})
该注解也是配合 @Component 这类注解使用,用于强制初始化其他bean
上面的代码指定,初始化bean “userAction"之前需要先初始化“aa”和“bb”两个bean,但是使用了@Lazy(true)所以spring容器初始化时不会初始化"userAction” bean。
5、 @PostConstructor和@PreDestroy
@PostConstructor 和 @PreDestroy 这两个注解是j2ee规范下的注解。这两个注解用于修饰方法,spring用这两个注解管理容器中spring生命周期行为。
a、 @PostConstructor 从名字可以看出构造器之后调用,相当于 。就是在依赖注入之后执行
b、 @PreDestroy 容器销毁之前bean调用的方法,相当于
6、 @Resource(name=“xx”)
@Resource 可以修饰成员变量也可以修饰set方法。当修饰成员变量时可以不写set方法,此时spring会直接使用j2ee规范的Field注入。
@Resource有两个比较重要的属性,name和type
a、 如果指定了name和type,则从Spring容器中找到唯一匹配的bean进行装配,找不到则抛出异常;
b、 如果指定了name,则从spring容器查找名称(id)匹配的bean进行装配,找不到则抛出异常;
c、 如果指定了type,则从spring容器中找到类型匹配的唯一bean进行装配,找不到或者找到多个,都会抛出异常;
d、 如果既没有指定name,又没有指定type,则自动按照byName方式进行装配
如果没有写name属性值时
a、 修饰成员变量,此时name为成员变量名称
b、 修饰set方法,此时name 为set方法的去掉set后首字母小写得到的字符串
7、 @Autowired(required=false)
@Autowired可以修饰构造器,成员变量,set方法,普通方法。@Autowired默认使用byType方式自动装配。required标记该类型的bean是否是必须的,默认为必须存在(true)。
可以配合 @Qualifier(value="xx") ,实现按beanName注入:
a、 required=true(默认),为true时,从spring容器查找和指定类型匹配的bean,匹配不到或匹配多个则抛出异常
b、 使用 @Qualifier("xx") ,则会从spring容器匹配类型和 id 一致的bean,匹配不到则抛出异常
@Autowired会根据修饰的成员选取不同的类型:
a、 修饰成员变量。该类型为成员变量类型
b、 修饰方法,构造器。注入类型为参数的数据类型,当然可以有多个参数
8、demo
业务逻辑层:
数据访问层:
测试类:
输出结果:
可以看到虽然UserDao 使用@Lazy,但是还是在spring容器初始化的时候还是创建了UserDao实例。原因很简单,因为在UserService中需要注入UserDao,所以在此时创建的UserDao实例也属于延时初始化。
在上面我们还使用了两个接口InitializingBean 和DisposableBean,这两个接口用于管理 singleton 作用域的bean的生命周期,类似init-method和destroy-method。不同之处就是调用的循序不一致:
a、 初始化调用顺序 :@PostConstructor > InitializingBean > init-method 用于指定bean依赖注入后的行为
b、 销毁调用顺序 @PreDestroy > DisposableBean > destroy-method 用于定制bean销毁之前的行为
该注解是AspectJ中的注解,并不是spring提供的,所以还需要导入aspectjweaverjar,aspectjrtjar,除此之外还需要依赖aopalliancejar
依赖包:
UserDaojava
配置文件 applicationContextxml:
测试类:
1、 @Aspect
修饰Java类,指定该类为切面类。当spring容器检测到某个bean被@Aspect修饰时,spring容器不会对该bean做增强处理(bean后处理器增强,代理增强)
2、 @Before
修饰方法,before增强处理。用于对目标方法(切入点表达式表示方法)执行前做增强处理。可以用于权限检查,登陆检查。
常用属性:
value: 指定切入点表达式 或者引用一个切入点
对comexampleaop 包下所有的类的所有方法做 before增强处理:
结果:
如果同一条切入点表达式被使用多次,可以使用更友好的方式。定义一个切入点:
增强方法可以接受一个JoinPoint 类型的参数,用于获取被执行目标方法的一下属性。
结果:
3、 @AfterReturning
修饰方法,afterreturning增强处理。目标方法正常结束后做增强处理。
常用属性:
a、 pointcut/value:指定切入点表达式
b、 returning:指定一个参数名,用于接受目标方法正常结束时返回的值。参数名称需要在增强方法中定义同名的参数。
注意:
a、 如果使用了returning 。那么增强方法中的数据类型必须是返回结果的类型或者父类型,否则不会调用该增强处理。
b、 使用了returning 还可以用来 修改返回结果 。
以上面的例子来说,目标方法返回结果类型应该满足下面的条件
修改返回值:
结果:
可以看到 AfterReturning 修改了返回结果。
4、 @AfterThrowing
修饰方法,afterthrowing增强处理。当目标程序方法抛出 异常或者异常无法捕获时,做增强处理。
常用属性:
a、 pointcut/value :指定切入点表达式
b、 throwing:指定一个形参,在增强方法中定义同名形参,用于访问目标方法抛出的异常
参数类型必须是 Throwable 的子类,同样也会有上面@AfterReturning 参数类型匹配的问题。
5、 @After
修饰方法 ,after增强处理。无论方法是否正常结束,都会调用该增强处理(@After= @AfterReturning+@AfterThrowing)。但是该增强方式无法获取目标方法的返回结果,也获取目标方法抛出的异常。所以一般用于进行释放资源,功能类似于 finally。
常用属性:
a、 value :指定切入点表达式
结果:
从上面的结果来看 After 增加处理 ,因为不能接受返回结果作为参数,所以不能修改返回结果。
6、 @Around
修饰方法, around增强处理。该处理可以目标方法执行之前和执行之后织入增强处理(@Before+@AfterReturning)。
Around增强处理通常需要在线程安全的环境下使用,如果@Before和@AfterReturning可以处理就没必要使用@Around。
常用属性:
a、 value :指定切入点表达式
当定义一个Aound增前处理时,增强方法第一形参需要时ProceedingJoinPoint类型。ProceedingJoinPoint有一个Object proceed()方法,用于执行目标方法。当然也可以为目标方法传递数组参数,来修改目前方法的传入参数。
around小结:
a、 Around增强处理通常需要 在线程安全 的环境下使用
b、 调用 proceed()可以获取返回结果,所以可以修改目标方法的返回值
c、 proceed(Object[] var1) 可以修改入参,修改目标方法的入参
d、 可以进行目标方法执行之前和执行之后织入增强处理
around 和 afterReturning 都可以修改返回结果。不过两者的原理不同:
a、 around:可以任意修改,或者返回不相关的值。这个返回值完全可以自主控制
b、 afterReturning,通过方法参数 ,使用对象引用的方式来修改对象。修改对象引用地址那么修改时无效的
除此之外从输出结果来看,增强处理是有序的:
around 和 afterReturning小结:
a、 只有 around 和 afterReturning 可以获取并修改返回结果。需要注意两种方式修改的区别。
b、 around 需要线程安全
c、 虽然增强处理都需要 切入点表达式,并不是都支持 pointcut 属性,所以最好都是用value 属性指定。当注解只需要value属性时,value可以省略
7、 @Pointcut
修饰方法,定义一个切入点表达式用于被其他增强调用。使用该方式定义切入点方便管理,易复用。
切入点方法定义和测试方法定义类似,具有以下特点:
a、 无返回值 (void)
b、 无参数
c、 方法体为空
d、 方法名就是切入点名称
e、 方法名不能为 execution
切入点表达式
切入点表达式可以通过 && 、 || 、 ! 连接
1)、execution 表达式:
2)、within 表达式:
a、匹配指定类下的所有方法。
b、匹配执行包及其子包下所有类的所有方法。
所以within可以看做execution的简写,不需要指定返回类型、方法名、参数( 最小作用单位是类 )
3)、 @annotation:匹配使用指定注解修饰的目标方法;
匹配使用@CustomMethodAnnotation注解的目标方法。
4)、 @within: 用于匹配使用指定注解修饰的类下的所有方法
within 作用范围是类,@within的作用范围与其一致。不同的是@within 指定的不是类而是注解
匹配使用@ResponseBody 注解的类 下的所有方法。
AOP小结:
1)、 Around增强处理通常需要 在线程安全 的环境下使用
2)、 使用 around 和 afterReturning 可以获取并修改返回结果
3)、 增强处理指定 切入点表达式时,最好使用value 属性
4)、 切入点 名称(方法名)不能为 execution
5)、 AfterReturning 指定了 returning 属性接受目标方法返回结果,注意 参数类型需要和返回结果类型一致(满足 resutType instanceof argsType )
增强方式的顺序:
1、 @Bean(name=“xxx”)
修饰方法,该方法的返回值为spring容器中管理的bean。当然该注解和上面的@Component效果一样,主要用于做区分。
@Bean 通常使用在 @Configuration 修饰的配置类中,该注解功能相当于 元素
常用的属性:
a、 name:bean id 。name可以省略,省略时bean名称为方法名。也可以指定多个名称(逗号隔开)。
b、 autowire: 是否自动注入,默认AutowireNO
c、 initMethod:bean的初始化方法。在依赖注入之后执行
d、 destroyMethod: spring容器关闭时bean调用的方法
当然 @Bean 还可以配合 @Scope 指定bean的作用域
2、 @ConfigurationProperties
用于从属性文件中获取值 applicationproperties 或者 applicationyml 。当然了 如果在配置文件中引入其他配置文件,也可以获取到属性值。
包含的属性:
a、 value | prefix 两者互为别名。指定前缀,默认为""
b、 ignoreUnknownFields:默认为true。是否忽略未知字段,当实体中的字段在配置文件中不存在时,是忽略还是抛出异常
c、 ignoreInvalidFields: 默认false。 是否忽略不合法的字段,此处的不合法是指类型不合适,配置文件中存在改配置但是无法转化为指定的字段类型。
Mybatis属性配置
applicationproperties:
ConfigurationProperties 可以配置前缀,然后会根据实体的变量名拼接前缀,去配置文件中查询配置。
3、 @Configuration
修饰一个Java类,被修饰的类相当于一个xml配置文件。功能类似于 。在springboot中大量使用了该注解,该注解提供了一种使用Java类方式配置bean。
可以发现 @Configuration使用了@Component 注解修饰。
实例 :
配置Mybatis会话工厂
4、 @Import
功能和 类似,修饰Java类,用于向当前类导入其他配置类。 可以导入多个配置文件,通常用于导入不在包扫描范围内的配置文件。可以被扫描的配置类可以直接访问,没有必要使用@Import 导入。
比如 SpringBoot的启动类指定的包扫描路径为 comexample
数据库的配置文件在 com包下。
在MyBatisConfig 中引入 DataSourceConfig, 就会解析DataSourceConfig。将解析出的Bean交给容器管理
5、 @ImportResource
修饰Java类,用于向类引入xml配置文件。
用于导入包含bean定义的配置文件,功能和 类似。默认情况下可以处理后缀为 groovy 和xml 的配置文件
6、 @Value("${expression}")
修饰成员变量或者 方法、构造器的参数,用于属性值注入(在配置文件中配置的值)。
注意: @Value不能对 static 属性注入。
如果的确需要注入到静态变量,可以通过以下方式间接进行注入:
1)、设置一个私有静态 实例
2)、通过构造函数或者 @PostConstruct 注解为 静态实例 赋值,指向本身(this)
3)、对成员属性注入内容
4)、提供静态方法,使用静态实例获取成员属性
7、@PropertySource(value=“classpath:jdbcproperties”)
该注解用来加载属性文件。
常用属性:
a、 ignoreResourceNotFound: 当资源文件找不到的时候是否会忽略该配置,而不是抛出错误。一般用于可选项
b、 encoding : 资源文件使用什么编码方式
c、 value : 指定属性文件位置。可以配置多个属性文件,不可以使用通配符。
在 PropertySource 中可以指定多个路径,并且会将属性文件中的值加载到 Environment 中。
@ConfigurationProperties 和 @PropertySource
它们的使用有一些差异:
1)、 @PropertySource 使用该注解加载的是 相对独立的属性文件,可以同时加载多个文件 (xxxproperties),而且 不支持自动注入 , 不支持前缀注入
2)、 @ConfigurationProperties 用于加载配置文件(applicationproperties | applicationyml)。该注解功能更强大:
a、 支持前缀注入 ( prefix )
b、 相同属性名的自动注入
c、 $("") 支持EL表达式注入
应用实例:
在以往的开发中通常会将数据库连接信息存放在单独的属性文件中(jdbcproperties)。而在spring boot 中我们会将数据库的信息存放在配置文件中,这会极大便利开发工作。
jdbcproperties:
可以通过 @Value 注解将配置文件的值注入到实体类中
也可以注入Environment ,通过Environment 获取值
1、 @ResponseBody
控制器方法返回值会使用 >
模板文件是使用 Compose 的核心,涉及到的指令关键字也比较多。大部分指令跟 docker run 相关参数的含义都是类似的。
默认的模板文件名称为 docker-composeyml ,格式为 YAML 格式。
可以将 Compose 文件命名为任何所需内容,以使其在逻辑上具有意义; docker-composeyml 仅为标准名称。我们可以简单地将此文件命名为 docker-stackyml 或更特定于项目的内容
注意每个服务都必须通过 image 指令指定镜像或 build 指令(需要 Dockerfile )等来自动构建生成镜像。
在 docker stack 下, build 指令不能使用,只能用 image
如果使用 build 指令,在 Dockerfile 中设置的选项(例如: CMD , EXPOSE , VOLUME , ENV 等) 将会自动被获取,无需在 docker-composeyml 中再次设置。
请注意,将 Compose 文件设置为 version:"3" 。本质上,这会使其兼容 swarm mode 。我们可以使用 deploy key (仅可用于 Compose 文件格式版本 3x 及更高版本)及其子选项对每项服务(例如,web)进行负载均衡和优化性能。我们可以使用 docker stack deploy 命令(仅在 Compose 文件版本 3x 及更高版本上受支持)运行此文件。您可以使用 docker-compose up 运行具有 非 swarm 配置的版本 3 文件。
指定 Dockerfile 所在文件夹的路径(可以是绝对路径,或者相对 docker-composeyml 文件的路径)。 Compose 将会利用它自动构建这个镜像,然后使用这个镜像。
也可以使用 context 指令指定 Dockerfile 所在文件夹的路径。
使用 dockerfile 指令指定 Dockerfile 文件名。
使用 arg 指令指定构建镜像时的变量。
使用 cache_from 指定构建镜像的缓存
指定容器的内核能力(capacity)分配。
让容器拥有所有能力可以指定为:
去掉 NET_ADMIN 能力可以指定为:
覆盖容器启动后默认执行的命令。
仅用于 Swarm mode
指定父 cgroup 组,意味着将继承该组的资源限制。
例如,创建了一个 cgroup 组名称为 cgroups_1。
指定容器名称。默认将会使用 项目名称_服务名称_序号 这样的格式。
仅用于 Swarm mode
指定设备映射关系。
解决容器的依赖、启动先后的问题。以下例子中会先启动 redis``db 再启动 web
自定义 DNS 服务器。可以是一个值,也可以是一个列表。
配置 DNS 搜索域。可以是一个值,也可以是一个列表。
挂载一个 tmpfs 文件系统到容器。
从文件中获取环境变量,可以为单独的文件路径或列表。
如果通过 docker-compose -f FILE 方式来指定 Compose 模板文件,则 env_file 中变量的路径会基于模板文件路径。
如果有变量名称与 environment 指令冲突,则按照惯例,以后者为准。
环境变量文件中每一行必须符合格式,支持 # 开头的注释行。
设置环境变量。你可以使用数组或字典两种格式。
只给定名称的变量会自动获取运行 Compose 主机上对应变量的值,可以用来防止泄露不必要的数据。
如果变量名称或者值中用到 true|false , yes|no 等表达 布尔 含义的词汇,最好放到引号里,避免 YAML 自动解析某些内容为对应的布尔语义。这些特定词汇,包括
y|Y|yes|Yes|YES|n|N|no|No|NO|true|True|TRUE|false|False|FALSE|on|On|ON|off|Off|OFF
暴露端口,但不映射到宿主机,只被连接的服务访问。
仅可以指定内部端口为参数
类似 Docker 中的 --add-host 参数,指定额外的 host 名称映射信息。
会在启动后的服务容器中 /etc/hosts 文件中添加如下两条条目。
通过命令检查容器是否健康运行。
指定为 镜像名称或镜像 ID 。如果镜像在本地不存在, Compose 将会尝试拉取这个镜像。
为容器添加 Docker 元数据(metadata)信息。例如可以为容器添加辅助说明信息。
配置日志选项。
目前支持三种日志驱动类型:
options 配置日志驱动的相关参数:
设置网络模式。使用和 docker run 的 --network 参数一样的值。
配置容器连接的网络。
跟主机系统共享进程命名空间。打开该选项的容器之间,以及容器和宿主机系统之间可以通过 进程ID 来相互访问和 *** 作。
暴露端口信息。
使用宿主端口:容器端口 (HOST:CONTAINER) 格式,或者仅仅指定容器的端口(宿主将会随机选择端口)都可以。
存储敏感数据,例如 mysql 服务密码。
指定容器模板标签(label)机制的默认属性(用户、角色、类型、级别等)。例如配置标签的用户名和角色名。
设置另一个信号来停止容器。在默认情况下使用的是 SIGTERM 停止容器。
配置容器内核参数。
指定容器的 ulimits 限制值。
例如,指定最大进程数为 65535,指定文件句柄数为 20000(软限制,应用可以随时修改,不能超过硬限制) 和 40000(系统硬限制,只能 root 用户提高)。
数据卷所挂载路径设置。可以设置宿主机路径 (HOST:CONTAINER) 或加上访问模式 (HOST:CONTAINER:ro) 。
该指令中路径支持相对路径。
此外,还有包括 domainname , entrypoint , hostname , ipc , mac_address , privileged , read_only , shm_size , restart , stdin_open , tty , user , working_dir 等指令,基本跟 docker run 中对应参数的功能一致。
指定服务容器启动后执行的入口文件。
指定容器中运行应用的用户名。
指定容器中工作目录。
指定容器中搜索域名、主机名、mac 地址等。
允许容器中运行一些特权命令。
指定容器退出后的重启策略为始终重启。该命令对保持服务始终运行十分有效,在生产环境中推荐配置为 always 或者 unless-stopped 。
以只读模式挂载容器的 root 文件系统,意味着不能对容器内容进行修改。
打开标准输入,可以接受外部输入。
模拟一个伪终端。
Compose 模板文件支持动态读取主机的系统环境变量和当前目录下的 env 文件中的变量。
例如,下面的 Compose 文件将从运行它的环境中读取变量 ${MONGO_VERSION} 的值,并写入执行的指令中。
如果执行 MONGO_VERSION=32 docker-compose up 则会启动一个 mongo:32 镜像的容器;如果执行 MONGO_VERSION=28 docker-compose up 则会启动一个 mongo:28 镜像的容器。
若当前目录存在 env 文件,执行 docker-compose 命令时将从该文件中读取变量。
在当前目录新建 env 文件并写入以下内容。
执行 docker-compose up 则会启动一个 mongo:36 镜像的容器。
这些方式优先级如下:
命令行参数
来自java:comp/env的JNDI属性
Java系统属性(SystemgetProperties())
*** 作系统环境变量
RandomValuePropertySource配置的random属性值
jar包外部的application-{profile}properties或applicationyml(带springprofile)配置文件
jar包内部的application-{profile}properties或applicationyml(带springprofile)配置文件
jar包外部的applicationproperties或applicationyml(不带springprofile)配置文件
jar包内部的applicationproperties或applicationyml(不带springprofile)配置文件
@Configuration注解类上的@PropertySource
applicationyml是用户级的资源配置项
bootstrapyml是系统级的, 优先级更加高
SpringCloud会创建一个'Bootstrap Context',作为Spring应用的'Application Context'的 父上下文 初始化的时候,'Bootstrap Context'负责从外部源加载配置属性并解析配置这两个上下文共享一个从外部获取的'Environment''Bootstrap'属性有高优先级,默认情况下,他们不会被本地配置覆盖'Bootsrap context'和'Application Context'有着不同的约定,所以新增了一个'bootstrapyml'文件,保证'Bootstrap Context'和'Application Context'配置的分离
以上是一个最简单的Springboot程序(203版本)示例,也是我们最通用的写法,但其中其实封装这一系列复杂的功能 *** 作,让我们开始逐步进行分析。
首先这里最重要的必然是注解 @SpringBootApplication
@SpringBootApplication 注解由几个注解复合组成,其中最主要的就是 @SpringBootConfiguration 、 @EnableAutoConfiguration 和 @ComponentScan 这三个。
其中的 @ComponentScan 是spring的原生注解, @SpringBootConfiguration 虽然是springboot中的注解,但其实质就是包装后的 @Configuration ,仍然是spring中的注解,用于代替xml的方式管理配置bean
@EnableAutoConfiguration 的定义如上,这里最重要的注解是 @Import ( @AutoConfigurationPackage 注解的实现也是基于 @Import ),借助 @Import 的帮助,将所有符合自动配置条件的bean定义加载到IoC容器中。关于 @EnableAutoConfiguration 注解后续涉及到时会再详细说明。这里我们先回到启动类的 run 方法从头分析初始化流程。
可以看到'run'方法最终调用的是 new SpringApplication(primarySources)run(args) ,这里首先创建了 SpringApplication 对象,然后调用其 run 方法
这里主要是为 SpringApplication 对象进行初始化,这里要专门提一下的是 webApplicationType 和 getSpringFactoriesInstances 。
它用来标识我们的应用是什么类型的应用,来看一下 deduceWebApplicationType() 方法的实现
其返回值是 WebApplicationType 类型的枚举类,其值有 NONE 、 SERVLET 、 REACTIVE 三种,分别对应非WEB应用,基于servlet的WEB应用和基于reactive的WEB应用。
这里的核心是 SpringFactoriesLoaderloadFactoryNames(type, classLoader) 方法,来看一下
重点关注一下 loadSpringFactories(classLoader) 做了什么
这里的 FACTORIES_RESOURCE_LOCATION 定义为 META-INF/springfactories ,因此该方法会扫描所有包下的该文件,将其解析成map对象并缓存到 cache 中以避免重复加载,springboot包下该文件的部分片段如下
从这里可以看出, setInitializers((Collection) getSpringFactoriesInstances( ApplicationContextInitializerclass)) 和 setListeners((Collection) getSpringFactoriesInstances(ApplicationListenerclass)); 分别对应设置的是上述这些类。
解析完成后调用 createSpringFactoriesInstances(type, parameterTypes, classLoader, args, names) 处理解析结果,生成对应的实例,源码如下
这里的核心是通过 ClassUtilsforName(name, classLoader) 方法,以反射的方式生成类实例 instanceClass 。由此可以看出 SpringFactoriesLoaderloadFactoryNames(type, classLoader) 的作用就是将 META-INF/springfactories 中配置的内容进行实例化的工厂方法类,具备很强的扩展性,与SPI机制有异曲同工
的效果。
看完 SpringApplication 的初始化,接着跳回 run 方法继续分析
这里挑其中比较重要的几个方法进行分析
通过 getOrCreateEnvironment() 方法创建容器环境
可以看到 environment 存在则不会重复创建,当应用类型为servlet时创建的是 StandardServletEnvironment 对象,否则创建 StandardEnvironment 对象。
接着来看 configureEnvironment(environment, applicationArgumentsgetSourceArgs())
configurePropertySources(environment, args) 加载启动命令行的配置属性,来看一下实现
这里的 MutablePropertySources 对象用于存储配置集合,其内部维护了一个 CopyOnWriteArrayList 类型的list对象,当默认配置存在时,会向该list的尾部插入一个 new MapPropertySource("defaultProperties", thisdefaultProperties) 对象。
接着来看 configureProfiles(environment, args)
这里主要做的事情就是获取 environmentgetActiveProfiles() 的参数设置到 environment 中,即 springprofilesactive 对应的环境变量。
最后来看一下 listenersenvironmentPrepared(environment)
这里的 listeners 就是之前通过 META-INF/springfactories 注册的所有listeners,后面我们先以其中最重要的 ConfigFileApplicationListener 做为例子进行分析,接着来看 listenerenvironmentPrepared(environment)
可以看到这里创建了一个 ApplicationEnvironmentPreparedEvent 类型的事件,并且调用了 multicastEvent 方法,通过该方法最终会调用到listener的 onApplicationEvent 方法,触发事件监听器的执行。
接下来具体看一下 ConfigFileApplicationListener 的 onApplicationEvent 方法做了什么
可以看到当监听到 ApplicationEnvironmentPreparedEvent 类型的事件时,调用 onApplicationEnvironmentPreparedEvent( (ApplicationEnvironmentPreparedEvent) event) 方法
可以看到这里通过 loadPostProcessors() 方法加载了 META-INF/springfactories 中的所有 EnvironmentPostProcessor 类到list中,同时把 ConfigFileApplicationListener 自己也添加进去了。接着遍历list中所有对象,并执行 postProcessEnvironment 方法,于是接着来看该方法
这里的核心是 new Loader(environment, resourceLoader)load() ,这里的 Loader 是一个内部类,用于处理配置文件的加载,首先看一下其构造方法
可以看到这里的 resourceLoader 又是通过 SpringFactoriesLoader 进行加载,那么来看看 META-INF/springfactories 中定义了哪些 resourceLoader
从名字就可以看出来, PropertiesPropertySourceLoader 和 YamlPropertySourceLoader 分别用于处理properties和yml类型的配置文件。
接着来看看 load() 方法做了什么
initializeProfiles() 进行了 profiles 的初始化,默认会添加 null 和 default 到 profiles 中, null 对应配置文件applicationproperties和applicationyml, default 对应配置文件application-defaultyml和application-defaultproperties,这里的 null 会被优先处理,由于后处理的会覆盖先处理的,因此其优先级最低。
接着来看 load(profile, this::getPositiveProfileFilter, addToLoaded(MutablePropertySources::addLast, false)) 方法
这里重点是通过 getSearchLocations() 获取配置文件的路径,默认会获得4个路径
接着会遍历这些路径,拼接配置文件名称,选择合适的yml或者properties解析器进行解析,最后将结果添加到 environment 的 propertySources 中。
可以看到这里也是根据 webApplicationType 的取值,分别创建不同的返回类型。
这里的 sources 装的就是我们的启动类,然后通过 load(context, sourcestoArray(new Object[0])) 方法进行加载
来看一下 loader 是如何被加载的
经过一系列调用之后最终由 load(Class<> source) 方法执行,这里比较有趣的是当Groovy存在时居然是优先调用Groovy的方式进行加载,否则才走 thisannotatedReaderregister(source) 方法将启动类注册到 beanDefinitionMap 中。
这个 refresh() 方法相当重要,尤其是 invokeBeanFactoryPostProcessors(beanFactory) ,这是实现spring-boot-starter-(mybatis、redis等)自动化配置的关键部分,后续再详细讲解。
至此Springboot的启动流程已经大体分析完了,也了解了配置文件和启动类分别是是如何被加载的,但仍有两个问题待解,一是Springboot的核心思想约定大于配置是如何做到的,二是Springboot的各种spring-boot-starter-是如何发挥作用的,这两个问题留待后续文章继续分析。
SpringBoot中文注释项目Github地址:
>
常规的,在springboot中一般只需要拿appolo或者nacos里配置的属性就够了。
但是也有一些很特殊的场景,要拿到appolo或者nacos里配置的文件,比如有个第三方jar包提供的方法中,要求把properties配置文件路径传进去来初始化第三方jar包里需要用到的东西,这时候一般是把properties文件配置到appolo或者nacos里,但是如何直接拿到这个properties文件而不是里面的属性值呢?
apollo里直接提供了把配置的相应namespace直接转换成file的方法:
再把这个content转换成输入流就可以用了
如果只是想拿到里面某个namespace的属性,则可以:
key为属性key名,cgetPropertyNames()方法能拿到该namespace下面的所有属性,返回一个Set<String>集合,再遍历这个集合就能拿到所有属性。
nacos跟apollo的处理思路有点不一样,找了很多资料,貌似没有找到nacos里直接获取整个获取配置文件的方法,后面如果有同学找到了这个方法记得留言提醒我。
nacos在springboot启动的时候已经把所有配置文件都注入到了spring里。
第一种:可以直接用注解 @Value("${key}")来获取配置好的属性值
第二种:在java里获取:
新建SpringContextUtil实现orgspringframeworkcontextApplicationContextAware这个接口:
在启动类用注解导入该类:@Import({SpringContextUtilclass})
利用orgspringframeworkcoreenvEnvironment类来直接获取属性:
如果有这样一个需求,有个第三方的jar包要求初始化配置好的properties文件,只给了properties文件的路径传参,只能用文件路径的方式初始化这个第三方jar包,那么我们就必须保证项目里或者其他文件夹有这个properties文件才可以,而这些配置如果经常要变的话,最好也是配置在nacos或者apollo,如此看来,apollo是可以直接把配置的相应namespace直接转换成file,而nacos大概只能把所有属性手工生成一个新的properties文件来保存到本地了。
这个生成文件的过程,要在springboot启动之后立即执行:
那我们就要建一个配置类实现orgspringframeworkbeansfactoryInitializingBean这个接口,重写afterPropertiesSet()方法:把需要启动后执行的逻辑放在里面,下面是一个示例:
把这个类在启动类里注入:
如此,在启动的时候就可以在本地生成一个cssconfigproperties文件了。
于是乎就可以类似这样调用第三方接口(根据第三方jar包来定):
以上就是关于spring常用注解全部的内容,包括:spring常用注解、二、SpringBoot的配置--yaml、docker-compose.yml说明和编写等相关内容解答,如果想了解更多相关内容,可以关注我们,你们的支持是我们更新的动力!
欢迎分享,转载请注明来源:内存溢出
评论列表(0条)