SpringBoot各种注解的作用汇总（学习笔记）_springboot的注解及作用-CSDN博客

本文链接：https://blog.csdn.net/Tian208/article/details/122533687

SpringBoot各种注解的作用汇总（学习笔记）

一、基本注解

1. @SpringBootApplication

申明让spring boot自动给程序进行必要的配置，这个配置等同于：@Configuration ，@EnableAutoConfiguration 和 @ComponentScan 三个配置。

2. @ResponseBody

表示该方法的返回结果直接写入HTTP response body中，一般在异步获取数据时使用，用于构建RESTful的api。在使用@RequestMapping后，返回值通常解析为跳转路径，加上@Responsebody后返回结果不会被解析为跳转路径，而是直接写入HTTP response body中。比如异步获取json数据，加上@Responsebody后，会直接返回json数据。该注解一般会配合@RequestMapping一起使用。

3. @Controller

用于定义控制器类，在spring项目中由控制器负责将用户发来的URL请求转发到对应的服务接口（service层），一般这个注解在类中，通常方法需要配合注解@RequestMapping

4.@Restcontroller

用于标注控制层组件(如struts中的action)，是@ResponseBody和@Controller的合集。

5.@RequestMappering

提供路由信息，负责URL到Controller中的具体函数的映射

6.EnableAutoConfiguration

SpringBoot自动配置（auto-configuration）：尝试根据你添加的jar依赖自动配置Spring应用。例如，如果classpath下存在HSQLDB，并且你没有手动配置任何数据库连接beans，那么我们将自动配置一个内存型（in-memory）数据库。也可以将@EnableAutoConfiguration或者@SpringBootApplication注解添加到一个@Configuration类上来选择自动配置。如果发现应用了你不想要的特定自动配置类，你可以使用@EnableAutoConfiguration注解的排除属性来禁用它们

7.@ComponentScan

表示将该类自动发现扫描组件。如果扫描到有@Component、@Controller、@Service等这些注解的类，并注册为Bean，可以自动收集所有的Spring组件，包括@Configuration类。当使用@ComponentScan注解搜索beans，结合@Autowired注解导入。如果没有配置的话，Spring Boot会扫描启动类所在包下以及子包下的使用了@Service,@Repository等注解的类。

8.@Configuration

相当于传统的xml配置文件，如果有些第三方库需要用到xml文件，建议仍然通过@Configuration类作为项目的配置主类——可以使用@ImportResource注解加载xml配置文件。

9.@Import

用来导入其他配置类。

10.@ImportResource

用来加载xml配置文件

11.@Service

一般修饰service层的组件

12.@Repository

使用@Repository注解可以确保DAO或者repositories提供异常转译，这个注解修饰的DAO或者repositories类会被ComponetScan发现并配置，同时也不需要为它们提供XML配置项

13.@Value

注入Spring boot application.properties配置的属性的值。

14.@Inject

等价于默认的@Autowired，只是没有required属性；

15.@Component

泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注。

16.@Bean

用@Bean标注方法等价于XML中配置的bean，放在方法的上面，而不是类，意思是产生一个bean,并交给spring管理。

17.@AutoWired

自动导入依赖的bean。byType方式。把配置好的Bean拿来用，完成属性、方法的组装，它可以对类成员变量、方法及构造函数进行标注，完成自动装配的工作。当加上（required=false）时，就算找不到bean也不报错。

18.@Qualifier

当有多个同一类型的Bean时，可以用@Qualifier(“name”)来指定。与@Autowired配合使用。@Qualifier限定描述符除了能根据名字进行注入，但能进行更细粒度的控制如何选择候选者

19. @Resource(name=“name”,type=“type”)

没有括号内内容的话，默认byName。与@Autowired干类似的事。

20.@PathVariable

获取参数

21.@JsonBackReference

解决嵌套外链问题。

22. @RepositoryRestResourcepublic

配合spring-boot-starter-data-rest使用

二、JPA注解

23.@Entity

@Table(name=“”)：表明这是一个实体类。一般用于jpa这两个注解一般一块使用，但是如果表名和实体类名相同的话，@Table可以省略

24.@MappedSuperClass

用在确定是父类的entity上。父类的属性子类可以继承。

25.@NoRepositoryBean

一般用作父类的repository，有这个注解，spring不会去实例化该repository

26.@Column

如果字段名与列名相同，则可以省略

27.@Id

表示该属性为主键

28.@GeneratedValue(strategy = GenerationType.SEQUENCE,generator = “repair_seq”)

表示主键生成策略是sequence（可以为Auto、IDENTITY、native等，Auto表示可在多个数据库间切换），指定sequence的名字是repair_seq

29.@SequenceGeneretor(name = “repair_seq”, sequenceName = “seq_repair”, allocationSize = 1)

name为sequence的名称，以便使用，sequenceName为数据库的sequence名称，两个名称可以一致。

30.@Transient

表示该属性并非一个到数据库表的字段的映射,ORM框架将忽略该属性。如果一个属性并非数据库表的字段映射,就务必将其标示为@Transient,否则,ORM框架默认其注解为@Basic

31.@JsonIgnore

