SpringMVC之JSON数据返回及异常处理机制-阿里云开发者社区

一、概述

( 1 ) JSON

在SpringMVC中，JSON数据返回通常是通过使用`@ResponseBody`注解将Java对象转换为JSON格式，并直接发送给客户端。该注解可以用于Controller中的方法，用于指示该方法的返回值应该作为响应的内容返回，而不是作为视图解析。当请求到达被注解的方法时，SpringMVC会自动将返回的对象转换为JSON格式，并将其作为HTTP响应发送给客户端。这个过程通常是通过使用Jackson、Gson等JSON转换库来完成的。JSON数据的返回使得前后端可以方便地进行数据交换和通信。

需要注意的是，为了使Java对象正确地被转换为JSON格式，需要为对象提供相应的getter方法，并确保对象的属性与JSON键值一致。

当客户端收到这个响应后，它可以解析JSON数据，并根据其中的信息进行相应的处理。常见的客户端处理方式可以是使用JavaScript进行解析和展示，或者使用其他的后端程序进行数据处理。

以上就是在SpringMVC中返回JSON数据的一般过程。

作用 :

返回JSON数据在Web开发中具有多种重要作用：

1. 前后端数据交互：JSON是一种轻量级的数据交换格式，它可以在客户端和服务器之间方便地传递数据。通过返回JSON数据，前后端可以进行无缝的数据交互，使得数据的传输和处理更高效、灵活。

2. API开发：当开发RESTful风格的API时，通常使用JSON来表示资源的结构和信息。通过返回JSON数据，API客户端可以轻松地解析和使用数据。JSON格式的数据还可以方便地与其他编程语言进行交互。

3. 移动应用开发：对于移动应用开发，使用JSON作为数据交换格式是非常常见的。通过返回JSON数据，移动应用可以方便地与服务器进行通信，并获取所需的数据。

4. 前端渲染：现代的前端框架（如React、Vue等）通常使用JSON数据来进行组件渲染。通过返回JSON数据，前端代码可以根据数据动态地生成用户界面，并提供更好的用户体验。

5. 数据存储和传输效率：相比于其他数据格式（如XML），JSON具有更小的体积和更高的传输效率。返回JSON数据可以减少网络传输量和提高数据交互效率。

总的来说，返回JSON数据在Web开发中扮演着重要角色，它简化了前后端的数据交互，提供了高效的数据传输和处理方式。同时，JSON数据格式也易于解析和使用，使得开发人员能够更好地处理和展示数据。

( 2 ) 异常处理机制

在异常处理过程中，当发生异常时，SpringMVC会自动寻找匹配的异常处理方法进行处理。首先会寻找当前Controller类中标注的@ExceptionHandler注解方法，如果找不到，则会寻找全局异常处理器中匹配的方法。然后，根据处理方法的返回值，进行适当的处理，例如返回错误页面视图或JSON格式的错误信息。

通过异常处理机制，我们可以对特定类型的异常进行定制化处理，提高应用程序的可靠性和友好性。同时，全局异常处理器和自定义异常处理器的使用可以有效地统一和简化异常处理逻辑，提高代码的可维护性。

作用 :

SpringMVC中的异常处理机制具有以下几个作用：

1. 提供友好的错误页面或错误信息：异常处理机制可以捕获并处理应用程序中的异常，从而提供用户友好的错误页面或错误信息。这样可以改善用户体验，减少用户的困惑和不良的使用体验。

2. 统一处理异常逻辑：通过异常处理机制，可以将异常处理逻辑集中在一个地方，如`@ExceptionHandler`注解标注的方法或全局异常处理器中。这样可以减少代码的重复性，提高代码的复用性和可维护性。

3. 分类和定制化处理异常：使用异常处理机制，可以根据异常的类型进行分类和定制化处理。通过自定义异常类和`@ExceptionHandler`注解，可以针对不同类型的异常编写不同的处理逻辑，以满足具体业务需求。

