SpringBoot常用註解總結！安排！

目錄如下，內容有點多：

1. @SpringBootApplication

這裡先單獨拎出@SpringBootApplication 註解說一下，雖然我們一般不會主動去使用它。

注：這個註解是 Spring Boot 項目的基石，創建 SpringBoot 項目之後會默認在主類加上。

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

根據 SpringBoot 官網，這三個註解的作用分別是：

• @EnableAutoConfiguration：啟用 SpringBoot 的自動配置機制
• @ComponentScan： 掃描被@Component (@Service,@Controller)註解的 bean，註解默認會掃描該類所在的包下所有的類。
• @Configuration：允許在 Spring 上下文中註冊額外的 bean 或導入其他配置類

2. Spring Bean 相關

2.1. @Autowired

自動導入對象到類中，被注入進的類同樣要被 Spring 容器管理比如：Service 類注入到 Controller 類中。

2.2. Component,@Repository,@Service, @Controller

我們一般使用 @Autowired 註解讓 Spring 容器幫我們自動裝配 bean。要想把類標識成可用於 @Autowired 註解自動裝配的 bean 的類,可以採用以下註解實現：

• @Component ：通用的註解，可標註任意類為 Spring 組件。如果一個 Bean 不知道屬於哪個層，可以使用@Component 註解標註。
• @Repository : 對應持久層即 Dao 層，主要用於數據庫相關操作。
• @Service : 對應服務層，主要涉及一些複雜的邏輯，需要用到 Dao 層。
• @Controller : 對應 Spring MVC 控制層，主要用戶接受用戶請求並調用 Service 層返回數據給前端頁面。

2.3. @RestController

@RestController註解是@Controller和@ResponseBody的合集,表示這是個控制器 bean,並且是將函數的返回值直 接填入 HTTP 響應體中,是 REST 風格的控制器。

注：現在都是前後端分離，說實話我已經很久沒有用過@Controller。如果你的項目太老了的話，就當我沒說。

單獨使用 @Controller 不加 @ResponseBody的話一般使用在要返回一個視圖的情況，這種情況屬於比較傳統的 Spring MVC 的應用，對應於前後端不分離的情況。@Controller +@ResponseBody 返回 JSON 或 XML 形式數據

2.4. @Scope

聲明 Spring Bean 的作用域，使用方法：

四種常見的 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註解聲明配置類更加語義化。

3. 處理常見的 HTTP 請求類型

5 種常見的請求類型:

• GET ：請求從服務器獲取特定資源。舉個例子：GET /users（獲取所有學生）
• POST ：在服務器上創建一個新的資源。舉個例子：POST /users（創建學生）
• PUT ：更新服務器上的資源（客戶端提供更新後的整個資源）。舉個例子：PUT /users/12（更新編號為 12 的學生）
• DELETE ：從服務器刪除特定的資源。舉個例子：DELETE /users/12（刪除編號為 12 的學生）
• PATCH ：更新服務器上的資源（客戶端提供更改的屬性，可以看做作是部分更新），使用的比較少，這裡就不舉例子了。

3.1. GET 請求

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

3.2. POST 請求

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

關於@RequestBody註解的使用，在下面的“前後端傳值”這塊會講到。

<code>
@PostMapping
(
"/users"
)
public ResponseEntity createUser(
@Valid
 
@RequestBody
 UserCreateRequest userCreateRequest) {
 
return
 
userRespository
.save
(user);
}/<code>

3.3. PUT 請求

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

3.4. DELETE 請求

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

3.5. PATCH 請求

一般實際項目中，我們都是 PUT 不夠用了之後才用 PATCH 請求去更新數據。

<code> 
@PatchMapping
(
"/profile" 
)
  public ResponseEntity updateStudent(
@RequestBody
 StudentUpdateRequest studentUpdateRequest) {
        
studentRepository
.updateDetail
(studentUpdateRequest);
        
return
 
ResponseEntity
.ok
()
.build
();
    }/<code>

4. 前後端傳值

