Spring 常用注解有哪些?

Spring 常用注解有哪些?

这个注解是 Spring Boot 项目的基石,创建 SpringBoot 项目之后会默认在主类加上。

我们可以把 @SpringBootApplication看作是 @Configuration、@EnableAutoConfiguration、@ComponentScan 注解的集合。

根据 SpringBoot 官网,这三个注解的作用分别是:

自动导入对象到类中,被注入进的类同样要被 Spring 容器管理比如:Service 类注入到 Controller 类中。

我们一般使用 @Autowired 注解让 Spring 容器帮我们自动装配 bean。要想把类标识成可用于 @Autowired 注解自动装配的 bean 的类,可以采用以下注解实现:

@RestController注解是@Controller和@ResponseBody的合集,表示这是个控制器 bean,并且是将函数的返回值直 接填入 HTTP 响应体中,是 REST 风格的控制器。

单独使用 @Controller 不加 @ResponseBody的话一般使用在要返回一个视图的情况,这种情况属于比较传统的 Spring MVC 的应用,对应于前后端不分离的情况。@Controller +@ResponseBody 返回 JSON 或 XML 形式数据

声明 Spring Bean 的作用域,使用方法:

四种常见的 Spring Bean 的作用域:

一般用来声明配置类,可以使用 @Component注解替代,不过使用Configuration注解声明配置类更加语义化。

5 种常见的请求类型:

@GetMapping("users") 等价于@RequestMapping(value="/users",method=RequestMethod.GET)

@PostMapping("users") 等价于@RequestMapping(value="/users",method=RequestMethod.POST)

关于@RequestBody注解的使用,在下面的“前后端传值”这块会讲到。

@PutMapping("/users/{userId}") 等价于@RequestMapping(value="/users/{userId}",method=RequestMethod.PUT)

@DeleteMapping("/users/{userId}")等价于@RequestMapping(value="/users/{userId}",method=RequestMethod.DELETE)

一般实际项目中,我们都是 PUT 不够用了之后才用 PATCH 请求去更新数据。

掌握前后端传值的正确姿势,是你开始 CRUD 的第一步!

@PathVariable用于获取路径参数,@RequestParam用于获取查询参数。

举个简单的例子:

如果我们请求的 url 是:/klasses/{123456}/teachers?type=web

那么我们服务获取到的数据就是:klassId=123456,type=web。

用于读取 Request 请求(可能是 POST,PUT,DELETE,GET 请求)的 body 部分并且Content-Type 为 application/json 格式的数据,接收到数据之后会自动将数据绑定到 Java 对象上去。系统会使用HttpMessageConverter或者自定义的HttpMessageConverter将请求的 body 中的 json 字符串转换为 java 对象。

我用一个简单的例子来给演示一下基本使用!

我们有一个注册的接口:

UserRegisterRequest对象:

我们发送 post 请求到这个接口,并且 body 携带 JSON 数据:

这样我们的后端就可以直接把 json 格式的数据映射到我们的 UserRegisterRequest 类上。

需要注意的是:一个请求方法只可以有一个@RequestBody,但是可以有多个@RequestParam和@PathVariable。 如果你的方法必须要用两个 @RequestBody来接受数据的话,大概率是你的数据库设计或者系统设计出问题了!

使用 @Value("${property}") 读取比较简单的配置信息:

通过@ConfigurationProperties读取配置信息并与 bean 绑定。

你可以像使用普通的 Spring bean 一样,将其注入到类中使用。

@PropertySource读取指定 properties 文件

数据的校验的重要性就不用说了,即使在前端对数据进行校验的情况下,我们还是要对传入后端的数据再进行一遍校验,避免用户绕过浏览器直接通过一些 HTTP 工具直接向后端请求一些违法数据。

我们在需要验证的参数上加上了@Valid注解,如果验证失败,它将抛出MethodArgumentNotValidException。

一定一定不要忘记在类上加上 Validated 注解了,这个参数可以告诉 Spring 去校验方法参数。

