一、元注解

从JDK 1.5开始, Java增加了对元数据(MetaData)的支持,也就是 Annotation(注解)。
注解其实就是代码里的特殊标记,它用于替代配置文件:传统方式通过配置文件告诉类如何运行,有了注解技术后,开发人员可以通过注解告诉类如何运行。在Java技术里注解的典型应用是:可以通过反射技术去得到类里面的注解,以决定怎么去运行类。
注解可以标记在包、类、属性、方法,方法参数以及局部变量上,且同一个地方可以同时标记多个注解。

  1. // 抑制编译期的未指定泛型、未使用和过时警告
  2. @SuppressWarnings({ "rawtypes", "unused", "deprecation" })
  3. // 重写
  4. @Override

meta-annotation(元注解)
除了直接使用JDK 定义好的注解,我们还可以自定义注解,在JDK 1.5中提供了4个标准的用来对注解类型进行注解的注解类,我们称之为 meta-annotation(元注解),他们分别是:

  • @Target
  • @Retention
  • @Documented
  • @Inherited

我们可以使用这4个元注解来对我们自定义的注解类型进行注解,接下来,我们挨个对这4个元注解的作用进行介绍。

@Target注解

Target注解的作用是:描述注解的使用范围(即:被修饰的注解可以用在什么地方) 。
Target注解用来说明那些被它所注解的注解类可修饰的对象范围:注解可以用于修饰 packages、types(类、接口、枚举、注解类)、类成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(如循环变量、catch参数),在定义注解类时使用了@Target 能够更加清晰的知道它能够被用来修饰哪些对象,它的取值范围定义在ElementType 枚举中。

  1. public enum ElementType {
  2. TYPE, // 类、接口、枚举类
  3. FIELD, // 成员变量(包括:枚举常量)
  4. METHOD, // 成员方法
  5. PARAMETER, // 方法参数
  6. CONSTRUCTOR, // 构造方法
  7. LOCAL_VARIABLE, // 局部变量
  8. ANNOTATION_TYPE, // 注解类
  9. PACKAGE, // 可用于修饰:包
  10. TYPE_PARAMETER, // 类型参数,JDK 1.8 新增
  11. TYPE_USE // 使用类型的任何地方,JDK 1.8 新增
  12. }

@Retention注解

Reteniton注解的作用是:描述注解保留的时间范围(即:被描述的注解在它所修饰的类中可以被保留到何时) 。
Reteniton注解用来限定那些被它所注解的注解类在注解到其他类上以后,可被保留到何时,一共有三种策略,定义在RetentionPolicy枚举中。

  1. public enum RetentionPolicy {
  2. SOURCE, // 源文件保留
  3. CLASS, // 编译期保留,默认值
  4. RUNTIME // 运行期保留,可通过反射去获取注解信息
  5. }

为了验证应用了这三种策略的注解类有何区别,分别使用三种策略各定义一个注解类做测试。

  1. @Retention(RetentionPolicy.SOURCE)
  2. public @interface SourcePolicy {
  3. }
  1. @Retention(RetentionPolicy.CLASS)
  2. public @interface ClassPolicy {
  3. }
  1. @Retention(RetentionPolicy.RUNTIME)
  2. public @interface RuntimePolicy {
  3. }

用定义好的三个注解类分别去注解一个方法。

  1. public class RetentionTest {
  2. @SourcePolicy
  3. public void sourcePolicy() {
  4. }
  5. @ClassPolicy
  6. public void classPolicy() {
  7. }
  8. @RuntimePolicy
  9. public void runtimePolicy() {
  10. }
  11. }

