SpringMVC之JSON数据返回与异常处理机制---全方面讲解-Toy模板网

这篇具有很好参考价值的文章主要介绍了SpringMVC之JSON数据返回与异常处理机制---全方面讲解。希望对大家有所帮助。如果存在错误或未考虑完全的地方，请大家不吝赐教，您也可以点击"举报违法"按钮提交疑问。

一，JSON数据返回的理解

在Spring MVC中，当需要将数据以JSON格式返回给客户端时，可以使用@ResponseBody注解或@RestController注解将Controller方法的返回值直接转化为JSON格式并返回。这使得开发者可以方便地将Java对象转换为JSON，并通过HTTP响应返回给客户端。Spring MVC框架会自动地处理这一转换过程，将对象序列化为JSON字符串。这种方式适用于RESTful API的实现

1.2 Jackson

1.2.1 介绍

Jackson是一个简单基于Java应用库，Jackson可以轻松的将Java对象转换成json对象和xml文档，同样也可以将json、xml转换成Java对象。Jackson所依赖的jar包较少，简单易用并且性能也要相对高些，并且Jackson社区相对比较活跃，更新速度也比较快。

1.2.2 特点

容易使用，提供了高层次外观，简化常用的用例。

无需创建映射，API提供了默认的映射大部分对象序列化。

性能高，快速，低内存占用

创建干净的json

不依赖其他库

代码开源

1.2.3.常用注解

注解	说明
@JsonIgnore	作用在字段或方法上，用来完全忽略被注解的字段和方法对应的属性
@JsonProperty	作用在字段或方法上，用来对属性的序列化/反序列化，可以用来避免遗漏属性，同时提供对属性名称重命名
@JsonIgnoreProperties	作用在类上，用来说明有些属性在序列化/反序列化时需要忽略掉
@JsonUnwrapped	作用在属性字段或方法上，用来将子JSON对象的属性添加到封闭的JSON对象
@JsonFormat	指定序列化日期/时间值时的格式

二，JSON入门的使用

2.1 导入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>

2.2 配置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>

2.3 @ResponseBody注解使用

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

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

2.4 实例演示

