使用Spring MVC开发Restful Web服务

REST简介

摘自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;
 }

 @Override
 public int hashCode() {
  final int prime = 31;
  int result = 1;
  result = prime * result + id;
  return result;
 }

 @Override
 public 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)
 @ResponseBody
 public 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