常用注解 - 图2
如图所示,通过执行 javap -verbose RetentionTest命令获取到的RetentionTest 的 class 字节码内容如下。

  1. {
  2. public retention.RetentionTest();
  3. flags: ACC_PUBLIC
  4. Code:
  5. stack=1, locals=1, args_size=1
  6. 0: aload_0
  7. 1: invokespecial #1 // Method java/lang/Object."<init>":()V
  8. 4: return
  9. LineNumberTable:
  10. line 3: 0
  11. public void sourcePolicy();
  12. flags: ACC_PUBLIC
  13. Code:
  14. stack=0, locals=1, args_size=1
  15. 0: return
  16. LineNumberTable:
  17. line 7: 0
  18. public void classPolicy();
  19. flags: ACC_PUBLIC
  20. Code:
  21. stack=0, locals=1, args_size=1
  22. 0: return
  23. LineNumberTable:
  24. line 11: 0
  25. RuntimeInvisibleAnnotations:
  26. 0: #11()
  27. public void runtimePolicy();
  28. flags: ACC_PUBLIC
  29. Code:
  30. stack=0, locals=1, args_size=1
  31. 0: return
  32. LineNumberTable:
  33. line 15: 0
  34. RuntimeVisibleAnnotations:
  35. 0: #14()
  36. }

从 RetentionTest 的字节码内容我们可以得出以下两点结论:
1. 编译器并没有记录下 sourcePolicy() 方法的注解信息;
2. 编译器分别使用了 RuntimeInvisibleAnnotations 和 RuntimeVisibleAnnotations 属性去记录了classPolicy()方法 和 runtimePolicy()方法 的注解信息;


@Documented注解

Documented注解的作用是:描述在使用 javadoc 工具为类生成帮助文档时是否要保留其注解信息。
为了验证Documented注解的作用到底是什么,我们创建一个带有 @Documented 的自定义注解类。

  1. import java.lang.annotation.Documented;
  2. import java.lang.annotation.ElementType;
  3. import java.lang.annotation.Target;
  4. @Documented
  5. @Target({ElementType.TYPE,ElementType.METHOD})
  6. public @interface MyDocumentedtAnnotation {
  7. public String value() default "这是@Documented注解为文档添加的注释";
  8. }

再创建一个 MyDocumentedTest 类。

  1. @MyDocumentedtAnnotation
  2. public class MyDocumentedTest {
  3. @Override
  4. @MyDocumentedtAnnotation
  5. public String toString() {
  6. return this.toString();
  7. }
  8. }

接下来,使用以下命令为 MyDocumentedTest 类生成帮助文档。
常用注解 - 图3
命令执行完成之后,会在当前目录下生成一个 doc 文件夹,其内包含以下文件。
常用注解 - 图4
查看 index.html 帮助文档,可以发现在类和方法上都保留了 MyDocumentedtAnnotation 注解信息。
常用注解 - 图5
修改 MyDocumentedtAnnotation 注解类,去掉上面的 @Documented 注解。

  1. import java.lang.annotation.ElementType;
  2. import java.lang.annotation.Target;
  3. @Target({ElementType.TYPE,ElementType.METHOD})
  4. public @interface MyDocumentedtAnnotation {
  5. public String value() default "这是@Documented注解为文档添加的注释";
  6. }

重新生成帮助文档,此时类和方法上的 MyDocumentedtAnnotation 注解信息都不见了。
常用注解 - 图6


@Inherited注解

Inherited注解的作用是:使被它修饰的注解具有继承性(如果某个类使用了被@Inherited修饰的注解,则其子类将自动具有该注解)。
接下来我们使用代码来进行测试,首先创建一个被@Inherited修饰的注解类MyInheritedAnnotation。

  1. import java.lang.annotation.ElementType;
  2. import java.lang.annotation.Inherited;
  3. import java.lang.annotation.Retention;
  4. import java.lang.annotation.RetentionPolicy;
  5. import java.lang.annotation.Target;
  6. @Inherited
  7. @Target(ElementType.TYPE)
  8. @Retention(RetentionPolicy.RUNTIME)
  9. public @interface MyInheritedAnnotation {
  10. public String name() default "pengjunlee";
  11. }

创建一个带有 MyInheritedAnnotation 注解的父类和一个无任何注解的子类。

  1. @MyInheritedAnnotation(name="parent")
  2. public class Parent {
  3. }
  1. public class Child extends Parent{
  2. public static void main(String[] args) {
  3. Class<Child> child=Child.class;
  4. MyInheritedAnnotation annotation = child.getAnnotation(MyInheritedAnnotation.class);
  5. System.out.println(annotation.name());
  6. }
  7. }

运行程序,打印结果如下:

  1. parent

注解应用举例

