接近8000字的Spring/SpringBoot常用注解總結瞬矩！安排！

以下文章來源于公眾號JavaGuide 锋玲，作者Guide哥

可以毫不夸張地說景用，這篇文章介紹的 Spring/SpringBoot 常用注解基本已經(jīng)涵蓋你工作中遇到的大部分常用的場景。對于每一個注解我都說了具體用法嫩絮，掌握搞懂丛肢，使用 SpringBoot 來開發(fā)項目基本沒啥大問題了围肥！

image

為什么要寫這篇文章？

最近看到網(wǎng)上有一篇關于 SpringBoot 常用注解的文章被轉載的比較多蜂怎，我看了文章內(nèi)容之后屬實覺得質量有點低穆刻，并且有點會誤導沒有太多實際使用經(jīng)驗的人（這些人又占據(jù)了大多數(shù)）。所以杠步，自己索性花了大概 兩天時間簡單總結一下了氢伟。

整個目錄如下，內(nèi)容有點多：

image

因為我個人的能力和精力有限幽歼，如果有任何不對或者需要完善的地方朵锣，請幫忙指出！Guide 哥感激不盡甸私！

1. @SpringBootApplication

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

Guide 哥：這個注解是 Spring Boot 項目的基石皇型，創(chuàng)建 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 {

}

根據(jù) SpringBoot 官網(wǎng)，這三個注解的作用分別是：

  • @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 的類,可以采用以下注解實現(xiàn)：

  • @Component ：通用的注解，可標注任意類為 Spring 組件藕畔。如果一個 Bean 不知道屬于哪個層马僻，可以使用@Component 注解標注。
  • @Repository : 對應持久層即 Dao 層注服，主要用于數(shù)據(jù)庫相關操作。
  • @Service : 對應服務層措近，主要涉及一些復雜的邏輯溶弟，需要用到 Dao 層。
  • @Controller : 對應 Spring MVC 控制層瞭郑，主要用戶接受用戶請求并調(diào)用 Service 層返回數(shù)據(jù)給前端頁面辜御。

2.3. @RestController

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

Guide 哥：現(xiàn)在都是前后端分離屈张，說實話我已經(jīng)很久沒有用過@Controller擒权。如果你的項目太老了的話袱巨，就當我沒說。

image

單獨使用 @Controller 不加 @ResponseBody的話一般使用在要返回一個視圖的情況碳抄，這種情況屬于比較傳統(tǒng)的 Spring MVC 的應用愉老，對應于前后端不分離的情況。@Controller +@ResponseBody 返回 JSON 或 XML 形式數(shù)據(jù)

2.4. @Scope

聲明 Spring Bean 的作用域剖效，使用方法:

@Bean
@Scope("singleton")
public Person personSingleton() {
    return new Person();
}

四種常見的 Spring Bean 的作用域：

  • singleton : 唯一 bean 實例嫉入，Spring 中的 bean 默認都是單例的。
  • prototype : 每次請求都會創(chuàng)建一個新的 bean 實例璧尸。
  • request : 每一次 HTTP 請求都會產(chǎn)生一個新的 bean咒林，該 bean 僅在當前 HTTP request 內(nèi)有效。
  • session : 每一次 HTTP 請求都會產(chǎn)生一個新的 bean爷光，該 bean 僅在當前 HTTP session 內(nèi)有效垫竞。

2.5. Configuration

一般用來聲明配置類，可以使用 @Component注解替代蛀序，不過使用Configuration注解聲明配置類更加語義化欢瞪。

@Configuration
public class AppConfig {
    @Bean
    public TransferService transferService() {
        return new TransferServiceImpl();
    }

}

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

5 種常見的請求類型:

  • GET ：請求從服務器獲取特定資源。舉個例子：GET /users（獲取所有學生）
  • POST ：在服務器上創(chuàng)建一個新的資源哼拔。舉個例子：POST /users（創(chuàng)建學生）
  • 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 請求去更新數(shù)據(jù)抒巢。

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

4. 前后端傳值

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

4.1. @PathVariable 和 @RequestParam

@PathVariable用于獲取路徑參數(shù)蛉谜，@RequestParam用于獲取查詢參數(shù)。

舉個簡單的例子：

@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

那么我們服務獲取到的數(shù)據(jù)就是：klassId=123456,type=web崇堵。

