轉自：【Guide哥】
0.前言
可以毫不誇張地說，這篇文章介紹的 Spring/SpringBoot 常用註解基本已經涵蓋你工作中遇到的大部分常用的場景。對於每一個註解我都說了具體用法，掌握搞懂，使用 SpringBoot 來開發專案基本沒啥大問題了！
為什麼要寫這篇文章？
最近看到網上有一篇關於 SpringBoot 常用註解的文章被轉載的比較多，我看了文章內容之後屬實覺得質量有點低，並且有點會誤導沒有太多實際使用經驗的人（這些人又佔據了大多數）。所以，自己索性花了大概 兩天時間簡單總結一下了。
1. @SpringBootApplication
這裡先單獨拎出@SpringBootApplication 註解說一下，雖然我們一般不會主動去使用它。
這個註解是 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 層異常。
相關注解：
@ControllerAdvice:註解定義全域性異常處理類@ExceptionHandler:註解宣告異常處理方法
如何使用呢？拿我們在第 5 節引數校驗這塊來舉例子。如果方法引數不對的話就會丟擲MethodArgumentNotValidException，我們來處理這個異常。
@ControllerAdvice
@ResponseBody
public class GlobalExceptionHandler {
/**
* 請求引數異常處理
*/
@ExceptionHandler(MethodArgumentNotValidException.class)
public ResponseEntity<?> handleMethodArgumentNotValidException(MethodArgumentNotValidException ex, HttpServletRequest request) {
......
}
}
更多關於 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);
}
}
簡單介紹一下上面設計到的一些註解：
-
@CreatedDate: 表示該欄位為建立時間時間欄位，在這個實體被 insert 的時候，會設定值 -
@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 事務的內容請檢視：
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 {
......
}