首先自定义一个注解类。

  1. package com.pengjunlee;
  2. import java.lang.annotation.ElementType;
  3. import java.lang.annotation.Inherited;
  4. import java.lang.annotation.Retention;
  5. import java.lang.annotation.RetentionPolicy;
  6. import java.lang.annotation.Target;
  7. @Target({ ElementType.TYPE, ElementType.METHOD })
  8. @Retention(RetentionPolicy.RUNTIME)
  9. @Inherited
  10. public @interface MyAnnotation {
  11. public String name() default "pengjunlee";
  12. }

在 AnnotationTest 中使用反射获取注解信息。

  1. package com.pengjunlee;
  2. import java.lang.annotation.Annotation;
  3. import java.lang.reflect.Method;
  4. @MyAnnotation(name = "name of type")
  5. public class AnnotationTest {
  6. @MyAnnotation(name = "name of method")
  7. public String hello() {
  8. return "hello";
  9. }
  10. public static void main(String[] args) throws NoSuchMethodException, SecurityException {
  11. Class<AnnotationTest> annotationTest = AnnotationTest.class;
  12. // 获取类上的所有注解
  13. Annotation[] annotations = annotationTest.getAnnotations();
  14. for (Annotation annotation : annotations) {
  15. // 获取注解的全类名
  16. System.out.println(annotation.annotationType().getName());
  17. }
  18. // 获取 hello() 方法
  19. Method method = annotationTest.getMethod("hello", new Class[] {});
  20. // hello() 方法上是否有 MyAnnotation 注解
  21. if (method.isAnnotationPresent(MyAnnotation.class)) {
  22. // 获得注解
  23. MyAnnotation annotation = method.getAnnotation(MyAnnotation.class);
  24. // 获取注解的内容
  25. System.out.println(annotation.name());
  26. }
  27. }
  28. }

运行程序,打印结果如下:

  1. com.pengjunlee.MyAnnotation
  2. name of method

二、Spring Web MVC注解

@RequestMapping

@RequestMapping注解的主要用途是将Web请求与请求处理类中的方法进行映射。Spring MVC和Spring WebFlux都通过RquestMappingHandlerMapping和RequestMappingHndlerAdapter两个类来提供对@RequestMapping注解的支持。
@RequestMapping注解对请求处理类中的请求处理方法进行标注;@RequestMapping注解拥有以下的六个配置属性:

  • value:映射的请求URL或者其别名
  • method:兼容HTTP的方法名
  • params:根据HTTP参数的存在、缺省或值对请求进行过滤
  • header:根据HTTP Header的存在、缺省或值对请求进行过滤
  • consume:设定在HTTP请求正文中允许使用的媒体类型
  • product:在HTTP响应体中允许使用的媒体类型

提示:在使用@RequestMapping之前,请求处理类还需要使用@Controller或@RestController进行标记
下面是使用@RequestMapping的两个示例:
常用注解 - 图7
@RequestMapping还可以对类进行标记,这样类中的处理方法在映射请求路径时,会自动将类上@RequestMapping设置的value拼接到方法中映射路径之前,如下:
常用注解 - 图8


@RequestBody

@RequestBody在处理请求方法的参数列表中使用,它可以将请求主体中的参数绑定到一个对象中,请求主体参数是通过HttpMessageConverter传递的,根据请求主体中的参数名与对象的属性名进行匹配并绑定值。此外,还可以通过@Valid注解对请求主体中的参数进行校验。
下面是一个使用@RequestBody的示例:
常用注解 - 图9


@GetMapping

@GetMapping注解用于处理HTTP GET请求,并将请求映射到具体的处理方法中。具体来说,@GetMapping是一个组合注解,它相当于是@RequestMapping(method=RequestMethod.GET)的快捷方式。
下面是@GetMapping的一个使用示例:
常用注解 - 图10


@PostMapping

@PostMapping注解用于处理HTTP POST请求,并将请求映射到具体的处理方法中。@PostMapping与@GetMapping一样,也是一个组合注解,它相当于是@RequestMapping(method=HttpMethod.POST)的快捷方式。
下面是使用@PostMapping的一个示例:
常用注解 - 图11


@PutMapping

@PutMapping注解用于处理HTTP PUT请求,并将请求映射到具体的处理方法中,@PutMapping是一个组合注解,相当于是@RequestMapping(method=HttpMethod.PUT)的快捷方式。
下面是使用@PutMapping的一个示例:
常用注解 - 图12


