Spring MVC 4 - 返回JSON

1.返回json
2.Ajax请求
3.多视图输出
4.MyBatis使用

这个例子将使用Spring MVC framework输出JSON数据到前端。

1.使用技术

1. IntelliJ IDEA 2016
2. Maven 3
3. JDK 1.8
4. Spring 4.1.4.RELEASE
5. Jackson 2.8.5

2.项目结构

3.项目代码

3.1项目依赖

将Spring4 和 Jackson 添加到pom文件中。
然后添加编译插件和部署插件。

pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.jeikerxiao.spring</groupId>
  <artifactId>Spring4MVC</artifactId>
  <packaging>war</packaging>
  <version>1.0-SNAPSHOT</version>
  <name>Spring4MVC Maven Webapp</name>
  <url>http://maven.apache.org</url>

  <!-- 属性 -->
  <properties>
    <spring.version>4.1.4.RELEASE</spring.version>
    <jackson.version>2.8.5</jackson.version>
    <jdk.version>1.8</jdk.version>

  </properties>

  <dependencies>
    <!--Spring 4 dependencies-->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-core</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-web</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>${spring.version}</version>
    </dependency>

    <!-- Jackson JSON Mapper -->
    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-core</artifactId>
      <version>${jackson.version}</version>
    </dependency>
    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-databind</artifactId>
      <version>${jackson.version}</version>
    </dependency>
    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-annotations</artifactId>
      <version>${jackson.version}</version>
    </dependency>

  </dependencies>

  <build>
    <finalName>Spring4MVC</finalName>

    <plugins>
      <!-- 部署至本机 -->
      <plugin>
        <groupId>org.eclipse.jetty</groupId>
        <artifactId>jetty-maven-plugin</artifactId>
        <version>9.3.9.v20160517</version>
        <configuration>
          <httpConnector>
            <port>8080</port>
          </httpConnector>
          <webAppConfig>
            <contextPath>/</contextPath>
          </webAppConfig>
        </configuration>
      </plugin>

      <!--编译插件-->
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <configuration>
         <source>${jdk.version}</source>
         <target>${jdk.version}</target>
         </configuration>
      </plugin>

    </plugins>

  </build>
</project>

3.2.Model

简单的POJO,最后将格式化成JSON数据后，输出到前端。

package com.jeiker.common.model;

public class Name {

    String name;
    String otherName[];

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String[] getOtherName() {
        return otherName;
    }

    public void setOtherName(String[] otherName) {
        this.otherName = otherName;
    }
}

3.3.Controller

添加@ResponseBody 作为返回值。
Spring将进行如下检查：

1. Jackson jar包是否存在于工程中。
2. mvc:annotation-driven是否打开。
3. 返回方法上面是否添加了@ResponseBody注解。

Spring就会自动将返回值转换为JSON数据。

JsonController.java

package com.jeiker.common.controller;

import com.jeiker.common.model.Name;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
@RequestMapping("/")
public class JsonController {

    @RequestMapping(value = "{name}", method = RequestMethod.GET)
    @ResponseBody
    public Name getShopInJSON(@PathVariable String name) {

        Name nameModel = new Name();
        nameModel.setName(name);
        nameModel.setOtherName(new String[] {"xiao","jeikerxiao"});

        return nameModel;
    }

}

3.4 mvc:annotation-driven

在工程的Spring xml配置文件中，打开：mvc:annotation-driven

<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc" 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-4.1.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context-4.1.xsd
        http://www.springframework.org/schema/mvc
        http://www.springframework.org/schema/mvc/spring-mvc-4.1.xsd">
    <!--扫描Controller-->
    <context:component-scan base-package="com.jeiker.common.controller" />
    <!--jackson配置-->
    <mvc:annotation-driven/>

</beans>

3.5 web.xml

<web-app id="WebApp_ID" version="2.4"
         xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee
    http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">

  <display-name>Archetype Created Web Application</display-name>


  <servlet>
    <servlet-name>mvc-dispatcher</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <load-on-startup>1</load-on-startup>
  </servlet>

  <servlet-mapping>
    <servlet-name>mvc-dispatcher</servlet-name>
    <url-pattern>/*</url-pattern>
  </servlet-mapping>

  <context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>/WEB-INF/mvc-dispatcher-servlet.xml</param-value>
  </context-param>

  <listener>
    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
  </listener>
</web-app>

4.运行结果

URL：http://localhost:8080/xiao