4. 异常信息记录和监控：在异常处理过程中，可以记录异常的详细信息，如异常类型、发生时间、请求参数等。这些信息对于日志记录和后续的系统监控和故障排查非常有用。

5. 保护系统安全和稳定性：合理处理异常可以避免一些潜在的安全风险，如异常信息的泄露。同时，通过处理异常，可以保证系统在遇到异常情况下的稳定性，防止系统崩溃或无法正常响应。

总的来说，SpringMVC中的异常处理机制对于提供用户友好的错误提示、统一处理异常逻辑、定制化处理异常、记录异常信息和保护系统安全和稳定性具有重要作用。它是开发高质量、稳定性较高的Web应用程序的重要组成部分。

二、JSON数据返回

( 1 ) 讲述

当使用`@ResponseBody`注解返回JSON数据时，SpringMVC会自动将Java对象序列化为JSON格式。以下是SpringMVC返回JSON数据的一般步骤：

1. 配置Jackson或其他JSON处理库：SpringMVC默认使用Jackson库来进行JSON转换，因此你需要在项目中添加相关的依赖，或者确保已经正确配置了Jackson库。

2. 在Controller方法上标注`@ResponseBody`注解：在需要返回JSON数据的方法上添加`@ResponseBody`注解，以指示返回值应当被转换为JSON格式。

3. 创建Java对象并返回：在被`@ResponseBody`注解标注的方法中，构造一个需要返回的对象，并将其返回。这个对象将被自动序列化为JSON格式。

4. 响应头和内容：SpringMVC会自动设置HTTP响应头的Content-Type为`application/json`，以指示返回的是JSON数据类型。同时，将序列化后的JSON数据作为HTTP响应内容返回给客户端。

( 2 ) 演示

以下的实例演示的项目代码是基于本人的博客 : Spring-MVC使用JSR303及拦截器
导入依赖
在项目中找到 pom.xml 配置文件，在该文件的指定位置增加以下配置

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.9.3</version>
</dependency>
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-core</artifactId>
    <version>2.9.3</version>
</dependency>
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-annotations</artifactId>
    <version>2.9.3</version>
</dependency>

配置 spring-mvc.xml

在项目中找到我们自己创建的配置文件， spring-mvc.xml 配置文件，进行配置

<bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter">
        <property name="messageConverters">
            <list>
                <ref bean="mappingJackson2HttpMessageConverter"/>
            </list>
        </property>
    </bean>
    <bean id="mappingJackson2HttpMessageConverter"
          class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
        <!--处理中文乱码以及避免IE执行AJAX时，返回JSON出现下载文件-->
        <property name="supportedMediaTypes">
            <list>
                <value>text/html;charset=UTF-8</value>
                <value>text/json;charset=UTF-8</value>
                <value>application/json;charset=UTF-8</value>
            </list>
        </property>
    </bean>

然后将上篇博客中的配置进行注释，便于我们进行测试 : Spring-MVC使用JSR303及拦截器

以下为需要注释的配置代码 :

<mvc:interceptors>

</mvc:interceptors>

<mvc:interceptors>

<mvc:interceptor>

<mvc:mapping path="/**"/>

</mvc:interceptor>

<mvc:interceptor>

<mvc:mapping path="/hot/**"/>

</mvc:interceptor>

</mvc:interceptors>

<mvc:interceptors>

</mvc:interceptors>

使用@ResponseBody注解

@ResponseBody注解的作用是将Controller的方法返回的对象通过适当的转换器转换为指定的格式之后，写入到response对象的body区，通常用来返回JSON数据或者是XML数据。

注意：在使用此注解之后不会再走视图解析器，而是直接将数据写入到输入流中，他的效果等同于通过response对象输出指定格式的数据。

创建一个名为 JsonController 的类，类编写访问地址的方法进行数据返回。

package com.CloudJun.web;
import com.CloudJun.biz.Hotelbiz;
import com.CloudJun.model.Hotel;
import com.CloudJun.utils.PageBean;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import javax.servlet.http.HttpServletRequest;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
 * @author CloudJun
 * @create  2023-09-13 13:57
 */
