如何全局定製Spring Data REST資源的集合資源rel和路徑？

Question

基礎上的樣本項目https://spring.io/guides/gs/accessing-data-rest/https://github.com/jcoig/gs-accessing-data-rest）我有庫定義如下：

@RepositoryRestResource 
public interface PersonRepository extends PagingAndSortingRepository<Person, Long> { 
    List<Person> findByLastName(@Param("name") String name); 
} 

這樣定義的庫通過http://localhost:8080/persons可用並且反應是：

{ 
    "_links" : { 
    "self" : { 
     "href" : "http://localhost:8080/persons{?page,size,sort}", 
     "templated" : true 
    }, 
    "search" : { 
     "href" : "http://localhost:8080/persons/search" 
    } 
    }, 
    "_embedded" : { 
    "persons" : [ { 
     "firstName" : "John", 
     "lastName" : "Smith", 
     "_links" : { 
     "self" : { 
      "href" : "http://localhost:8080/persons/1" 
     } 
     } 
    } ] 
    }, 
    "page" : { 
    "size" : 20, 
    "totalElements" : 1, 
    "totalPages" : 1, 
    "number" : 0 
    } 
} 

我不想在URL中有persons，我不想讓persons作爲返回的JSON中的關鍵字。當然，我也確定我的倉庫如下：

@RepositoryRestResource(collectionResourceRel = "key", path = "path") 
public interface PersonRepository extends PagingAndSortingRepository<Person, Long> { 
    List<Person> findByLastName(@Param("name") String name); 
} 

但我的問題是如何改變默認的Spring的行爲，得到了自定義鍵和自定義路徑提供商（就像例如禁用s後綴）。

Answer 1

讓我們確保我們首先想要實現的目標：Spring Data REST公開了兩種主要資源：集合資源和項目資源。爲了能夠區分兩者，我們需要兩個不同的關係名稱。因此，默認情況下，Spring Data REST使用項目資源rel和Evo Inflector庫的非大寫域名類來複用項目資源rel並將其用作集合關係名稱（實際上您非正式地描述爲添加後綴）。

如果您手動排除Evo Inflector庫，則Spring Data REST將回退到${itemRel}List以收集關係，首先比使用正確複數名稱更笨拙。

正如您已經發現的那樣，您可以手動配置要用於每個存儲庫的名稱。 但是，將收集資源rel配置爲項目資源rel是一個非常糟糕的主意，因爲這會阻止客戶端區分這兩種資源類型。

假設你走了這麼遠讀，還是要部署在全球範圍內改變了類型的關係名就可以實現自定義策略RelProvider（參見實施例EvoInflectorRelProvider或DefaultRelProvider）。如果您將該實現註冊爲Spring bean。

@Configuration 
class MyConfig { 

    @Bean 
    YourCustomRelProvider customRelProvider() { 
    return new YourCustomRelProvider(…); 
    } 
} 

您可能想實驗的執行順序（見@Order或Ordered接口），以確保您的自定義提供選擇有利於註冊的默認的的。

Answer 2

如果定製RelProvider例如施加@Order(value = Ordered.HIGHEST_PRECEDENCE)的解決方案是行不通以下解決方法可能會有所幫助：

@Configuration 
@Import(RepositoryRestMvcConfiguration.class) 
public class RestMvcConfigurer extends RepositoryRestMvcConfiguration 
{ 
... 
@Override 
public ResourceMappings resourceMappings() 
{ 

    final Repositories repositories = repositories(); 
    final RepositoryRestConfiguration config = config(); 
    return new RepositoryResourceMappings(config, repositories, new YourCustomRelProvider()); 
} 
} 

而且我必須排除evo-inflector從classpath：

<dependency> 
     <groupId>org.springframework.boot</groupId> 
     <artifactId>spring-boot-starter-data-rest</artifactId> 
     <exclusions> 
      <exclusion> 
       <groupId>org.atteo</groupId> 
       <artifactId>evo-inflector</artifactId> 
      </exclusion> 
     </exclusions> 
    </dependency> 

不是一個真正的很好的解決方案，但它適用於我的設置。