【推荐】SpringMVC与JSON数据返回及异常处理机制的使用

🎬 艳艳耶✌️：个人主页

🔥 个人专栏 ：《【推荐】Spring与Mybatis集成整合》

⛺️ 生活的理想，为了不断更新自己 !

1.JSON

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

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

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

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

2.异常处理机制

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

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

3.JSON数据返回

当使用`@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响应内容返回给客户端。

3.1代码演示

导入依赖

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

使用@ResponseBody注解

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

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

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

package com.sy.web;


import com.sy.biz.BookBiz;
import com.sy.exception.GlobalException;
import com.sy.model.Book;
import com.sy.utis.PageBean;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

//@ResponseBody
//@Controller

@RestController

@RequestMapping("/book/json")
public class JsonController {
    @Autowired
    private BookBiz bookBiz;

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

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


    /**
     * 返回List<Map>
     * @param req
     * @param book
     * @return
     */
    @ResponseBody
    @RequestMapping("/mapList")
    public List<Map> mapList(HttpServletRequest req, Book book){
        PageBean pageBean = new PageBean();
        pageBean.setRequest(req);
        List<Map> lst = this.bookBiz.mapListPager(book, pageBean);
        System.out.println(1 / 0);
        return lst;
    }

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


    @ResponseBody
    @RequestMapping("/all")
    public Map all(HttpServletRequest req, Book book){
        PageBean pageBean = new PageBean();
        pageBean.setRequest(req);
        List<Book> lst = this.bookBiz.selectByBookPager(book, pageBean);
        Map map = new HashMap();
        map.put("lst",lst);
        map.put("pageBean",pageBean);
        return map;
    }

//    @ResponseBody
    @RequestMapping("/jsonStr")
    public String jsonStr(HttpServletRequest req, Book book){
        if(true)
        throw new GlobalException("温馨提示：信号不稳定！！！");
        return "clzEdit";
    }


}

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

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

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

 List<Map>  mapListPager(Book book);

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

   List<Map>  mapListPager(Book book, PageBean pageBean);

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

 @Override
    public List<Map> mapListPager(Book book, PageBean pageBean) {
        book = null;
        return bookMapper.mapListPager(book);
    }

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

4.异常处理机制

4.1 为什么

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

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

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

4.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></head>
<title>Title</title>
<h1>错误信息</h1>
<hr>
${ex}
<hr>
${msg}
</body>
</html>

异常一：

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

book= null;

如下👇👇👇:

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

结果展示：

异常二：

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

package com.sy.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.sy.component;

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

}

结果展示：

异常三：

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

package com.sy.component;

import com.sy.exception.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 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;
    }
}

结果展示：

今日分享结束！