2022-04-14

字数统计: 3.8k字 | 阅读时长≈ 15分

40个常用的SpringBoot注解

一、Spring Web MVC注解

@RequestMapping

@RequestMapping注解的主要用途是将Web请求与请求处理类中的方法进行映射。Spring MVC和Spring WebFlux都通过RquestMappingHandlerMapping和RequestMappingHndlerAdapter两个类来提供对@RequestMapping注解的支持。@RequestMapping注解对请求处理类中的请求处理方法进行标注；

@RequestMapping注解拥有以下的六个配置属性：

value: 映射的请求URL或者其别名
指定请求的实际地址，指定的地址可以是URI Template 模式；
method: 兼容HTTP的方法名
指定请求的method类型， GET、POST、PUT、DELETE等；
params: 根据HTTP参数的存在、缺省或值对请求进行过滤
指定request中必须包含某些参数值时，才让该方法处理。
header: 根据HTTP Header的存在、缺省或值对请求进行过滤
指定request中必须包含某些指定的header值，才能让该方法处理请求。
consume: 设定在HTTP请求正文中允许使用的媒体类型
指定处理请求的提交内容类型（Content-Type），例如application/json, text/html;
product: 在HTTP响应体中允许使用的媒体类型
指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回；

**提示：**在使用@RequestMapping之前，请求处理类还需要使用@Controller或@RestController进行标记

@RestController
public class ControllerTest {

  @RequestMapping(value = "/demo/home", method = RequestMethod.GET)
  public String home() {
    return "home";
  }
  
  // controller–限制接收post 请求以及consumes="application/json"。
  @RequestMapping(value = "/testMethod", method = RequestMethod.POST,consumes="application/json")
  public String testMethod() {
    System.out.println("testMethod");
    return "SUCCESS";
  }

  // 返回值类型是json格式
  // text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8
  // 其中最后一项 ： */*;q=0.8。
  // 该项表明可以接收任何类型的，权重系数0.8表明如果前面几种类型不能正常接收。则使用该项进行自动分析。
  // application/json 几种主流浏览器都可以自动解析。
  @RequestMapping(value = "/testMethod", method = RequestMethod.POST,produces="application/json")
  @ResponseBody
  public RestMessage testMethod2(Model model) throws IOException {
    return new RestMessage("SUCCESS");
  }

  // 设定必须包含username 和age两个参数，且age参数不为10 (可以有多个参数)。
  @RequestMapping(value = "testParams", params = { "username","age!=10" })
  public String testParams() {
    System.out.println("testParamsAndHeaders");
    return "SUCCESS";
  }

  // 设定请求头中第一语言必须为US。
  // 必须包含username 和age两个参数，且age参数不为10 (可以有多个参数)。
  @RequestMapping(value = "testParamsAndHeaders", params = { "username","age!=10" }, headers = { "Accept-Language=US,zh;q=0.8" })
  public String testParamsAndHeaders() {
    System.out.println("testParamsAndHeaders");
    return "SUCCESS";
  }

}

@RequestBody

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

@PostMapping("/user")
public User createUser(@Valid @RequestBody User user) {
  return sava(user);
}

@GetMapping

@GetMapping注解用于处理HTTP GET请求，并将请求映射到具体的处理方法中。具体来说，@GetMapping是一个组合注解，它相当于是@RequestMapping(method=RequestMethod.GET)的快捷方式。

@PostMapping

@PostMapping注解用于处理HTTP POST请求，并将请求映射到具体的处理方法中。@PostMapping与@GetMapping一样，也是一个组合注解，它相当于是@RequestMapping(method=HttpMethod.POST)的快捷方式。

@PutMapping

@PutMapping注解用于处理HTTP PUT请求，并将请求映射到具体的处理方法中，@PutMapping是一个组合注解，相当于是@RequestMapping(method=HttpMethod.PUT)的快捷方式。

@DeleteMapping

@DeleteMapping注解用于处理HTTP DELETE请求，并将请求映射到删除方法中。@DeleteMapping是一个组合注解，它相当于是@RequestMapping(method=HttpMethod.DELETE)的快捷方式。

@PatchMapping

@PatchMapping注解用于处理HTTP PATCH请求，并将请求映射到对应的处理方法中。@PatchMapping相当于是@RequestMapping(method=HttpMethod.PATCH)的快捷方式。

@ControllerAdvice

@ControllerAdvice是@Component注解的一个延伸注解，Spring会自动扫描并检测被@ControllerAdvice所标注的类。@ControllerAdvice需要和@ExceptionHandler、@InitBinder以及@ModelAttribute注解搭配使用，主要是用来处理控制器所抛出的异常信息。

首先，我们需要定义一个被@ControllerAdvice所标注的类，在该类中，定义一个用于处理具体异常的方法，并使用@ExceptionHandler注解进行标记。此外，在有必要的时候，可以使用@InitBinder在类中进行全局的配置，还可以使用@ModelAttribute配置与视图相关的参数。使用@ControllerAdvice注解，就可以快速的创建统一的，自定义的异常处理类。