@Controller
@RequestMapping("/hot/json")
public class JsonController {
    @Autowired
    private Hotelbiz hotelbiz;
    @ResponseBody
    @RequestMapping("/list")
    public List<Hotel> list(HttpServletRequest req, Hotel hotel){
        PageBean pageBean = new PageBean();
        pageBean.setRequest(req);
        List<Hotel> list = hotelbiz.selectHotelPage(hotel, pageBean);
        return list;
    }
    @ResponseBody
    @RequestMapping("/load")
    public Hotel load(HttpServletRequest req, Hotel hotel){
        if(hotel.getHid() != null && hotel.getHid()!=0){
            Hotel hot = hotelbiz.selectByPrimaryKey(hotel.getHid());
            return hot;
        }
        return null;
    }
    @ResponseBody
    @RequestMapping("/mapList")
    public List<Map> mapList(HttpServletRequest req, Hotel hotel){
        PageBean pageBean = new PageBean();
        pageBean.setRequest(req);
        List<Map> list = hotelbiz.mapListPage(hotel, pageBean);
        return list;
    }
    @ResponseBody
    @RequestMapping("/all")
    public Map all(HttpServletRequest req, Hotel hotel){
        PageBean pageBean = new PageBean();
        pageBean.setRequest(req);
        List<Hotel> list = hotelbiz.selectHotelPage(hotel, pageBean);
        Map map = new HashMap();
        map.put("list",list);
        map.put("pageBean",pageBean);
        return map;
    }
    @ResponseBody
    @RequestMapping("/jsonStr")//直接在页面返回字符串，如: hotEdit
    public String jsonStr(HttpServletRequest req, Hotel hotel){
        return "hotEdit";
    }
}

在自动生成的 HotelMapper.xml 配置文件中，配置动态SQL( mapListPager )来查询数据。

