Spring boot常用注解介绍

一.注解列表

1.@SpringBootApplication（Spring boot项目的基石）：包含了@ComponentScan、@Configuration和@EnableAutoConfiguration

package org.springframework.boot.autoconfigure;
@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 {
   ......
}

package org.springframework.boot;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
public @interface SpringBootConfiguration {

}

其中@ComponentScan让spring Boot扫描到Configuration类并把它加入到程序中。

•  @SpringBootApplication：等同spring的XML配置文件，使用Java代码可以检查类型安全
• @EnableAutoConfiguration：自动配置
• @Configuration：允许在 Spring 上下文中注册额外的 bean 或导入其他配置类
• @ComponentScan：组件扫描并发现和装配bean
• @Component ：通用注解，可标注任意Spring组件。如一个Bean不知道属于哪个层也可使用该注解。同时还可以配合CommandLineRunner使用
• @Repository：使用@Repository注解可以确保DAO或者repositories提供异常转译，这个注解修饰的DAO或者repositories类会被ComponetScan发现并配置，同时也不需要为它们提供XML配置项
• @AutoWired:自动导入
• @PathVariable：获取参数
• @JsonBackReference：解决嵌套外链问题
• @RepositoryRestResourcepublic：配合spring-boot-starter-data-rest使用   
• @Service：一般用于修饰service层的组件
• @ImportResource：用来加载xml配置文件  
• @Import：用来导入其他配置类     
• @Bean：用@Bean标注方法等价于XML中配置的bean
• @Value：注入Spring boot application.properties配置的属性的值。示例代码：                          

  @Value(value = “#{apple}”) 
  private String apple;

• @Resource(name=”name”,type=”type”)：没有括号内内容的话，默认byName。与@Autowired干类似的事    
• @Qualifier：当有多个同一类型的Bean时，可以用@Qualifier(“name”)来指定。与@Autowired配合使用。@Qualifier限定描述符除了能根据名字进行注入，但能进行更细粒度的控制如何选择候选者，具体使用方式如下：                                                                                                  

  @Autowired 
  @Qualifier(value = “demoInfoService”) 
  private DemoInfoService demoInfoService;

二.springMVC相关注解

@RequestMapping：@RequestMapping(“/path”)表示该控制器处理所有“/path”的URL请求。RequestMapping是一个用来处理请求地址映射的注解，可用于类或方法上。

用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。

该注解的六个属性：

1. params:指定request中必须包含某些参数值是什么，才让该方法处理

2. headers:指定request中必须包含某些指定的header值，才能让该方法处理请求

3. value:指定请求的实际地址，指定的地址可以是URI Template 模式

4. method:指定请求的method类型， GET、POST、PUT、DELETE等

5. consumes:指定处理请求的提交内容类型（Content-Type），如application/json,text/html

6. produces:指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回@RequestParam：用在方法的参数前面

三.声明Spring Bean的作用域

使用方法为：

@Bean
@Scope("singleton")
public Person personSingleton() {
    return new Person();
}

四种常见的 Spring Bean 的作用域：

• singleton : 唯一 bean 实例，Spring 中的 bean 默认都是单例的。
• prototype : 每次请求都会创建一个新的 bean 实例。
• request : 每一次 HTTP 请求都会产生一个新的 bean，该 bean 仅在当前 HTTP request 内有效。
• session : 每一次 HTTP 请求都会产生一个新的 bean，该 bean 仅在当前 HTTP session 内有效。

四.一些常用字段验证的注解

• @NotEmpty 被注释的字符串的不能为 null 也不能为空
• @NotBlank 被注释的字符串非 null，并且必须包含一个非空白字符
• @Null 被注释的元素必须为 null
• @NotNull 被注释的元素必须不为 null
• @AssertTrue 被注释的元素必须为 true
• @AssertFalse 被注释的元素必须为 false
• @Pattern(regex=,flag=)被注释的元素必须符合指定的正则表达式
• @Email 被注释的元素必须是 Email 格式。
• @Min(value)被注释的元素必须是一个数字，其值必须大于等于指定的最小值
• @Max(value)被注释的元素必须是一个数字，其值必须小于等于指定的最大值
• @DecimalMin(value)被注释的元素必须是一个数字，其值必须大于等于指定的最小值
• @DecimalMax(value) 被注释的元素必须是一个数字，其值必须小于等于指定的最大值
• @Size(max=, min=)被注释的元素的大小必须在指定的范围内
• @Digits (integer, fraction)被注释的元素必须是一个数字，其值必须在可接受的范围内
• @Past被注释的元素必须是一个过去的日期
• @Future 被注释的元素必须是一个将来的日期
• ......

四.全局异常处理

@ControllerAdvice：包含@Component 可以被扫描到,并统一处理异常

@ExceptionHandler（Exception.class）：用在方法上面表示遇到这个异常就执行以下方法。