作用是json序列化时将Java bean中的一些属性忽略掉,序列化和反序列化都受影响。

32.@JoinColumn（name=”loginId”）

一对一：本表中指向另一个表的外键。一对多：另一个表指向本表的外键。

33.@OneToOne、@OneToMany、@ManyToOne

对应hibernate配置文件中的一对一，一对多，多对一

三、SpringMVC相关注解

34.@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)类型中包含该指定类型才返回

35.@RequestParam

用在方法的参数前面，用以绑定请参数

36.@PathVariable

路径变量。参数与大括号里的名字一样要相同

四、全局异常处理

37.@ControllerAdvice

包含@Component。可以被扫描到。统一处理异常。

38.@ExceptionHandler

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

1.1 自定义错误页面

SpringBoot 默认的处理异常的机制： SpringBoot 默认的已经提供了一套处理异常的机制。一旦程序中出现了异常 SpringBoot 会发送一个/error 的 url 请求。在 springBoot 中提供了一个叫 BasicExceptionController 来处理/error 请求，然后跳转到默认显示异常的页面来展示异常信息。

1.2

如果我们需要将所有的异常同一跳转到自定义的错误页面，需要再src/main/resources/templates 目录下创建 error.html 页面。注意：名称必须叫 error！！！springboot已经封装异常到exception里面了，直接就可以取出来，但是这种方法不适用于2.1.3.RELEASE的，1.5.10.RELEASE可以使用这个自定义页面

1.3 该方法需要返回一个 ModelAndView：

目的是可以让我们封装异常信息以及视图的指定参数 Exception e:会将产生异常对象注入到方法中

1.4 @ControllerAdvice+@ExceptionHandler 注解处理异常

需要创建一个能够处理异常的全局异常类。在该类上需要添加@ControllerAdvice 注解，该方法需要返回一个 ModelAndView：目的是可以让我们封装异常信息以及视图的指定参数，Exception e:会将产生异常对象注入到方法中。

1.5 配置 SimpleMappingExceptionResolver 处理异常

在全局异常类中添加一个方法完成异常的同一处理
通过 SimpleMappingExceptionResolver 做全局异常处理，并且使用@Configuration注解，但是这种方法不能返回异常的具体信息

1.6 自定义 HandlerExceptionResolver 类处理异常

需要再全局异常处理类中实现HandlerExceptionResolver 接口，并添加@Configuration注解

五、项目中具体配置解析和使用环境

39.@MappedSuperclass

注解使用在父类上面，是用来标识父类的

40.@MappedSuperclass

标识的类表示其不能映射到数据库表，因为其不是一个完整的实体类，但是它所拥有的属性能够映射在其子类对用的数据库表中。
@MappedSuperclass 标识的类不能再有@Entity或@Table注解

41.@Column

1.当实体的属性与其映射的数据库表的列不同名时需要使用@Column标注说明，该属性通常置于实体的属性声明语句之前，还可与 @Id 标注一起使用。
2.@Column 标注的常用属性是name，用于设置映射数据库表的列名。此外，该标注还包含其它多个属性，如：unique、nullable、length、precision等。具体如下：
① name属性：name属性定义了被标注字段在数据库表中所对应字段的名称
② unique属性：unique属性表示该字段是否为唯一标识，默认为false，如果表中有一个字段需要唯一标识，则既可以使用该标记，也可以使用@Table注解中的@UniqueConstraint
③ nullable属性：nullable属性表示该字段是否可以为null值，默认为true
④ insertable属性：insertable属性表示在使用INSERT语句插入数据时，是否需要插入该字段的值
⑤ updateable属性：updateable属性表示在使用”UPDATE”语句插入数据时，是否需要更新该字段的值
⑥ insertable和updateable属性：一般多用于只读的属性，例如主键和外键等，这些字段通常是自动生成的
⑦ columnDefinition属性：columnDefinition属性表示创建表时，该字段创建的SQL语句，一般用于通过Entity生成表定义时使用，如果数据库中表已经建好，该属性没有必要使用
⑧ table属性：table属性定义了包含当前字段的表名
⑨ length属性：length属性表示字段的长度，当字段的类型为varchar时，该属性才有效，默认为255个字符
⑩ precision属性和scale属性：precision属性和scale属性一起表示精度，当字段类型为double时，precision表示数值的总长度，scale表示小数点所占的位数
具体如下：
double类型将在数据库中映射为double类型，precision和scale属性无效double类型若在columnDefinition属性中指定数字类型为decimal并指定精度，则最终以columnDefinition为准， BigDecimal类型在数据库中映射为decimal类型，precision和scale属性有效， precision和scale属性只在BigDecimal类型中有效。

42.@Column

标注的columnDefinition属性: 表示该字段在数据库中的实际类型.通常 ORM 框架可以根据属性类型自动判断数据库中字段的类型,但是对于Date类型仍无法确定数据库中字段类型究竟是DATE,TIME还是TIMESTAMP.此外,String的默认映射类型为VARCHAR,如果要将 String 类型映射到特定数据库的 BLOB 或TEXT字段类型.
4.@Column标注也可置于属性的getter方法之前