@ControllerAdvice(basePackages = {"com.shawn.controller"})
public class UserControllerAdvice {
  @InitBinder
  public void binder(WebDataBinder binder) {
    SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss", Locale.getDefault());
    // String dob= "1/55/1999";
    // SimpleDateFormat的setLenient(true)
    // 这种情况下java会把你输入的日期进行计算，比如55个月那么就是4年以后，这时候年份就会变成03年了
    // SimpleDateFormat的setLenient(false)
    // 这种情况下java不会把你输入的日期进行计算，比如55个月那么就是不合法的日期了，直接异常
    dateFormat.setLenient(false);
    binder.registerCustomEditor(Date.class, "user", new CustomDateEditor(dateFormat, true));
  }

  @ModelAttribute
  public void modelAttribute(Model model) {
    model.addAttribute("messgae", "User not found exception.");
  }

  @ExceptionHandler(UserNotFoundException.class)
  public ModelAndView userNotFoundExceptionHandler(UserNotFoundException exception) {
    ModelAndView modelAndView = new ModelAndView();
    modelAndView.addObject("exception", exception);
    modelAndView.setViewName("erro");
    return modelAndView;
  }

}

@ResponseBody

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

@RequestMapping(value = "/testMethod")
@ResponseBody
public RestMessage testMethod2(Model model) throws IOException {
  return new RestMessage("SUCCESS");
}

@ExceptionHandler

@ExceptionHander注解用于标注处理特定类型异常类所抛出异常的方法。当控制器中的方法抛出异常时，Spring会自动捕获异常，并将捕获的异常信息传递给被@ExceptionHandler标注的方法。

@ExceptionHandler(UserNotFoundException.class)
public ModelAndView userNotFoundExceptionHandler(UserNotFoundException exception) {
  ModelAndView modelAndView = new ModelAndView();
  modelAndView.addObject("exception", exception);
  modelAndView.setViewName("erro");
  return modelAndView;
}

@ResponseStatus

@ResponseStatus注解可以标注请求处理方法。使用此注解，可以指定响应所需要的HTTP STATUS。

特别地，我们可以使用HttpStauts类对该注解的value属性进行赋值。

@ResponseStatus(HttpStatus.BAD_REQUEST)
@ExceptionHandler(UserNotFoundException.class)
public ModelAndView userNotFoundExceptionHandler(UserNotFoundException exception) {
  ModelAndView modelAndView = new ModelAndView();
  modelAndView.addObject("exception", exception);
  modelAndView.setViewName("error");
  return modelAndView;
}

@PathVariable

@PathVariable注解是将方法中的参数绑定到请求URI中的模板变量上。

可以通过@RequestMapping注解来指定URI的模板变量，然后使用@PathVariable注解将方法中的参数绑定到模板变量上。特别地，@PathVariable注解允许我们使用value或name属性来给参数取一个别名

@GetMapping("users/{id}/roles/{roleId}")
  public Role getUserRole(@PathVariable(name = "id") long id, @PathVariable(name = "roleId") long roleId) {
  return new Role();

}

@RequestParam

@RequestParam注解用于将方法的参数与Web请求的传递的参数进行绑定。使用@RequestParam可以轻松的访问HTTP请求参数的值。

@GetMapping("/role")
  public Role getUserRole(@RequestParam(name = "id") long id, @RequestParam(name = "roleId") long roleId) {
  return new Role();
}
// 特别的，如果传递的参数为空，还可以通过defaultValue设置一个默认值。

@Controller

@Controller是@Component注解的一个延伸，Spring会自动扫描并配置被该注解标注的类。

此注解用于标注Spring MVC的控制器。

@RestController

@RestController是在Spring 4.0开始引入的，这是一个特定的控制器注解。此注解相当于@Controller和@ResponseBody的快捷方式。当使用此注解时，不需要再在方法上使用@ResponseBody注解。

@ModelAttribute

通过此注解，可以通过模型索引名称来访问已经存在于控制器中的model。

@CrossOrigin

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

@CrossOrigin
@GetMapping("/role")
public Role getUserRole(@RequestParam(name = "id") long id, @RequestParam(name = "roleId") long roleId) {
  return new Role();
}

@InitBinder

@InitBinder注解用于标注初始化WebDataBinider的方法，该方法用于对Http请求传递的表单数据进行处理，如时间格式化、字符串处理等。

@InitBinder
public void binder(WebDataBinder binder) {
  SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss", Locale.getDefault());
  // String dob= "1/55/1999";
  // SimpleDateFormat的setLenient(true)
  // 这种情况下java会把你输入的日期进行计算，比如55个月那么就是4年以后，这时候年份就会变成03年了
  // SimpleDateFormat的setLenient(false)
  // 这种情况下java不会把你输入的日期进行计算，比如55个月那么就是不合法的日期了，直接异常
  dateFormat.setLenient(false);
  binder.registerCustomEditor(Date.class, "user", new CustomDateEditor(dateFormat, true));

}