<select id="mapListPager" resultType="java.util.Map" parameterType="com.CloudJun.model.Hotel" >
  select  * from t_hotel
  <where>
    <if test="hname != null">
      and hname like concat('%',#{hname},'%')
    </if>
  </where>
</select>

在自动生成的 HotelMapper 接口中，编写需要访问文件的方法

List<Map> mapListPager(Hotel hotel);

在自己创建的接口 ( HotelBiz ) 中增加该方法

List<Map> mapListPage(Hotel hotel,PageBean pageBean);

在自己创建的实现类 ( HotelBizimpl ) 中重写该方法

@Override
    public List<Map> mapListPage(Hotel hotel, PageBean pageBean) {
        return hotelMapper.mapListPager(hotel);
    }

之后就可以直接开启服务器，在浏览器中进行访问地址输入进行测试

输入以下访问地址进行测试 : localhost:8081/ssm/hot/json/list

测试结果如图:

输入以下访问地址进行测试 : localhost:8081/ssm/hot/json/load?hid=4

测试结果如图:

输入以下访问地址进行测试 : localhost:8081/ssm/hot/json/mapList

测试结果如图:

输入以下访问地址进行测试 : localhost:8081/ssm/hot/json/jsonStr

测试结果如图:

( 3 ) 扩展使用

在 JsonController 类中，如果该类的所有方法都进行了@ResponseBody注解，可以直接在类上注解这个，操作如图即可:

或者如下图也可以 :

注意 : 如果如图上操作，该类里面的方法上的注解(@ResponseBody)就需要进行注释比较快。

如果在数据显示的时候，需要对该返回数据的对象的属性不显示时，可以在对象实体类中，

在该属性的上面进行，这个注解 @JsonIgnore ，该注解是使用json数据返回时对该属性不进行数据返回显示

如图操作 :

再次进行访问（localhost:8081/ssm/hot/json/list）的时候，数据返回时结果如图:

三、异常处理机制

3.1 为什么

编译时异常和运行时异常RuntimeException，前者通过捕获异常从而获取异常信息，后者主要通过规范代码开发、测试通过手段减少运行时异常的发生。在开发中，不管是dao层、service层还是controller层，都有可能抛出异常，在springmvc中，能将所有类型的异常处理从各处理过程解耦出来，既保证了相关处理过程的功能较单一，也实现了异常信息的统一处理和维护。

SpringMVC作为一个优秀的Web层开发框架，在框架中已经集成了异常处理机制，可以帮我们我们灵活地处理程序中发生的异常，提高了我们程序的稳定性，令我们对程序运行中发生的异常更加可以控制，今天我们讲的就是SpringMVC框架中的对于异常的处理机制。

本文中的所有程序都是基于SSM框架环境，以上一篇博文SSM框架整合为基础。

思维图 :

系统的dao、service、controller出现异常都通过throws Exception向上抛出，最后由springmvc前端控制器交由异常处理器进行异常处理。springmvc提供全局异常处理器（一个系统只有一个异常处理器）进行统一异常处理。

3.2 演示

在项目中名为 spring-mvc.xml 配置文件中增加异常处理的配置，增加以下配置。

<!-- springmvc提供的简单异常处理器 -->
    <bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
        <!-- 定义默认的异常处理页面 -->
        <property name="defaultErrorView" value="error"/>
        <!-- 定义异常处理页面用来获取异常信息的变量名，也可不定义，默认名为exception -->
        <property name="exceptionAttribute" value="ex"/>
        <!-- 定义需要特殊处理的异常，这是重要点 -->
        <property name="exceptionMappings">
            <props>
                <prop key="java.lang.RuntimeException">error</prop>
            </props>
            <!-- 还可以定义其他的自定义异常 -->
        </property>
    </bean>

创建一个名为 : error.jsp 的显示页面，方便我们查看错误。

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>错误信息页面</title>
</head>
<body>
<h2>显示错误信息</h2>
<h4>${ex}</h4>
<h4>${msg}</h4>
</body>
</html>

方法一：

然后我们创造一个错误进行测试，在创建的接口实现类中，找到mapListPage方法，增加一行代码 :

hotel = null;

如图:

再之后在 JsonController 类中找到 jsonStr 方法进行修改。

// @ResponseBody

@RequestMapping("/jsonStr")//直接在页面返回字符串，如: hotEdit public String jsonStr(HttpServletRequest req, Hotel hotel){

if(true)

throw new GlobalException("小卡拉米，代码错误异常。。。");

return "hotEdit"; }

如图:

开启服务器，在浏览器中进行访问地址 : localhost:8081/ssm/hot/json/mapList

测试结果为 :

方法二：

创建一个处理异常类名为: GlobalException

package com.CloudJun.exception;
public class GlobalException extends RuntimeException {
    public GlobalException() {
    }
    public GlobalException(String message) {
        super(message);
    }
    public GlobalException(String message, Throwable cause) {
        super(message, cause);
    }
    public GlobalException(Throwable cause) {
        super(cause);
    }
    public GlobalException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
        super(message, cause, enableSuppression, writableStackTrace);
    }
}

创建一个处理异常类名为: GlobalExceptionHandler

package com.CloudJun.exception;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.HashMap;
import java.util.Map;
@Component
public class GlobalExceptionHandler implements HandlerExceptionResolver {
    @Override
    public ModelAndView resolveException(HttpServletRequest httpServletRequest,
                                         HttpServletResponse httpServletResponse,
                                         Object o, Exception e) {
        ModelAndView mv = new ModelAndView();
        mv.setViewName("error");
        if (e instanceof GlobalException){
            GlobalException globalException = (GlobalException) e;
            mv.addObject("ex",globalException.getMessage());
            mv.addObject("msg","全局错误异常....");
        }else if (e instanceof RuntimeException){
            RuntimeException runtimeException = (RuntimeException) e;
            mv.addObject("ex",runtimeException.getMessage());
            mv.addObject("msg","运行时错误异常....");
        }else{
            mv.addObject("ex",e.getMessage());
            mv.addObject("msg","其他错误异常....");
        }
        return mv;
    }
}