Mapper.xml的配置：

  <select id="mapListPager" resultType="java.util.Map" parameterType="com.Bingzy.model.Tbook" >
    select  * from t_mvc_book
    <where>
      <if test="bname != null">
        and bname like concat('%',#{bname},'%')
      </if>
      <if test="bid != null">
        and bid = #{bid}
      </if>
    </where>
  </select>

Mapper类的方法：

    List<Map> mapListPager(Tbook tbook);

Biz层：

    List<Map> mapListPager(Tbook tbook,PageBean pageBean);

实现Biz层：

    @Override
        public List<Map> mapListPager(Tbook tbook, PageBean pageBean) {
            return tbookMapper.mapListPager(tbook);
    }

JsonController层：

/**
 * @Name BingBing
 * @company zking cy
 * @create 2023-09-08-19:51
 */
@Controller
@RequestMapping("/book")
public class JsonController {
    @Autowired
    private TbookBiz tbookbiz;

    /**
     * 返回List<T>
     * @param req
     * @param tbook
     * @return
     */
    @ResponseBody
    @RequestMapping("/list")
    public List<Tbook> list(HttpServletRequest req, Tbook tbook){
        PageBean pageBean = new PageBean();
        pageBean.setRequest(req);
        List<Tbook> lst = this.tbookbiz.listPager(tbook, pageBean);
        return lst;
    }

    /**
     * 返回T
     * @param req
     * @param tbook
     * @return
     */
    @ResponseBody
    @RequestMapping("/load")
    public Tbook load(HttpServletRequest req, Tbook tbook){
        if(tbook.getBid() != null){
            List<Tbook> lst = this.tbookbiz.listPager(tbook, null);
            return lst.get(0);
        }
        return null;
    }


    /**
     * 返回List<Map>
     * @param req
     * @param tbook
     * @return
     */
    @ResponseBody
    @RequestMapping("/mapList")
    public List<Map> mapList(HttpServletRequest req, Tbook tbook){
        PageBean pageBean = new PageBean();
        pageBean.setRequest(req);
        List<Map> lst = this.tbookbiz.mapListPager(tbook, pageBean);
        return lst;
    }

    /**
     * 返回Map
     * @param req
     * @param tbook
     * @return
     */
    @ResponseBody
    @RequestMapping("/mapLoad")
    public Map mapLoad(HttpServletRequest req, Tbook tbook){
        if(tbook.getBid() != null){
            List<Map> lst = this.tbookbiz.mapListPager(tbook, null);
            return lst.get(0);
        }
        return null;
    }


    @ResponseBody
    @RequestMapping("/all")
    public Map all(HttpServletRequest req, Tbook tbook){
        PageBean pageBean = new PageBean();
        pageBean.setRequest(req);
        List<Tbook> lst = this.tbookbiz.listPager(tbook, pageBean);
        Map map = new HashMap();
        map.put("lst",lst);
        map.put("pageBean",pageBean);
        return map;
    }

    @ResponseBody
    @RequestMapping("/jsonStr")
    public String jsonStr(HttpServletRequest req, Tbook tbook){
        return "clzEdit";
    }


}

以下我会以JSON格式的不同情况来演示数据回显

返回List<T>：

SpringMVC之JSON数据返回与异常处理机制---全方面讲解,json,spring,intellij-idea,mvc,java

返回T：

SpringMVC之JSON数据返回与异常处理机制---全方面讲解,json,spring,intellij-idea,mvc,java

返回List<Map>：

SpringMVC之JSON数据返回与异常处理机制---全方面讲解,json,spring,intellij-idea,mvc,java

返回Map：

SpringMVC之JSON数据返回与异常处理机制---全方面讲解,json,spring,intellij-idea,mvc,java

返回JSON数组：

SpringMVC之JSON数据返回与异常处理机制---全方面讲解,json,spring,intellij-idea,mvc,java

返回字符串：

SpringMVC之JSON数据返回与异常处理机制---全方面讲解,json,spring,intellij-idea,mvc,java

三，异常机制的处理

3.1 异常机制处理概念

异常处理是在应用程序中捕获和处理异常的过程。在Spring MVC中，异常处理机制允许我们在请求处理的各个阶段捕获异常并采取相应的操作，比如返回错误页面或JSON格式的错误信息。通过自定义异常处理器，我们可以在应用程序中集中管理异常，并为每种异常定义不同的处理方式

3.2 为什么要全局异常处理

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

3.3 异常处理思路

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

具体来说，异常处理的思路包括以下几个方面：

确定异常类型：在进行异常处理之前，需要先确定可能会出现哪些异常情况，以及这些异常情况对应的异常类型。

添加异常处理代码：在程序中添加相应的异常处理代码，用于捕获可能出现的异常，并进行相应的处理。

处理异常：根据不同的异常类型，采取不同的处理方式。例如，对于运行时异常，可以采取打印错误信息等方式进行处理；对于受检异常，则需要在方法声明中添加throws关键字，并在调用该方法时进行try-catch处理。

优化异常处理：在实际应用中，需要根据具体情况对异常处理进行优化。例如，可以使用多线程机制来提高程序的性能；或者使用日志系统来记录程序运行过程中出现的异常情况等。

异常处理思路图：

SpringMVC之JSON数据返回与异常处理机制---全方面讲解,json,spring,intellij-idea,mvc,java

3.4 SpringMVC异常分类

使用Spring MVC提供的简单异常处理器SimpleMappingExceptionResolver；

实现Spring的异常处理接口HandlerExceptionResolver自定义自己的异常处理器；

使用@ControllerAdvice + @ExceptionHandler

四，案例异常实战(三种)

4.1 异常处理方式一

SpringMVC中自带了一个异常处理器叫SimpleMappingExceptionResolver，该处理器实现了HandlerExceptionResolver 接口，全局异常处理器都需要实现该接口

在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>

JsonController创建一个错误方法：

    @RequestMapping("/error")
    public String error(Tbook tbook) {
        tbook = null;
        tbook.getBname();
        return "error";
    }

在WEB-INF创建jsp包下创建一个error.jsp页面来接受报错信息

SpringMVC之JSON数据返回与异常处理机制---全方面讲解,json,spring,intellij-idea,mvc,java

error.jsp:

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>系统繁忙</title>
</head>
<body>
<b1>发生异常！！！</b1>
${ex }
</body>
</html>

运行结果：

注意:因为在JsonController已经给实体为null值了接受的Bname值为空值，所以报出空指针异常

SpringMVC之JSON数据返回与异常处理机制---全方面讲解,json,spring,intellij-idea,mvc,java

1.通过instanceof判断异常类型

2.通过设置mv.setView(new MappingJackson2JsonView())方式返回JSON数据

4.2 异常处理方式二

创建一个Package包，定义GlobalException类并继承RuntimeException

GlobalException类：

package com.Bingzy.Excetion;

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);
    }
}

再创建一个Package包，定义GlobalExceptionHandler类并继承HandlerExceptionResolver

GlobalExceptionHandler类：

@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","运行时异常....");
        }
        return mv;
    }
}

在JsonController中再创建一个error2方法

    @RequestMapping("/error2")
    public String error2(Tbook tbook) {
        if (true)
            throw  new GlobalException("你不正经 怎么能乱发请求呢？😒😒");
        return "error";
    }

error.jsp:

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>系统繁忙</title>
</head>
<body>
<b1>发生异常！！！</b1>
<br>-----------------------<br>
${ex }
<br>--------------------<br>
${msg }
</body>
</html>

运行结果：

SpringMVC之JSON数据返回与异常处理机制---全方面讲解,json,spring,intellij-idea,mvc,java

4.3 异常处理方式三

定义一个GlobalExceptionResolver类

package com.Bingzy.GlobaExcetion;

import com.Bingzy.Excetion.GlobalException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

import java.util.HashMap;
import java.util.Map;

@ControllerAdvice
public class GlobalExceptionResolver {


// 返回错误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;
    }
}

这种方式是将我们的错误信息进行map保存然后转换为JSON格式输出在页面上

SpringMVC之JSON数据返回与异常处理机制---全方面讲解,json,spring,intellij-idea,mvc,java