使用SpringMVC返回json字符串的实例讲解

2019-11-26 10:09:02

字体：大中小

来源：转载

供稿：网友

最近开始接触SpringMVC这个框架，这个框架使用起来很方便，框架搭起来之后，写起代码几乎都是一个模式。当然要走到这一步必须保证你的SpringMVC的相关配置都已经完成，并且配置正确！

作为我的关于S平ringMVC的首篇博客，本篇博客主要说名如何配置SpringMVC，并且可以使之正常的返回Bean实体，这里的bean实体一般返回到前端都是以Json字符串的形式返回的。

使用的开发工具为eclipse，这个也是比较大众化的开发工具了，算的上是人人都会使用的了，只是熟练程度不一样！

具体的配置如下：

web.xml:

<?xml version="1.0" encoding="UTF-8"?><web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:context="http://www.springframework.org/schema/context"  xmlns:mvc="http://www.springframework.org/schema/mvc"  xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd  http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd  http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd"  id="WebApp_ID" version="3.1">  <context-param>    <param-name>contextConfigLocation</param-name>    <param-value>classpath:applicationContext.xml</param-value>  </context-param>  <listener>    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>  </listener>  <display-name>ReturnJsonDemo</display-name>  <welcome-file-list>    <welcome-file>index.jsp</welcome-file>  </welcome-file-list>  <servlet>    <servlet-name>dispatcher</servlet-name>    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>    <init-param>      <param-name>contextConfigLocation</param-name>      <param-value>classpath:dispatcher-servlet.xml</param-value>    </init-param>  </servlet>  <servlet-mapping>    <servlet-name>dispatcher</servlet-name>    <url-pattern>/</url-pattern>  </servlet-mapping></web-app>

dispatcher-servlet.xml:

<?xml version="1.0" encoding="UTF-8"?><beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  xmlns="http://www.springframework.org/schema/beans"  xmlns:context="http://www.springframework.org/schema/context"  xmlns:mvc="http://www.springframework.org/schema/mvc"  xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd  http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd  http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd  http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd">  <mvc:default-servlet-handler />  <context:component-scan base-package="com.zyq.springmvc.controller">    <context:exclude-filter type="annotation"      expression="org.springframework.stereotype.Service" />  </context:component-scan>  <context:annotation-config />  <mvc:annotation-driven>    <mvc:message-converters>      <bean class="org.springframework.http.converter.StringHttpMessageConverter">        <property name="supportedMediaTypes">          <list>            <value>text/plain;charset=UTF-8</value>            <value>text/html;charset=UTF-8</value>          </list>        </property>      </bean>      <bean        class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">        <property name="supportedMediaTypes">          <list>            <value>application/json; charset=UTF-8</value>            <value>application/x-www-form-urlencoded; charset=UTF-8</value>          </list>        </property>      </bean>    </mvc:message-converters>  </mvc:annotation-driven></beans>

还有一个applicationContext.xml，不过我的里面什么都没有写，我就不给出了！

新建一个index.jsp，这个作为主界面用来测试各个接口的返回值是否正常！这里也给出代码：

<%@ page language="java" contentType="text/html; charset=ISO-8859-1"  pageEncoding="ISO-8859-1"%><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Main Page</title></head><body>  <h1>Welcome Main Page!!!</h1>  <form action="/ReturnJsonDemo/first">    <input type="submit" value="first" />  </form>  <form action="/ReturnJsonDemo/second">    <input type="submit" value="second" />  </form>  <form action="/ReturnJsonDemo/third">    <input type="submit" value="third" />  </form>  <form action="/ReturnJsonDemo/fourth">    <input type="submit" value="fourth" />  </form></body></html>

到这里基本上配置方面的都完成了，然后是申明一个Controller，具体的代码也比较简单，基本上都是固定的格式！

MainController.java

package com.zyq.springmvc.controller;import java.text.SimpleDateFormat;import java.util.ArrayList;import java.util.HashMap;import java.util.List;import java.util.Map;import org.springframework.stereotype.Controller;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.ResponseBody;import com.zyq.springmvc.bean.CommonBean;import com.zyq.springmvc.bean.SonBean;@Controllerpublic class MainController {  @RequestMapping("/first")  @ResponseBody  public CommonBean getFirst(){    CommonBean bean = new CommonBean();    bean.setResultCode("success");    bean.setTimeStamp(new SimpleDateFormat("yyyy/MM/dd HH:mm:ss").format(System.currentTimeMillis()));    bean.setData("this is first message");    return bean;  }  @RequestMapping("/second")  @ResponseBody  public CommonBean getSecond(){    CommonBean bean = new CommonBean();    bean.setResultCode("success");    bean.setTimeStamp(new SimpleDateFormat("yyyy/MM/dd HH:mm:ss").format(System.currentTimeMillis()));    List<String> data = new ArrayList<>();    data.add("JAVA");    data.add("C");    data.add("PYTHON");    data.add("C++");    bean.setData(data);    return bean;  }  @RequestMapping("/third")  @ResponseBody  public CommonBean getThird(){    CommonBean bean = new CommonBean();    bean.setResultCode("success");    bean.setTimeStamp(new SimpleDateFormat("yyyy/MM/dd HH:mm:ss").format(System.currentTimeMillis()));    Map<String, String> data = new HashMap<>();    data.put("first", "JAVA");    data.put("second","PYTHON");    data.put("third", "C++");    data.put("fourth", "C");    bean.setData(data);    return bean;  }  @RequestMapping("/fourth")  @ResponseBody  public CommonBean getFourth(){    CommonBean bean = new CommonBean();    bean.setResultCode("success");    bean.setTimeStamp(new SimpleDateFormat("yyyy/MM/dd HH:mm:ss").format(System.currentTimeMillis()));    SonBean sonBean = new SonBean();    sonBean.setAge(25);    sonBean.setName("Hacker's Delight");    sonBean.setGender("male");    bean.setData(sonBean);    return bean;  }}

代码的运行效果如下：

好像不同浏览器对于接口的请求操作不一样，在使用eclipse请求接口，会让下载一个json文件，文件的内容就是一个json字符串。

在配置完整的工程需要用到springframework的jar包，jackson的相关jar包，我使用的tomcat8.5在运行的时候提示报错，需要引入common-log的jar包。

在声明一个返回json字符串的接口时，一定要使用@ResponseBody注解，这个注解会将接口的返回数据写入response中的body区域，也就是重新传回前端。

在我测试的时候遇到一个问题，在返回bean的时候，只能返回类包裹，不能返回类继承或者接口继承，举个例子：

如果你返回一个ParentBean，其内部包含一个ChildBean，这样是ok！

如果在接口定义时，返回的是一个父类，而实际返回的是它的子类，这时候汇报错误，提示无法将子类转换成父类，就相当于你不能将String对象转换成object对象，关于这方面应该是根据父类无法查找子类的属性，导致无法正常将bean对象转换成json字符串，所以在框架中不允许在接口中声明bean而返回的是bean的子类（这些原因都只是个人猜测，具体的原因还需要分析框架中的代码）！

好了，关于返回json字符串就说到这里了！附上demo的源码，需要的jar包也在里面，需要的可以自己去下载！

源码下载

以上这篇使用SpringMVC返回json字符串的实例讲解就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持武林网。

上一篇：springMVC返回复杂的json格式数据方法

下一篇：Java实现五子棋网络版