javascript
使用Spring MVC开发Restful Web服务
摘自Wikipedia: REST風格的體系結構由客戶端和服務器組成。 客戶端向服務器發起請求; 服務器處理請求并返回適當的響應。 請求和響應圍繞資源表示的傳遞而構建。 資源本質上可以是可以解決的任何連貫且有意義的概念。
正如您所閱讀的, Rest體系結構中最重要的事情是資源的存在。 該資源可以是任何可以用全局標識符(在HTTP情況下為URI )標識的內容(通常是客戶端請求的必需信息)。 為了操縱這些資源,客戶端使用標準接口(例如HTTP )進行通信并交換這些資源的表示形式(使用HTML , XML等等)。 請注意, Rest不會強迫您使用任何特定的網絡協議,也不會強迫您標識資源。對于那些從未了解過Rest的人來說,對Rest體系結構的這種描述似乎有些奇怪并且有些復雜。
RESTful Web服務是使用HTTP和REST原理實現的簡單Web服務。 URI定義為全局標識,通信接口為HTTP,資源表示形式可以為任何有效的Internet媒體類型,例如JSON , XML或YAML 。 可以對資源執行的一組操作取決于HTTP方法,并且是( GET –檢索/列出, PUT –替換/更新, POST –創建和DELETE –刪除)。 工作上的手 讓我們在Spring MVC的幫助下創建第一個Rest應用程序。 假設有一個包含漫畫字符數據庫的應用程序,并且您想提供一個Rest接口,以便客戶端可以按照RESTful策略檢索字符。 首先要做的就是識別資源。 在這種情況下,很容易“ 一個字符 ”。 下一步是找到明確確定字符的URI 。 可以在這里應用簡單的事實規則。 該規則建議,在我們的情況下,唯一的URI可以是<host> / <applicationname> / <resourceName> s / <id>來返回ID為1的( GET )字符,該URI為“ http:// localhost:8080 / RestServer / characters / 1 ”。 如果沒有標識符,則應檢索所有字符。 如果使用POST代替GET ,則將插入一個ID為“ 1”的字符。 最后確定所需的Internet媒體類型 ,在這種情況下沒有關系,因為我們同時實現了客戶端和服務器,因此最初將使用XML 。 編碼讓我們從使用Spring MVC模板創建的簡單Spring MVC應用程序開始。 這里沒有什么秘密,您將擁有一個servlet-context.xml ,其中注冊了component-scan , 注解驅動和InternalResourceViewResolver 。 <?xml version="1.0" encoding="UTF-8" ?> <beans:beans xmlns="http://www.springframework.org/schema/mvc" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:beans="http://www.springframework.org/schema/beans" xmlns:context="http://www.springframework.org/schema/context" xmlns:util="http://www.springframework.org/schema/util" xsi:schemaLocation="http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-3.0.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd"><!-- DispatcherServlet Context: defines this servlet's request-processing infrastructure --> <!-- Enables the Spring MVC @Controller programming model --> <annotation-driven /> <!-- Resolves views selected for rendering by @Controllers to .jsp resources in the /WEB-INF/views directory --> <beans:bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"><beans:property name="prefix" value="/WEB-INF/views/" /> <beans:property name="suffix" value=".jsp" /> </beans:bean><context:component-scan base-package="org.springframework.rest" /> </beans:beans>
下一步是定義Character類。 具有四個屬性的簡單POJO 。 使用Jaxb批注將類轉換為其XML表示 形式 。 Jaxb允許開發人員將Java類映射到XML表示,反之亦然。
package org.springframework.rest;import java.net.URL;import org.codehaus.jackson.annotate.JsonAutoDetect;@XmlRootElement public final class Character {private int id;private String name;private boolean isHuman;private URL characterUrl;protected Character() {}public Character(int id, String name, boolean isHuman, URL characterUrl) {super();this.id = id;this.name = name;this.isHuman = isHuman;this.characterUrl = characterUrl;}public int getId() {return id;}public void setId(int id) {this.id = id;}public String getName() {return name;}public void setName(String name) {this.name = name;}public boolean isHuman() {return isHuman;}public void setHuman(boolean isHuman) {this.isHuman = isHuman;}public URL getCharacterUrl() {return characterUrl;}public void setCharacterUrl(URL characterUrl) {this.characterUrl = characterUrl;}@Overridepublic int hashCode() {final int prime = 31;int result = 1;result = prime * result + id;return result;}@Overridepublic boolean equals(Object obj) {if (this == obj)return true;if (obj == null)return false;if (getClass() != obj.getClass())return false;Character other = (Character) obj;if (id != other.id)return false;return true;}}最后是Spring MVC中最重要的類“ 控制器 ”。 控制器將負責實施角色資源所需的操作。 在當前情況下,僅實現GET ,其他操作將類似。 讓我們看一下代碼:
@Controller public class HomeController {private static final Map<Integer, Character> characters = new HashMap<Integer, Character>();static {try {characters.put(1, new Character(1, "Totoro", false, new URL("http://animeonly.org/albums/VISINAUJI/EGIO/fourth/Mon-Voisin-Totoro/normal_totoro_001.jpg")));characters.put(2, new Character(2, "Satsuki Kusakabe", true, new URL("http://profile.ak.fbcdn.net/hprofile-ak-ash2/48980_1802552968_7286_n.jpg")));characters.put(3, new Character(3, "Therru", false, new URL("http://28.media.tumblr.com/tumblr_lj4ctjKA8Y1qdvyqpo1_400.jpg")));} catch (MalformedURLException e) {e.printStackTrace();}}/*** Simply selects the home view to render by returning its name.*/@RequestMapping(value = "/characters/{characterId}", method = RequestMethod.GET)@ResponseBodypublic Character findCharacter(@PathVariable int characterId) {return characters.get(characterId);}}第一部分是存儲所有字符的地圖。 我使用這種方法來不專注于數據訪問。 然后,當URI是/ characters / {characterId }時調用的findCharacter方法。 這是一個URI模板,是一個類似URI的字符串,包含一個或多個變量名,可以使用@PathVariable批注進行訪問。 因此,當您訪問/ characters / 1參數時, characterId綁定為1。
最后一個重要部分是@ResponseBody批注。 該注釋可以放在方法上,并指示返回類型應直接寫到HTTP響應主體,而不是放置在Model中 ,或解釋為視圖名稱,這是Spring MVC的標準行為。 因此findCharacter方法返回一個Character對象。
這就是您執行此代碼的全部,例如,您輸入URI http:// localhost:8080 / RestServer / characters / 1 ,輸出(使用RestClient UI )將是:
現在是您想知道的時候,如果我返回一個Character對象,并且輸出是XML ,則object和XML之間的轉換在哪里? 如此簡單,讓我介紹一個新概念: HttpMessageConverters 。 HttpMessageConverter負責從HTTP請求消息轉換為對象,以及從對象轉換為HTTP響應主體。 默認情況下,接下來注冊HttpMessageConverters :
– ByteArrayHttpMessageConverter – StringHttpMessageConverter – ResourceHttpMessageConverter – SourceHttpMessageConverter – XmlAwareHttpMessageConverter – Jaxb2RootElementHttpMessageConverter – MappingJacksonHttpMessageConverter 因此,現在您了解了為什么效果很好。 當您返回Character實例,Jaxb2RootElementHttpMessageConverter使用canWrite方法檢查類包含XmlRootElement將注釋。 如果注釋了類,則調用write方法。 在這種情況下,將調用Jaxb marshaller,并返回XML 。 從XML到對象相同,但使用Jaxb解組器類。 如此簡單,沒有復雜的配置,沒有復雜的映射,沒有不清楚的代碼,您只需要擔心模型對象,而不必擔心轉換。 但是,讓我介紹一個變化。 現在,我們要返回JSON而不是返回XML 。 更改并非易事 ,將Jackson庫添加到pom.xml并將@XmlRootElement更改為@JsonAutoDetect 。 現在MappingJacksonHttpMessageConverter將處理此對象,并將使用Jackson庫將Character實例轉換為JSON協議。 僅更改一行代碼!!! 現在輸出將是:結論
當然,這是一個非常簡單的應用程序,僅需一個操作,但是它為您提供了如何使用Spring MVC開發Restful Web服務的想法。 使用與GET相同的方法來編寫所有必需的操作只是時間問題。
在這一點上,我認為我們所有人都得出了相同的結論。 批注確實非常強大, Spring MVC非常適合開發RESTful Web服務。
下次見...
下載代碼。
參考:在One Jar To Rule Them All博客中, 使用我們的JCG合作伙伴 Alex Soto 使用Spring MVC開發Restful Web服務 。
相關文章 :
- jqGrid,REST,AJAX和Spring MVC集成
- Java RESTful API集成測試
- 使用Spring 3.1和基于Java的配置構建RESTful Web服務,第2部分
- 重審Gson的Android JSON解析
- Tomcat 7上具有RESTeasy JAX-RS的RESTful Web服務-Eclipse和Maven項目
- Spring3 RESTful Web服務
- Spring MVC開發–快速教程
翻譯自: https://www.javacodegeeks.com/2011/12/develop-restful-web-services-using.html
總結
以上是生活随笔為你收集整理的使用Spring MVC开发Restful Web服务的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 社保卡是银行办的吗?
- 下一篇: 使用Spring 3引导Web应用程序