使用Spring MVC编写RESTful Controller

1、Spring对REST的支持

Spring3（这里讨论Spring3.2+）对Spring MVC的一些增强功能为REST提供了良好的支持。Spring对开发REST资源提供以下支持：

1. 操作方式：控制器可以处理所有的HTTP方法，包含4个主要的REST方法：GET、PUT、DELETE以及POST。Spring的表单绑定JSP标签库的<form:form>标签以及新的HiddenHttpMethodFilter，使得通过HTML表单提交的PUT和DELETE请求成为可能
2. 资源标识：新的@PathVariable注解使得控制器能够处理参数化的URL
3. 资源表述方法1：通过使用Spring的视图解析器，资源可以以各种形式进行表述，包括XML、JSON、Atom和RSS（）。使用新的ContentNegotiatingViewResolver来选择最合适客户端的表述
4. 资源表述方法2：通过使用@ResponseBody注解和各种HttpMethodConverter实现来达到。@RequestBody注解记忆HttpMethodConverter实现可以将传入的HTTP数据转化为传入控制器方法的Java对象
5. REST客户端：RestTemplate简化了客户端对REST资源的使用

 2、参数化URL

Spring3.0中引入了新的@PathVariable注解，帮助Controller使用面向资源的方式处理请求。如：

@Controller
@RequestMapping(value="/spitters")
public class SpittleController{
    private SpitterService spitterService;
    ...
    @RequestMapping(value="/{id}", method= RequestMethod.PUT)
    @ResponseStatus(HttpStatus.NO_CONTENT)
    public void putSpittle(@PathVariable("id")) long id,
                           @Valid Spittle spittle)
    {
        spitterService.saveSpittle(spittle);
    }
}

3、协商资源表述

“协商资源表述”即确定一个HTTP请求所需要返回的资源格式，HTML、XML还是JSON等。按优先级，Spring MVC依次通过以下三个条件确定客户端需要什么类型的内容表述：

1. URL路径上添加扩展名，如 http://myserver/myapp/accounts/list.html 或者 http://myserver/myapp/accounts/list.xls。
2. URL参数，如 http://myserver/myapp/accounts/list?format=xls，参数名默认为“format”，但也可以更改。
3. 通过HTTP请求的Accept头部信息确定返回资源格式，但由于客户端的处理不同，这个方法并不太可靠。

JAF（JavaBeans Activation Framework）可提供由扩展名（或URL参数）到资源格式的自动映射机制（如json->"application/json"），这时classpath下必须有activation.jar包。

Spring MVC通过ContentNegotiationManager来进行资源协商，一般配置如下：

<bean id="contentNegotiationManager"
      class="org.springframework.web.accept.ContentNegotiationManagerFactoryBean">
<property name="favorPathExtension" value="false" />
<property name="favorParameter" value="true" />
<property name="parameterName" value="mediaType" />
<property name="ignoreAcceptHeader" value="true"/>
<property name="useJaf" value="false"/>
<property name="defaultContentType" value="application/json" />

<property name="mediaTypes">
    <map>
        <entry key="json" value="application/json" />
        <entry key="xml" value="application/xml" />
    </map>
</property>
</bean>

以上配置表示：不使用路径扩展名方式，也不使用Accept头信息方式，仅使用URL参数方式确定资源类型，URL参数名使用“mediaType”代替默认的“format”，不使用JAF而是自行定义URL参数到资源格式的映射，这里只定义了JSON和XML。

4、表述资源（一）

Spring MVC通过两种方式将Java表述形式的资源转化为发送给客户端的表述形式：

• 基于视图渲染进行协商（@ContentNegotiatingViewResolver）
• HTTP消息转换器（HttpMessageConverters）

首先是第一种方式，使用HttpMessageConverters表述资源。当ContentNegotiationManager配置如下，且类路径下包含JAXB和Jackson包时，Spring MVC将自动匹配使用哪种HttpMessageCoverter。

ContentNegotiationManager配置：

<!-- enable the "produces" annotation of "RequestMapping" -->
<mvc:annotation-driven content-negotiation-manager="contentNegotiationManager" />

<!-- Simple strategy: only path extension is taken into account -->
<bean id="cnManager"
      class="org.springframework.web.accept.ContentNegotiationManagerFactoryBean">
<property name="favorPathExtension" value="true"/>
<property name="ignoreAcceptHeader" value="true" />
<property name="defaultContentType" value="text/html" />
<property name="useJaf" value="false"/>