掌握前後端傳值的正確姿勢，是你開始 CRUD 的第一步！

4.1. @PathVariable 和 @RequestParam

@PathVariable用於獲取路徑參數，@RequestParam用於獲取查詢參數。

舉個簡單的例子：

如果我們請求的 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 對象。

我用一個簡單的例子來給演示一下基本使用！

我們有一個註冊的接口：

<code>
@PostMapping
(
"/sign-up"
)
public ResponseEntity signUp(
@RequestBody
 
@Valid
 UserRegisterRequest userRegisterRequest) {
  
userService
.save
(userRegisterRequest);
  
return
 
ResponseEntity
.ok
()
.build 
();
}/<code>

UserRegisterRequest對象：

我們發送 post 請求到這個接口，並且 body 攜帶 JSON 數據：

<code>{
"userName"
:
"coder"
,
"fullName"
:
"shuangkou"
,
"password"
:
"123456"
}/<code> 

這樣我們的後端就可以直接把 json 格式的數據映射到我們的UserRegisterRequest 類上。

需要注意的是：一個請求方法只可以有一個@RequestBody，但是可以有多個@RequestParam和@PathVariable。 如果你的方法必須要用兩個@RequestBody來接受數據的話，大概率是你的數據庫設計或者系統設計出問題了！

5. 讀取配置信息

很多時候我們需要將一些常用的配置信息比如阿里雲 oss、發送短信、微信認證的相關配置信息等等放到配置文件中。

下面我們來看一下 Spring 為我們提供了哪些方式幫助我們從配置文件中讀取這些配置信息。

我們的數據源application.yml內容如下：

<code>
wuhan2020
: 
2020
年初武漢爆發了新型冠狀病毒，疫情嚴重，但是，我相信一切都會過去！武漢加油！中國加油！

my-profile
:
  
name
: Guide哥
  
email
: koushuangbwcx
@163
.com

library
:
  
location
: 湖北武漢加油中國加油
  
books
:
    - 
name
: 天才基本法
      
description
: 二十二歲的林朝夕在父親確診阿爾茨海默病這天，得知自己暗戀多年的校園男神裴之即將出國深造的消息——對方考取的學校，恰是父親當年為她放棄的那所。
    - 
name
: 時間的秩序
       
description
: 為什麼我們記得過去，而非未來？時間“流逝”意味著什麼？是我們存在於時間之內，還是時間存在於我們之中？卡洛·羅韋利用詩意的文字，邀請我們思考這一亙古難題——時間的本質。
    - 
name
: 了不起的我
      
description
: 如何養成一個新習慣？如何讓心智變得更成熟？如何擁有高質量的關係？ 如何走出人生的艱難時刻？/<code>

5.1. @value(常用)

使用 @Value("${property}") 讀取比較簡單的配置信息：

<code> 
String wuhan2020;/<code>

5.2. @ConfigurationProperties(常用)

通過@ConfigurationProperties讀取配置信息並與 bean 綁定。

你可以像使用普通的 Spring bean 一樣，將其注入到類中使用。

5.3. PropertySource（不常用）

@PropertySource讀取指定 properties 文件

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 生成）：

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

6.1. 一些常用的字段驗證的註解

• @NotEmpty 被註釋的字符串的不能為 null 也不能為空
• @NotBlank 被註釋的字符串非 null，並且必須包含一個非空白字符
• @Null 被註釋的元素必須為 null
• @NotNull 被註釋的元素必須不為 null
• @AssertTrue 被註釋的元素必須為 true
• @AssertFalse 被註釋的元素必須為 false
• @Pattern(regex=,flag=)被註釋的元素必須符合指定的正則表達式
• @Email 被註釋的元素必須是 Email 格式。
• @Min(value)被註釋的元素必須是一個數字，其值必須大於等於指定的最小值
• @Max(value)被註釋的元素必須是一個數字，其值必須小於等於指定的最大值
• @DecimalMin(value)被註釋的元素必須是一個數字，其值必須大於等於指定的最小值
• @DecimalMax(value) 被註釋的元素必須是一個數字，其值必須小於等於指定的最大值
• @Size(max=, min=)被註釋的元素的大小必須在指定的範圍內
• @Digits (integer, fraction)被註釋的元素必須是一個數字，其值必須在可接受的範圍內
• @Past被註釋的元素必須是一個過去的日期
• @Future 被註釋的元素必須是一個將來的日期
• ......

