From 768c2215f8b024f833daf86d9fa5d48294f8d916 Mon Sep 17 00:00:00 2001 From: "shuang.kou" Date: Thu, 23 Apr 2020 15:17:34 +0800 Subject: [PATCH] Update spring-annotations.md --- .../framework/spring/spring-annotations.md | 229 +++++++++--------- 1 file changed, 113 insertions(+), 116 deletions(-) diff --git a/docs/system-design/framework/spring/spring-annotations.md b/docs/system-design/framework/spring/spring-annotations.md index e31dd4b5..388dcd9e 100644 --- a/docs/system-design/framework/spring/spring-annotations.md +++ b/docs/system-design/framework/spring/spring-annotations.md @@ -1,8 +1,8 @@ -### 文章目录： +### 文章目录 -- [文章目录：](#%e6%96%87%e7%ab%a0%e7%9b%ae%e5%bd%95) +- [文章目录](#%e6%96%87%e7%ab%a0%e7%9b%ae%e5%bd%95) - [0.前言](#0%e5%89%8d%e8%a8%80) - [1. `@SpringBootApplication`](#1-springbootapplication) - [2. Spring Bean 相关](#2-spring-bean-%e7%9b%b8%e5%85%b3) @@ -11,12 +11,12 @@ - [2.3. `@RestController`](#23-restcontroller) - [2.4. `@Scope`](#24-scope) - [2.5. `Configuration`](#25-configuration) -- [3. 处理常见的HTTP请求类型](#3-%e5%a4%84%e7%90%86%e5%b8%b8%e8%a7%81%e7%9a%84http%e8%af%b7%e6%b1%82%e7%b1%bb%e5%9e%8b) - - [3.1. GET请求](#31-get%e8%af%b7%e6%b1%82) - - [3.2. POST请求](#32-post%e8%af%b7%e6%b1%82) - - [3.3. PUT请求](#33-put%e8%af%b7%e6%b1%82) - - [3.4. **DELETE请求**](#34-delete%e8%af%b7%e6%b1%82) - - [3.5. **PATCH请求**](#35-patch%e8%af%b7%e6%b1%82) +- [3. 处理常见的 HTTP 请求类型](#3-%e5%a4%84%e7%90%86%e5%b8%b8%e8%a7%81%e7%9a%84-http-%e8%af%b7%e6%b1%82%e7%b1%bb%e5%9e%8b) + - [3.1. GET 请求](#31-get-%e8%af%b7%e6%b1%82) + - [3.2. POST 请求](#32-post-%e8%af%b7%e6%b1%82) + - [3.3. PUT 请求](#33-put-%e8%af%b7%e6%b1%82) + - [3.4. **DELETE 请求**](#34-delete-%e8%af%b7%e6%b1%82) + - [3.5. **PATCH 请求**](#35-patch-%e8%af%b7%e6%b1%82) - [4. 前后端传值](#4-%e5%89%8d%e5%90%8e%e7%ab%af%e4%bc%a0%e5%80%bc) - [4.1. `@PathVariable` 和 `@RequestParam`](#41-pathvariable-%e5%92%8c-requestparam) - [4.2. `@RequestBody`](#42-requestbody) @@ -28,8 +28,8 @@ - [6.1. 一些常用的字段验证的注解](#61-%e4%b8%80%e4%ba%9b%e5%b8%b8%e7%94%a8%e7%9a%84%e5%ad%97%e6%ae%b5%e9%aa%8c%e8%af%81%e7%9a%84%e6%b3%a8%e8%a7%a3) - [6.2. 验证请求体(RequestBody)](#62-%e9%aa%8c%e8%af%81%e8%af%b7%e6%b1%82%e4%bd%93requestbody) - [6.3. 验证请求参数(Path Variables 和 Request Parameters)](#63-%e9%aa%8c%e8%af%81%e8%af%b7%e6%b1%82%e5%8f%82%e6%95%b0path-variables-%e5%92%8c-request-parameters) -- [7. 全局处理Controller层异常](#7-%e5%85%a8%e5%b1%80%e5%a4%84%e7%90%86controller%e5%b1%82%e5%bc%82%e5%b8%b8) -- [8. JPA相关](#8-jpa%e7%9b%b8%e5%85%b3) +- [7. 全局处理 Controller 层异常](#7-%e5%85%a8%e5%b1%80%e5%a4%84%e7%90%86-controller-%e5%b1%82%e5%bc%82%e5%b8%b8) +- [8. JPA 相关](#8-jpa-%e7%9b%b8%e5%85%b3) - [8.1. 创建表](#81-%e5%88%9b%e5%bb%ba%e8%a1%a8) - [8.2. 创建主键](#82-%e5%88%9b%e5%bb%ba%e4%b8%bb%e9%94%ae) - [8.3. 设置字段类型](#83-%e8%ae%be%e7%bd%ae%e5%ad%97%e6%ae%b5%e7%b1%bb%e5%9e%8b) @@ -40,33 +40,32 @@ - [8.8. 删除/修改数据](#88-%e5%88%a0%e9%99%a4%e4%bf%ae%e6%94%b9%e6%95%b0%e6%8d%ae) - [8.9. 关联关系](#89-%e5%85%b3%e8%81%94%e5%85%b3%e7%b3%bb) - [9. 事务 `@Transactional`](#9-%e4%ba%8b%e5%8a%a1-transactional) -- [10. json数据处理](#10-json%e6%95%b0%e6%8d%ae%e5%a4%84%e7%90%86) - - [10.1. 过滤json数据](#101-%e8%bf%87%e6%bb%a4json%e6%95%b0%e6%8d%ae) - - [10.2. 格式化json数据](#102-%e6%a0%bc%e5%bc%8f%e5%8c%96json%e6%95%b0%e6%8d%ae) +- [10. json 数据处理](#10-json-%e6%95%b0%e6%8d%ae%e5%a4%84%e7%90%86) + - [10.1. 过滤 json 数据](#101-%e8%bf%87%e6%bb%a4-json-%e6%95%b0%e6%8d%ae) + - [10.2. 格式化 json 数据](#102-%e6%a0%bc%e5%bc%8f%e5%8c%96-json-%e6%95%b0%e6%8d%ae) - [10.3. 扁平化对象](#103-%e6%89%81%e5%b9%b3%e5%8c%96%e5%af%b9%e8%b1%a1) - [11. 测试相关](#11-%e6%b5%8b%e8%af%95%e7%9b%b8%e5%85%b3) - ### 0.前言 -*大家好，我是Guide哥！这是我的221篇优质原创文章。如需转载，请在文首注明地址，蟹蟹！* +_大家好，我是 Guide 哥！这是我的 221 篇优质原创文章。如需转载，请在文首注明地址，蟹蟹！_ -本文已经收录进我的 75K Star 的 Java 开源项目JavaGuide：[https://github.com/Snailclimb/JavaGuide](https://github.com/Snailclimb/JavaGuide)。 +本文已经收录进我的 75K Star 的 Java 开源项目 JavaGuide：[https://github.com/Snailclimb/JavaGuide](https://github.com/Snailclimb/JavaGuide)。 -可以毫不夸张地说，这篇文章介绍的Spring/SpringBoot常用注解基本已经涵盖你工作中遇到的大部分常用的场景。对于每一个注解我都说了具体用法，掌握搞懂，使用 SpringBoot 来开发项目基本没啥大问题了！ +可以毫不夸张地说，这篇文章介绍的 Spring/SpringBoot 常用注解基本已经涵盖你工作中遇到的大部分常用的场景。对于每一个注解我都说了具体用法，掌握搞懂，使用 SpringBoot 来开发项目基本没啥大问题了！ **为什么要写这篇文章？** -最近看到网上有一篇关于 SpringBoot常用注解的文章被转载的比较多，我看了文章内容之后属实觉得质量有点低，并且有点会误导没有太多实际使用经验的人（这些人又占据了大多数）。所以，自己索性花了大概 两天时间简单总结一下了。 +最近看到网上有一篇关于 SpringBoot 常用注解的文章被转载的比较多，我看了文章内容之后属实觉得质量有点低，并且有点会误导没有太多实际使用经验的人（这些人又占据了大多数）。所以，自己索性花了大概 两天时间简单总结一下了。 -**因为我个人的能力和精力有限，如果有任何不对或者需要完善的地方，请帮忙指出！Guide哥感激不尽！** +**因为我个人的能力和精力有限，如果有任何不对或者需要完善的地方，请帮忙指出！Guide 哥感激不尽！** ### 1. `@SpringBootApplication` 这里先单独拎出`@SpringBootApplication` 注解说一下，虽然我们一般不会主动去使用它。 -*Guide哥：这个注解是 Spring Boot项目的基石，创建SpringBoot项目之后会默认在主类加上。* +_Guide 哥：这个注解是 Spring Boot 项目的基石，创建 SpringBoot 项目之后会默认在主类加上。_ ```java @SpringBootApplication @@ -77,7 +76,7 @@ public class SpringSecurityJwtGuideApplication { } ``` -我们可以把 `@SpringBootApplication `看作是 `@Configuration`、`@EnableAutoConfiguration`、`@ComponentScan ` 注解的集合。 +我们可以把 `@SpringBootApplication`看作是 `@Configuration`、`@EnableAutoConfiguration`、`@ComponentScan` 注解的集合。 ```java package org.springframework.boot.autoconfigure; @@ -104,17 +103,17 @@ public @interface SpringBootConfiguration { } ``` -根据 SpringBoot官网，这三个注解的作用分别是： +根据 SpringBoot 官网，这三个注解的作用分别是： - `@EnableAutoConfiguration`：启用 SpringBoot 的自动配置机制 -- `@ComponentScan`： 扫描被`@Component` (`@Service`,`@Controller`)注解的bean，注解默认会扫描该类所在的包下所有的类。 -- `@Configuration`：允许在Spring上下文中注册额外的bean或导入其他配置类 +- `@ComponentScan`： 扫描被`@Component` (`@Service`,`@Controller`)注解的 bean，注解默认会扫描该类所在的包下所有的类。 +- `@Configuration`：允许在 Spring 上下文中注册额外的 bean 或导入其他配置类 ### 2. Spring Bean 相关 #### 2.1. `@Autowired` -自动导入对象到类中，被注入进的类同样要被 Spring 容器管理比如：Service 类注入到 Controller类中。 +自动导入对象到类中，被注入进的类同样要被 Spring 容器管理比如：Service 类注入到 Controller 类中。 ```java @Service @@ -127,26 +126,26 @@ public class UserService { public class UserController { @Autowired private UserService userService; - ...... + ...... } ``` #### 2.2. `Component`,`@Repository`,`@Service`, `@Controller` -我们一般使用 `@Autowired` 注解让 Spring容器帮我们自动装配 bean。要想把类标识成可用于 `@Autowired` 注解自动装配的 bean 的类,可以采用以下注解实现： +我们一般使用 `@Autowired` 注解让 Spring 容器帮我们自动装配 bean。要想把类标识成可用于 `@Autowired` 注解自动装配的 bean 的类,可以采用以下注解实现： -- `@Component` ：通用的注解，可标注任意类为 `Spring` 组件。如果一个Bean不知道属于哪个层，可以使用`@Component` 注解标注。 +- `@Component` ：通用的注解，可标注任意类为 `Spring` 组件。如果一个 Bean 不知道属于哪个层，可以使用`@Component` 注解标注。 - `@Repository` : 对应持久层即 Dao 层，主要用于数据库相关操作。 -- `@Service` : 对应服务层，主要涉及一些复杂的逻辑，需要用到 Dao层。 +- `@Service` : 对应服务层，主要涉及一些复杂的逻辑，需要用到 Dao 层。 - `@Controller` : 对应 Spring MVC 控制层，主要用户接受用户请求并调用 Service 层返回数据给前端页面。 -#### 2.3. `@RestController` +#### 2.3. `@RestController` -`@RestController`注解是`@Controller和`@`ResponseBody`的合集,表示这是个控制器 bean,并且是将函数的返回值直 接填入HTTP响应体中,是REST风格的控制器。 +`@RestController`注解是`@Controller和`@`ResponseBody`的合集,表示这是个控制器 bean,并且是将函数的返回值直 接填入 HTTP 响应体中,是 REST 风格的控制器。 -*Guide哥：现在都是前后端分离，说实话我已经很久没有用过`@Controller`。如果你的项目太老了的话，就当我没说。* +_Guide 哥：现在都是前后端分离，说实话我已经很久没有用过`@Controller`。如果你的项目太老了的话，就当我没说。_ -单独使用 `@Controller` 不加 `@ResponseBody`的话一般使用在要返回一个视图的情况，这种情况属于比较传统的Spring MVC 的应用，对应于前后端不分离的情况。`@Controller` +`@ResponseBody` 返回JSON 或 XML 形式数据 +单独使用 `@Controller` 不加 `@ResponseBody`的话一般使用在要返回一个视图的情况，这种情况属于比较传统的 Spring MVC 的应用，对应于前后端不分离的情况。`@Controller` +`@ResponseBody` 返回 JSON 或 XML 形式数据 关于`@RestController` 和 `@Controller`的对比，请看这篇文章：[@RestController vs @Controller](https://mp.weixin.qq.com/s?__biz=Mzg2OTA0Njk0OA==&mid=2247485544&idx=1&sn=3cc95b88979e28fe3bfe539eb421c6d8&chksm=cea247a3f9d5ceb5e324ff4b8697adc3e828ecf71a3468445e70221cce768d1e722085359907&token=1725092312&lang=zh_CN#rd)。 @@ -162,12 +161,12 @@ public Person personSingleton() { } ``` -**四种常见的Spring Bean 的作用域：** +**四种常见的 Spring Bean 的作用域：** - singleton : 唯一 bean 实例，Spring 中的 bean 默认都是单例的。 - prototype : 每次请求都会创建一个新的 bean 实例。 -- request : 每一次HTTP请求都会产生一个新的bean，该bean仅在当前HTTP request内有效。 -- session : 每一次HTTP请求都会产生一个新的 bean，该bean仅在当前 HTTP session 内有效。 +- request : 每一次 HTTP 请求都会产生一个新的 bean，该 bean 仅在当前 HTTP request 内有效。 +- session : 每一次 HTTP 请求都会产生一个新的 bean，该 bean 仅在当前 HTTP session 内有效。 #### 2.5. `Configuration` @@ -184,9 +183,9 @@ public class AppConfig { } ``` -### 3. 处理常见的HTTP请求类型 +### 3. 处理常见的 HTTP 请求类型 -**5种常见的请求类型:** +**5 种常见的请求类型:** - **GET** ：请求从服务器获取特定资源。举个例子：`GET /users`（获取所有学生） - **POST** ：在服务器上创建一个新的资源。举个例子：`POST /users`（创建学生） @@ -194,7 +193,7 @@ public class AppConfig { - **DELETE** ：从服务器删除特定的资源。举个例子：`DELETE /users/12`（删除编号为 12 的学生） - **PATCH** ：更新服务器上的资源（客户端提供更改的属性，可以看做作是部分更新），使用的比较少，这里就不举例子了。 -#### 3.1. GET请求 +#### 3.1. GET 请求 `@GetMapping("users")` 等价于`@RequestMapping(value="/users",method=RequestMethod.GET)` @@ -205,9 +204,9 @@ public ResponseEntity> getAllUsers() { } ``` -#### 3.2. POST请求 +#### 3.2. POST 请求 - `@PostMapping("users")` 等价于`@RequestMapping(value="/users",method=RequestMethod.POST)` +`@PostMapping("users")` 等价于`@RequestMapping(value="/users",method=RequestMethod.POST)` 关于`@RequestBody`注解的使用，在下面的“前后端传值”这块会讲到。 @@ -218,7 +217,7 @@ public ResponseEntity createUser(@Valid @RequestBody UserCreateRequest use } ``` -#### 3.3. PUT请求 +#### 3.3. PUT 请求 `@PutMapping("/users/{userId}")` 等价于`@RequestMapping(value="/users/{userId}",method=RequestMethod.PUT)` @@ -230,7 +229,7 @@ public ResponseEntity updateUser(@PathVariable(value = "userId") Long user } ``` -#### 3.4. **DELETE请求** +#### 3.4. **DELETE 请求** `@DeleteMapping("/users/{userId}")`等价于`@RequestMapping(value="/users/{userId}",method=RequestMethod.DELETE)` @@ -241,9 +240,9 @@ public ResponseEntity deleteUser(@PathVariable(value = "userId") Long userId){ } ``` -#### 3.5. **PATCH请求** +#### 3.5. **PATCH 请求** -一般实际项目中，我们都是 PUT 不够用了之后才用PATCH请求去更新数据。 +一般实际项目中，我们都是 PUT 不够用了之后才用 PATCH 请求去更新数据。 ```java @PatchMapping("/profile") @@ -259,30 +258,30 @@ public ResponseEntity deleteUser(@PathVariable(value = "userId") Long userId){ #### 4.1. `@PathVariable` 和 `@RequestParam` - `@PathVariable`用于获取路径参数，`@RequestParam`用于获取查询参数。 +`@PathVariable`用于获取路径参数，`@RequestParam`用于获取查询参数。 举个简单的例子： ```java @GetMapping("/klasses/{klassId}/teachers") -public List getKlassRelatedTeachers( +public List getKlassRelatedTeachers( @PathVariable("klassId") Long klassId, @RequestParam(value = "type", required = false) String type ) { ... } ``` -如果我们请求的url是：`/klasses/{123456}/teachers?type=web` +如果我们请求的 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对象。 +用于读取 Request 请求（可能是 POST,PUT,DELETE,GET 请求）的 body 部分并且**Content-Type 为 application/json** 格式的数据，接收到数据之后会自动将数据绑定到 Java 对象上去。系统会使用`HttpMessageConverter`或者自定义的`HttpMessageConverter`将请求的 body 中的 json 字符串转换为 java 对象。 我用一个简单的例子来给演示一下基本使用！ -我们有一个注册的接口： +我们有一个注册的接口： ```java @PostMapping("/sign-up") @@ -319,11 +318,11 @@ public class UserRegisterRequest { ![](https://imgkr.cn-bj.ufileos.com/663d1ec1-7ebc-41ab-8431-159dc1ec6589.png) -👉需要注意的是：**一个请求方法只可以有一个`@RequestBody`，但是可以有多个`@RequestParam`和`@PathVariable`**。 如果你的方法必须要用两个 `@RequestBody`来接受数据的话，大概率是你的数据库设计或者系统设计出问题了！ +👉 需要注意的是：**一个请求方法只可以有一个`@RequestBody`，但是可以有多个`@RequestParam`和`@PathVariable`**。 如果你的方法必须要用两个 `@RequestBody`来接受数据的话，大概率是你的数据库设计或者系统设计出问题了！ ### 5. 读取配置信息 -**很多时候我们需要将一些常用的配置信息比如阿里云oss、发送短信、微信认证的相关配置信息等等放到配置文件中。** +**很多时候我们需要将一些常用的配置信息比如阿里云 oss、发送短信、微信认证的相关配置信息等等放到配置文件中。** **下面我们来看一下 Spring 为我们提供了哪些方式帮助我们从配置文件中读取这些配置信息。** @@ -384,7 +383,7 @@ class LibraryProperties { #### 5.3. `PropertySource`（不常用） - `@PropertySource`读取指定 properties 文件 +`@PropertySource`读取指定 properties 文件 ```java @Component @@ -393,47 +392,47 @@ class LibraryProperties { class WebSite { @Value("${url}") private String url; - + 省略getter/setter ...... } ``` -更多内容请查看我的这篇文章：《[10分钟搞定 SpringBoot 如何优雅读取配置文件？](https://mp.weixin.qq.com/s?__biz=Mzg2OTA0Njk0OA==&mid=2247486181&idx=2&sn=10db0ae64ef501f96a5b0dbc4bd78786&chksm=cea2452ef9d5cc384678e456427328600971180a77e40c13936b19369672ca3e342c26e92b50&token=816772476&lang=zh_CN#rd)》 。 +更多内容请查看我的这篇文章：《[10 分钟搞定 SpringBoot 如何优雅读取配置文件？](https://mp.weixin.qq.com/s?__biz=Mzg2OTA0Njk0OA==&mid=2247486181&idx=2&sn=10db0ae64ef501f96a5b0dbc4bd78786&chksm=cea2452ef9d5cc384678e456427328600971180a77e40c13936b19369672ca3e342c26e92b50&token=816772476&lang=zh_CN#rd)》 。 ### 6. 参数校验 **数据的校验的重要性就不用说了，即使在前端对数据进行校验的情况下，我们还是要对传入后端的数据再进行一遍校验，避免用户绕过浏览器直接通过一些 HTTP 工具直接向后端请求一些违法数据。** -**JSR(Java Specification Requests）** 是一套JavaBean参数校验的标准，它定义了很多常用的校验注解，我们可以直接将这些注解加在我们JavaBean的属性上面，这样就可以在需要校验的时候进行校验了，非常方便！ +**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）的参考实现。 +校验的时候我们实际用的是 **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 项目的 spring-boot-starter-web 依赖中已经有 hibernate-validator 包，不需要引用相关依赖。如下图所示（通过 idea 插件—Maven Helper 生成）： ![](https://imgkr.cn-bj.ufileos.com/c7bacd12-1c1a-4e41-aaaf-4cad840fc073.png) -非SpringBoot 项目需要自行引入相关依赖包，这里不多做讲解，具体可以查看我的这篇文章：《[如何在 Spring/Spring Boot 中做参数校验？你需要了解的都在这里！](https://mp.weixin.qq.com/s?__biz=Mzg2OTA0Njk0OA==&mid=2247485783&idx=1&sn=a407f3b75efa17c643407daa7fb2acd6&chksm=cea2469cf9d5cf8afbcd0a8a1c9cc4294d6805b8e01bee6f76bb2884c5bc15478e91459def49&token=292197051&lang=zh_CN#rd)》。 +非 SpringBoot 项目需要自行引入相关依赖包，这里不多做讲解，具体可以查看我的这篇文章：《[如何在 Spring/Spring Boot 中做参数校验？你需要了解的都在这里！](https://mp.weixin.qq.com/s?__biz=Mzg2OTA0Njk0OA==&mid=2247485783&idx=1&sn=a407f3b75efa17c643407daa7fb2acd6&chksm=cea2469cf9d5cf8afbcd0a8a1c9cc4294d6805b8e01bee6f76bb2884c5bc15478e91459def49&token=292197051&lang=zh_CN#rd)》。 -👉需要注意的是： **所有的注解，推荐使用JSR注解，即`javax.validation.constraints`，而不是`org.hibernate.validator.constraints`** +👉 需要注意的是： **所有的注解，推荐使用 JSR 注解，即`javax.validation.constraints`，而不是`org.hibernate.validator.constraints`** #### 6.1. 一些常用的字段验证的注解 -- `@NotEmpty ` 被注释的字符串的不能为 null 也不能为空 +- `@NotEmpty` 被注释的字符串的不能为 null 也不能为空 - `@NotBlank` 被注释的字符串非 null，并且必须包含一个非空白字符 - `@Null` 被注释的元素必须为 null - `@NotNull` 被注释的元素必须不为 null - `@AssertTrue` 被注释的元素必须为 true - `@AssertFalse` 被注释的元素必须为 false -- `@Pattern(regex=,flag=) `被注释的元素必须符合指定的正则表达式 -- `@Email` 被注释的元素必须是Email格式。 -- `@Min(value) `被注释的元素必须是一个数字，其值必须大于等于指定的最小值 -- `@Max(value) `被注释的元素必须是一个数字，其值必须小于等于指定的最大值 -- `@DecimalMin(value) `被注释的元素必须是一个数字，其值必须大于等于指定的最小值 +- `@Pattern(regex=,flag=)`被注释的元素必须符合指定的正则表达式 +- `@Email` 被注释的元素必须是 Email 格式。 +- `@Min(value)`被注释的元素必须是一个数字，其值必须大于等于指定的最小值 +- `@Max(value)`被注释的元素必须是一个数字，其值必须小于等于指定的最大值 +- `@DecimalMin(value)`被注释的元素必须是一个数字，其值必须大于等于指定的最小值 - `@DecimalMax(value)` 被注释的元素必须是一个数字，其值必须小于等于指定的最大值 -- `@Size(max=, min=) `被注释的元素的大小必须在指定的范围内 -- `@Digits (integer, fraction) `被注释的元素必须是一个数字，其值必须在可接受的范围内 -- `@Past `被注释的元素必须是一个过去的日期 +- `@Size(max=, min=)`被注释的元素的大小必须在指定的范围内 +- `@Digits (integer, fraction)`被注释的元素必须是一个数字，其值必须在可接受的范围内 +- `@Past`被注释的元素必须是一个过去的日期 - `@Future` 被注释的元素必须是一个将来的日期 - ...... @@ -477,7 +476,6 @@ public class PersonController { } ``` - #### 6.3. 验证请求参数(Path Variables 和 Request Parameters) **一定一定不要忘记在类上加上 `Validated` 注解了，这个参数可以告诉 Spring 去校验方法参数。** @@ -495,18 +493,18 @@ public class PersonController { } ``` -更多关于如何在Spring项目中进行参数校验的内容，请看《[如何在 Spring/Spring Boot 中做参数校验？你需要了解的都在这里！](https://mp.weixin.qq.com/s?__biz=Mzg2OTA0Njk0OA==&mid=2247485783&idx=1&sn=a407f3b75efa17c643407daa7fb2acd6&chksm=cea2469cf9d5cf8afbcd0a8a1c9cc4294d6805b8e01bee6f76bb2884c5bc15478e91459def49&token=292197051&lang=zh_CN#rd)》这篇文章。 +更多关于如何在 Spring 项目中进行参数校验的内容，请看《[如何在 Spring/Spring Boot 中做参数校验？你需要了解的都在这里！](https://mp.weixin.qq.com/s?__biz=Mzg2OTA0Njk0OA==&mid=2247485783&idx=1&sn=a407f3b75efa17c643407daa7fb2acd6&chksm=cea2469cf9d5cf8afbcd0a8a1c9cc4294d6805b8e01bee6f76bb2884c5bc15478e91459def49&token=292197051&lang=zh_CN#rd)》这篇文章。 -### 7. 全局处理Controller层异常 +### 7. 全局处理 Controller 层异常 -介绍一下我们Spring项目必备的全局处理 Controller 层异常。 +介绍一下我们 Spring 项目必备的全局处理 Controller 层异常。 **相关注解：** 1. `@ControllerAdvice` :注解定义全局异常处理类 2. `@ExceptionHandler` :注解声明异常处理方法 -如何使用呢？拿我们在第5节参数校验这块来举例子。如果方法参数不对的话就会抛出`MethodArgumentNotValidException`，我们来处理这个异常。 +如何使用呢？拿我们在第 5 节参数校验这块来举例子。如果方法参数不对的话就会抛出`MethodArgumentNotValidException`，我们来处理这个异常。 ```java @ControllerAdvice @@ -522,12 +520,13 @@ public class GlobalExceptionHandler { } } ``` + 更多关于 Spring Boot 异常处理的内容，请看我的这两篇文章： 1. [SpringBoot 处理异常的几种常见姿势](https://mp.weixin.qq.com/s?__biz=Mzg2OTA0Njk0OA==&mid=2247485568&idx=2&sn=c5ba880fd0c5d82e39531fa42cb036ac&chksm=cea2474bf9d5ce5dcbc6a5f6580198fdce4bc92ef577579183a729cb5d1430e4994720d59b34&token=2133161636&lang=zh_CN#rd) 2. [使用枚举简单封装一个优雅的 Spring Boot 全局异常处理！](https://mp.weixin.qq.com/s?__biz=Mzg2OTA0Njk0OA==&mid=2247486379&idx=2&sn=48c29ae65b3ed874749f0803f0e4d90e&chksm=cea24460f9d5cd769ed53ad7e17c97a7963a89f5350e370be633db0ae8d783c3a3dbd58c70f8&token=1054498516&lang=zh_CN#rd) -### 8. JPA相关 +### 8. JPA 相关 #### 8.1. 创建表 @@ -541,7 +540,7 @@ public class GlobalExceptionHandler { public class Role { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) - private Long id; + private Long id; private String name; private String description; 省略getter/setter...... @@ -554,7 +553,7 @@ public class Role { 使用`@Id`声明之后，我们还需要定义主键的生成策略。我们可以使用 `@GeneratedValue` 指定主键生成策略。 -**1.通过 `@GeneratedValue`直接使用JPA内置提供的四种主键生成策略来指定主键生成策略。** +**1.通过 `@GeneratedValue`直接使用 JPA 内置提供的四种主键生成策略来指定主键生成策略。** ```java @Id @@ -564,26 +563,26 @@ private Long id; JPA 使用枚举定义了 4 中常见的主键生成策略，如下： -*Guide哥：枚举替代常量的一种用法* +_Guide 哥：枚举替代常量的一种用法_ ```java -public enum GenerationType { +public enum GenerationType { /** * 使用一个特定的数据库表格来保存主键 * 持久化引擎通过关系数据库的一张特定的表格来生成主键, */ - TABLE, + TABLE, /** *在某些数据库中,不支持主键自增长,比如Oracle、PostgreSQL其提供了一种叫做"序列(sequence)"的机制生成主键 */ - SEQUENCE, + SEQUENCE, /** * 主键自增长 */ - IDENTITY, + IDENTITY, /** *把主键生成策略交给持久化引擎(persistence engine), @@ -604,7 +603,7 @@ public @interface GeneratedValue { } ``` -一般使用MySQL数据库的话，使用`GenerationType.IDENTITY`策略比较普遍一点（分布式系统的话需要另外考虑使用分布式ID）。 +一般使用 MySQL 数据库的话，使用`GenerationType.IDENTITY`策略比较普遍一点（分布式系统的话需要另外考虑使用分布式 ID）。 **2.通过 `@GenericGenerator`声明一个主键策略，然后 `@GeneratedValue`使用这个策略** @@ -664,7 +663,7 @@ public class DefaultIdentifierGeneratorFactory **示例：** -设置属性userName对应的数据库字段名为user_name，长度为32，非空 +设置属性 userName 对应的数据库字段名为 user_name，长度为 32，非空 ```java @Column(name = "user_name", nullable = false, length=32) @@ -682,20 +681,20 @@ private Boolean enabled; `@Transient` ：声明不需要与数据库映射的字段，在保存的时候不需要保存进数据库 。 -如果我们想让`secrect` 这个字段不被持久化，可以使用 ` @Transient`关键字声明。 +如果我们想让`secrect` 这个字段不被持久化，可以使用 `@Transient`关键字声明。 ```java Entity(name="USER") public class User { - + ...... @Transient private String secrect; // not persistent because of @Transient - + } ``` - 除了 ` @Transient`关键字声明， 还可以采用下面几种方法： +除了 `@Transient`关键字声明， 还可以采用下面几种方法： ```java static String secrect; // not persistent because of static @@ -717,9 +716,9 @@ private String content; 更详细的声明： ```java -@Lob +@Lob //指定 Lob 类型数据的获取策略， FetchType.EAGER 表示非延迟 加载，而 FetchType. LAZY 表示延迟加载 ； -@Basic(fetch = FetchType.EAGER) +@Basic(fetch = FetchType.EAGER) //columnDefinition 属性指定数据表对应的 Lob 字段类型 @Column(name = "content", columnDefinition = "LONGTEXT NOT NULL") private String content; @@ -747,7 +746,7 @@ public enum Gender { public class Role { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) - private Long id; + private Long id; private String name; private String description; @Enumerated(EnumType.STRING) @@ -756,7 +755,7 @@ public class Role { } ``` -数据库里面对应存储的是MAIL/FEMAIL。 +数据库里面对应存储的是 MAIL/FEMAIL。 #### 8.7. 增加审计功能 @@ -791,7 +790,7 @@ public abstract class AbstractAuditBase { ``` -我们对应的审计功能对应地配置类可能是下面这样的（Spring Security项目）: +我们对应的审计功能对应地配置类可能是下面这样的（Spring Security 项目）: ```java @@ -810,16 +809,16 @@ public class AuditSecurityConfiguration { 简单介绍一下上面设计到的一些注解： -1. `@CreatedDate`: 表示该字段为创建时间时间字段，在这个实体被insert的时候，会设置值 -2. `@CreatedBy` :表示该字段为创建人，在这个实体被insert的时候，会设置值 +1. `@CreatedDate`: 表示该字段为创建时间时间字段，在这个实体被 insert 的时候，会设置值 +2. `@CreatedBy` :表示该字段为创建人，在这个实体被 insert 的时候，会设置值 `@LastModifiedDate`、`@LastModifiedBy`同理。 -`@EnableJpaAuditing`：开启JPA审计功能。 +`@EnableJpaAuditing`：开启 JPA 审计功能。 #### 8.8. 删除/修改数据 -` @Modifying ` 注解提示 JPA 该操作是修改操作,注意还要配合`@Transactional`注解使用。 +`@Modifying` 注解提示 JPA 该操作是修改操作,注意还要配合`@Transactional`注解使用。 ```java @Repository @@ -838,7 +837,7 @@ public interface UserRepository extends JpaRepository { - `@ManyToOne`声明多对一关系 - `MangToMang`声明多对多关系 -更多关于 Spring Boot JPA 的文章请看我的这篇文章：[一文搞懂如何在Spring Boot 正确中使用JPA](https://mp.weixin.qq.com/s?__biz=Mzg2OTA0Njk0OA==&mid=2247485689&idx=1&sn=061b32c2222869932be5631fb0bb5260&chksm=cea24732f9d5ce24a356fb3675170e7843addbfcc79ee267cfdb45c83fc7e90babf0f20d22e1&token=292197051&lang=zh_CN#rd) 。 +更多关于 Spring Boot JPA 的文章请看我的这篇文章：[一文搞懂如何在 Spring Boot 正确中使用 JPA](https://mp.weixin.qq.com/s?__biz=Mzg2OTA0Njk0OA==&mid=2247485689&idx=1&sn=061b32c2222869932be5631fb0bb5260&chksm=cea24732f9d5ce24a356fb3675170e7843addbfcc79ee267cfdb45c83fc7e90babf0f20d22e1&token=292197051&lang=zh_CN#rd) 。 ### 9. 事务 `@Transactional` @@ -852,23 +851,23 @@ public void save() { ``` -我们知道 Exception 分为运行时异常RuntimeException和非运行时异常。在`@Transactional`注解中如果不配置`rollbackFor`属性,那么事物只会在遇到`RuntimeException`的时候才会回滚,加上`rollbackFor=Exception.class`,可以让事物在遇到非运行时异常时也回滚。 +我们知道 Exception 分为运行时异常 RuntimeException 和非运行时异常。在`@Transactional`注解中如果不配置`rollbackFor`属性,那么事物只会在遇到`RuntimeException`的时候才会回滚,加上`rollbackFor=Exception.class`,可以让事物在遇到非运行时异常时也回滚。 `@Transactional` 注解一般用在可以作用在`类`或者`方法`上。 -- **作用于类**：当把`@Transactional 注解放在类上时，表示所有该类的`public方法都配置相同的事务属性信息。 +- **作用于类**：当把`@Transactional 注解放在类上时，表示所有该类的`public 方法都配置相同的事务属性信息。 - **作用于方法**：当类配置了`@Transactional`，方法也配置了`@Transactional`，方法的事务会覆盖类的事务配置信息。 -更多关于关于 Spring事务的内容请查看： +更多关于关于 Spring 事务的内容请查看： -1. [可能是最漂亮的Spring事务管理详解](https://mp.weixin.qq.com/s?__biz=Mzg2OTA0Njk0OA==&mid=2247484943&idx=1&sn=46b9082af4ec223137df7d1c8303ca24&chksm=cea249c4f9d5c0d2b8212a17252cbfb74e5fbe5488b76d829827421c53332326d1ec360f5d63&token=1082669959&lang=zh_CN#rd) -2. [一口气说出 6种 @Transactional 注解失效场景](https://mp.weixin.qq.com/s?__biz=Mzg2OTA0Njk0OA==&mid=2247486483&idx=2&sn=77be488e206186803531ea5d7164ec53&chksm=cea243d8f9d5cacecaa5c5daae4cde4c697b9b5b21f96dfc6cce428cfcb62b88b3970c26b9c2&token=816772476&lang=zh_CN#rd) +1. [可能是最漂亮的 Spring 事务管理详解](https://mp.weixin.qq.com/s?__biz=Mzg2OTA0Njk0OA==&mid=2247484943&idx=1&sn=46b9082af4ec223137df7d1c8303ca24&chksm=cea249c4f9d5c0d2b8212a17252cbfb74e5fbe5488b76d829827421c53332326d1ec360f5d63&token=1082669959&lang=zh_CN#rd) +2. [一口气说出 6 种 @Transactional 注解失效场景](https://mp.weixin.qq.com/s?__biz=Mzg2OTA0Njk0OA==&mid=2247486483&idx=2&sn=77be488e206186803531ea5d7164ec53&chksm=cea243d8f9d5cacecaa5c5daae4cde4c697b9b5b21f96dfc6cce428cfcb62b88b3970c26b9c2&token=816772476&lang=zh_CN#rd) -### 10. json数据处理 +### 10. json 数据处理 -#### 10.1. 过滤json数据 +#### 10.1. 过滤 json 数据 - **`@JsonIgnoreProperties` 作用在类上用于过滤掉特定字段不返回或者不解析。** +**`@JsonIgnoreProperties` 作用在类上用于过滤掉特定字段不返回或者不解析。** ```java //生成json时将userRoles属性过滤 @@ -898,9 +897,9 @@ public class User { } ``` -#### 10.2. 格式化json数据 +#### 10.2. 格式化 json 数据 -`@JsonFormat`一般用来格式化json数据。： +`@JsonFormat`一般用来格式化 json 数据。： 比如： @@ -920,7 +919,7 @@ public class Account { private Location location; @JsonUnwrapped private PersonInfo personInfo; - + @Getter @Setter @ToString @@ -954,7 +953,7 @@ public class Account { } ``` -使用` @JsonUnwrapped` 扁平对象之后： +使用`@JsonUnwrapped` 扁平对象之后： ```java @Getter @@ -980,7 +979,7 @@ public class Account { ### 11. 测试相关 - **`@ActiveProfiles`一般作用于测试类上， 用于声明生效的Spring配置文件。** +**`@ActiveProfiles`一般作用于测试类上， 用于声明生效的 Spring 配置文件。** ```java @SpringBootTest(webEnvironment = RANDOM_PORT) @@ -995,7 +994,7 @@ public abstract class TestBase { **`@Transactional`被声明的测试方法的数据会回滚，避免污染测试数据。** -**`@WithMockUser` Spring Security提供的，用来模拟一个真实用户，并且可以赋予权限。** +**`@WithMockUser` Spring Security 提供的，用来模拟一个真实用户，并且可以赋予权限。** ```java @Test @@ -1006,8 +1005,6 @@ public abstract class TestBase { } ``` +_暂时总结到这里吧！虽然花了挺长时间才写完，不过可能还是会一些常用的注解的被漏掉，所以，我将文章也同步到了 Github 上去，Github 地址： 欢迎完善！_ - -*暂时总结到这里吧！虽然花了挺长时间才写完，不过可能还是会一些常用的注解的被漏掉，所以，我将文章也同步到了Github上去，Github地址： 欢迎完善！* - -本文已经收录进我的 75K Star 的 Java 开源项目JavaGuide：[https://github.com/Snailclimb/JavaGuide](https://github.com/Snailclimb/JavaGuide)。 \ No newline at end of file +本文已经收录进我的 75K Star 的 Java 开源项目 JavaGuide：[https://github.com/Snailclimb/JavaGuide](https://github.com/Snailclimb/JavaGuide)。