<property name="mediaTypes">
    <map>
        <entry key="html" value="text/html" />
        <entry key="json" value="application/json" />
        <entry key="xml" value="application/xml" />
    </map>
</property>
</bean>

Controller:

@Controller
class AccountController {
    // RESTful method, use MappingJacksonHttpMessageConverter and Jaxb2RootElementHttpMessageConverter automatically
    //accounts.json -> application/json
    //accounts.xml -> text/xml
    @RequestMapping(value="/accounts", produces={"application/xml", "application/json"})
    @ResponseStatus(HttpStatus.OK)
    public @ResponseBody List<Account> listWithMarshalling(Principal principal) {
        return accountManager.getAccounts(principal);
    }

    // View-based method
    //accounts.html -> text/html
    //accounts.others -> text/html
    @RequestMapping("/accounts")
    public String listWithView(Model model, Principal principal) {
        // Call RESTful method to avoid repeating account lookup logic
        model.addAttribute( listWithMarshalling(principal) );

        // Return the view to use for rendering the response
        return ¨accounts/list¨;
    }
}

 使用 JAXB 和 Jackson时，需要在account类上添加annotation：

/**
 * Represents an account for a member of a financial institution. An account has
 * zero or more {@link Transaction}s and belongs to a {@link Customer}. An aggregate entity.
 */
@Entity
@Table(name = "T_ACCOUNT")
@XmlRootElement
public class Account {

    // data-members omitted ...

    public Account(Customer owner, String number, String type) {
        this.owner = owner;
        this.number = number;
        this.type = type;
    }

    /**
     * Returns the number used to uniquely identify this account.
     */
    @XmlAttribute
    public String getNumber() {
        return number;
    }

    /**
     * Get the account type.
     *
     * @return One of "CREDIT", "SAVINGS", "CHECK".
     */
    @XmlAttribute
    public String getType() {
        return type;
    }

    /**
     * Get the credit-card, if any, associated with this account.
     *
     * @return The credit-card number or null if there isn't one.
     */
    @XmlAttribute
    public String getCreditCardNumber() {
        return StringUtils.hasText(creditCardNumber) ? creditCardNumber : null;
    }

    /**
     * Get the balance of this account in local currency.
     *
     * @return Current account balance.
     */
    @XmlAttribute
    public MonetaryAmount getBalance() {
        return balance;
    }


    /**
     * Returns a single account transaction. Callers should not attempt to hold
     * on or modify the returned object. This method should only be used
     * transitively; for example, called to facilitate reporting or testing.
     *
     * @param name
     *            the name of the transaction account e.g "Fred Smith"
     * @return the beneficiary object
     */
    @XmlElement   // Make these a nested <transactions> element
    public Set<Transaction> getTransactions() {
        return transactions;
    }

    // Setters and other methods ...

}

5、表述资源（二） 

第二种方式，使用视图渲染器（View Resolution）。使用ContentNegotiatingViewResolver和ContentNegotiationManager进行配置：

<!-- View resolver that delegates to other view resolvers based on the content type -->
<bean class="org.springframework.web.servlet.view.ContentNegotiatingViewResolver">
<!-- All configuration is now done by the manager - since Spring V3.2 -->
    <property name="contentNegotiationManager" ref="cnManager"/>
</bean>

<!-- Setup a simple strategy -->
<bean id="cnManager" class="org.springframework.web.accept.ContentNegotiationManagerFactoryBean">
    <property name="ignoreAcceptHeader" value="true"/>
    <property name="defaultContentType" value="text/html" />
</bean>

使用以上配置Spring将根据约定自动查找ViewResolvers，并渲染资源。也可显式配置ViewResolvers：

<bean class="org.springframework.web.servlet.view.ContentNegotiatingViewResolver">
<property name="contentNegotiationManager" ref="cnManager"/>

<!-- Define the view resolvers explicitly -->
<property name="viewResolvers">
    <list>
        <bean class="org.springframework.web.servlet.view.XmlViewResolver">
            <property name="location" value="spreadsheet-views.xml"/>
        </bean>

        <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
            <property name="prefix" value="WEB-INF/views"/>
            <property name="suffix" value=".jsp"/>
        </bean>
    </list>
</property>
</bean>

这样Controller就可以去掉@ResponseBody的Method，只写一个Method了。

6、参考

《Spring in Action 第三版》

Content Negotiation using Spring MVC

Content Negotiation using Views