介绍一下我们 Spring 项目必备的全局处理 Controller 层异常。

相关注解:

如何使用呢?拿我们在第 5 节参数校验这块来举例子。如果方法参数不对的话就会抛出MethodArgumentNotValidException,我们来处理这个异常。

更多关于 Spring Boot 异常处理的内容,请看我的这两篇文章

@Entity声明一个类对应一个数据库实体。

@Table 设置表明

@Id :声明一个字段为主键。

使用@Id声明之后,我们还需要定义主键的生成策略。我们可以使用 @GeneratedValue 指定主键生成策略。

1.通过 @GeneratedValue直接使用 JPA 内置提供的四种主键生成策略来指定主键生成策略。

JPA 使用枚举定义了 4 中常见的主键生成策略,如下:

public enum GenerationType { /** * 使用一个特定的数据库表格来保存主键 * 持久化引擎通过关系数据库的一张特定的表格来生成主键, */ TABLE, /** *在某些数据库中,不支持主键自增长,比如Oracle、PostgreSQL其提供了一种叫做"序列(sequence)"的机制生成主键 */ SEQUENCE, /** * 主键自增长 */ IDENTITY, /** *把主键生成策略交给持久化引擎(persistence engine), *持久化引擎会根据数据库在以上三种主键生成 策略中选择其中一种 */ AUTO}

@GeneratedValue注解默认使用的策略是GenerationType.AUTO

一般使用 MySQL 数据库的话,使用GenerationType.IDENTITY策略比较普遍一点(分布式系统的话需要另外考虑使用分布式 ID)。

2.通过 @GenericGenerator声明一个主键策略,然后 @GeneratedValue使用这个策略

等价于:

jpa 提供的主键生成策略有如下几种:

@Column 声明字段。

示例:

设置属性 userName 对应的数据库字段名为 user_name,长度为 32,非空

设置字段类型并且加默认值,这个还是挺常用的。

@Transient :声明不需要与数据库映射的字段,在保存的时候不需要保存进数据库 。

如果我们想让secrect 这个字段不被持久化,可以使用 @Transient关键字声明。

除了 @Transient关键字声明, 还可以采用下面几种方法:

一般使用注解的方式比较多。

@Lob:声明某个字段为大字段。

更详细的声明:

可以使用枚举类型的字段,不过枚举字段要用@Enumerated注解修饰。

8.7. 增加审计功能

只要继承了 AbstractAuditBase的类都会默认加上下面四个字段。

我们对应的审计功能对应地配置类可能是下面这样的(Spring Security 项目):

简单介绍一下上面设计到的一些注解:

@EnableJpaAuditing:开启 JPA 审计功能。

@Modifying 注解提示 JPA 该操作是修改操作,注意还要配合@Transactional注解使用。

更多关于 Spring Boot JPA 的文章请看我的这篇文章:一文搞懂如何在 Spring Boot 正确中使用 JPA 。

在要开启事务的方法上使用@Transactional注解即可!

我们知道 Exception 分为运行时异常 RuntimeException 和非运行时异常。在@Transactional注解中如果不配置rollbackFor属性,那么事物只会在遇到RuntimeException的时候才会回滚,加上rollbackFor=Exception.class,可以让事物在遇到非运行时异常时也回滚。

@Transactional 注解一般用在可以作用在类或者方法上。

更多关于关于 Spring 事务的内容请查看:

@JsonIgnoreProperties 作用在类上用于过滤掉特定字段不返回或者不解析。

@JsonIgnore一般用于类的属性上,作用和上面的@JsonIgnoreProperties 一样。

@JsonFormat一般用来格式化 json 数据。:

比如:

未扁平化之前:

使用@JsonUnwrapped 扁平对象之后:

@ActiveProfiles一般作用于测试类上, 用于声明生效的 Spring 配置文件。

@Test声明一个方法为测试方法

@Transactional被声明的测试方法的数据会回滚,避免污染测试数据。

@WithMockUser Spring Security 提供的,用来模拟一个真实用户,并且可以赋予权限。