安排上了！一文掌握 Spring Boot 常用注解

410次阅读  |  发布于3年以前

1. 目录

Spring Boot 常用注解

可以看到七哥给大家整理的目录，我个人觉得还是比较清晰的，也尽可能的完善了，我带着大家过一遍，整清楚了含义和用法，剩下的就交给你们去实战了。

2. Bean处理

下面这些注解都是处理 Spring 中 Bean 相关的。

@Resource

依赖注入，自动导入标注的对象到当前类中，比如我们的 Controller 类通常要导入 Service 类（需要注意这里 Service 类要被 Spring 容器管理）。

<span style="font-family:Optima-Regular, Optima, PingFangSC-light, PingFangTC-light, PingFang SC, Cambria, Cochin, Georgia, Times, Times New Roman, serif;">@Component、``@Repository、``@Service、``@Controller、``@RestController

我们一般使用 @Resource 注解让 Spring 容器帮我们自动装配 bean。要想把类标识成可用于 @Resource 注解自动装配的 bean 就需要我们使用这几个注解了，它们表示对应的类将被 Spring 容器管理。

@Configuration

标注是 Java 代码的配置类， Spring Boot 中推荐这种做法不再使用 xml 配置了；

@Configuration
public class AppConfig {
   //相当于 xml 中配置 Bean
    @Bean 
    public TransferService transferService() {
        return new TransferServiceImpl();
    }

}

@Scope

声明 Spring Bean 的作用域,作用于一共有以下几种：

3. HTTP请求

下面这些注解对应 Http 常见的请求方式，用于标注接口路径请求。

@GetMapping

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

@PostMapping

@PostMapping("/users")
public ResponseEntity<User> createUser(@RequestBody @Valid User user) {
    userService.save(user);
    return new ResponseEntity(HttpStatus.OK);
}

@PutMapping

put 方式的请求，常用语更新服务器上的资源。举个例子：PUT /users/7（更新编号为 7 的学生）

@DeleteMapping

DELETE 请求，从服务器删除特定的资源。

4. 前后端参数传递

@RequestParam & @PathVariable

@RequestParam 用在方法的参数前面，获取请求中表单类型的key=value格式的数据。

@PathVariable 用于获取请求路径中的参数。

@PostMapping("/{id}")
public ResponseEntity<List<User>> getUser(@PathVariable long id,@RequestParam String macAddress) {
    return new ResponseEntity(userService.findById(id),HttpStatus.OK);
}

@RequestBody

获取请求 body 中的数据，常用于搭配 @PostMapping 请求来提交对象数据. 请求体 的Content-Type 必须为 application/json 格式的数据，接收到数据之后会自动将数据绑定到 Java 对象上去。

系统会使用 HttpMessageConverter 或者自定义的 HttpMessageConverter将请求的 body 中的 json 字符串转换为 java 对象。

@PostMapping("/users")
public ResponseEntity<User> createUser(@RequestBody @Valid User user) {
    userService.save(user);
    return new ResponseEntity(HttpStatus.OK);
}

强调一下：请求方法只可以有一个@RequestBody，但是可以有多个 @RequestParam 和 @PathVariable。 如果你的方法必须要用两个 @RequestBody 来接受数据的话，那你就只思考下你的设计了，或者套娃形式的。

@ResponseBody

表示该方法的返回结果直接写入 HTTP response body 中，格式为 json。上面我们提到的 @RestController 其实就是 @Controller 和 @ResponseBody 两个结合起来的。

5. 读取配置

@value

可以在任意 Spring 管理的 Bean 中通过这个注解获取任何来源配置的属性值。比如我们的 application.properties 或者 application.yml 配置文件中配置的属性值，当然也可以是 JVM 属性配置或者系统环境变量配置的值，如果对 Spring Boot 应用程序都有哪些属性配置源以及它们之间的优先级不了解的小伙伴可以看我之前的文章：[Spring Boot 属性配置你所不知道的细节] 。

@Value("${who}")
String name;

@ConfigurationProperties(重点)

上面 @Value 在每个类中获取属性配置值的做法其实是不推荐的，我们一般在企业项目开发中，不会使用那么杂乱无章的写法而且维护也麻烦，通过就是一次性读取到一个 Java 配置类，然后需要使用的地方直接引用这个类就可以多次访问了，方便维护。