@DeleteMapping

@DeleteMapping注解用于处理HTTP DELETE请求,并将请求映射到删除方法中。@DeleteMapping是一个组合注解,它相当于是@RequestMapping(method=HttpMethod.DELETE)的快捷方式。
下面是使用@DeleteMapping的一个示例:
常用注解 - 图13


@PatchMapping

@PatchMapping注解用于处理HTTP PATCH请求,并将请求映射到对应的处理方法中。@PatchMapping相当于是@RequestMapping(method=HttpMethod.PATCH)的快捷方式。
下面是一个简单的示例:
常用注解 - 图14


@ControllerAdvice

@ControllerAdvice是@Component注解的一个延伸注解,Spring会自动扫描并检测被@ControllerAdvice所标注的类。@ControllerAdvice需要和@ExceptionHandler、@InitBinder以及@ModelAttribute注解搭配使用,主要是用来处理控制器所抛出的异常信息。
首先,我们需要定义一个被@ControllerAdvice所标注的类,在该类中,定义一个用于处理具体异常的方法,并使用@ExceptionHandler注解进行标记。
此外,在有必要的时候,可以使用@InitBinder在类中进行全局的配置,还可以使用@ModelAttribute配置与视图相关的参数。使用@ControllerAdvice注解,就可以快速的创建统一的,自定义的异常处理类。
下面是一个使用@ControllerAdvice的示例代码:
常用注解 - 图15


@ResponseBody

@ResponseBody会自动将控制器中方法的返回值写入到HTTP响应中。特别的,@ResponseBody注解只能用在被@Controller注解标记的类中。如果在被@RestController标记的类中,则方法不需要使用@ResponseBody注解进行标注。@RestController相当于是@Controller和@ResponseBody的组合注解。
下面是使用该注解的一个示例
常用注解 - 图16


@ExceptionHandler

@ExceptionHander注解用于标注处理特定类型异常类所抛出异常的方法。当控制器中的方法抛出异常时,Spring会自动捕获异常,并将捕获的异常信息传递给被@ExceptionHandler标注的方法。
下面是使用该注解的一个示例:
常用注解 - 图17


@ResponseStatus

@ResponseStatus注解可以标注请求处理方法。使用此注解,可以指定响应所需要的HTTP STATUS。特别的,我们可以使用HttpStauts类对该注解的value属性进行赋值。
下面是使用@ResponseStatus注解的一个示例:
常用注解 - 图18


@PathVariable

@PathVariable注解是将方法中的参数绑定到请求URI中的模板变量上。可以通过@RequestMapping注解来指定URI的模板变量,然后使用@PathVariable注解将方法中的参数绑定到模板变量上。
特别地,@PathVariable注解允许我们使用value或name属性来给参数取一个别名。下面是使用此注解的一个示例:
常用注解 - 图19
模板变量名需要使用{ }进行包裹,如果方法的参数名与URI模板变量名一致,则在@PathVariable中就可以省略别名的定义。
下面是一个简写的示例:
常用注解 - 图20
提示:如果参数是一个非必须的,可选的项,则可以在@PathVariable中设置require = false


@RequestParam

@RequestParam注解用于将方法的参数与Web请求的传递的参数进行绑定。使用@RequestParam可以轻松的访问HTTP请求参数的值。
下面是使用该注解的代码示例:
常用注解 - 图21
该注解的其他属性配置与@PathVariable的配置相同,特别的,如果传递的参数为空,还可以通过defaultValue设置一个默认值。示例代码如下:
常用注解 - 图22


@Controller

@Controller是@Component注解的一个延伸,Spring会自动扫描并配置被该注解标注的类。此注解用于标注Spring MVC的控制器。下面是使用此注解的示例代码:
常用注解 - 图23


@RestController

@RestController是在Spring 4.0开始引入的,这是一个特定的控制器注解。此注解相当于@Controller和@ResponseBody的快捷方式。当使用此注解时,不需要再在方法上使用@ResponseBody注解。
下面是使用此注解的示例代码:
常用注解 - 图24


@ModelAttribute