6.2. 驗證請求體(RequestBody)

我們在需要驗證的參數上加上了@Valid註解，如果驗證失敗，它將拋出MethodArgumentNotValidException。

6.3. 驗證請求參數(Path Variables 和 Request Parameters)

一定一定不要忘記在類上加上 Validated 註解了，這個參數可以告訴 Spring 去校驗方法參數。

@RestController
@RequestMapping("/api")
@Validated
public class PersonController {
@GetMapping("/person/{id}")
public ResponseEntity getPersonByID(@Valid @PathVariable("id") @Max(value = 5,message = "超過 id 的範圍了") Integer id) {
return ResponseEntity.ok().body(id);
}
}

7. 全局處理 Controller 層異常

介紹一下我們 Spring 項目必備的全局處理 Controller 層異常。

相關注解：

1. @ControllerAdvice :註解定義全局異常處理類
2. @ExceptionHandler :註解聲明異常處理方法

如何使用呢？拿我們在第 5 節參數校驗這塊來舉例子。如果方法參數不對的話就會拋出MethodArgumentNotValidException，我們來處理這個異常。

@ControllerAdvice
@ResponseBody
public class GlobalExceptionHandler {
/**
* 請求參數異常處理
*/
@ExceptionHandler(MethodArgumentNotValidException.class)
public ResponseEntity> handleMethodArgumentNotValidException(MethodArgumentNotValidException ex, HttpServletRequest request) {
......
}
}

8. JPA 相關

8.1. 創建表

@Entity聲明一個類對應一個數據庫實體。

@Table 設置表明

8.2. 創建主鍵

@Id ：聲明一個字段為主鍵。

使用@Id聲明之後，我們還需要定義主鍵的生成策略。我們可以使用 @GeneratedValue 指定主鍵生成策略。

1.通過 @GeneratedValue直接使用 JPA 內置提供的四種主鍵生成策略來指定主鍵生成策略。

<code>
@Id
@GeneratedValue
(strategy = GenerationType.IDENTITY)
private Long id;/<code>

JPA 使用枚舉定義了 4 中常見的主鍵生成策略，如下：

注：枚舉替代常量的一種用法

<code>
public
 
enum
 
GenerationType
 
{

     
    
TABLE
,

     
    
SEQUENCE
,

     
    
IDENTITY
,

     
     
AUTO
}
/<code>

@GeneratedValue註解默認使用的策略是GenerationType.AUTO

一般使用 MySQL 數據庫的話，使用GenerationType.IDENTITY策略比較普遍一點（分佈式系統的話需要另外考慮使用分佈式 ID）。

2.通過 @GenericGenerator聲明一個主鍵策略，然後 @GeneratedValue使用這個策略

等價於：

jpa 提供的主鍵生成策略有如下幾種：

public class DefaultIdentifierGeneratorFactory
implements MutableIdentifierGeneratorFactory, Serializable, ServiceRegistryAwareService {
@SuppressWarnings("deprecation")
public DefaultIdentifierGeneratorFactory() {
register( "uuid2", UUIDGenerator.class );
register( "guid", GUIDGenerator.class ); // can be done with UUIDGenerator + strategy
register( "uuid", UUIDHexGenerator.class ); // "deprecated" for new use
register( "uuid.hex", UUIDHexGenerator.class ); // uuid.hex is deprecated
register( "assigned", Assigned.class );
register( "identity", IdentityGenerator.class );
register( "select", SelectGenerator.class );

register( "sequence", SequenceStyleGenerator.class );
register( "seqhilo", SequenceHiLoGenerator.class );
register( "increment", IncrementGenerator.class );
register( "foreign", ForeignGenerator.class );
register( "sequence-identity", SequenceIdentityGenerator.class );
register( "enhanced-sequence", SequenceStyleGenerator.class );
register( "enhanced-table", TableGenerator.class );
}
public void register(String strategy, Class generatorClass) {
LOG.debugf( "Registering IdentifierGenerator strategy [%s] -> [%s]", strategy, generatorClass.getName() );
final Class previous = generatorStrategyToClassNameMap.put( strategy, generatorClass );
if ( previous != null ) {
LOG.debugf( " - overriding [%s]", previous.getName() );
}
}
}

