1.概述
本文介紹了如何在Spring中設置REST –控制器和HTTP響應代碼,有效負載編組配置和內容協商。
2.在Spring了解REST
Spring框架支持兩種創建RESTful服務的方式:
- 與ModelAndView一起使用MVC
- 使用HTTP消息轉換器
ModelAndView方法較舊,文檔記載得更好,但也很冗長,配置繁重。 它試圖將REST范式轉換為舊模型,但這并非沒有問題。 Spring團隊對此有所了解,并從Spring 3.0開始提供了一流的REST支持。
基于HttpMessageConverter和注釋的新方法輕巧得多,易于實現。 配置是最小的,它為RESTful服務提供了合理的默認值。 但是,它在文檔方面比較新,有點輕松。 更重要的是,參考并不能完全消除兩者之間的區別和權衡取舍。 盡管如此,這是在Spring 3.0之后構建RESTful服務的方式。
3. Java配置
@Configuration
@EnableWebMvc
public class WebConfig{//
}
新的@EnableWebMvc注釋做了很多有用的事情-特別是在REST的情況下,它檢測到類路徑中存在Jackson和JAXB 2,并自動創建并注冊默認的JSON和XML轉換器 。 注釋的功能等效于XML版本:
<mvc:注釋驅動/>
這是一個捷徑,盡管在許多情況下可能有用,但它并不完美。 當需要更復雜的配置時,請刪除注釋并直接擴展WebMvcConfigurationSupport 。
4.測試Spring上下文
從Spring 3.1開始, 我們獲得對@Configuration類的一流測試支持:
@RunWith( SpringJUnit4ClassRunner.class )
@ContextConfiguration( classes = { ApplicationConfig.class, PersistenceConfig.class },loader = AnnotationConfigContextLoader.class )
public class SpringTest{@Testpublic void whenSpringContextIsInstantiated_thenNoExceptions(){// When}
}
只需使用@ContextConfiguration批注指定Java配置類,新的AnnotationConfigContextLoader即可從@Configuration類加載Bean定義。
注意, WebConfig配置類未包含在測試中,因為它需要在未提供的Servlet上下文中運行。
5.控制器
@Controller是RESTful API整個Web層中的中心構件。 出于本文的目的,控制器正在對簡單的REST資源– Foo建模:
@Controller
@RequestMapping( value = "foo" )
class FooController{@AutowiredIFooService service;@RequestMapping( method = RequestMethod.GET )@ResponseBodypublic List< Foo > getAll(){return service.getAll();}@RequestMapping( value = "/{id}", method = RequestMethod.GET )@ResponseBodypublic Foo get( @PathVariable( "id" ) Long id ){return RestPreconditions.checkNotNull( service.getById( id ) );}@RequestMapping( method = RequestMethod.POST )@ResponseStatus( HttpStatus.CREATED )@ResponseBodypublic Long create( @RequestBody Foo entity ){RestPreconditions.checkNotNullFromRequest( entity );return service.create( entity );}@RequestMapping( method = RequestMethod.PUT )@ResponseStatus( HttpStatus.OK )public void update( @RequestBody Foo entity ){RestPreconditions.checkNotNullFromRequest( entity );RestPreconditions.checkNotNull( service.getById( entity.getId() ) );service.update( entity );}@RequestMapping( value = "/{id}", method = RequestMethod.DELETE )@ResponseStatus( HttpStatus.OK )public void delete( @PathVariable( "id" ) Long id ){service.deleteById( id );}}
Controller的實現是非公開的 –這是因為不需要這樣做。 通常,控制器是依賴關系鏈中的最后一個控制器–它從Spring前端控制器( DispathcerServlet )接收HTTP請求,然后簡單地將它們委托給服務層。 如果沒有用例必須通過直接引用來注入或操縱控制器,則我不希望將其聲明為公共。
請求映射很簡單–與任何控制器一樣,映射的實際值以及HTTP 方法都用于確定請求的目標方法。 @ RequestBody將方法的參數綁定到HTTP請求的主體,而@ResponseBody對響應和返回類型執行相同的操作。 它們還確保使用正確的HTTP轉換器對資源進行編組和解組。 盡管也可以使用其他HTTP頭來確定表示形式,但將主要根據Accept頭進行內容協商,以選擇使用哪個活動轉換器。
6.映射HTTP響應代碼
HTTP響應的狀態碼是REST服務最重要的部分之一,因此主題很快就會變得非常復雜。 正確執行這些操作可能會導致或中斷服務。
6.1。 未映射的請求
如果Spring MVC收到沒有映射的請求,則認為該請求不被允許,并向客戶端返回405 METHOD NOT ALLOWED NOT ALLOWED 。 這也是很好的做法,包括允許 HTTP標頭返回一個405到客戶端時,以指定哪些操作是允許的。 這是Spring MVC的標準行為,不需要任何其他配置。
6.2。 有效的映射請求
對于任何確實具有映射的請求,Spring MVC認為該請求有效,如果未指定其他狀態代碼,則響應為200 OK 。 因此,控制器為create , update和delete動作聲明了不同的@ResponseStatus ,但為get聲明了不同的@ResponseStatus ,實際上應該返回默認的200 OK。
6.3。 客戶端錯誤
如果發生客戶端錯誤 ,則會定義自定義異常并將其映射到適當的錯誤代碼。 只需從Web層的任何層拋出這些異常,即可確保Spring在HTTP響應上映射相應的狀態代碼。
@ResponseStatus( value = HttpStatus.BAD_REQUEST )
public class BadRequestException extends RuntimeException{//
}
@ResponseStatus( value = HttpStatus.NOT_FOUND )
public class ResourceNotFoundException extends RuntimeException{//
}
這些例外是REST API的一部分,因此,僅應在與REST相對應的適當層中使用; 例如,如果存在DAO / DAL層,則不應直接使用異常。 還要注意,這些不是經過檢查的異常,而是運行時異常 –與Spring的實踐和習慣用法一致。
6.4。 使用@ExceptionHandler
將自定義異常映射到特定狀態代碼的另一種方法是在控制器中使用@ExceptionHandler批注。 這種方法的問題在于,注釋僅適用于定義了它的控制器,而不適用于整個Spring容器,這意味著需要在每個控制器中分別聲明它。 這很快變得很麻煩,尤其是在具有許多控制器的更復雜的應用程序中。 目前,Spring已解決了一些JIRA問題 ,以解決此限制和其他相關限制: SPR-8124 , SPR-7278 , SPR-8406 。
7.其他Maven依賴項
除了標準Web應用程序所需的spring-webmvc依賴關系之外,我們還需要為REST API設置內容編組和解編組:
<dependencies><dependency><groupId>com.fasterxml.jackson.core</groupId><artifactId>jackson-databind</artifactId><version>${jackson.version}</version></dependency><dependency><groupId>javax.xml.bind</groupId><artifactId>jaxb-api</artifactId><version>${jaxb-api.version}</version><scope>runtime</scope></dependency>
</dependencies><properties><jackson.version>2.2.2</jackson.version><jaxb-api.version>2.2.9</jaxb-api.version>
</properties>
這些庫用于將REST資源的表示形式轉換為JSON或XML 。
8.結論
這篇文章介紹了使用Spring 3.1和基于Java的配置對RESTful服務的配置和實現,并討論了HTTP響應代碼,基本內容協商和封送處理。
在本系列的下一篇文章中,我將重點介紹API的可發現性 ,高級內容協商以及使用資源的其他表示形式 。 同時,檢查github項目 。
翻譯自: https://www.javacodegeeks.com/2011/11/building-restful-web-service-with.html