Spring Boot 常用注解汇总

Spring Boot 常用注解汇总

一、启动注解 @SpringBootApplication

1. <code>@Target(ElementType.TYPE)
2. @Retention(RetentionPolicy.RUNTIME)
3. @Documented
4. @Inherited
5. @SpringBootConfiguration
6. @EnableAutoConfiguration
7. @ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
8. @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
9. public @interface SpringBootApplication {
10. // ... 此处省略源码
11. }</code>

复制代码

检察源码可发现，@SpringBootApplication是一个复合注解，包含了@SpringBootConfiguration，@EnableAutoConfiguration，@ComponentScan这三个注解

@SpringBootConfiguration 注解，继承@Configuration注解，重要用于加载设置文件

@SpringBootConfiguration继承自@Configuration，二者功能也划一，标注当前类是设置类， 并会将当前类内声明的一个或多个以@Bean注解标志的方法的实例纳入到spring容器中，而且实例名就是方法名。

@EnableAutoConfiguration 注解，开启自动设置功能

@EnableAutoConfiguration可以资助SpringBoot应用将全部符合条件的@Configuration设置都加载到当前SpringBoot创建并利用的IoC容器。借助于Spring框架原有的一个工具类：SpringFactoriesLoader的支持，@EnableAutoConfiguration可以智能的自动设置功效才得以大功告成

@ComponentScan 注解，重要用于组件扫描和自动装配

@ComponentScan的功能其实就是自动扫描并加载符合条件的组件或bean定义，终极将这些bean定义加载到容器中。我们可以通过basePackages等属性指定@ComponentScan自动扫描的范围，假如不指定，则默认Spring框架实现从声明@ComponentScan所在类的package进行扫描，默认情况下是不指定的，所以SpringBoot的启动类最好放在root package下。

二、Controller 相关注解

@Controller

控制器，处理惩罚http哀求。

@RestController 复合注解

检察@RestController源码

1. <code>@Target(ElementType.TYPE)
2. @Retention(RetentionPolicy.RUNTIME)
3. @Documented
4. @Controller
5. @ResponseBody
6. public @interface RestController {
8. /**
9. * The value may indicate a suggestion for a logical component name,
10. * to be turned into a Spring bean in case of an autodetected component.
11. * @return the suggested component name, if any (or empty String otherwise)
12. * @since 4.0.1
13. */
14. @AliasFor(annotation = Controller.class)
15. String value() default "";
16. }</code>

复制代码

从源码我们知道,@RestController注解相称于@ResponseBody+@Controller合在一起的作用,RestController利用的效果是将方法返回的对象直接在欣赏器上展示成json格式.

@RequestBody

通过HttpMessageConverter读取Request Body并反序列化为Object（泛指）对象

@RequestMapping

@RequestMapping 是 Spring Web 应用程序中最常被用到的注解之一。这个注解会将 HTTP 哀求映射到 MVC 和 REST 控制器的处理惩罚方法上

@GetMapping用于将HTTP get哀求映射到特定处理惩罚程序的方法注解

注解简写：@RequestMapping(value = "/say",method = RequestMethod.GET)等价于：@GetMapping(value = "/say")

GetMapping源码

1. <code>@Target(ElementType.METHOD)
2. @Retention(RetentionPolicy.RUNTIME)
3. @Documented
4. @RequestMapping(method = RequestMethod.GET)
5. public @interface GetMapping {
6. //...
7. }</code>

复制代码

是@RequestMapping(method = RequestMethod.GET)的缩写

@PostMapping用于将HTTP post哀求映射到特定处理惩罚程序的方法注解

1. <code>@Target(ElementType.METHOD)
2. @Retention(RetentionPolicy.RUNTIME)
3. @Documented
4. @RequestMapping(method = RequestMethod.POST)
5. public @interface PostMapping {
6. //...
7. }</code>

复制代码

是@RequestMapping(method = RequestMethod.POST)的缩写

三、取哀求参数值

@PathVariable:获取url中的数据

1. <code>@Controller
2. @RequestMapping("/User")
3. public class HelloWorldController {
5. @RequestMapping("/getUser/{uid}")
6. public String getUser(@PathVariable("uid")Integer id, Model model) {
7. System.out.println("id:"+id);
8. return "user";
9. }
10. }</code>

复制代码

哀求示例：http://localhost:8080/User/getUser/123

@RequestParam:获取哀求参数的值

@Controller
@RequestMapping("/User")
public class HelloWorldController {

1. <code>@RequestMapping("/getUser")
2. public String getUser(@RequestParam("uid")Integer id, Model model) {
3. System.out.println("id:"+id);
4. return "user";
5. }</code>

复制代码

}

哀求示例：http://localhost:8080/User/getUser?uid=123

@RequestHeader 把Request哀求header部分的值绑定到方法的参数上

@CookieValue 把Request header中关于cookie的值绑定到方法的参数上

四、注入bean相关

@Repository

DAO层注解，DAO层中接口继承JpaRepository,需要在build.gradle中引入相关jpa的一个jar自动加载。

Repository注解源码

1. <code>@Target({ElementType.TYPE})
2. @Retention(RetentionPolicy.RUNTIME)
3. @Documented
4. @Component
5. public @interface Repository {
7. /**
8. * The value may indicate a suggestion for a logical component name,
9. * to be turned into a Spring bean in case of an autodetected component.
10. * @return the suggested component name, if any (or empty String otherwise)
11. */
12. @AliasFor(annotation = Component.class)
13. String value() default "";
15. }</code>

复制代码

@Service