通过此注解,可以通过模型索引名称来访问已经存在于控制器中的model。下面是使用此注解的一个简单示例:
常用注解 - 图25
与@PathVariable和@RequestParam注解一样,如果参数名与模型具有相同的名字,则不必指定索引名称,简写示例如下:
常用注解 - 图26
特别地,如果使用@ModelAttribute对方法进行标注,Spring会将方法的返回值绑定到具体的Model上。示例如下:
常用注解 - 图27
在Spring调用具体的处理方法之前,被@ModelAttribute注解标注的所有方法都将被执行。


@CrossOrigin

@CrossOrigin注解将为请求处理类或请求处理方法提供跨域调用支持。如果我们将此注解标注类,那么类中的所有方法都将获得支持跨域的能力。使用此注解的好处是可以微调跨域行为。使用此注解的示例如下:
常用注解 - 图28


@InitBinder

@InitBinder注解用于标注初始化WebDataBinder的方法,该方法用于对Http请求传递的表单数据进行处理,如时间格式化、字符串处理等。下面是使用此注解的示例:
常用注解 - 图29

三、Spring Bean 注解

@ComponentScan

@ComponentScan注解用于配置Spring需要扫描的被组件注解注释的类所在的包。可以通过配置其basePackages属性或者value属性来配置需要扫描的包路径。value属性是basePackages的别名。
常用属性如下:

  • basePackages、value:指定扫描路径,如果为空则以@ComponentScan注解的类所在的包为基本的扫描路径
  • basePackageClasses:指定具体扫描的类
  • includeFilters:指定满足Filter条件的类
  • excludeFilters:指定排除Filter条件的类
  • includeFilters和excludeFilters 的FilterType可选:ANNOTATION=注解类型默认、ASSIGNABLE_TYPE(指定固定类)、ASPECTJ(ASPECTJ类型)、REGEX(正则表达式)、CUSTOM(自定义类型),自定义的Filter需要实现TypeFilter接口