4.2. @RequestBody

用于讀取 Request 請求（可能是 POST,PUT,DELETE,GET 請求）的 body 部分并且Content-Type 為 application/json 格式的數(shù)據(jù)型诚，接收到數(shù)據(jù)之后會自動將數(shù)據(jù)綁定到 Java 對象上去。系統(tǒng)會使用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;
}

我們發(fā)送 post 請求到這個接口，并且 body 攜帶 JSON 數(shù)據(jù)：

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

這樣我們的后端就可以直接把 json 格式的數(shù)據(jù)映射到我們的 UserRegisterRequest 類上。

image

?? 需要注意的是：一個請求方法只可以有一個@RequestBody涵紊，但是可以有多個@RequestParam和@PathVariable傍妒。如果你的方法必須要用兩個 @RequestBody來接受數(shù)據(jù)的話，大概率是你的數(shù)據(jù)庫設計或者系統(tǒng)設計出問題了摸柄！

5. 讀取配置信息

很多時候我們需要將一些常用的配置信息比如阿里云 oss颤练、發(fā)送短信、微信認證的相關配置信息等等放到配置文件中塘幅。

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

我們的數(shù)據(jù)源application.yml內(nèi)容如下：：

wuhan2020: 2020年初武漢爆發(fā)了新型冠狀病毒，疫情嚴重电媳，但是踏揣，我相信一切都會過去！武漢加油匾乓！中國加油捞稿！

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

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

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

6. 參數(shù)校驗

數(shù)據(jù)的校驗的重要性就不用說了睹簇，即使在前端對數(shù)據(jù)進行校驗的情況下奏赘，我們還是要對傳入后端的數(shù)據(jù)再進行一遍校驗，避免用戶繞過瀏覽器直接通過一些 HTTP 工具直接向后端請求一些違法數(shù)據(jù)太惠。

JSR(Java Specification Requests） 是一套 JavaBean 參數(shù)校驗的標準志珍，它定義了很多常用的校驗注解，我們可以直接將這些注解加在我們 JavaBean 的屬性上面垛叨，這樣就可以在需要校驗的時候進行校驗了，非常方便！

校驗的時候我們實際用的是 Hibernate Validator 框架嗽元。Hibernate Validator 是 Hibernate 團隊最初的數(shù)據(jù)校驗框架敛纲，Hibernate Validator 4.x 是 Bean Validation 1.0（JSR 303）的參考實現(xiàn)，Hibernate Validator 5.x 是 Bean Validation 1.1（JSR 349）的參考實現(xiàn)剂癌，目前最新版的 Hibernate Validator 6.x 是 Bean Validation 2.0（JSR 380）的參考實現(xiàn)淤翔。

SpringBoot 項目的 spring-boot-starter-web 依賴中已經(jīng)有 hibernate-validator 包，不需要引用相關依賴佩谷。如下圖所示（通過 idea 插件—Maven Helper 生成）：

image

非 SpringBoot 項目需要自行引入相關依賴包旁壮，這里不多做講解。

?? 需要注意的是：所有的注解谐檀，推薦使用 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)被注釋的元素必須是一個數(shù)字，其值必須大于等于指定的最小值
  • @Max(value)被注釋的元素必須是一個數(shù)字溃肪，其值必須小于等于指定的最大值
  • @DecimalMin(value)被注釋的元素必須是一個數(shù)字免胃，其值必須大于等于指定的最小值
  • @DecimalMax(value) 被注釋的元素必須是一個數(shù)字，其值必須小于等于指定的最大值
  • @Size(max=, min=)被注釋的元素的大小必須在指定的范圍內(nèi)
  • @Digits (integer, fraction)被注釋的元素必須是一個數(shù)字惫撰，其值必須在可接受的范圍內(nèi)
  • @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;

}

我們在需要驗證的參數(shù)上加上了@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. 驗證請求參數(shù)(Path Variables 和 Request Parameters)

一定一定不要忘記在類上加上 Validated 注解了扼雏，這個參數(shù)可以告訴 Spring 去校驗方法參數(shù)。

@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 層異常

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

相關注解：

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

如何使用呢呢蛤？拿我們在第 5 節(jié)參數(shù)校驗這塊來舉例子。如果方法參數(shù)不對的話就會拋出MethodArgumentNotValidException棍郎，我們來處理這個異常其障。

