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

2023-09-14 00:48:24

目录

前言

一、JSON数据返回

1.导入依赖

2.配置spring-mvc.xml

3.使用@ResponseBody注解

4.Jackson

4.1.介绍

4.2.常用注解

二、异常处理机制

1.为什么要全局异常处理

2.异常处理思路

3.SpringMVC异常分类

4.综合案例

4.1.异常处理方式一

4.2.异常处理方式二

4.3异常处理方式三

5.响应封装类

前言

        Spring MVC是一个基于Java的实现了MVC设计模式的请求驱动类型的轻量级Web框架，通过一套注解，我们可以快速的搭建一个Web应用。在本文中，我们将重点介绍如何在Spring MVC中返回JSON数据以及如何处理异常。

一、JSON数据返回

1.导入依赖

为了使@ResponseBody注解生效，我们需要配置一个Jackson消息转换器，用于将Java对象序列化为JSON字符串。需要在pom.xml文件中添加Jackson依赖：

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

3.使用@ResponseBody注解

        在SpringMVC中，我们可以使用@ResponseBody注解将Controller方法的返回值直接转换为JSON格式。这样，当客户端请求该方法时，将会收到一个JSON格式的响应。

package com.ctb.controller;

import com.ctb.biz.UserBiz;
import com.ctb.model.User;
import com.ctb.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;


@Controller
@RequestMapping("/user/json")
public class JsonController {
    @Autowired
    private UserBiz userBiz;

    /**
     * 返回List<T> JSON数组
     * @param req
     * @param user
     * @return
     */
    @ResponseBody
    @RequestMapping("/list")
    public List<User> list(HttpServletRequest req, User user){
        PageBean pageBean = new PageBean();
        pageBean.setRequest(req);
        List<User> lst = this.userBiz.listPager(user, pageBean);
        System.out.println(1 / 0);
        return lst;
    }

    /**
     * 返回T JSON对象
     * @param req
     * @param user
     * @return
     */
    @ResponseBody
    @RequestMapping("/load")
    public User load(HttpServletRequest req, User user){
        if(user.getId() != null){
            List<User> lst = this.userBiz.listPager(user, null);
            return lst.get(0);
        }
        return null;
    }


    /**
     * 返回List<Map> JSON数组
     * @param req
     * @param user
     * @return
     */
    @ResponseBody
    @RequestMapping("/mapList")
    public List<Map> mapList(HttpServletRequest req, User user){
        PageBean pageBean = new PageBean();
        pageBean.setRequest(req);
        List<Map> lst = this.userBiz.mapListPager(user, pageBean);
        return lst;
    }

    /**
     * 返回Map JSON对象
     * @param req
     * @param user
     * @return
     */
    @ResponseBody
    @RequestMapping("/mapLoad")
    public Map mapLoad(HttpServletRequest req, User user){
        if(user.getId() != null){
            List<Map> lst = this.userBiz.mapListPager(user, null);
            return lst.get(0);
        }
        return null;
    }

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

    @ResponseBody//
    @RequestMapping("/jsonStr")
    public String jsonStr(HttpServletRequest req, User user){
       
        return "userEdit";
    }


}

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

 以下是部分方法运行结果

4.Jackson

4.1.介绍

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

特点

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

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

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

  • 创建干净的json

  • 不依赖其他库

  • 代码开源

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

二、异常处理机制

1.为什么要全局异常处理

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

2.异常处理思路

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

3.SpringMVC异常分类

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

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

  • 使用@ControllerAdvice + @ExceptionHandler

4.综合案例

4.1.异常处理方式一

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

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

注：页面跳转由SpringMVC来接管了，所以此处的定义默认的异常处理页面都应该配置成逻辑视图名。  

前端页面


<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>错误界面</title>
</head>
<body>
错误信息界面。。。。。。
${ex}
</body>
</html>

4.2.异常处理方式二
  •  创建一个名为GlobalException的自定义异常类

这是一个名为GlobalException的Java类，它继承自RuntimeException。RuntimeException是Java中所有未检查异常的父类。这个类提供了多种构造方法，用于创建不同类型的异常对象。

package com.ctb.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的类，并实现了HandlerExceptionResolver接口。
package com.ctb.component;

