SpringBoot详细列举常用注解的说明-Java开发

在开发SpringBoot程序的过程中,有可能与其他业务系统进行对接开发,获取封装公共的API接口等等,下面这篇文章主要给大家介绍了关于SpringBoot常见的注解的相关资料,需要的朋友可以参考下

1 概述

IOC 是Spring 最为重要的功能之一，就是将Bean初始化加载到容器中，Bean是如何加载到容器的，可以使用Spring注解方式或者Spring XML配置方式。

简言之，注解本身没有什么业务功能的，和 xml 一样，是一种元数据，元数据即解释数据的数据，这就是所谓配置。

2 常用注解

@Component

表示一个带注释的类是一个“组件”，成为Spring管理的Bean。当使用基于注解的配置和类路径扫描时，这些类被视为自动检测的候选对象。同时@Component还是一个元注解。

所谓元注解，其实就是可以注解到别的注解上的注解，被注解的注解称之为组合注解，组合注解具备其上元注解的功能。

@Service

组合注解（组合了@Component注解），应用在service层（业务逻辑层）。

@Repository

组合注解（组合了@Component注解），应用在dao层（数据访问层）。

@Controller

组合注解（组合了@Component注解），应用在MVC层（控制层），DispatcherServlet会自动扫描注解了此注解的类，然后将web请求映射到注解了@RequestMapping的方法上。

@RequestMapping

用于映射Web请求，包括访问路径和参数。（类或方法上）

@ResponseBody

注解的作用是将controller的方法返回的对象通过适当的转换器转换为指定的格式之后，写入到response对象的body区，通常用来返回JSON数据或者是XML数据。

注意：在使用此注解之后不会再走视图处理器，而是直接将数据写入到输入流中，他的效果等同于通过response对象输出指定格式的数据。

@RequestBody

将 HTTP 请求正文插入方法中，使用适合的 HttpMessageConverter 将请求体写入某个对象。

作用：

该注解用于读取Request请求的body部分数据，使用系统默认配置的HttpMessageConverter进行解析，然后把相应的数据绑定到要返回的对象上；
再把HttpMessageConverter返回的对象数据绑定到 controller中方法的参数上。

使用时机

GET、POST方式提时，根据request header Content-Type的值来判断:

application/x-www-form-urlencoded，可选（即非必须，因为这种情况的数据@RequestParam, @ModelAttribute也可以处理，当然@RequestBody也能处理）。
multipart/form-data, 不能处理（即使用@RequestBody不能处理这种格式的数据）
其他格式，必须（其他格式包括application/json, application/xml等。这些格式的数据，必须使用@RequestBody来处理）

PUT方式提交时，根据request header Content-Type的值来判断

application/x-www-form-urlencoded，必须；multipart/form-data, 不能处理；其他格式，必须

举个例子：

@RequestMapping(value = "user/login")
@ResponseBody
// 将ajax（datas）发出的请求写入 User 对象中
public User login(@RequestBody User user) {   
// 这样就不会再被解析为跳转路径，而是直接将user对象写入 HTTP 响应正文中
    return user;

@PathVariable

用于接收路径参数，比如@RequestMapping(“/hello/{name}”)申明的路径，将注解放在参数中前，即可获取该值，通常作为Restful的接口实现方法。

@RestController

该注解为一个组合注解，相当于@Controller和@ResponseBody的组合，注解在类上，意味着，该Controller的所有方法都默认加上了@ResponseBody。

@ExceptionHandler

用于全局处理控制器里的异常。为什么会有这个注解，原因在于：

Exception什么的异常太过广泛，我们直接抛出所有异常信息，对用户而言是非常不友好的。
在事务管理里，如果我们自定义的异常继承的是Exception，则事务无效。如果我们是继承RuntimeException，则不会出现这个问题。

@ModelAttribute

本来的作用是绑定键值对到 Model 里，在 @ControllerAdvice 中是让全局的@RequestMapping都能获得在此处设置的键值对。

@Autowired

可以对成员变量、方法和构造函数进行标注，来完成自动装配的工作，@Autowired标注可以放在成员变量上，也可以放在成员变量的set方法上，也可以放在任意方法上表示，自动执行当前方法，如果方法有参数，会在IOC容器中自动寻找同类型参数为其传值。

注意：@Autowired是根据类型进行自动装配的，如果需要按名称进行装配，则需要配合@Qualifier使用；

@Configuration

声明当前类是一个配置类（相当于一个Spring配置的xml文件）。

@Bean

注解在方法上，声明当前方法的返回值为一个Bean。返回的Bean对应的类中可以定义init()方法和destroy()方法，然后在@Bean(initMethod=”init”,destroyMethod=”destroy”)定义，在构造之后执行init，在销毁之前执行destroy。

@ComponentScan

自动扫描指定包下所有使用@Service、@Component、@Controller、@Repository的类并注册。

@Aspect

声明一个切面（类上）使用@After、@Before、@Around定义建言（advice），可直接将拦截规则（切点）作为参数。

@After ：在方法执行之后执行（方法上）。
@Before：在方法执行之前执行（方法上）。
@Around：在方法执行之前与之后执行（方法上）。
@PointCut：声明切点在java配置类中使用@EnableAspectJAutoProxy注解开启Spring对AspectJ代理的支持。AspectJ静态编译织入（Aspect for java），他其实是一套独立的面向切面编程的解决方案。Spring中虽然使用了Aspect的Annotation，但是并没有使用它的编译器和织入器。

@Scope

定义我们采用什么模式去创建Bean（方法上，得有@Bean）其设置类型包括：

Singleton （单例，一个Spring容器中只有一个bean实例，默认模式）
Prototype（每次调用新建一个bean）
Request （web项目中，给每个http request新建一个bean）
Session（web项目中，给每个http session新建一个bean）
GlobalSession（给每一个 global http session新建一个Bean实例）。

@Scope("prototype")//多实例，IOC容器启动创建的时候，并不会创建对象放在容器在容器当中，当你需要的时候，需要从容器当中取该对象的时候，就会创建。
@Scope("singleton")//单实例 IOC容器启动的时候就会调用方法创建对象，以后每次获取都是从容器当中拿同一个对象（map当中）。
@Scope("request")//同一个请求创建一个实例
@Scope("session")//同一个session创建一个实例

@PostConstruct

标注在方法上，该方法在构造函数执行完成之后执行。

@PreDestory

标注在方法上，该方法在对象销毁之前执行。

@Value

经常与Sping EL表达式语言一起使用，注入普通字符，系统属性，表达式运算结果，其他Bean的属性，文件内容，网址请求内容，配置文件属性值等。

@EnableAsync

配置类中，通过此注解开启对异步任务的支持，叙事性AsyncConfigurer接口。

@Async

在实际执行的bean方法使用该注解来申明其是一个异步任务（方法上或类上所有的方法都将异步，需要@EnableAsync开启异步任务）

@EnableScheduling

在配置类上使用，开启计划任务的支持。