上一篇我們介紹了使用Spring Data REST時的一些高階特性，以及使用程式碼演示瞭如何使用這些高階的特性。本文將繼續講解前面我們列出來的七個高階特性中的後四個。至此，這些特效能滿足我們大部分的介面開發場景。

需要滿足的一些要求：
1.針對欄位級別，方法級別，類級別進行限制（禁止某些欄位，方法，介面的對外對映）。
2.對資料增刪改查的限制（禁止某些請求方法的訪問）。
3.能個性化定義請求的路徑。
4.對所傳引數進行值校驗。
5.響應統一處理。
6.異常處理。
7.資料處理的切面。

➡️本文，將演示7個要求中的其餘四個要求。

---

對所傳引數進行值校驗

對於值校驗，Spring 提供了Validator介面，Spring Data REST提供了使用Validator來進行值校驗的功能。

首先我們通過實現Validator介面來建立一個校驗器，然後在實現RepositoryRestConfigurer或Spring Data REST的RepositoryRestConfigurerAdapter的子類的配置中，重寫configureValidatingRepositoryEventListener方法，並在ValidatingRepositoryEventListener上呼叫addValidator，傳遞要觸發此校驗器的事件和校驗器的例項。以下示例顯示瞭如何執行此操作：

public class SaveTenantValidator implements Validator {
    @Override
    public boolean supports(Class<?> clazz) {
        return Tenant.class.isAssignableFrom(clazz);
    }

    @Override
    public void validate(Object target, Errors errors) {
        Tenant tenant = (Tenant) target;
        if (StringUtils.isEmpty(tenant.getMobile())) {
            errors.rejectValue("mobile", "1001", "手機號不能為空");
        }
    }
}

 

如上，我們聲明瞭一個Validator類，作為對手機號校驗的Validator。接著我們通過以下程式碼註冊我們的校驗器。

@Component
public class SpringDataRestCustomization implements RepositoryRestConfigurer {
    @Override
    public void configureValidatingRepositoryEventListener(ValidatingRepositoryEventListener validatingListener) {
        validatingListener.addValidator("beforeCreate", new SaveTenantValidator());
    }
}
 

validatingListener.addValidator("beforeCreate", new SaveTenantValidator());我們使用validatingListener.addValidator()來註冊我們的校驗器。該方法傳入兩個引數，第一個代表著要校驗的事件，"beforeCreate"即代表著在插入新紀錄之前，對插入資料進行校驗。spring Data REST還提供了其他的事件：

• BeforeCreateEvent
• AfterCreateEvent
• BeforeSaveEvent
• AfterSaveEvent
• BeforeLinkSaveEvent
• AfterLinkSaveEvent
• BeforeDeleteEvent
• AfterDeleteEvent

我們都可以從字面意思進行理解。

方法中的第二個引數，就是指定我們要註冊的校驗器，如上程式碼中，我們對我們剛剛建立的校驗器進行註冊。

如下為驗證效果：

---

響應統一處理

有時候我們需要對響應結果進行統一處理，比如，我們希望我們的響應結果中包含當前時間的時間戳又或者我們希望我們的HAL格式的響應資料中增加其他的連結。這時候，我們可以通過響應統一處理來完成這種看似重複性的工作。但是Spring Data REST並沒有提供現成的功能，不過我們可以通過覆蓋Spring Data REST響應處理程式，來實現這一目標。

@RepositoryRestController
public class TenantController {
    private final TenantRepository tenantRepository;
		@Resource
    private RepositoryEntityLinks entityLinks;
    @Autowired
    public TenantController(TenantRepository tenantRepository) {
        this.tenantRepository = tenantRepository;
    }

    @GetMapping(value = "/tenantPath/search/mobile")
    public ResponseEntity<?> getByMobile(@RequestParam String mobile) {
        Tenant tenant = tenantRepository.findFirstByMobile(mobile);
        EntityModel<Tenant> resource = new EntityModel<>(tenant);
        resource.add(linkTo(methodOn(TenantController.class).getByMobile(mobile)).withSelfRel());
      resource.add(entityLinks.linkToSearchResource(Tenant.class, LinkRelation.of("findAllByIdCardContaining")));
        return ResponseEntity.ok(resource);
    }
}

如上程式碼，我們使用了@RepositoryRestController註解來建立了一個控制器，並定義了一個路徑的請求，以此我們覆蓋了之前Spring Data REST自動為我們提供的相同路徑的介面。我們給介面的響應增加了兩個連結。

注意：上述程式碼中用到了Spring HATEOAS的庫，所以我們需要增加Spring HATEOAS的依賴。

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-hateoas</artifactId>
</dependency>
<dependency>
  <groupId>org.atteo</groupId>
  <artifactId>evo-inflector</artifactId>