import com.ctb.exception.GlobalException;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@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");//error.jsp
        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;
    }
}

它实现了HandlerExceptionResolver接口（异常处理解析器）。当应用程序中抛出异常时，这个处理器会被调用，返回一个ModelAndView对象，用于渲染错误页面。

代码解析：

  1. @Component注解表示这个类是一个Spring组件，Spring会自动扫描并管理这个类的实例。

  2. GlobalExceptionHandler类实现了HandlerExceptionResolver接口，该接口只有一个方法resolveException，Spring在处理异常时会调用这个方法。

  3. resolveException方法接收四个参数，分别是HttpServletRequest、HttpServletResponse、Object和Exception。HttpServletRequest和HttpServletResponse是HTTP请求和响应的对象，Object是当前处理的请求或响应的对象，Exception是发生的异常。

  4. 在resolveException方法中，首先创建了一个ModelAndView对象mv，然后设置了视图名称为"error"，即错误页面。

  5. 接着判断异常的类型，如果是GlobalException类型，则获取其消息并添加到mv中，同时添加一条"全局异常...."的消息。如果是RuntimeException类型，则获取其消息并添加到mv中，同时添加一条"运行时异常...."的消息。

  6. 最后返回mv对象，Spring会根据这个对象渲染错误页面。

部分方法测试 

4.3异常处理方式三

  • ControllerAdvice：这是一个全局的异常处理器，可以捕获所有控制器中抛出的异常。通常我们会使用 @ControllerAdvice 注解来标记一个类为 ControllerAdvice，然后在该类中定义异常处理方法。

  • @ExceptionHandler：这是一个用于处理方法参数中抛出的指定类型的异常的注解。我们可以在方法上使用 @ExceptionHandler 注解来指定要处理的异常类型，以及处理方法的名称。

package com.ctb.component;