1. <code>@Target({ElementType.TYPE})
2. @Retention(RetentionPolicy.RUNTIME)
3. @Documented
4. @Component
5. public @interface Service {
7. /**
8. * The value may indicate a suggestion for a logical component name,
9. * to be turned into a Spring bean in case of an autodetected component.
10. * @return the suggested component name, if any (or empty String otherwise)
11. */
12. @AliasFor(annotation = Component.class)
13. String value() default "";
14. }</code>

复制代码

• @Service是@Component注解的一个特例，作用在类上
• @Service注解作用域默以为单例
• 利用注解设置和类路径扫描时，被@Service注解标注的类会被Spring扫描并注册为Bean
• @Service用于标注服务层组件,表示定义一个bean
• @Service利用时没有传参数，Bean名称默以为当前类的类名，首字母小写
• @Service(“serviceBeanId”)或@Service(value=”serviceBeanId”)利用时传参数，利用value作为Bean名字

@Scope作用域注解

@Scope作用在类上和方法上，用来设置 spring bean 的作用域，它标识 bean 的作用域

@Scope源码

1. <code>@Target({ElementType.TYPE, ElementType.METHOD})
2. @Retention(RetentionPolicy.RUNTIME)
3. @Documented
4. public @interface Scope {
6. /**
7. * Alias for {@link #scopeName}.
8. * @see #scopeName
9. */
10. @AliasFor("scopeName")
11. String value() default "";
13. @AliasFor("value")
14. String scopeName() default "";
16. ScopedProxyMode proxyMode() default ScopedProxyMode.DEFAULT;
17. }</code>

复制代码

属性介绍

1. <code>value
2. singleton 表示该bean是单例的。(默认)
3. prototype 表示该bean是多例的，即每次利用该bean时都会新建一个对象。
4. request 在一次http哀求中，一个bean对应一个实例。
5. session 在一个httpSession中，一个bean对应一个实例。
7. proxyMode
8. DEFAULT 不利用代理。(默认)
9. NO 不利用代理，等价于DEFAULT。
10. INTERFACES 利用基于接口的代理(jdk dynamic proxy)。
11. TARGET_CLASS 利用基于类的代理(cglib)。</code>

复制代码

@Entity实体类注解

@Table(name ="数据库表名")，这个注解也表明在实体类上，对应数据库中相应的表。
@Id、@Column注解用于标注实体类中的字段，pk字段标注为@Id，别的@Column。

@Bean产生一个bean的方法

@Bean明确地指示了一种方法，产生一个bean的方法，而且交给Spring容器管理。支持别名@Bean("xx-name")

@Autowired 自动导入

• @Autowired注解作用在构造函数、方法、方法参数、类字段以及注解上
• @Autowired注解可以实现Bean的自动注入

@Component

把平凡pojo实例化到spring容器中，相称于设置文件中的

固然有了@Autowired,但是我们照旧要写一堆bean的设置文件,相称贫困,而@Component就是告诉spring,我是pojo类,把我注册到容器中吧,spring会自动提取相关信息。那么我们就不用写贫困的xml设置文件了

五、导入设置文件

@PropertySource注解

引入单个properties文件：

@PropertySource(value = {"classpath : xxxx/xxx.properties"})

引入多个properties文件：

@PropertySource(value = {"classpath : xxxx/xxx.properties"，"classpath : xxxx.properties"})

@ImportResource导入xml设置文件

可以额外分为两种模式 相对路径classpath，绝对路径（真实路径）file

留意：单文件可以不写value或locations，value和locations都可用

相对路径（classpath）

• 引入单个xml设置文件：@ImportSource("classpath : xxx/xxxx.xml")

• 引入多个xml设置文件：@ImportSource(locations={"classpath : xxxx.xml" , "classpath : yyyy.xml"})

绝对路径（file）

• 引入单个xml设置文件：@ImportSource(locations= {"file : d:/hellxz/dubbo.xml"})

• 引入多个xml设置文件：@ImportSource(locations= {"file : d:/hellxz/application.xml" , "file : d:/hellxz/dubbo.xml"})

取值：利用@Value注解取设置文件中的值

@Value("${properties中的键}")
private String xxx;

@Import 导入额外的设置信息

功能类似XML设置的，用来导入设置类，可以导入带有@Configuration注解的设置类或实现了ImportSelector/ImportBeanDefinitionRegistrar。

利用示例

1. <code>@SpringBootApplication
2. @Import({SmsConfig.class})
3. public class DemoApplication {
4. public static void main(String[] args) {
5. SpringApplication.run(DemoApplication.class, args);
6. }
7. }</code>

复制代码

六、事件注解 @Transactional

在Spring中，事件有两种实现方式，分别是编程式事件管理和声明式事件管理两种方式

• 编程式事件管理： 编程式事件管理利用TransactionTemplate大概直接利用底层的PlatformTransactionManager。对于编程式事件管理，spring保举利用TransactionTemplate。
• 声明式事件管理： 建立在AOP之上的。其本质是对方法前后进行拦截，然后在目标方法开始之前创建大概加入一个事件，在实行完目标方法之后根据实行情况提交大概回滚事件，通过@Transactional就可以进行事件操纵，更快捷而且简朴。保举利用

七、全局非常处理惩罚

@ControllerAdvice 同一处理惩罚非常

@ControllerAdvice 注解定义全局非常处理惩罚类

1. <code>@ControllerAdvice
2. public class GlobalExceptionHandler {
3. }</code>

复制代码

@ExceptionHandler 注解声明非常处理惩罚方法

1. <code>@ControllerAdvice
2. public class GlobalExceptionHandler {
4. @ExceptionHandler(Exception.class)
5. @ResponseBody
6. String handleException(){
7. return "Exception Deal!";
8. }
9. }</code>

复制代码

八、资料

• Java题目收集
• 原文地址

来源：https://www.cnblogs.com/tqlin/p/11687811.html