javascript
使用Spring MVC开发Restful Web服务
摘自Wikipedia: REST風(fēng)格的體系結(jié)構(gòu)由客戶端和服務(wù)器組成。 客戶端向服務(wù)器發(fā)起請(qǐng)求; 服務(wù)器處理請(qǐng)求并返回適當(dāng)?shù)捻憫?yīng)。 請(qǐng)求和響應(yīng)圍繞資源表示的傳遞而構(gòu)建。 資源本質(zhì)上可以是可以解決的任何連貫且有意義的概念。
正如您所閱讀的, Rest體系結(jié)構(gòu)中最重要的事情是資源的存在。 該資源可以是任何可以用全局標(biāo)識(shí)符(在HTTP情況下為URI )標(biāo)識(shí)的內(nèi)容(通常是客戶端請(qǐng)求的必需信息)。 為了操縱這些資源,客戶端使用標(biāo)準(zhǔn)接口(例如HTTP )進(jìn)行通信并交換這些資源的表示形式(使用HTML , XML等等)。 請(qǐng)注意, Rest不會(huì)強(qiáng)迫您使用任何特定的網(wǎng)絡(luò)協(xié)議,也不會(huì)強(qiáng)迫您標(biāo)識(shí)資源。對(duì)于那些從未了解過Rest的人來(lái)說(shuō),對(duì)Rest體系結(jié)構(gòu)的這種描述似乎有些奇怪并且有些復(fù)雜。
RESTful Web服務(wù)是使用HTTP和REST原理實(shí)現(xiàn)的簡(jiǎn)單Web服務(wù)。 URI定義為全局標(biāo)識(shí),通信接口為HTTP,資源表示形式可以為任何有效的Internet媒體類型,例如JSON , XML或YAML 。 可以對(duì)資源執(zhí)行的一組操作取決于HTTP方法,并且是( GET –檢索/列出, PUT –替換/更新, POST –創(chuàng)建和DELETE –刪除)。 工作上的手 讓我們?cè)?strong>Spring MVC的幫助下創(chuàng)建第一個(gè)Rest應(yīng)用程序。 假設(shè)有一個(gè)包含漫畫字符數(shù)據(jù)庫(kù)的應(yīng)用程序,并且您想提供一個(gè)Rest接口,以便客戶端可以按照RESTful策略檢索字符。 首先要做的就是識(shí)別資源。 在這種情況下,很容易“ 一個(gè)字符 ”。 下一步是找到明確確定字符的URI 。 可以在這里應(yīng)用簡(jiǎn)單的事實(shí)規(guī)則。 該規(guī)則建議,在我們的情況下,唯一的URI可以是<host> / <applicationname> / <resourceName> s / <id>來(lái)返回ID為1的( GET )字符,該URI為“ http:// localhost:8080 / RestServer / characters / 1 ”。 如果沒有標(biāo)識(shí)符,則應(yīng)檢索所有字符。 如果使用POST代替GET ,則將插入一個(gè)ID為“ 1”的字符。 最后確定所需的Internet媒體類型 ,在這種情況下沒有關(guān)系,因?yàn)槲覀兺瑫r(shí)實(shí)現(xiàn)了客戶端和服務(wù)器,因此最初將使用XML 。 編碼讓我們從使用Spring MVC模板創(chuàng)建的簡(jiǎn)單Spring MVC應(yīng)用程序開始。 這里沒有什么秘密,您將擁有一個(gè)servlet-context.xml ,其中注冊(cè)了component-scan , 注解驅(qū)動(dòng)和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類。 具有四個(gè)屬性的簡(jiǎn)單POJO 。 使用Jaxb批注將類轉(zhuǎn)換為其XML表示 形式 。 Jaxb允許開發(fā)人員將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中最重要的類“ 控制器 ”。 控制器將負(fù)責(zé)實(shí)施角色資源所需的操作。 在當(dāng)前情況下,僅實(shí)現(xiàn)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);}}第一部分是存儲(chǔ)所有字符的地圖。 我使用這種方法來(lái)不專注于數(shù)據(jù)訪問。 然后,當(dāng)URI是/ characters / {characterId }時(shí)調(diào)用的findCharacter方法。 這是一個(gè)URI模板,是一個(gè)類似URI的字符串,包含一個(gè)或多個(gè)變量名,可以使用@PathVariable批注進(jìn)行訪問。 因此,當(dāng)您訪問/ characters / 1參數(shù)時(shí), characterId綁定為1。
最后一個(gè)重要部分是@ResponseBody批注。 該注釋可以放在方法上,并指示返回類型應(yīng)直接寫到HTTP響應(yīng)主體,而不是放置在Model中 ,或解釋為視圖名稱,這是Spring MVC的標(biāo)準(zhǔn)行為。 因此findCharacter方法返回一個(gè)Character對(duì)象。
這就是您執(zhí)行此代碼的全部,例如,您輸入U(xiǎn)RI http:// localhost:8080 / RestServer / characters / 1 ,輸出(使用RestClient UI )將是:
現(xiàn)在是您想知道的時(shí)候,如果我返回一個(gè)Character對(duì)象,并且輸出是XML ,則object和XML之間的轉(zhuǎn)換在哪里? 如此簡(jiǎn)單,讓我介紹一個(gè)新概念: HttpMessageConverters 。 HttpMessageConverter負(fù)責(zé)從HTTP請(qǐng)求消息轉(zhuǎn)換為對(duì)象,以及從對(duì)象轉(zhuǎn)換為HTTP響應(yīng)主體。 默認(rèn)情況下,接下來(lái)注冊(cè)HttpMessageConverters :
– ByteArrayHttpMessageConverter – StringHttpMessageConverter – ResourceHttpMessageConverter – SourceHttpMessageConverter – XmlAwareHttpMessageConverter – Jaxb2RootElementHttpMessageConverter – MappingJacksonHttpMessageConverter 因此,現(xiàn)在您了解了為什么效果很好。 當(dāng)您返回Character實(shí)例,Jaxb2RootElementHttpMessageConverter使用canWrite方法檢查類包含XmlRootElement將注釋。 如果注釋了類,則調(diào)用write方法。 在這種情況下,將調(diào)用Jaxb marshaller,并返回XML 。 從XML到對(duì)象相同,但使用Jaxb解組器類。 如此簡(jiǎn)單,沒有復(fù)雜的配置,沒有復(fù)雜的映射,沒有不清楚的代碼,您只需要擔(dān)心模型對(duì)象,而不必?fù)?dān)心轉(zhuǎn)換。 但是,讓我介紹一個(gè)變化。 現(xiàn)在,我們要返回JSON而不是返回XML 。 更改并非易事 ,將Jackson庫(kù)添加到pom.xml并將@XmlRootElement更改為@JsonAutoDetect 。 現(xiàn)在MappingJacksonHttpMessageConverter將處理此對(duì)象,并將使用Jackson庫(kù)將Character實(shí)例轉(zhuǎn)換為JSON協(xié)議。 僅更改一行代碼!!! 現(xiàn)在輸出將是:結(jié)論
當(dāng)然,這是一個(gè)非常簡(jiǎn)單的應(yīng)用程序,僅需一個(gè)操作,但是它為您提供了如何使用Spring MVC開發(fā)Restful Web服務(wù)的想法。 使用與GET相同的方法來(lái)編寫所有必需的操作只是時(shí)間問題。
在這一點(diǎn)上,我認(rèn)為我們所有人都得出了相同的結(jié)論。 批注確實(shí)非常強(qiáng)大, Spring MVC非常適合開發(fā)RESTful Web服務(wù)。
下次見...
下載代碼。
參考:在One Jar To Rule Them All博客中, 使用我們的JCG合作伙伴 Alex Soto 使用Spring MVC開發(fā)Restful Web服務(wù) 。
相關(guān)文章 :
- jqGrid,REST,AJAX和Spring MVC集成
- Java RESTful API集成測(cè)試
- 使用Spring 3.1和基于Java的配置構(gòu)建RESTful Web服務(wù),第2部分
- 重審Gson的Android JSON解析
- Tomcat 7上具有RESTeasy JAX-RS的RESTful Web服務(wù)-Eclipse和Maven項(xiàng)目
- Spring3 RESTful Web服務(wù)
- Spring MVC開發(fā)–快速教程
翻譯自: https://www.javacodegeeks.com/2011/12/develop-restful-web-services-using.html
總結(jié)
以上是生活随笔為你收集整理的使用Spring MVC开发Restful Web服务的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 社保卡是银行办的吗?
- 下一篇: 邮政理财宝每天有收益吗?