接近8000字的Spring/SpringBoot經常使用註解總結！安排！

0.前言

你們好，我是 Guide 哥！這是個人 221 篇優質原創文章。如需轉載，請在文首註明地址，蟹蟹！

本文已經收錄進個人 75K Star 的 Java 開源項目 JavaGuide：https://github.com/Snailclimb/JavaGuide 相關閱讀：V2.0 版本的 《JavaGuide面試突擊版》來啦！帶着它的在線閱讀版原本啦！

能夠絕不誇張地說，這篇文章介紹的 Spring/SpringBoot 經常使用註解基本已經涵蓋你工做中遇到的大部分經常使用的場景。對於每個註解我都說了具體用法，掌握搞懂，使用 SpringBoot 來開發項目基本沒啥大問題了！

整個目錄以下，內容有點多：

爲何要寫這篇文章？

最近看到網上有一篇關於 SpringBoot 經常使用註解的文章被轉載的比較多，我看了文章內容以後屬實以爲質量有點低，而且有點會誤導沒有太多實際使用經驗的人（這些人又佔據了大多數）。因此，本身索性花了大概 兩天時間簡單總結一下了。

由於我我的的能力和精力有限，若是有任何不對或者須要完善的地方，請幫忙指出！Guide 哥感激涕零！

1. @SpringBootApplication

這裏先單獨拎出@SpringBootApplication 註解說一下，雖然咱們通常不會主動去使用它。

Guide 哥：這個註解是 Spring Boot 項目的基石，建立 SpringBoot 項目以後會默認在主類加上。

@SpringBootApplication
public class SpringSecurityJwtGuideApplication {
      public static void main(java.lang.String[] args) {
        SpringApplication.run(SpringSecurityJwtGuideApplication.class, args);
    }
}

咱們能夠把 @SpringBootApplication看做是 @Configuration、@EnableAutoConfiguration、@ComponentScan 註解的集合。

package org.springframework.boot.autoconfigure;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = {
        @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
        @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {
   ......
}

package org.springframework.boot;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
public @interface SpringBootConfiguration {

}

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

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

2. Spring Bean 相關

2.1. @Autowired

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

@Service
public class UserService {
  ......
}

@RestController
@RequestMapping("/users")
public class UserController {
   @Autowired
   private UserService userService;
   ......
}

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 風格的控制器。

Guide 哥：如今都是先後端分離，說實話我已經好久沒有用過@Controller。若是你的項目太老了的話，就當我沒說。

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

關於@RestController 和 @Controller的對比，請看這篇文章：@RestController vs @Controller。

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 請求類型

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)

@GetMapping("/users")
public ResponseEntity<List<User>> getAllUsers() {
 return userRepository.findAll();
}

3.2. POST 請求

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

關於@RequestBody註解的使用，在下面的「先後端傳值」這塊會講到。

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

3.3. PUT 請求

@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.4. DELETE 請求

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

@DeleteMapping("/users/{userId}")
public ResponseEntity deleteUser(@PathVariable(value = "userId") Long userId){
  ......
}

3.5. PATCH 請求

通常實際項目中，咱們都是 PUT 不夠用了以後才用 PATCH 請求去更新數據。

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

4. 先後端傳值

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

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;
    @FullName
    @NotBlank
    private String fullName;
}

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

{"userName":"coder","fullName":"shuangkou","password":"123456"}

這樣咱們的後端就能夠直接把 json 格式的數據映射到咱們的 UserRegisterRequest 類上。

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

5. 讀取配置信息

不少時候咱們須要將一些經常使用的配置信息好比阿里雲 oss、發送短信、微信認證的相關配置信息等等放到配置文件中。

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

咱們的數據源application.yml內容以下：：

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

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

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

5.1. @value(經常使用)

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

@Value("${wuhan2020}")
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
  ......
}

更多內容請查看個人這篇文章：《10 分鐘搞定 SpringBoot 如何優雅讀取配置文件？》 。

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 項目須要自行引入相關依賴包，這裏很少作講解，具體能夠查看個人這篇文章：《如何在 Spring/Spring Boot 中作參數校驗？你須要瞭解的都在這裏！》。

👉 須要注意的是： 全部的註解，推薦使用 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)

@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);
    }
}

更多關於如何在 Spring 項目中進行參數校驗的內容，請看《如何在 Spring/Spring Boot 中作參數校驗？你須要瞭解的都在這裏！》這篇文章。

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) {
       ......
    }
}

更多關於 Spring Boot 異常處理的內容，請看個人這兩篇文章：

1. SpringBoot 處理異常的幾種常見姿式
2. 使用枚舉簡單封裝一個優雅的 Spring Boot 全局異常處理！

8. JPA 相關

8.1. 建立表

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

@Table 設置代表

@Entity
@Table(name = "role")
public class Role {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;
    private String description;
    省略getter/setter......
}

8.2. 建立主鍵

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

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

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

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

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

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

public enum GenerationType {

    /**
     * 使用一個特定的數據庫表格來保存主鍵
     * 持久化引擎經過關係數據庫的一張特定的表格來生成主鍵,
     */
    TABLE,

    /**
     *在某些數據庫中,不支持主鍵自增加,好比Oracle、PostgreSQL其提供了一種叫作"序列(sequence)"的機制生成主鍵
     */
    SEQUENCE,

    /**
     * 主鍵自增加
     */
    IDENTITY,

    /**
     *把主鍵生成策略交給持久化引擎(persistence engine),
     *持久化引擎會根據數據庫在以上三種主鍵生成 策略中選擇其中一種
     */
    AUTO
}

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

public @interface GeneratedValue {