此注解的用法如下:

  1. @ComponentScan(value="com.maple.learn",
  2. excludeFilters = {@ComponentScan.Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class)},
  3. includeFilters = {@ComponentScan.Filter(type=FilterType.ANNOTATION,classes={Controller.class})}
  4. )
  5. public class SampleClass{
  6. ...

@Component

@Component注解用于标注一个普通的组件类,它没有明确的业务范围,只是通知Spring被此注解的类需要被纳入到Spring Bean容器中并进行管理。此注解的使用示例如下:
常用注解 - 图30


@Service

@Service注解是@Component的一个延伸(特例),它用于标注业务逻辑类。与@Component注解一样,被此注解标注的类,会自动被Spring所管理。下面是使用@Service注解的示例:
常用注解 - 图31


@Repository

@Repository注解也是@Component注解的延伸,与@Component注解一样,被此注解标注的类会被Spring自动管理起来,@Repository注解用于标注DAO层的数据持久化类。此注解的用法如下:
常用注解 - 图32

四、Spring Dependency Inject 与 Bean Scops注解

@DependsOn

@DependsOn注解可以配置Spring IoC容器在初始化一个Bean之前,先初始化其他的Bean对象。下面是此注解使用示例代码:
常用注解 - 图33


@Bean

@Bean注解主要的作用是告知Spring,被此注解所标注的类将需要纳入到Bean管理工厂中。@Bean注解的用法很简单,在这里,着重介绍@Bean注解中initMethod和destroyMethod的用法。示例如下:
常用注解 - 图34


@Scope

@Scope注解可以用来定义@Component标注的类的作用范围以及@Bean所标记的类的作用范围。@Scope所限定的作用范围有:singleton、prototype、request、session、globalSession或者其他的自定义范围。这里以prototype为例子进行讲解。
当一个Spring Bean被声明为prototype(原型模式)时,在每次需要使用到该类的时候,Spring IoC容器都会初始化一个新的改类的实例。在定义一个Bean时,可以设置Bean的scope属性为prototype:scope=“prototype”,也可以使用@Scope注解设置,如下:
@Scope(value=ConfigurableBeanFactory.SCOPE_PROPTOTYPE)
下面将给出两种不同的方式来使用@Scope注解,示例代码如下:
常用注解 - 图35


@Scope 单例模式

当@Scope的作用范围设置成Singleton时,被此注解所标注的类只会被Spring IoC容器初始化一次。在默认情况下,Spring IoC容器所初始化的类实例都为singleton。同样的原理,此情形也有两种配置方式,示例代码如下:
常用注解 - 图36

image.png五、容器配置注解

@Autowired

@Autowired注解用于标记Spring将要解析和注入的依赖项。此注解可以作用在构造函数、字段和setter方法上。
作用于构造函数
下面是@Autowired注解标注构造函数的使用示例:
常用注解 - 图38
作用于setter方法
下面是@Autowired注解标注setter方法的示例代码:
常用注解 - 图39
作用于字段
@Autowired注解标注字段是最简单的,只需要在对应的字段上加入此注解即可,示例代码如下:
常用注解 - 图40


@Primary

当系统中需要配置多个具有相同类型的bean时,@Primary可以定义这些Bean的优先级。下面将给出一个实例代码来说明这一特性:
常用注解 - 图41
输出结果:
this is send DingDing method message.


@PostConstruct与@PreDestroy

值得注意的是,这两个注解不属于Spring,它们是源于JSR-250中的两个注解,位于common-annotations.jar中。@PostConstruct注解用于标注在Bean被Spring初始化之前需要执行的方法。@PreDestroy注解用于标注Bean被销毁前需要执行的方法。下面是具体的示例代码:
常用注解 - 图42


@Qualifier

当系统中存在同一类型的多个Bean时,@Autowired在进行依赖注入的时候就不知道该选择哪一个实现类进行注入。此时,我们可以使用@Qualifier注解来微调,帮助@Autowired选择正确的依赖项。下面是一个关于此注解的代码示例:
常用注解 - 图43

六、Spring Boot注解

@SpringBootApplication

@SpringBootApplication注解是一个快捷的配置注解,在被它标注的类中,可以定义一个或多个Bean,并自动触发自动配置Bean和自动扫描组件。此注解相当于@Configuration、@EnableAutoConfiguration和@ComponentScan的组合。
在Spring Boot应用程序的主类中,就使用了此注解。示例代码如下:

  1. @SpringBootApplication
  2. public class Application{
  3. public static void main(String [] args){
  4. SpringApplication.run(Application.class,args);
  5. }
  6. }

@EnableAutoConfiguration

@EnableAutoConfiguration注解用于通知Spring,根据当前类路径下引入的依赖包,自动配置与这些依赖包相关的配置项。


@ConditionalOnClass与@ConditionalOnMissingClass

这两个注解属于类条件注解,它们根据是否存在某个类作为判断依据来决定是否要执行某些配置。下面是一个简单的示例代码:

  1. @Configuration
  2. @ConditionalOnClass(DataSource.class)
  3. class MySQLAutoConfiguration {
  4. //...
  5. }

@ConditionalOnBean与@ConditionalOnMissingBean

这两个注解属于对象条件注解,根据是否存在某个对象作为依据来决定是否要执行某些配置方法。示例代码如下:

  1. @Bean
  2. @ConditionalOnBean(name="dataSource")
  3. LocalContainerEntityManagerFactoryBean entityManagerFactory(){
  4. //...
  5. }
  6. @Bean
  7. @ConditionalOnMissingBean
  8. public MyBean myBean(){
  9. //...
  10. }

@ConditionalOnProperty

@ConditionalOnProperty注解会根据Spring配置文件中的配置项是否满足配置要求,从而决定是否要执行被其标注的方法。示例代码如下:

  1. @Bean
  2. @ConditionalOnProperty(name="alipay",havingValue="on")
  3. Alipay alipay(){
  4. return new Alipay();
  5. }

@ConditionalOnResource

此注解用于检测当某个配置文件存在使,则触发被其标注的方法,下面是使用此注解的代码示例:

  1. @ConditionalOnResource(resources = "classpath:website.properties")
  2. Properties addWebsiteProperties(){
  3. //...
  4. }

@ConditionalOnWebApplication与@ConditionalOnNotWebApplication

这两个注解用于判断当前的应用程序是否是Web应用程序。如果当前应用是Web应用程序,则使用Spring WebApplicationContext,并定义其会话的生命周期。下面是一个简单的示例:

  1. @ConditionalOnWebApplication
  2. HealthCheckController healthCheckController(){
  3. //...
  4. }

@ConditionalExpression

此注解可以让我们控制更细粒度的基于表达式的配置条件限制。当表达式满足某个条件或者表达式为真的时候,将会执行被此注解标注的方法。

  1. @Bean
  2. @ConditionalException("${localstore} && ${local == 'true'}")
  3. LocalFileStore store(){
  4. //...
  5. }

@Conditional

@Conditional注解可以控制更为复杂的配置条件。在Spring内置的条件控制注解不满足应用需求的时候,可以使用此注解定义自定义的控制条件,以达到自定义的要求。下面是使用该注解的简单示例:

  1. @Conditioanl(CustomConditioanl.class)
  2. CustomProperties addCustomProperties(){
  3. //...
  4. }

七、扩展

@Component 和 @Bean 的区别是什么?

  1. 作用对象不同:@Component 注解作用于类,而 @Bean 注解作用于方法
  2. @Component 通常是通过路径扫描来自动侦测以及自动装配到 Spring 容器中(我们可以使用 @ComponentScan 注解定义要扫描的路径从中找出标识了需要装配的类自动装配到 Spring 的 bean 容器中)。@Bean 注解通常是我们在标有该注解的方法中定义产生这个 bean,@Bean 告诉了 Spring 这是某个类的实例,当我们需要用它的时候还给我。
  3. @Bean 注解比 @Component 注解的自定义性更强,而且很多地方我们只能通过 @Bean 注解来注册 bean。比如当我们引用第三方库中的类需要装配到 Spring 容器时,只能通过 @Bean 来实现。

@Bean 注解使用示例:

  1. @Configuration
  2. public class AppConfig {
  3. @Bean
  4. public TransferService transferService() {
  5. return new TransferServiceImpl();
  6. }
  7. }

@Component 注解使用示例:

  1. @Component
  2. public class ServiceImpl implements AService {
  3. ....
  4. }

下面这个例子是通过 @Component 无法实现的:

  1. @Bean
  2. public OneService getService(status) {
  3. case (status) {
  4. when 1:
  5. return new serviceImpl1();
  6. when 2:
  7. return new serviceImpl2();
  8. when 3:
  9. return new serviceImpl3();
  10. }
  11. }

@Autowire 和 @Resource 的区别

  1. @Autowire 和 @Resource都可以用来装配bean,都可以用于字段或setter方法。
  2. @Autowire 默认按类型装配,默认情况下必须要求依赖对象必须存在,如果要允许 null 值,可以设置它的 required 属性为 false。
  3. @Resource 默认按名称装配,当找不到与名称匹配的 bean 时才按照类型进行装配。名称可以通过 name 属性指定,如果没有指定 name 属性,当注解写在字段上时,默认取字段名,当注解写在 setter 方法上时,默认取属性名进行装配。

注意:如果 name 属性一旦指定,就只会按照名称进行装配。
@Autowire和@Qualifier配合使用效果和@Resource一样:

  1. @Autowired(required = false)
  2. @Qualifier("example")
  3. private Example example;
  4. @Resource(name = "example")
  5. private Example example;

@Resource 装配顺序

  1. 如果同时指定 name 和 type,则从容器中查找唯一匹配的 bean 装配,找不到则抛出异常;
  2. 如果指定 name 属性,则从容器中查找名称匹配的 bean 装配,找不到则抛出异常;
  3. 如果指定 type 属性,则从容器中查找类型唯一匹配的 bean 装配,找不到或者找到多个抛出异常;
  4. 如果不指定,则自动按照 byName 方式装配,如果没有匹配,则回退一个原始类型进行匹配,如果匹配则自动装配。

将一个类声明为 Spring 的 bean 的注解有哪些?

  1. @Component :通用的注解,可标注任意类为 Spring 的组件。如果一个 Bean 不知道属于哪个层,可以使用 @Component 注解标注。
  2. @Repository :对应持久层即 Dao 层,主要用于数据库相关操作。
  3. @Service :对应服务层,主要设计一些复杂的逻辑,需要用到 Dao 层。
  4. @Controller :对应 Spring MVC 控制层,主要用来接受用户请求并调用 Service 层返回数据给前端页面。
  5. @Configuration :声明该类为一个配置类,可以在此类中声明一个或多个 @Bean 方法。

@Configuration :配置类注解

@Configuration 表明在一个类里可以声明一个或多个 @Bean 方法,并且可以由 Spring 容器处理,以便在运行时为这些 bean 生成 bean 定义和服务请求,例如:

  1. @Configuration
  2. public class AppConfig {
  3. @Bean
  4. public MyBean myBean() {
  5. // instantiate, configure and return bean ...
  6. }
  7. }

我们可以通过 AnnotationConfigApplicationContext 来注册 @Configuration 类:

  1. AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
  2. ctx.register(AppConfig.class);
  3. ctx.refresh();
  4. MyBean myBean = ctx.getBean(MyBean.class);
  5. // use myBean ...

另外也可以通过组件扫描(component scanning)来加载,@Configuration 使用 @Component 进行原注解,因此 @Configuration 类也可以被组件扫描到(特别是使用 XML 的 元素)。@Configuration 类不仅可以使用组件扫描进行引导,还可以使用 @ComponentScan 注解自行配置组件扫描:

  1. @Configuration
  2. @ComponentScan("com.acme.app.services")
  3. public class AppConfig {
  4. // various @Bean definitions ...
  5. }

使用 @Configuration 的约束:

  • 配置类必须以类的方式提供(比如不能是由工厂方法返回的实例)。
  • 配置类必须是非 final 的。
  • 配置类必须是非本地的(即可能不在方法中声明),native 标注的方法。
  • 任何嵌套的配置类必须声明为 static。
  • @Bean 方法可能不会反过来创建更多的配置类。

除了单独使用 @Configuration 注解,我们还可以结合一些外部的 bean 或者注解共同使用,比如 Environment API,@PropertySource,@Value,@Profile 等等许多,这里就不做详细介绍了,更多的用法可以参看 Spring @Configuration 的相关文档 。


@ControllerAdvice :处理全局异常利器

在 Spring 3.2 中,新增了 @ControllerAdvice、@RestControllerAdvice、@RestController 注解,可以用于定义 @ExceptionHandler、@InitBinder、@ModelAttribute,并应用到所有 @RequestMapping 、@PostMapping、@GetMapping等这些 Controller 层的注解中。
默认情况下,@ControllerAdvice 中的方法应用于全局所有的 Controller。而使用选择器 annotations(),basePackageClasses() 和 basePackages() (或其别名value())来定义更小范围的目标 Controller 子集。如果声明了多个选择器,则应用 OR 逻辑,这意味着所选的控制器应匹配至少一个选择器。请注意,选择器检查是在运行时执行的,因此添加许多选择器可能会对性能产生负面影响并增加复杂性。
@ControllerAdvice 我们最常使用的是结合 @ExceptionHandler 用于全局异常的处理。可以结合以下例子,我们可以捕获自定义的异常进行处理,并且可以自定义状态码返回:

  1. @ControllerAdvice("com.developlee.errorhandle")
  2. public class MyExceptionHandler {
  3. /**
  4. * 捕获CustomException
  5. * @param e
  6. * @return json格式类型
  7. */
  8. @ResponseBody
  9. @ExceptionHandler({CustomException.class}) //指定拦截异常的类型
  10. @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) //自定义浏览器返回状态码
  11. public Map>String, Object< customExceptionHandler(CustomException e) {
  12. Map&lt;String, Object&gt; map = new HashMap&lt;&gt;();
  13. map.put("code", e.getCode());
  14. map.put("msg", e.getMsg());
  15. return map;
  16. }
  17. }

更多信息可以参看 Spring @ControllerAdvice 的官方文档。


@Component, @Repository, @Service 的区别

常用注解 - 图44
@Component是一个通用的Spring容器管理的单例bean组件。而@Repository, @Service, @Controller就是针对不同的使用场景所采取的特定功能化的注解组件。
因此,当你的一个类被@Component所注解,那么就意味着同样可以用@Repository, @Service, @Controller 来替代它,同时这些注解会具备有更多的功能,而且功能各异。
最后,如果你不知道要在项目的业务层采用@Service还是@Component注解。那么,@Service是一个更好的选择。