二、Spring Bean 注解

@ComponentScan

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

@Component

@Component注解用于标注一个普通的组件类，它没有明确的业务范围，只是通知Spring被此注解的类需要被纳入到Spring Bean容器中并进行管理。

@Service

@Service注解是@Component的一个延伸（特例），它用于标注业务逻辑类。与@Component注解一样，被此注解标注的类，会自动被Spring所管理。

@Repository

@Repository注解也是@Component注解的延伸，与@Component注解一样，被此注解标注的类会被Spring自动管理起来，@Repository注解用于标注DAO层的数据持久化类。

三、Spring Dependency Inject

@DependsOn

@DependsOn注解可以配置Spring IoC容器在初始化一个Bean之前，先初始化其他的Bean对象。

@Bean("firstBean")
@DependsOn(value = {"secondBean", "thirdBean"})
public firstBean firstBean() {
  return new FirstBean();
}

@Bean

@Bean注解主要的作用是告知Spring，被此注解所标注的类将需要纳入到Bean管理工厂中。@Bean注解的用法很简单，在这里，着重介绍@Bean注解中initMethod和destroyMethod的用法。

@Component
public class DataBaseInitializer {
  public void init() {
    System.out.println("This is init method");
  }

  public void destroy() {
    System.out.println("This is destroy method");
  }
}

// 引入bean
@Bean(initMethod = "init", destroyMethod = "destroy")
public DataBaseInitializer dataBaseInitializer() {
  return new DataBaseInitializer();
}

@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)

// 第一种
@Bean
@Scope(value = ConfigurableBeanFactory.SCOPE_PROTOTYPE)
public DataBaseInitializer dataBaseInitializer() {
  return new DataBaseInitializer();
}
// ----------------------------------------
// 第二种
@Component
@Scope(value= ConfigurableBeanFactory.SCOPE_PROTOTYPE)
public class DataBaseInitializer {
  public void init() {
    System.out.println("This is init method");
  }
  public void destroy() {
    System.out.println("This is destroy method");
  }
}

@Scope 单例模式

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

四、容器配置注解

@Autowired

@Autowired注解用于标记Spring将要解析和注入的依赖项。此注解可以作用在构造函数、字段和setter方法上。

@Primary

当系统中需要配置多个具有相同类型的bean时，@Primary可以定义这些Bean的优先级。比如多个实现类serviceImpl，有一个实现类注解加@Primary则优先实现该类。

@PostConstruct与@PreDestroy

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

@Component
public class DemoComponet {
  private List<String> list = new ArrayList<>();
  @PostConstruct
  public void init() {
    list.add("q");
    list.add("w");
  }

  @PreDestroy
  public void destroy() {
    list.clear();
  }
}

@Qualifier

当系统中存在同一类型的多个Bean时，@Autowired在进行依赖注入的时候就不知道该选择哪一个实现类进行注入。此时，我们可以使用@Qualifier注解来微调，帮助@Autowired选择正确的依赖项。

1	@Qualifier("要使用的实现类")

五、Spring Boot注解

@SpringBootApplication

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

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

@EnableAutoConfiguration

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

@ConditionalOnClass与@ConditionalOnMissingClass

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

@Configuration  
@ConditionalOnClass(DataSource.class)  
class MySQLAutoConfiguration {  
  //...  
}

@ConditionalOnBean与@ConditionalOnMissingBean

这两个注解属于对象条件注解，根据是否存在某个对象作为依据来决定是否要执行某些配置方法。

@Bean  
@ConditionalOnBean(name="dataSource")  
LocalContainerEntityManagerFactoryBean entityManagerFactory(){  
  //...  
}  

@Bean  @ConditionalOnMissingBean  public MyBean myBean(){  
  //...  
}

@ConditionalOnProperty

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

@Bean  
@ConditionalOnProperty(name="alipay",havingValue="on")  
Alipay alipay(){  
  return new Alipay();  
}

@ConditionalOnResource

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

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

@ConditionalOnWebApplication与@ConditionalOnNotWebApplication

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

@ConditionalOnWebApplication  
HealthCheckController healthCheckController(){  
  //...  
}

@ConditionalExpression

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

@Bean 
@ConditionalException("${localstore} && ${local == 'true'}")  
LocalFileStore store(){  
  //...  
}

@Conditional

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

@Conditioanl(CustomConditioanl.class)  
CustomProperties addCustomProperties(){  
  //...  
}

转载自：https://mp.weixin.qq.com/s/o9b0oJ5eFy8Uo2n_1jQskw

-------------本文结束^-^感谢您的阅读-------------

本文作者： Shawn
发布时间： 2022-04-14
最后更新： 2023-03-17
本文标题： 40个常用的SpringBoot注解
本文链接： https://blog.shawncoding.top/posts/6b7eab5.html
版权声明： 本作品采用 CC BY-NC-SA 4.0 许可协议进行许可。转载请注明出处！