import com.ctb.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 GlobalExceptionResolver {

//    跳转错误页面
//    @ExceptionHandler
//    public ModelAndView handler(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;
//    }

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

代码解析

handler(Exception e)方法：

  • 使用@ResponseBody注解，表示将返回的对象作为响应体发送给客户端。
  • 使用@ExceptionHandler注解，表示该方法用于处理控制器中抛出的异常。
  • 创建一个HashMap对象，用于存储异常信息。
  • 判断异常类型，如果是GlobalException，则将异常信息添加到map中，并设置提示信息为"全局异常....";
  • 如果异常类型是RuntimeException，则将异常信息添加到map中，并设置提示信息为"运行时异常....";
  • 其他类型的异常，将异常信息添加到map中，并设置提示信息为"其它异常....";
  • 返回map对象。

部分方法测试 

 

 

5.响应封装类

  • 创建自定义异常类BusinessException

BusinessException自定义异常类将继承RuntimeException异常，该异常类用于处理在程序代码运行过程所产生的运行时业务异常信息。

  • 创建响应枚举类JsonResponseStatus

JsonResponseStatus响应枚举类用于自定义错误码。

  • 创建响应封装类JsonResponseBody

JsonResponseBody响应封装类用于以JSON的形式统一输出错误信息。

// 响应封装类
    @ResponseBody
    @ExceptionHandler
    public R handler(Exception e){
        if (e instanceof GlobalException){
            GlobalException globalException = (GlobalException) e;
            return R.ok(666,"全局异常....",globalException.getMessage());
        }else if (e instanceof RuntimeException){
            RuntimeException runtimeException = (RuntimeException) e;
            return R.ok(666,"运行异常....",runtimeException.getMessage());
        }else {
            return R.ok(666,"其它异常....",e.getMessage());
        }
    }

根据传入的异常对象进行类型判断，并返回相应的响应结果。

部分方法测试

 

 

 

更多推荐

数据结构之美：如何优化内存和性能

文章目录什么是数据结构？内存优化使用紧凑的数据类型避免冗余存储使用位运算压缩数据性能优化使用适当的数据结构减少不必要的复制使用合适的算法数据结构优化的案例分析结论🎉欢迎来到数据结构学习专栏~探索数据结构之美：如何优化内存和性能☆*o(≧▽≦)o*☆嗨~我是IT·陈寒🍹✨博客主页：IT·陈寒的博客🎈该系列文章专栏：

阿里云ACP认证备考指南，赶紧收藏！

新技术更新迭代，后浪追逐，前浪内卷。唯有硬技能才能助你在职场乘风破浪。作为技术人，该如何有效的提高职场竞争力呢？而证书是一种能非常有效证明自己能力的东西，不仅能够提高简历通过率，为你的面试加分，还可以为你的升职加薪提高筹码，通过考证去提升自己，真的是一种性价比很高的方式。阿里云ACP认证专业工程师考试是当前比较热门的一

（WRF/Chem）在大气环境领域实践技术应用

随着我国经济快速发展，我国面临着日益严重的大气污染问题。近年来，严重的大气污染问题已经明显影响国计民生，引起政府、学界和人们越来越多的关注。大气污染是工农业生产、生活、交通、城市化等方面人为活动的综合结果，同时气象因素是控制大气污染的关键自然因素。大气污染问题既是局部、当地的，也是区域的，甚至是全球的。本地的污染物排放

百度ERNIE 3.0——中文情感分析实战

目录前言一、百度ERNIE3.0二、使用ERNIE3.0中文预训练模型进行句子级别的情感分析2-1、环境2-2、数据集加载2-3、加载预训练模型和分词器2-4、基于预训练模型的数据处理2-5、数据训练和评估2-6、模型验证2-7、情感分析结果的预测以及保存三、自定义个人案例3-1、如何自定义数据集总结前言ERNIE（E

Linux Tips 04

文章目录一、文件系统的简单操作列出文件系统的整体磁盘使用量查看文件系统的磁盘使用量（常用在查看目录所占磁盘空间）硬链接观察磁盘分区状态磁盘分区文件系统挂载与卸载一、文件系统的简单操作列出文件系统的整体磁盘使用量列出文件系统的整体磁盘使用量df[-ahikHTm]目录或文件名-a列出所有的文件系统-kKBytes容量显示

windbg调试句柄问题

这里写自定义目录标题winform，句柄资源不够强，程序crash句柄主程序c++程序，加载的插件是c#dll，这时候如何用windbg调试dll库如果查看句柄和对象的关系!handle怎么能知道哪个句柄是Form对话框的句柄如何查看句柄对应的类对象winform，句柄资源不够强，程序crashWinForm中句柄资源

如何应对软件项目中的变化

软件研发管理中，变化是常态，如何应对变化，及时解决不利因素至关重要。它可以帮助企业适应市场需求、提高竞争力和软件质量、及时降低风险，增强团队合作。如果不能及时适应开发中的变化，不能及时调整项目计划和资源分配来适应变化，项目可能无法按时完成，导致额外的开销和资源浪费等问题。应对软件项目中的变化因此，我们需要采取策略及时应

物料主数据的建设过程分享

一、什么是物料1.1物料的定义物料主数据包含了对所有企业所采购、生产和存储在库存中物料的集中描述。它是企业中有关物料信息的物料数据代码库。将所有的物料数据集成在单一的物料数据库中，消除了数据冗余的问题，而且不仅允许采购部门使用这些数据，其他应用部门也可以使用这些数据。物料主数据贯穿于制造型企业的各个环节，企业的物流、信

我的C#基础

usingSystem;namespaceHelloWorldApplication}@TOC欢迎使用Markdown编辑器你好！这是你第一次使用Markdown编辑器所展示的欢迎页。为帮助您在CSDN创作的文章获得更多曝光和关注，我们为您提供了专属福利：已注册且未在CSDN平台发布过文章的用户，9月1日—9月30日期

MySQL 主从复制与读写分离

1、主从复制与读写分离1.1什么是读写分离读写分离，基本的原理是让主数据库处理事务性增、改、删操作（INSERT、UPDATE、DELETE），而从数据库处理SELECT查询操作。数据库复制被用来把事务性操作导致的变更同步到集群中的从数据库。1.2为什么要读写分离因为数据库的“写”（写10000条数据可能要3分钟）操作

2023_Spark_实验十二：Spark高级算子使用

掌握Spark高级算子在代码中的使用相同点分析三个函数的共同点，都是Transformation算子。惰性的算子。不同点分析map函数是一条数据一条数据的处理，也就是，map的输入参数中要包含一条数据以及其他你需要传的参数。mapPartitions函数是一个partition数据一起处理，也即是说，mapPartit