@Component
@ConfigurationProperties(prefix = "my", ignoreUnknownFields = false)
@Data
public class MyProperties implements Serializable {

    private String name;

    private String username;

    private List<Book> books;

    @Data
    static class Book implements Serializable{
        private int id;
        private String bookName;
    }

}

@PropertySource

这个注解是用来指定读取我们自定义的配置文件的。

@Component
@ConfigurationProperties(prefix= "my" )
@PropertySource(value = {"classpath:my.properties"})
@Data
public class MyProperties {
    private int maxValue= 0;
}

6. 参数校验

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

JSR(Java Specification Requests） 是一套 JavaBean 参数校验的标准，它定义了很多常用的校验注解，我们可以直接将这些注解加在我们 JavaBean 的属性上面，这样就可以在需要校验的时候进行校验了，非常方便！

校验的时候我们实际用的是 Hibernate Validator 框架。Hibernate Validator 是 Hibernate 团队最初的数据校验框架，Hibernate Validator 4.x 是 Bean Validation 1.0（JSR 303）的参考实现，Hibernate Validator 5.x 是 Bean Validation 1.1（JSR 349）的参考实现，目前最新版的 Hibernate Validator 6.x 是 Bean Validation 2.0（JSR 380）的参考实现。

需要注意的是从 Spring Boot 2.3开始，我们还需要显式地添加 spring-boot-starter-validation 依赖项，在此之前的 Spring Boot 版本是在 spring-boot-starter-web 依赖项中包含的不需要额外引入。

我现在使用的是 Spring Boot 2.5.2 版本了，所以手动增加依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
    <version>2.5.2</version>
</dependency>

需要注意的是： 所有的注解，推荐使用 JSR 注解，即 javax.validation.constraints，而不是 org.hibernate.validator.constraints

Bean字段验证注解

验证请求体(RequestBody)

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {

    @Min(100)
    private Long id;

    @NotNull(message = "name 不能为空")
    @NotEmpty
    @JsonProperty(value = "name")
    private String name;

}

只需要在请求处理方法中需要验证的参数前加上 @Valid 注解就会开启校验了，如果验证失败将抛出异常：MethodArgumentNotValidException。

@PostMapping("/users")
public ResponseEntity<User> createUser(@RequestBody @Valid User user) {
    userService.save(user);
    return new ResponseEntity(HttpStatus.OK);
}

@Validated

如果你的入参不是用一个 Java 对象来接收的话，比如用 @PathVariables 和 @RequestParam 注解来获取入参，这种情况下要校验参数不要忘记在类的头上加 @Validated 注解，这个参数可以告诉 Spring 去校验方法参数。

@RestController
@RequestMapping("/user")
@Validated
public class UserController {
   @GetMapping("/{id}")
    public ResponseEntity<List<User>> findById( @PathVariable @Max(value = 5,message = "超过 id 的范围了") long id) {
        return new ResponseEntity(userService.findById(id),HttpStatus.OK);
    }

}

7. 统一异常处理

异常处理通常也是我们在开发中一定要做的，因为不可能将一些程序员才能看懂的异常抛出到前端去（总会有不靠谱的同事忘记捕获异常的），所以一般都会加上统一的异常处理，在对用户不友好的错误堆栈转换为普通用户可以看懂的文案提示。

这里涉及到的注解只有两个：

  1. @ControllerAdvice : 定义全局异常处理类，包含 @Component 所以可以被 Spring 扫描到。
  2. @ExceptionHandler : 声明异常处理方法，表示遇到这个异常，就执行标注的方法。
@ControllerAdvice
@ResponseBody
class GlobalDefaultExceptionHandler {
  // 如果是遇到注解中指定的异常就会进这个方法处理后返回
    @ExceptionHandler({MethodArgumentNotValidException.class, ConstraintViolationException.class})
    public Map argumentErrorHandler(HttpServletRequest req, Exception e) throws Exception {
        Map map = new HashMap();
        map.put("error", "参数不合法");
        map.put("param", req.getParameterMap());
        return map;
    }
}

8. JPA数据持久化

上面是百度百科给的概念，只能说在实际项目开发中还是用的不多，大家还是喜欢用 Mybatis，不过相比更加简洁的技术还是要学习下的。

创建表

这俩是放在 Java Bean 上面用来标注数据库实体对象和表明之间的映射关系的。

@Data
@Entity
@Table("user")
public class User {
    @Id
    @GeneratedValue
    @JsonProperty(value = "id")
    private Long id;

创建主键

这俩主键放在 Bean 的字段上，用来标识数据库的主键以及主键自动生成的。通过 @GeneratedValue直接使用 JPA 内置提供的四种主键生成策略来指定。

@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;

设置字段类型

@Column 声明字段。

比如：Java Bean 属性名为 nickName 对应的数据库字段名为 user_name，长度为 32，非空。

@Column(name = "user_name", nullable = false, length=32)
private String nickName;

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

Column(columnDefinition = "tinyint(1) default 1")
private Boolean enabled;

指定不持久化特定字段

@Transient ：有一些字段我们有时间不需要落库，就可以加上这个注解就好了。

@声明事务

这个注解可以作用于类上，也可以作用于方法上。前者表示所有该类的 public 方法都配置相同的事务属性信息，后者表示当类配置了@Transactional，方法也配置了@Transactional，方法的事务会覆盖类的事务配置信息。

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

@Transactional(rollbackFor = Exception.class)
public void save() {
  ......
}

9. JSON格式处理

指定过滤字段

//生成json时将userRoles属性过滤
@JsonIgnoreProperties({"password"})
public class User {
    private String userName;
    private String fullName;
    @JsonIgnore
    private String password;
}

格式化 json 数据

@JsonFormat(pattern="yyyy-MM-dd HH:mm:ss",timezone="GMT+8")
private Date createDate;

要注意的是，它只会在类似 @ResponseBody 返回 json 数据的时候，才会返回格式化的 yyyy-MM-dd HH:mm:ss 时间，你直接使用System.out.println()输出的话，仍然是类似 Fri Dec 01 21:05:20 CST 2017 这样的时间样式。

扁平化对象

@JsonUnwrapped

这个可能不太好说，大家直接看代码就懂了：

@Getter
@Setter
@ToString
public class Account {
  @JsonUnwrapped
  private Location location;
  @JsonUnwrapped
  private PersonInfo personInfo;

  @Getter
  @Setter
  @ToString
  public static class Location {
     private String provinceName;
     private String countyName;
  }
  @Getter
  @Setter
  @ToString
  public static class PersonInfo {
    private String userName;
    private String fullName;
  }
}

未扁平化之前：

{
    "location": {
        "provinceName":"广东",
        "countyName":"深圳"
    },
    "personInfo": {
        "userName": "sevenluo",
        "fullName": "程序员七哥"
    }
}

使用 @JsonUnwrapped 扁平对象之后：

@Getter
@Setter
@ToString
public class Account {
    @JsonUnwrapped
    private Location location;
    @JsonUnwrapped
    private PersonInfo personInfo;
    ......
}
{
  "provinceName":"广东",
  "countyName":"深圳",
  "userName": "sevenluo",
  "fullName": "程序员七哥"
}

10. 测试处理

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

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

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

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

11. 配置启动

@SpringBootApplication : 等价于使用 @Configuration、@EnableAutoConfiguration、@ComponentScan 三个注解。

@Configuration：声明是是一个 Java 形式的配置类，Spring Boot 提倡基于 Java 的配置，相当于你之前在 xml 中配置 bean；

@EnableAutoConfiguration：类级别的注解，这个注解告诉 Spring Boot 根据添加的 jar 依赖猜测你想如何配置 Spring，也就是 Spring 实现自动配置的开关。

@ComponentScan：标注哪些路径下的类需要被Spring扫描。

@Conditional：Spring4 新提供的注解，通过 @Conditional 注解可以根据代码中设置的条件装载不同的 bean，也是SpringBoot实现自动配置的基石。

Spring Boot 源码中大量扩展了 @Condition 注解，用于实现智能的自动化配置，满足各种使用场景。下面我给大家列举下：

那目前暂定就先总结这么多，虽然花了不少时间，但是难免有遗漏，七哥后续也会继续更新，也欢迎大家评论区指导和补充，谢谢啦。

总结

大家在看的过程中也别担心记不住，根本不用死记硬背，可以先收藏起来嘛。学编程很多时候就是灌个耳音，知道有这么个东西就好了，用的时候搜索一下就好。我都会打包给到大家。

Copyright© 2013-2020

All Rights Reserved 京ICP备2023019179号-8