@ControllerAdvice
@ResponseBody
public class GlobalExceptionHandler {

    /**
     * 請求參數(shù)異常處理
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<?> handleMethodArgumentNotValidException(MethodArgumentNotValidException ex, HttpServletRequest request) {
       ......
    }
}

8. JPA 相關

8.1. 創(chuàng)建表

@Entity聲明一個類對應一個數(shù)據(jù)庫實體。

@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. 創(chuàng)建主鍵

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

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

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

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

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

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

public enum GenerationType {

    /**
     * 使用一個特定的數(shù)據(jù)庫表格來保存主鍵
     * 持久化引擎通過關系數(shù)據(jù)庫的一張?zhí)囟ǖ谋砀駚砩芍麈I,
     */
    TABLE,

    /**
     *在某些數(shù)據(jù)庫中,不支持主鍵自增長,比如Oracle伯病、PostgreSQL其提供了一種叫做"序列(sequence)"的機制生成主鍵
     */
    SEQUENCE,

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

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

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

public @interface GeneratedValue {

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

一般使用 MySQL 數(shù)據(jù)庫的話，使用GenerationType.IDENTITY策略比較普遍一點（分布式系統(tǒng)的話需要另外考慮使用分布式 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 對應的數(shù)據(jù)庫字段名為 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 ：聲明不需要與數(shù)據(jù)庫映射的字段放案，在保存的時候不需要保存進數(shù)據(jù)庫 。

如果我們想讓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 類型數(shù)據(jù)的獲取策略舰始， FetchType.EAGER 表示非延遲 加載丸卷，而 FetchType. LAZY 表示延遲加載 ；
@Basic(fetch = FetchType.EAGER)
//columnDefinition 屬性指定數(shù)據(jù)表對應的 Lob 字段類型
@Column(name = "content", columnDefinition = "LONGTEXT NOT NULL")
private String content;

8.6. 創(chuàng)建枚舉類型的字段

可以使用枚舉類型的字段萎坷，不過枚舉字段要用@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......
}

數(shù)據(jù)庫里面對應存儲的是 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: 表示該字段為創(chuàng)建時間時間字段偶惠，在這個實體被 insert 的時候，會設置值

  2. @CreatedBy :表示該字段為創(chuàng)建人谢床，在這個實體被 insert 的時候厘线，會設置值

    @LastModifiedDate、@LastModifiedBy同理渡讼。

@EnableJpaAuditing：開啟 JPA 審計功能成箫。

8.8. 刪除/修改數(shù)據(jù)

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

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

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

8.9. 關聯(lián)關系

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

9. 事務 @Transactional

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

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

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

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

  • 作用于類：當把@Transactional 注解放在類上時辈末，表示所有該類的public 方法都配置相同的事務屬性信息败潦。
  • 作用于方法：當類配置了@Transactional劫扒，方法也配置了@Transactional，方法的事務會覆蓋類的事務配置信息添怔。

10. json 數(shù)據(jù)處理

10.1. 過濾 json 數(shù)據(jù)

@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 數(shù)據(jù)

@JsonFormat一般用來格式化 json 數(shù)據(jù)购桑。：

比如：

@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被聲明的測試方法的數(shù)據(jù)會回滾阳惹，避免污染測試數(shù)據(jù)。

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