热文推荐
  1. == 和 equals 的区别

    😀前言我们首先介绍了==运算符，它主要用于比较对象的引用地址。我们明确了它适用于基本数据类型和引用类型，以及其默认行为。然后，我们详细讨论了equals方法，它是一个方法，通常用于比较对象的内容。我们强调了需要在自定义类中重写equals方法以便实现对象内容的比较，同时提到了一些重写equals方法时需要遵循的约定�

  2. 初创型企业如何申报专精特新中小企业！？

    数据显示，我国已培育7万多家技术专精特新中小民营企业，其中自己专精特新“小巨人”企业8997家。去年新上市公司企业中，专精特新中小民营企业占59％。今年我国将深入研究实施提供优质服务企业进行梯度培育工程，力争今年全国专精特新中小企业员工数量超过8万家，计划培育100个左右中小企业文化特色社会产业集群。那么初创型企业申报

  3. 【uniapp】Dcloud的uni手机号一键登录，具体实现及踩过的坑，调用uniCloud.getPhoneNumber(),uni.login()等

    一键登录Dcloud官网请戳这里，感兴趣的可以看看官网，有很详细的示例，选择App一键登录，可以看到一些常用的概述比如：1、调用uni.login就能弹出一键登录的页面2、一键登录的流程，可以选择先预登录uni.prelogin()或直接登录uni.login()3、要先开通Dcloud一键登录服务，在Dcloud开发

  4. 基于5G网络的智能车间MES设计方案

    导读在数字化转型建设过程中，机械制造企业的难点是智能车间的设计。随着5G技术的发展，大量的带网络接口的智能设备的投入使用，智能车间的实施成为可能。本文从车间生产计划调度、过程管控、设备管理、质量管理、能耗管理和物流仓储等方面提出了车间MES执行系统设计的要求，同时对企业实施MES的过程提出了四个注意事项。01引言随着网

  5. 详解SpringBoot的核心特性

    详解SpringBoot的核心特性SpringBoot是一个用于简化Spring应用程序开发的框架，它提供了一系列核心特性，使得开发者能够更快速、更简单地构建和部署Spring应用程序。本文将详细介绍SpringBoot的五个核心特性，并为每个特性提供三个子特性的详细解释。1.独立运行的Spring应用程序Spring

  6. 在SpringBoot中如何整合消息服务组件？

    在开发中，消息服务组件在系统架构中扮演着举足轻重的角色。本文将介绍消息服务组件的基本概念，以及如何在SpringBoot中整合常见的消息服务组件，如ActiveMQ、RabbitMQ和Kafka。最后，我们将探讨整合消息服务组件在实际应用场景中的优势。1.消息服务组件的基本概念1.1什么是消息服务组件消息服务组件作为一

  7. Spring Boot 有哪些特点？

    目录一、自动配置二、嵌入式TomcatWeb服务器三、入门POM四、Actuator执行器API五、SpringBoot初始化器一、自动配置SpringBoot的自动配置是SpringBoot框架提供的一种功能，它可以根据用程序的依赖和配置信息，自动配置一些常见的功能模块。这样，开发人员可以快速构建和部署应用程序，而无

  8. 在虚拟机上安装win10/ubuntu的教程

    以下内容源于网络资源的学习与整理，如有侵权请告知删除。一、资源下载（1）下载虚拟机Vmware_Pro17：网盘链接（2）下载操作系统镜像：MSDN,我告诉你-做一个安静的工具站或者从网盘下载：win10镜像（囧，没会员不能上传），ubuntu20镜像。二、在虚拟机上安装ubuntu系统1、打开虚拟机，选择文件>>新建

  9. 电商平台淘宝、京东、1688等，它们都提供了相应的API数据接口供开发者使用

    获取商品数据已经成为许多应用程序的重要组成部分。为了实现这一目标，许多公司和技术开发者使用API数据接口来获取相关数据。本文将详细介绍如何使用API数据接口获取商品数据，并使用Python作为编程语言示例来展示相关代码。API数据接口是一种通信协议，它允许不同的应用程序或服务之间进行数据交换。这些接口通常是由各种平台、