8.3. 設置字段類型

@Column 聲明字段。

示例：

設置屬性 userName 對應的數據庫字段名為 user_name，長度為 32，非空

設置字段類型並且加默認值，這個還是挺常用的。

8.4. 指定不持久化特定字段

@Transient ：聲明不需要與數據庫映射的字段，在保存的時候不需要保存進數據庫 。

如果我們想讓secrect 這個字段不被持久化，可以使用 @Transient關鍵字聲明。

除了 @Transient關鍵字聲明， 還可以採用下面幾種方法：

一般使用註解的方式比較多。

8.5. 聲明大字段

@Lob:聲明某個字段為大字段。

<code> 
private
 
String
 content;/<code>

更詳細的聲明：

<code>
@Lob
 
@Basic
(fetch = FetchType.EAGER)
 
@Column
(name = 
"content"
, columnDefinition = 
"LONGTEXT NOT NULL"
)
private String content;/<code>

8.6. 創建枚舉類型的字段

可以使用枚舉類型的字段，不過枚舉字段要用@Enumerated註解修飾。

數據庫裡面對應存儲的是 MAIL/FEMAIL。

8.7. 增加審計功能

只要繼承了 AbstractAuditBase的類都會默認加上下面四個字段。

我們對應的審計功能對應地配置類可能是下面這樣的（Spring Security 項目）:

簡單介紹一下上面設計到的一些註解：

1. @CreatedDate: 表示該字段為創建時間時間字段，在這個實體被 insert 的時候，會設置值
2. @CreatedBy :表示該字段為創建人，在這個實體被 insert 的時候，會設置值@LastModifiedDate、@LastModifiedBy同理。

@EnableJpaAuditing：開啟 JPA 審計功能。

8.8. 刪除/修改數據

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

8.9. 關聯關係

• @OneToOne 聲明一對一關係
• @OneToMany 聲明一對多關係
• @ManyToOne聲明多對一關係
• MangToMang聲明多對多關係

9. 事務 @Transactional

在要開啟事務的方法上使用@Transactional註解即可!

我們知道 Exception 分為運行時異常 RuntimeException 和非運行時異常。在@Transactional註解中如果不配置rollbackFor屬性,那麼事物只會在遇到RuntimeException的時候才會回滾,加上rollbackFor=Exception.class,可以讓事物在遇到非運行時異常時也回滾。

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

• 作用於類：當把@Transactional 註解放在類上時，表示所有該類的public 方法都配置相同的事務屬性信息。
• 作用於方法：當類配置了@Transactional，方法也配置了@Transactional，方法的事務會覆蓋類的事務配置信息。

10. json 數據處理

10.1. 過濾 json 數據

@JsonIgnoreProperties 作用在類上用於過濾掉特定字段不返回或者不解析。

@JsonIgnore一般用於類的屬性上，作用和上面的@JsonIgnoreProperties 一樣。

10.2. 格式化 json 數據

@JsonFormat一般用來格式化 json 數據。：

比如：

<code> 
private
 Date date;/<code> 

10.3. 扁平化對象

未扁平化之前：

使用@JsonUnwrapped 扁平對象之後：

11. 測試相關

@ActiveProfiles一般作用於測試類上， 用於聲明生效的 Spring 配置文件。

@Test聲明一個方法為測試方法

@Transactional被聲明的測試方法的數據會回滾，避免汙染測試數據。

@WithMockUser Spring Security 提供的，用來模擬一個真實用戶，並且可以賦予權限。