    @Test
    @Transactional
    @WithMockUser(username = "user-id-18163138155", authorities = "ROLE_TEACHER")
    void should_import_student_success() throws Exception {
        ......
    }
?著作權歸作者所有,轉載或內(nèi)容合作請聯(lián)系作者
  • 人面猴
    序言：七十年代末，一起剝皮案震驚了整個濱河市沽翔，隨后出現(xiàn)的幾起案子仅偎，更是在濱河造成了極大的恐慌，老刑警劉巖窗轩，帶你破解...
    沈念sama閱讀 221,198評論 6贊 514
  • 死咒
    序言：濱河連續(xù)發(fā)生了三起死亡事件痢艺，死亡現(xiàn)場離奇詭異，居然都是意外死亡色建，警方通過查閱死者的電腦和手機舌缤，發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,334評論 3贊 398
  • 救了他兩次的神仙讓他今天三更去死
    文/潘曉璐 我一進店門友驮，熙熙樓的掌柜王于貴愁眉苦臉地迎上來卸留，“玉大人椭豫，你說我怎么就攤上這事赏酥。” “怎么了框都？”我有些...
    開封第一講書人閱讀 167,643評論 0贊 360
  • 道士緝兇錄：失蹤的賣姜人
    文/不壞的土叔 我叫張陵魏保，是天一觀的道長摸屠。 經(jīng)常有香客問我，道長檩咱，這世上最難降的妖魔是什么胯舷？ 我笑而不...
    開封第一講書人閱讀 59,495評論 1贊 296
  • ?港島之戀（遺憾婚禮）
    正文 為了忘掉前任桑嘶，我火速辦了婚禮不翩，結果婚禮上麻裳，老公的妹妹穿的比我還像新娘津坑。我一直安慰自己傲霸，他們只是感情好，可當我...
    茶點故事閱讀 68,502評論 6贊 397
  • 惡毒庶女頂嫁案：這布局不是一般人想出來的
    文/花漫 我一把揭開白布。 她就那樣靜靜地躺著梳凛，像睡著了一般韧拒。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上塑悼，一...
    開封第一講書人閱讀 52,156評論 1贊 308
  • 城市分裂傳說
    那天厢蒜，我揣著相機與錄音烹植，去河邊找鬼刊橘。 笑死，一個胖子當著我的面吹牛攒庵，可吹牛的內(nèi)容都是我干的败晴。 我是一名探鬼主播尖坤，決...
    沈念sama閱讀 40,743評論 3贊 421
  • 雙鴛鴦連環(huán)套：你想象不到人心有多黑
    文/蒼蘭香墨 我猛地睜開眼慢味，長吁一口氣：“原來是場噩夢啊……” “哼墅冷！你這毒婦竟也來了寞忿？” 一聲冷哼從身側響起顶岸，我...
    開封第一講書人閱讀 39,659評論 0贊 276
  • 萬榮殺人案實錄
    序言：老撾萬榮一對情侶失蹤辖佣，失蹤者是張志新（化名）和其女友劉穎，沒想到半個月后杯拐，有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體世蔗，經(jīng)...
    沈念sama閱讀 46,200評論 1贊 319
  • ?護林員之死
    正文 獨居荒郊野嶺守林人離奇死亡凸郑，尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,282評論 3贊 340
  • ?白月光啟示錄
    正文 我和宋清朗相戀三年芙沥，在試婚紗的時候發(fā)現(xiàn)自己被綠了而昨。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片找田。...
    茶點故事閱讀 40,424評論 1贊 352
  • 活死人
    序言：一個原本活蹦亂跳的男人離奇死亡墩衙，死狀恐怖漆改，靈堂內(nèi)的尸體忽然破棺而出，到底是詐尸還是另有隱情去扣，我是刑警寧澤樊破，帶...
    沈念sama閱讀 36,107評論 5贊 349
  • ?日本核電站爆炸內(nèi)幕
    正文 年R本政府宣布，位于F島的核電站艾岂，受9級特大地震影響档押，放射性物質發(fā)生泄漏令宿。R本人自食惡果不足惜，卻給世界環(huán)境...
    茶點故事閱讀 41,789評論 3贊 333
  • 男人毒藥：我在死后第九天來索命
    文/蒙蒙 一筛婉、第九天 我趴在偏房一處隱蔽的房頂上張望爽撒。 院中可真熱鬧响蓉，春花似錦、人聲如沸源武。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,264評論 0贊 23
  • 一樁弒父案闹究，背后竟有這般陰謀
    文/蒼蘭香墨 我抬頭看了看天上的太陽食店。三九已至，卻和暖如春砂代，著一層夾襖步出監(jiān)牢的瞬間率挣，已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,390評論 1贊 271
  • 情欲美人皮
    我被黑心中介騙來泰國打工智什， 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留荠锭，地道東北人晨川。 一個月前我還...
    沈念sama閱讀 48,798評論 3贊 376
  • 代替公主和親
    正文 我出身青樓共虑，卻偏偏與公主長得像，于是被迫代替她去往敵國和親拥坛。 傳聞我的和親對象是個殘疾皇子尘分，可洞房花燭夜當晚...
    茶點故事閱讀 45,435評論 2贊 359