Marshal's Blog

在spring web项目中使用json视图

在在gwt json中使用复杂结构的对象及相关日志中，尝试了在gwt中使用json数据。那么如何通过服务器端生成json数据呢？

因为以前一直使用spring和spring web框架，因此希望有一种办法，可以集成到spring中生成json视图。

比较成熟的办法是，使用spring-json view，见：

http://spring-json.sourceforge.net/

在试用该api时出现了一些问题，比如war示例文件下载不全，缺少最新版本的maven支持等，其实这些都不是什么大问题。

spring-json比较复杂，和spring 3.0中的REST方式使用json比较起来。因此，决定直接升级使用spring3.0的json支持。

写了一个极为简单的示例，说明json的部署和调用。

首先，需要导入类库，这里还是使用maven：

<properties>
    <spring.version>3.0.0.RELEASE</spring.version>
</properties>
<dependencies>
    <dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>servlet-api</artifactId>
        <version>2.4</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>jsp-api</artifactId>
        <version>2.0</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-core</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-webmvc</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-orm</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.codehaus.jackson</groupId>
        <artifactId>jackson-mapper-asl</artifactId>
        <version>1.4.1</version>
    </dependency>
</dependencies>

 

然后，需要创建一个web项目，在WEB-INF目录下的web.xml文件中加入：

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
    id="WebApp_ID" version="2.5">
    <display-name>spring.json.demo</display-name>
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/applicationContext.xml</param-value>
    </context-param>
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>

    <servlet>
        <servlet-name>controller</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>controller</servlet-name>
        <url-pattern>*.json</url-pattern>
    </servlet-mapping>
</web-app>

 

在同目录下，创建两个spring配置文件，一个用spring mvc（在这里是controller-servlet.xml），一个用于后台业务（applicationContext.xml）。其中后者是空文件，因为示例没有业务部分：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">
</beans>

controller-servlet.xml文件：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"
    xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd">
    <context:component-scan base-package="com.easymorse.web" />
    <context:annotation-config />
    <bean
        class="org.springframework.web.servlet.view.ContentNegotiatingViewResolver">
        <property name="ignoreAcceptHeader" value="true" />
        <property name="defaultContentType" value="text/html" />
        <property name="mediaTypes">
            <map>
                <entry key="json" value="application/json" />
            </map>
        </property>
        <property name="favorParameter" value="false" />
        <property name="viewResolvers">
            <list>
                <bean class="org.springframework.web.servlet.view.BeanNameViewResolver" />
            </list>
        </property>
        <property name="defaultViews">
            <list>
                <bean
                    class="org.springframework.web.servlet.view.json.MappingJacksonJsonView" />
            </list>
        </property>
    </bean>

</beans>

 

然后需要写一个spring mvc的控制类，这里是com.easymorse.web.DemoService：

package com.easymorse.web;

import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
public class DemoService {
    @RequestMapping("/a.json")
    public String doService(ModelMap modelMap) {
        modelMap.put("name", "张三");
        return "list";
    }
}

 

然后，启动项目，通过比如，http://localhost:8080/spring.json.demo/a.json，会下载一个文本文件，内容即：

{"name":"张三"}

源代码见：

http://easymorse.googlecode.com/svn/tags/spring.json.demo-0.1/

   发送文章为PDF