[TOC]
Spring Boot方式的项目已经逐步成为Java应用开发领域的主流框架,开发者不仅可以创建生产级的Spring应用,还能轻松通过一些注解配置与目前比较火热的微服务框架SpringCloud集成。Spring Boot极大地简化了项目的配置,最大化地实现了“约定大于配置”的原则,然后虽然开发方便了,但也很容易让人云里雾里,特别是各种注解很容易让人“知其然而不知其所以然”,因此,要想用好Spring Boot就必须对其提供的各类功能注解有一个全面而清晰地认识和理解。因此特意去各大博客摘录了一些常用注解的解释,大家一起学习吧。。。
1. @Configuration
从Spring3.0,@Configuration用于定义配置类,可替换xml配置文件,被注解的类内部包含有一个或多个被@Bean注解的方法,这些方法将会被AnnotationConfigApplicationContext或AnnotationConfigWebApplicationContext类进行扫描,并用于构建bean定义,初始化Spring容器。
注意:@Configuration注解的配置类有如下要求:
@Configuration不可以是final类型;
@Configuration不可以是匿名类;
嵌套的configuration必须是静态类。
一、用@Configuration加载spring
1.1、@Configuration配置spring并启动spring容器
@Configuration标注在类上,相当于把该类作为spring的xml配置文件中的
1 | package com.dxz.demo.configuration; |
相当于:
1 | <?xml version="1.0" encoding="UTF-8"?> |
主方法进行测试:
1 | package com.dxz.demo.configuration; |
从运行主方法结果可以看出,spring容器已经启动了:
1.2、@Configuration启动容器+@Bean注册Bean
@Bean标注在方法上(返回某个实例的方法),等价于spring的xml配置文件中的
bean类:
1 | package com.dxz.demo.configuration; |
配置类:
1 | package com.dxz.demo.configuration; |
主方法测试类:
1 | package com.dxz.demo.configuration; |
结果:
注:
(1)、@Bean注解在返回实例的方法上,如果未通过@Bean指定bean的名称,则默认与标注的方法名相同;
(2)、@Bean注解默认作用域为单例singleton作用域,可通过@Scope(“prototype”)设置为原型作用域;
(3)、既然@Bean的作用是注册bean对象,那么完全可以使用@Component、@Controller、@Service、@Ripository等注解注册bean,当然需要配置@ComponentScan注解进行自动扫描。
@Bean下管理bean的生命周期
可以使用基于 Java 的配置来管理 bean 的生命周期。@Bean 支持两种属性,即 initMethod 和destroyMethod,这些属性可用于定义生命周期方法。在实例化 bean 或即将销毁它时,容器便可调用生命周期方法。生命周期方法也称为回调方法,因为它将由容器调用。使用 @Bean 注释注册的 bean 也支持 JSR-250 规定的标准 @PostConstruct 和 @PreDestroy 注释。如果您正在使用 XML 方法来定义 bean,那么就应该使用 bean 元素来定义生命周期回调方法。以下代码显示了在 XML 配置中通常使用 bean 元素定义回调的方法。
1 | @Configuration |
启动类:
1 | public class TestMain { |
结果:
分析:
结果中的1:表明initMethod生效
结果中的2:表明@Scope(“prototype”)生效
1.3、@Configuration启动容器+@Component注册Bean
bean类:
1 | package com.dxz.demo.configuration; |
配置类:
1 | package com.dxz.demo.configuration; |
主方法测试获取bean对象:
1 | package com.dxz.demo.configuration; |
sayHello()方法都被正常调用。
1.4、使用 AnnotationConfigApplicationContext 注册 AppContext 类的两种方法
1.4.1、 配置类的注册方式是将其传递给 AnnotationConfigApplicationContext 构造函数
1 | public static void main(String[] args) { |
1.4.2、 AnnotationConfigApplicationContext 的register 方法传入配置类来注册配置类
1 | public static void main(String[] args) { |
1.5、配置Web应用程序(web.xml中配置AnnotationConfigApplicationContext)
过去,您通常要利用 XmlWebApplicationContext 上下文来配置 Spring Web 应用程序,即在 Web 部署描述符文件 web.xml 中指定外部 XML 上下文文件的路径。XMLWebApplicationContext 是 Web 应用程序使用的默认上下文类。以下代码描述了 web.xml 中指向将由 ContextLoaderListener 监听器类载入的外部 XML 上下文文件的元素。
1 | <web-app> |
现在,您要将 web.xml 中的上述代码更改为使用 AnnotationConfigApplicationContext 类。切记,XmlWebApplicationContext 是 Spring 为 Web 应用程序使用的默认上下文实现,因此您永远不必在您的web.xml 文件中显式指定这个上下文类。现在,您将使用基于 Java 的配置,因此在配置 Web 应用程序时,需要在web.xml 文件中指定 AnnotationConfigApplicationContext 类。上述代码将修改如下:
1 | <web-app> |
以上修改后的 web.xml 现在定义了 AnnotationConfigWebApplicationContext 上下文类,并将其作为上下文参数和 servlet 元素的一部分。上下文配置位置现在指向 AppContext 配置类。这非常简单。下一节将演示 bean 的生命周期回调和范围的实现。
1.6、@Configuation总结
@Configuation等价于
@Bean等价于
@ComponentScan等价于<context:component-scan base-package=”com.dxz.demo”/>
二、组合多个配置类
2.1、在@Configuration中引入spring的xml配置
1 | package com.dxz.demo.configuration2; |
bean类:
1 | package com.dxz.demo.configuration2; |
测试类:
1 |
|
结果:
2.2、在@Configuration中引入其它注解配置
1 | package com.dxz.demo.configuration2; |
测试类:
1 | package com.dxz.demo.configuration2; |
结果:
2.3、@Configuration嵌套(嵌套的Configuration必须是静态类)
通过配置类嵌套的配置类,达到组合多个配置类的目的。但注意内部类必须是静态类。
上代码:
1 | package com.dxz.demo.configuration3; |
1 | package com.dxz.demo.configuration3; |
配置类:
1 | package com.dxz.demo.configuration3; |
启动类:
1 | package com.dxz.demo.configuration3; |
结果:
1 | TestConfiguration容器启动初始化。。。 |
三、@EnableXXX注解
配合@Configuration使用,包括 @EnableAsync, @EnableScheduling, @EnableTransactionManagement, @EnableAspectJAutoProxy, @EnableWebMvc。
@EnableWebMvc
在springboot mvc或者java config配置中,如果我们项配置mvc相关的一些配置,那么就会涉及到这三个注解中的某个,那么他们之间有什么关系呢。
@EnableWebMvc = WebMvcConfigurationSupport,使用@EnableWebMvc注解就等于扩展了WebMvcConfigurationSupport,但是没有扩展任何方法。具体用法有如下三种:
@EnableWebMvc+extends WebMvcConfigurationAdapter,在扩展的类中重写父类的方法即可,这种方式会屏蔽springboot的@EnableAutoConfiguration中的设置。
extends WebMvcConfigurationSupport,在扩展的类中重写父类的方法即可,这种方式会屏蔽springboot的@EnableAutoConfiguration中的设置。
extends WebMvcConfigurationAdapter,在扩展的类中重写父类的方法即可,这种方式依旧使用springboot的@EnableAutoConfiguration中的设置。
前两种用法会屏蔽springboot的@EnableAutoConfiguration中的设置,最后一种用法则不会屏蔽默认设置,所以要使用部分spring mvc默认配置的话,就需要使用第三种配置方式。
@EnableScheduling、@Scheduled
1. 在 main 中开启定时任务的注解 @EnableScheduling
1 | package com.cun; |
2.在 Service 中编写定时任务 @Scheduled
fixedDelay: 每次方法执行完毕后,等待Nms再执行此方法。
1 | /** |
注意:定时方法返回值只能是void且不能有传入参数
fixedRate: 每隔5s调用一次此方法,无论之前的方法是否执行完毕
1 | /** |
initialDelay: 第一次调用此方法前的等待时间
1 | /*** |
cron:通过cron配置值
1 | /** |
3. Maven 依赖
1 | <dependency> |
四、@Profile逻辑组配置
@PropertySource注解可以配置读取单个或多个配置文件:
单个配置文件:
1 | @PropertySource(value = "classpath:spring/config.properties") |
多个配置文件:
1 | @PropertySource(value = {"classpath:spring/config.properties","classpath:spring/news.properties"}) |
@PropertySource注解使用有两种方式:
1、@PropertySource + Environment,通过@PropertySource注解将properties配置文件中的值存储到Spring的 Environment中,Environment接口提供方法去读取配置文件中的值,参数是properties文件中定义的key值。
2、@PropertySource(PropertySourcesPlaceholderConfigurer)+@Value
示例1:@PropertySource + Environment
在spring3.1中(不是spring3.0)还可以这样:
1 | package com.dxz.config; |
配置文件config.properties:
1 | key1=abc |
测试类:
1 | package com.dxz.config; |
结果:
1 | root of context hierarchy |
示例2: @PropertySource(PropertySourcesPlaceholderConfigurer)+@Value
创建Spring配置Class
1 | package com.dxz.config2; |
1 | package com.dxz.config2; |
测试类:
1 | package com.dxz.config2; |
结果:
1 | root of context hierarchy |
spring4版本
在Spring 4版本中,Spring提供了一个新的注解——@PropertySources,从名字就可以猜测到它是为多配置文件而准备的。
1 | package com.dxz.config3; |
spring的配置class
1 | package com.dxz.config3; |
测试类:
1 | package com.dxz.config3; |
结果:
另外在Spring 4版本中,@PropertySource允许忽略不存在的配置文件。先看下面的代码片段:
1 | @Configuration |
如果missing.properties不存在或找不到,系统则会抛出异常FileNotFoundException。
Caused by: java.io.FileNotFoundException:
class path resource [missiong.properties] cannot be opened because it does not exist
幸好Spring 4为我们提供了ignoreResourceNotFound属性来忽略找不到的文件
1 | package com.dxz.config3; |
最上面的AppConfiguation 的配置代码等于如下的XML配置文件
1 | <?xml version="1.0" encoding="UTF-8"?> |
五、使用外部变量
1、@PropertySource + Environment,通过@PropertySource注解将properties配置文件中的值存储到Spring的 Environment中,Environment接口提供方法去读取配置文件中的值,参数是properties文件中定义的key值。
2、@PropertySource(PropertySourcesPlaceholderConfigurer)+@Value