Spring框架注解说明

WEB类

@CrossOrigin

• 参数:
  • origins： 允许可访问的域列表
  • maxAge:准备响应前的缓存持续的最大时间(以秒为单位)。
• 作用:
  解决接口的跨域问题。(Spring>4.2)
• 使用
  可以与Controller和RequestMappnig注解一起使用

  @CrossOrigin(origins = "http://demo.com", maxAge = 3600)
  @Controller
  ...
  
  
  @Controller
  @ReuqestMapping("/")
  public class DemoController{
      
      @CrossOrigin
      //这里需要注意，最好注明请求类型，否则可能会造成跨域失效
      @GetMapping("/demo")
      public String demo(){
          ...
      }
  }
  //这两个属性可以分开设置
  

@RequestParam(value = "$count", required = false)

• 作用：
  用于从路径中获取前端传递的参数
• 参数：
  • value: 参数名
  • required: 是否必传(boolean型)
• 使用：
  @RequestParam(value = "name", required = false),从路径?xxx&name=xxx中获取name的值，若required为true，则没有name参数的时候，name的值为null。

@RequestBody

获取Post请求中的请求体。

@PathVariable

• 作用：
  从Rest请求中获取指定参数的值。
• 参数：
  • value：指定参数的参数名。
• 使用
  和RequestMapping连用

  /**
   * 获取id的值
   * @Param id
   */
  @PostMapping("\xxx\xxx\{id}\p")
  public String getId(@PathVariable("id") Integer id){}
  

组件类

@PostConstruct

• 作用
  被注解的方法，在对象加载完依赖注入后执行。且只执行一次。
• 介绍
  这个注解实在Java EE5规范中加入的，是在javax.annotation包中，并非Spring注解，在Servle生命周期中有一定作用，通常是一些初始化操作。
• 使用
  • 除了拦截器外，不允许有参数，否则报IllegalStateException异常。
  • 方法可以为private
  • 返回值为void

@PreDestory

• 作用
  被注解的方法，在对象消亡之前执行。

@Component

泛指组件，当组件不好归类的时候，使用Component进行标注

@Controller

控制层标记，用于标注控制层组件，基于@Component

@Service

业务层标记，用于标注业务层组件，基于@Component

@Repository

持久层标记，用于标注数据库访问组件，基于@Component

@Autowired

接口可以被容器注入

@Qualifier

当接口有多个实现类的时候，使用这个注解声明使用哪个实现

@ComponentScan({“com.x.x.x”,”com.x.y.y})

指定Spring扫描包的范围，SpringBoot默认扫描SpringApplication类下的所有包，如果不在其包下，则可以使用这个注解扫描指定的包，扩大spring的扫描范围

@Retryable

• 作用：
  • 使用try/catch来重新处理显得不够优雅时，使用spring-retry注解，在不入侵原有业务代码的方式下，实现重新处理的功能。
  • 被注解的方法发生异常时会重试
• 参数：
  • value:指定发生的异常进行重试
  • include:和value一样，默认空，当exclude也为空时，所有异常都重试
  • exclude:指定异常不重试，默认空，当include也为空时，所有异常都重试
  • maxAttemps:重试次数，默认3
  • backoff:重试补偿机制，默认没有
• 使用：

引用

<dependency>
<groupId>org.springframework.retry</groupId>
<artifactId>spring-retry</artifactId>
</dependency>

开启retry

@SpringBootApplication
@EnableRetry
public class DatasyncApplication {

    public static void main(String[] args)  {
        SpringApplication.run(DatasyncApplication.class, args);
    }
}

在指定方法上标记@Retryable来开启重试

@Retryable(value={A异常.class,B异常.class},
maxAttempts=重试次数,
backoff = @Backoff(value = 每次重试延迟毫秒数))
public Integer retry() {
    LOGGER.info(“测试retry”);
    final int a = 5;
    int num = new SecureRandom().nextInt();
    if (num % a == 0) {
        return num;
    }
    throw new RetryException(“重试失败”);
}

在指定方法上标记@Recover来开启重试失败后调用的方法(注意,需跟重处理方法在同一个类中)

@Recover
public void recover(A异常 e) {
// … do something
}

@Recover
public void recover(B异常 e) {
// … do something
}

@Backoff注解

delay:指定延迟后重试
multiplier:指定延迟的倍数，比如delay=5000l,multiplier=2时，第一次重试为5秒后，第二次为10秒，第三次为20秒

@Recover
当重试到达指定次数时，被注解的方法将被回调，可以在该方法中进行日志处理。需要注意的是发生的异常和入参类型一致时才会回调