SpringBoot常用注解
目录
- 1 @SpringBootApplication
- 2 Spring Bean相关
-
- 2.1 @Autowired
- 2.2 @Component/@Controller/@Service/@Repository
- 2.3 @RestController
- 2.4 @Scope
- 2.5 @Configuration
- 3 处理常见的 HTTP 请求类型
-
- 3.1 @GetMapping
- 3.2 @PostMapping
- 3.3 @PutMapping
- 3.3 @DeleteMapping
- 4 前后端传值
-
- 4.1 @PathVariable和@RequestParam
- 4.2 @RequestBody
- 5 读取配置信息
-
- 5.1 @value(常用)
- 5.2 @ConfigurationProperties(常用)
- 5.3 @PropertySource（不常用）
- 6 参数校验
-
- 6.1 一些常用的字段验证的注解
- 6.2 验证请求体(RequestBody)
- 6.3 验证请求参数(Path Variables 和 Request Parameters)
- 7 全局处理 Controller 层异常
- 8 json 数据处理
-
- 8.1 过滤 json 数据
- 8.2 格式化 json 数据
- 8.3 扁平化对象
1 @SpringBootApplication
- @SpringBootApplication是 Spring Boot 项目的基石，创建 SpringBoot 项目之后会默认在主类加上；可以把 @SpringBootApplication看作是@EnableAutoConfiguration、@ComponentScan、@Configuration注解的集合；
- @EnableAutoConfiguration：启用 SpringBoot 的自动配置机制；
- @ComponentScan： 扫描被@Component (@Service,@Controller)注解的 bean，注解默认会扫描该类所在的包下所有的类；
- @Configuration：允许在 Spring 上下文中注册额外的 bean 或导入其他配置类；
2 Spring Bean相关
2.1 @Autowired
自动导入对象到类中，被注入进的类同样要被 Spring 容器管理。比如：Service 类注入到 Controller 类中。
2.2 @Component/@Controller/@Service/@Repository
一般使用 @Autowired 让 Spring 容器帮我们自动装配 bean。要想把类标识成可用于 @Autowired 注解自动装配的 bean 的类,可以采用以下注解实现：
- @Component ：通用注解，可标注任意类为 Spring 组件。如果一个 Bean 不知道属于哪个层，可以使用@Component注解标注；
- @Controller : 对应 Spring MVC 控制层，主要用于接受用户请求并调用 Service 层返回数据给前端页面；
- @Service : 对应服务层，主要涉及一些复杂的逻辑，需要用到 Dao 层；
- @Repository : 对应持久层即 Dao 层，主要用于数据库相关操作；
2.3 @RestController
- @RestController是@Controller和@ResponseBody的合集，表示这是个控制器 bean，并且是将函数的返回值直接填入 HTTP 响应体中，是 REST 风格的控制器；
- 单独使用@Controller不加@ResponseBody一般使用在要返回一个视图的情况，这种情况属于比较传统的Spring MVC的应用，对应于前后端不分离的情况;
- @Controller+@ResponseBody 返回JSON或XML形式数据；
2.4 @Scope
声明 Spring Bean 的作用域。
@Bean
@Scope("singleton")
public Person personSingleton() {
return new Person();
}
四种常见的 Spring Bean 的作用域：
- singleton : 唯一 bean 实例，Spring 中的 bean 默认都是单例的；
- prototype : 每次请求都会创建一个新的 bean 实例；
- request : 每一次 HTTP 请求都会产生一个新的 bean，该 bean 仅在当前 HTTP request 内有效；
- session : 每一次 HTTP 请求都会产生一个新的 bean，该 bean 仅在当前 HTTP session 内有效。
2.5 @Configuration
一般用来声明配置类，可以使用@Component注解替代，不过使用@Configuration注解声明配置类更加语义化。
@Configuration
public class AppConfig {
@Bean
public TransferService transferService() {
return new TransferServiceImpl();
}
}
3 处理常见的 HTTP 请求类型
- GET ：请求从服务器获取特定资源。举个例子：GET /users（获取所有学生）
- POST ：在服务器上创建一个新的资源。举个例子：POST /users（创建学生）
- PUT ：更新服务器上的资源（客户端提供更新后的整个资源）。举个例子：PUT /users/12（更新编号为 12 的学生）
- DELETE ：从服务器删除特定的资源。举个例子：DELETE /users/12（删除编号为 12 的学生）
3.1 @GetMapping
@GetMapping(“users”) 等价于@RequestMapping(value=“/users”,method=RequestMethod.GET)
@GetMapping("/users")
public ResponseEntity<List<User>> getAllUsers() {
return userRepository.findAll();
}
3.2 @PostMapping
@PostMapping(“users”) 等价于@RequestMapping(value=“/users”,method=RequestMethod.POST)
@PostMapping("/users")
public ResponseEntity<User> createUser(@Valid @RequestBody UserCreateRequest userCreateRequest) {
return userRespository.save(user);
}
3.3 @PutMapping
@PutMapping(“/users/{userId}”) 等价于@RequestMapping(value=“/users/{userId}”,method=RequestMethod.PUT)
@PutMapping("/users/{userId}")
public ResponseEntity<User> updateUser(@PathVariable(value = "userId") Long userId,
@Valid @RequestBody UserUpdateRequest userUpdateRequest) {
......
}
3.3 @DeleteMapping
@DeleteMapping(“/users/{userId}”)等价于@RequestMapping(value=“/users/{userId}”,method=RequestMethod.DELETE)
@DeleteMapping("/users/{userId}")
public ResponseEntity deleteUser(@PathVariable(value = "userId") Long userId){
......
}
4 前后端传值
4.1 @PathVariable和@RequestParam
@PathVariable用于获取路径参数，@RequestParam用于获取查询参数。
例：
@GetMapping("/klasses/{klassId}/teachers")
public List<Teacher> getKlassRelatedTeachers(
@PathVariable("klassId") Long klassId,
@RequestParam(value = "type", required = false) String type ) {
...
}
如果我们请求的 url 是：/klasses/{123456}/teachers?type=web，那么我们服务获取到的数据就是：klassId=123456,type=web。
4.2 @RequestBody
用于读取 Request 请求（可能是 POST,PUT,DELETE,GET 请求）的 body 部分并且Content-Type 为 application/json 格式的数据，接收到数据之后会自动将数据绑定到 Java 对象上去。系统会使用HttpMessageConverter或者自定义的HttpMessageConverter将请求的 body 中的 json 字符串转换为 java 对象。
例：
@PostMapping("/sign-up")
public ResponseEntity signUp(@RequestBody @Valid UserRegisterRequest userRegisterRequest) {
userService.save(userRegisterRequest);
return ResponseEntity.ok().build();
}
UserRegisterRequest对象：
@Data
@AllArgsConstructor
@NoArgsConstructor
public class UserRegisterRequest {
@NotBlank
private String userName;
@NotBlank
private String password;
@NotBlank
private String fullName;
}
我们发送 post 请求到这个接口，并且 body 携带 JSON 数据：
{"userName":"coder","fullName":"shuangkou","password":"123456"}
这样后端就可以直接把 json 格式的数据映射到UserRegisterRequest类上。
一个请求方法只可以有一个@RequestBody，但是可以有多个@RequestParam和@PathVariable。
5 读取配置信息
很多时候我们需要将一些常用的配置信息比如阿里云 oss、发送短信、微信认证的相关配置信息等等放到配置文件中。
Spring 为我们提供了以下几种方式帮助我们从配置文件中读取这些配置信息。
数据源application.yml：
wuhan:
2020: 2020年初武汉爆发了新型冠状病毒，疫情严重，但是，我相信一切都会过去！武汉加油！中国加油！
my-profile:
name: Guide哥
email: koushuangbwcx@163.com
library:
location: 湖北武汉加油中国加油
books:
- name: 天才基本法
description: 二十二岁的林朝夕在父亲确诊阿尔茨海默病这天，得知自己暗恋多年的校园男神裴之即将出国深造的消息——对方考取的学校，恰是父亲当年为她放弃的那所。
- name: 时间的秩序
description: 为什么我们记得过去，而非未来？时间“流逝”意味着什么？是我们存在于时间之内，还是时间存在于我们之中？卡洛·罗韦利用诗意的文字，邀请我们思考这一亘古难题——时间的本质。
- name: 了不起的我
description: 如何养成一个新习惯？如何让心智变得更成熟？如何拥有高质量的关系？ 如何走出人生的艰难时刻？
5.1 @value(常用)
使用 @Value(“${property}”) 读取比较简单的配置信息：
@Value("${wuhan.2020}")
String wuhan2020;
5.2 @ConfigurationProperties(常用)
通过@ConfigurationProperties读取配置信息并与 bean 绑定。
@Component
@ConfigurationProperties(prefix = "library")
class LibraryProperties {
@NotEmpty
private String location;
private List<Book> books;
@Setter
@Getter
@ToString
static class Book {
String name;
String description;
}
省略getter/setter
......
}
可以像使用普通的 Spring bean 一样，将其注入到类中使用。
5.3 @PropertySource（不常用）
@PropertySource读取指定 properties 文件
@Component
@PropertySource("classpath:website.properties")
class WebSite {
@Value("${url}")
private String url;
省略getter/setter
......
}
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）的参考实现；
- SpringBoot 项目的 spring-boot-starter-web 依赖中已经有 hibernate-validator 包，不需要引用相关依赖。如下图所示（通过 idea 插件—Maven Helper 生成）：
- 非 SpringBoot 项目需要自行引入相关依赖包；
- 所有的注解，推荐使用 JSR 注解，即javax.validation.constraints，而不是org.hibernate.validator.constraints；
6.1 一些常用的字段验证的注解
- @NotEmpty(message=)：被注释的字符串的不能为 null 也不能为空，即长度必须大于0；
- @NotBlank(message=)：被注释的字符串非 null，并且必须包含一个非空白字符，即调用trim()后，长度必须大于0；
- @Null(message=)：被注释的元素必须为 null；
- @NotNull(message=)：被注释的元素必须不为 null；
- @AssertTrue：被注释的元素必须为 true；
- @AssertFalse：被注释的元素必须为 false；
- @Pattern(regexp=,message=)：被注释的元素必须符合指定的正则表达式；
- @Email：被注释的元素必须是 Email 格式；
- @Min(value)：被注释的元素必须是一个数字，其值必须大于等于指定的最小值；
- @Max(value)：被注释的元素必须是一个数字，其值必须小于等于指定的最大值；
- @DecimalMin(value)：被注释的元素必须是一个数字，其值必须大于等于指定的最小值；
- @DecimalMax(value)：被注释的元素必须是一个数字，其值必须小于等于指定的最大值；
- @Size(max=, min=)：被注释的字符串、Collection、Map、数组等的大小必须在指定的范围内；
- @Range(min=最小值, max=最大值)：被注释的BigDecimal,BigInteger,CharSequence, byte, short, int, long等原子类型和包装类型在最小值和最大值之间；
- @Digits (integer=整数位数, fraction=小数位数)：被注释的元素必须是一个数字，其值必须在可接受的范围内；
- @Past：被注释的元素必须是一个过去的日期；
- @Future：被注释的元素必须是一个将来的日期；
6.2 验证请求体(RequestBody)
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Person {
@NotNull(message = "classId不能为空")
private String classId;
@Size(max=33)
@NotNull(message = "name不能为空")
private String name;
@Pattern(regexp ="((^Man$|^Woman$|^UGM$))", message = "sex值不在可选范围")
@NotNull(message = "sex不能为空")
private String sex;
@Email(message = "email格式不正确")
@NotNull(message = "email不能为空")
private String email;
}
在需要验证的参数上加上@Valid注解，如果验证失败，它将抛出MethodArgumentNotValidException。
@RestController
@RequestMapping("/api")
public class PersonController {
@PostMapping("/person")
public ResponseEntity<Person> getPerson(@RequestBody @Valid Person person) {
return ResponseEntity.ok().body(person);
}
}
6.3 验证请求参数(Path Variables 和 Request Parameters)
需要在类上加上 Validated 注解，它可以告诉 Spring 去校验方法参数。
@RestController
@RequestMapping("/api")
@Validated
public class PersonController {
@GetMapping("/person/{id}")
public ResponseEntity<Integer> getPersonByID(@Valid @PathVariable("id") @Max(value = 5,message = "超过 id 的范围了") Integer id) {
return ResponseEntity.ok().body(id);
}
}
7 全局处理 Controller 层异常
- @ControllerAdvice :注解定义全局异常处理类
- @ExceptionHandler :注解声明异常处理方法
拿参数校验来举例。如果方法参数不对的话就会抛出MethodArgumentNotValidException。
@ControllerAdvice
@ResponseBody
public class GlobalExceptionHandler {
/**
* 请求参数异常处理
*/
@ExceptionHandler(MethodArgumentNotValidException.class)
public ResponseEntity<?> handleMethodArgumentNotValidException(MethodArgumentNotValidException ex, HttpServletRequest request) {
......
}
}
8 json 数据处理
8.1 过滤 json 数据
- @JsonIgnoreProperties 作用在类上用于过滤掉特定字段不返回或者不解析；
//生成json时将userRoles属性过滤
@JsonIgnoreProperties({"userRoles"})
public class User {
private String userName;
private String fullName;
private String password;
private List<UserRole> userRoles = new ArrayList<>();
}
- @JsonIgnore一般用于类的属性上，作用和上面的@JsonIgnoreProperties 一样；
public class User {
private String userName;
private String fullName;
private String password;
//生成json时将userRoles属性过滤
@JsonIgnore
private List<UserRole> userRoles = new ArrayList<>();
}
8.2 格式化 json 数据
@JsonFormat一般用来格式化 json 数据。
例
@JsonFormat(shape=JsonFormat.Shape.STRING, pattern="yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", timezone="GMT")
private Date date;
8.3 扁平化对象
@Data
public class Account {
private Location location;
private PersonInfo personInfo;
@Data
public static class Location {
private String provinceName;
private String countyName;
}
@Data
public static class PersonInfo {
private String userName;
private String fullName;
}
}
未扁平化之前：
{
"location": {
"provinceName":"湖北",
"countyName":"武汉"
},
"personInfo": {
"userName": "coder1234",
"fullName": "shaungkou"
}
}
使用@JsonUnwrapped 扁平对象之后：
@Data
public class Account {
@JsonUnwrapped
private Location location;
@JsonUnwrapped
private PersonInfo personInfo;
......
}
{
"provinceName":"湖北",
"countyName":"武汉",
"userName": "coder1234",
"fullName": "shaungkou"
}