</dependency>

現在我們訪問http://localhost:8080/tenantPath/search/mobile?mobile=186****3331,看到響應結果：

{
  "name": "王一",
  "mobile": "186****3331",
  "rentDateTime": "2020-04-22 17:48:40",
  "_links": {
    "self": {
      "href": "http://localhost:8080/tenantPath/search/mobile?mobile=186****3331"
    },
    "findAllByIdCardContaining": {
      "href": "http://localhost:8080/tenantPath/search/findAllByIdCardContaining{?idCard,page,size,sort,projection}",
      "templated": true
    }
  }
}

可以看到，links屬性中連結已經變成我們指定的連結了。

---

異常統一處理

Spring Data REST中並沒有提供異常處理的功能，但是我們可以使用Springboot中自帶的異常處理功能來實現我們的要求。

@Slf4j
@ControllerAdvice
public class ExceptionTranslator {
    @ExceptionHandler
    public ResponseEntity<Object> handleEmailAlreadyUsedException(NullPointerException ex, NativeWebRequest request) {
        log.info("遇到空指標");
        return ResponseEntity.ok(List.of("攔截到空指標異常"));
    }
}

如上，我們聲明瞭一個異常處理器。接下來我人為製造一個錯誤。

@RepositoryRestController
public class TenantController {
    private final TenantRepository tenantRepository;

    @Autowired
    public TenantController(TenantRepository tenantRepository) {
        this.tenantRepository = tenantRepository;
    }

    @GetMapping(value = "/tenantPath/search/mobile")
    public ResponseEntity<?> getByMobile(@RequestParam String mobile) {
      	if (1 == 1) {
           throw new NullPointerException();
        }
        Tenant tenant = tenantRepository.findFirstByMobile(mobile);
        EntityModel<Tenant> resource = new EntityModel<>(tenant);
        resource.add(linkTo(methodOn(TenantController.class).getByMobile(mobile)).withSelfRel());
        return ResponseEntity.ok(resource);
    }
}

此時，我們請求此介面：

[
  "攔截到空指標異常"
]

可以看到，我們的異常被我們的異常處理器攔截掉了。

---

資料切面處理

Spring Data REST提供了類似的Aop切面操作，雖然不能和Spring的原生aop相比，但是其簡潔性也能滿足需求。Spring Data REST提供的是基於事件的切面。如下我們聲明瞭一個切面。

@Component
@Slf4j
@RepositoryEventHandler
public class TenantEventHandler {
    @HandleBeforeDelete
    protected void onBeforeDelete(Tenant entity) {
        log.info("現在要開始刪除操作了，刪除物件:{}", entity);
    }
    @HandleAfterDelete
    protected void onAfterDelete(Tenant entity) {
        log.info("刪除物件完成，刪除物件:{}", entity);
    }

}

如上，我們聲明瞭一個切面，我們可以在刪除操作之前和之後進行額外的邏輯處理，示例中很簡單，我們使用日誌記錄事件的發生。

此時，我們訪問專案的刪除介面curl --location --request DELETE 'http://localhost:8080/tenantPath/1'

我們可以看到控制輸出了相應的日誌：

2020-04-23 17:26:29.950 INFO 38077 --- [nio-8080-exec-1] c.e.d.configuration.TenantEventHandler : 現在要開始刪除操作了，刪除物件:Tenant(id=1, name=王一, idCard=3305221, mobile=1863331, rentDateTime=2020-04-22T17:24:46.105897, house=House(id=2, houseNumber=1101, owner=張三, idCard=3305211))

2020-04-23 17:26:30.035 INFO 38077 --- [nio-8080-exec-1] c.e.d.configuration.TenantEventHandler : 刪除物件完成，刪除物件:Tenant(id=1, name=王一, idCard=3305221, mobile=1863331, rentDateTime=2020-04-22T17:24:46.105897, house=House(id=2, houseNumber=1101, owner=張三, idCard=3305211))

此時，我們的資料切面處理生效了，除此之外，Spring Data REST還提供瞭如下幾個基於事件的切面：

---

總結

至此，我們先前列出的所有功能特性三篇文章中都有涉及到，通過引入這些功能特性，我們能更加輕鬆的使用Spring Data REST，並且也能滿足我們大部分介面開發的場景。當然三篇文章不能涉及Spring Data REST的全部，有興趣的小夥伴可以訪問Spring Data REST的官方文件檢視更多關於Spring Data REST的特性及資訊。

---

關注筆者公眾號，推送各類原創/優質技術文章 ⬇️

相關推薦