开启服务器，在浏览器中进行访问地址 : localhost:8081/ssm/hot/json/mapList

结果如图 :

开启服务器，在浏览器中进行访问地址 : localhost:8081/ssm/hot/json/jsonStr

结果如图 :

方法三：

将创建的处理异常类(GlobalExceptionHandler) 中所有代码修改为以下代码 :

package com.CloudJun.exception;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.HashMap;
import java.util.Map;
@ControllerAdvice
public class GlobalExceptionHandler {
    // 返回错误json数据
    @ResponseBody
    @ExceptionHandler
    public Map handler(Exception e){
        Map map = new HashMap();
        if (e instanceof GlobalException){
            GlobalException globalException = (GlobalException) e;
            map.put("ex",globalException.getMessage());
            map.put("msg","全局错误异常....");
        }else if (e instanceof RuntimeException){
            RuntimeException runtimeException = (RuntimeException) e;
            map.put("ex",runtimeException.getMessage());
            map.put("msg","运行时错误异常....");
        }else {
            map.put("ex",e.getMessage());
            map.put("msg","其它错误异常....");
        }
        return map;
    }
}

开启服务器，在浏览器中进行访问地址 : localhost:8081/ssm/hot/json/mapList

结果如图 :

开启服务器，在浏览器中进行访问地址 : localhost:8081/ssm/hot/json/jsonStr

结果如图 :

给我们带来的收获

学习SpringMVC中的JSON数据返回及异常处理机制可以给我们带来以下收获：

1. JSON数据返回：SpringMVC提供了方便的方式来将Java对象转换为JSON格式的数据，并返回给客户端。这样可以简化开发过程，减少手动转换的工作量，并提高数据传输的效率。

2. 异常处理机制：在开发过程中，不可避免地会出现各种异常情况，例如数据库连接失败、参数错误等。SpringMVC的异常处理机制可以帮助我们捕获并处理这些异常，使得应用程序更加健壮和稳定。

3. 统一异常处理：SpringMVC的异常处理机制可以将所有的异常集中处理，避免了在每个Controller中都要编写异常处理代码的繁琐工作。我们可以通过自定义异常处理类来统一处理所有的异常，并返回给客户端一个统一的错误信息。

4. 更好的用户体验：通过合理处理异常，我们可以给用户提供更好的用户体验。例如，在发生异常时，可以返回给用户友好的错误信息，而不是暴露给用户一些技术细节。

5. 更好的日志记录：异常处理机制可以帮助我们更好地记录日志。通过捕获异常并记录相关信息，我们可以更好地追踪和排查问题，提高应用程序的可维护性。

总之，学习SpringMVC中的JSON数据返回及异常处理机制可以提高我们的开发效率，增强应用程序的稳定性和可维护性，并提供更好的用户体验。

SpringMVC之JSON数据返回及异常处理机制

一、概述

( 1 ) JSON

( 2 ) 异常处理机制

二、JSON数据返回

( 1 ) 讲述

( 2 ) 演示

( 3 ) 扩展使用

三、异常处理机制

3.1 为什么

3.2 演示

方法一：

方法二：

方法三：

给我们带来的收获

热门文章

最新文章

相关课程

相关电子书

相关实验场景

热门

活动广场

任务中心

开发者评测

高校计划

乘风者计划

训练营

阿里云MVP

话题

直播

下载

镜像站

技术资料

插件

SpringMVC之JSON数据返回及异常处理机制

一、概述

( 1 ) JSON

( 2 ) 异常处理机制

二、JSON数据返回

( 1 ) 讲述

( 2 ) 演示

( 3 ) 扩展使用

三、异常处理机制

3.1 为什么

3.2 演示

方法一 ：

方法二 ：

方法三 ：

给我们带来的收获

热门文章

最新文章

相关课程

相关电子书

相关实验场景

方法一：

方法二：

方法三：