    GenerationType strategy() default AUTO;
    String generator() default "";
}

通常使用 MySQL 數據庫的話，使用GenerationType.IDENTITY策略比較廣泛一點（分佈式系統的話須要另外考慮使用分佈式 ID）。

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

@Id
@GeneratedValue(generator = "IdentityIdGenerator")
@GenericGenerator(name = "IdentityIdGenerator", strategy = "identity")
private Long id;

等價於：

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

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，非空

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

設置字段類型而且加默認值，這個仍是挺經常使用的。

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

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

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

若是咱們想讓secrect 這個字段不被持久化，可使用 @Transient關鍵字聲明。

Entity(name="USER")
public class User {

    ......
    @Transient
    private String secrect; // not persistent because of @Transient

}

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

static String secrect; // not persistent because of static
final String secrect = 「Satish」; // not persistent because of final
transient String secrect; // not persistent because of transient

通常使用註解的方式比較多。

8.5. 聲明大字段

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

@Lob
private String content;

更詳細的聲明：

@Lob
//指定 Lob 類型數據的獲取策略， FetchType.EAGER 表示非延遲 加載，而 FetchType. LAZY 表示延遲加載 ；
@Basic(fetch = FetchType.EAGER)
//columnDefinition 屬性指定數據表對應的 Lob 字段類型
@Column(name = "content", columnDefinition = "LONGTEXT NOT NULL")
private String content;

8.6. 建立枚舉類型的字段

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

public enum Gender {
    MALE("男性"),
    FEMALE("女性");

    private String value;
    Gender(String str){
        value=str;
    }
}

@Entity
@Table(name = "role")
public class Role {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;
    private String description;
    @Enumerated(EnumType.STRING)
    private Gender gender;
    省略getter/setter......
}

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

8.7. 增長審計功能

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

@Data
@AllArgsConstructor
@NoArgsConstructor
@MappedSuperclass
@EntityListeners(value = AuditingEntityListener.class)
public abstract class AbstractAuditBase {

    @CreatedDate
    @Column(updatable = false)
    @JsonIgnore
    private Instant createdAt;

    @LastModifiedDate
    @JsonIgnore
    private Instant updatedAt;

    @CreatedBy
    @Column(updatable = false)
    @JsonIgnore
    private String createdBy;

    @LastModifiedBy
    @JsonIgnore
    private String updatedBy;
}

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

@Configuration
@EnableJpaAuditing
public class AuditSecurityConfiguration {
    @Bean
    AuditorAware<String> auditorAware() {
        return () -> Optional.ofNullable(SecurityContextHolder.getContext())
                .map(SecurityContext::getAuthentication)
                .filter(Authentication::isAuthenticated)
                .map(Authentication::getName);
    }
}

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

1. @CreatedDate: 表示該字段爲建立時間時間字段，在這個實體被 insert 的時候，會設置值
2. @CreatedBy :表示該字段爲建立人，在這個實體被 insert 的時候，會設置值

   @LastModifiedDate、@LastModifiedBy同理。

@EnableJpaAuditing：開啓 JPA 審計功能。

8.8. 刪除/修改數據

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

@Repository
public interface UserRepository extends JpaRepository<User, Integer> {

    @Modifying
    @Transactional(rollbackFor = Exception.class)
    void deleteByUserName(String userName);
}

8.9. 關聯關係

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

更多關於 Spring Boot JPA 的文章請看個人這篇文章：一文搞懂如何在 Spring Boot 正確中使用 JPA 。

9. 事務 @Transactional

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

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

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

@Transactional 註解通常用在能夠做用在類或者方法上。

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

更多關於關於 Spring 事務的內容請查看：

1. 多是最漂亮的 Spring 事務管理詳解
2. 一口氣說出 6 種 @Transactional 註解失效場景

10. json 數據處理

10.1. 過濾 json 數據

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

//生成json時將userRoles屬性過濾
@JsonIgnoreProperties({"userRoles"})
public class User {

    private String userName;
    private String fullName;
    private String password;
    @JsonIgnore
    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<>();
}

10.2. 格式化 json 數據

@JsonFormat通常用來格式化 json 數據。：

好比：

@JsonFormat(shape=JsonFormat.Shape.STRING, pattern="yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", timezone="GMT")
private Date date;

10.3. 扁平化對象

@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": "coder1234",
        "fullName": "shaungkou"
    }
}

使用@JsonUnwrapped 扁平對象以後：

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

{
  "provinceName":"湖北",
  "countyName":"武漢",
  "userName": "coder1234",
  "fullName": "shaungkou"
}

11. 測試相關

@ActiveProfiles通常做用於測試類上， 用於聲明生效的 Spring 配置文件。

@SpringBootTest(webEnvironment = RANDOM_PORT)
@ActiveProfiles("test")
@Slf4j
public abstract class TestBase {
  ......
}

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

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

@WithMockUser Spring Security 提供的，用來模擬一個真實用戶，而且能夠賦予權限。

@Test
    @Transactional
    @WithMockUser(username = "user-id-18163138155", authorities = "ROLE_TEACHER")
    void should_import_student_success() throws Exception {
        ......
    }

暫時總結到這裏吧！雖然花了挺長時間才寫完，不過可能仍是會一些經常使用的註解的被漏掉，因此，我將文章也同步到了 Github 上去，Github 地址：https://github.com/Snailclimb/JavaGuide/blob/master/docs/system-design/framework/spring/spring-annotations.md 歡迎完善！

本文已經收錄進個人 75K Star 的 Java 開源項目 JavaGuide：https://github.com/Snailclimb/JavaGuide。