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

2023-09-13 21:03:51

一,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>:

返回T:

 返回List<Map>:

返回Map:

返回JSON数组:

返回字符串:

三,异常机制的处理

3.1 异常机制处理概念

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

3.2 为什么要全局异常处理

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

3.3 异常处理思路

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

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

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

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

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

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

异常处理思路图:

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页面来接受报错信息

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值为空值,所以报出空指针异常

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>

运行结果:

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格式输出在页面上

好啦 今天的分享就到这啦  感觉还不错的小伙伴还请三连噢!

更多推荐

开源媒体浏览器Kyoo

什么是Kyoo?Kyoo是一款开源媒体浏览器,可让您流式传输电影、电视节目或动漫。它是Plex、Emby或Jellyfin的替代品。Kyoo是从头开始创建的,它不是一个分叉。一切都将永远是免费和开源的。软件特性:管理您的电影、电视剧和动漫自动下载元数据Transmux/Transcode文件以使它们在每个平台上可用具有

Redis常用数据类型及其应用场景

文章目录StringListHashSetSortedSetBitmapString字符串(String):可以存储任意类型的数据,比如字符串、整数、浮点数等。Redis中String数据类型的常用命令包括:设置值:SETkeyvalue,设置键key的值为value。获取值:GETkey,获取键key的值。获取值的长

产品新闻稿件怎么写?纯干货

写产品新闻稿件需要遵循一定的结构和写作规范,接下来伯乐网络传媒来给大家分享一下,以下是一些建议和步骤,供您参考:标题:使用简洁、准确的语言来概括产品的核心信息,吸引读者的兴趣。导语/导览:在开篇部分,以简洁明了的语句引起读者的兴趣,概述产品的主要特点和亮点。产品背景:介绍产品推出的背景和动机,例如市场需求、行业趋势或竞

【教程】AERMOD高斯稳态扩散模型

查看原文>>>基于AERMOD模型在大气环境影响评价中的实践应用随着我国经济快速发展,我国面临着日益严重的大气污染问题。近年来,严重的大气污染问题已经明显影响国计民生,引起政府、学界和人们越来越多的关注。大气污染是工农业生产、生活、交通、城市化等方面人为活动的综合结果,同时气象因素是控制大气污染的关键自然因素。大气污染

基础概念回顾:云原生应用交付

原文链接:基础概念回顾:云原生应用交付转载来源:NGINX开源社区NGINX唯一中文官方社区,尽在nginx.org.cn尽管云原生应用开发诞生于21世纪初,但是在术语使用方面还是非常混乱。本文将带您了解常见的术语和问题。云原生云原生计算基金会(CNCF)对“云原生”的定义如下:云原生技术允许企业在公有云、私有云和混合

数据结构-----栈(栈的初始化、建立、入栈、出栈、遍历、清空等操作)

目录前言栈1.定义2.栈的特点3.栈的储存方式3.1数组栈3.2链栈4.栈的基本操作(C语言)4.1初始化4.2判断是否满栈4.3判断空栈4.4入栈4.5出栈4.6获取栈顶元素4.7遍历栈4.8清空栈完整代码示例前言大家好呀!今天我们开始学习新的线性表结构----栈,前面我们学习了链表以及链表的相关操作,那么栈跟链表有

java高级:注解

目录认识注解&自定义注解元注解解析注解注解的应用场景认识注解&自定义注解注解和反射一样,都是用来做框架的,我们这里学习注解的目的其实是为了以后学习框架或者做框架做铺垫的。先来认识一下什么是注解?Java注解是代码中的特殊标记,比如@Override、@Test等,作用是:让其他程序根据注解信息决定怎么执行该程序。比如:

【Powershell 】(Windows下)常用命令 | 命令别名 | 运行Windows命令行工具 | 运行用户程序(vim、gcc、gdb)

微软官方Powershell文档:https://learn.microsoft.com/zh-cn/powershell/命令详细说明,在PDF的最后面:一、Powershell及命令简介1.1命令格式1.2命令的别名二、cmdlet别名三、cmdlet分类介绍3.1基础命令1.Get-Command2.Get-He

什么是Web浏览器的缓存机制?如何控制和清除浏览器缓存?

聚沙成塔·每天进步一点点⭐专栏简介⭐Web浏览器的缓存机制⭐浏览器缓存的工作原理⭐控制和清除浏览器缓存控制缓存⭐清除缓存⭐写在最后⭐专栏简介前端入门之旅:探索Web开发的奇妙世界欢迎来到前端入门之旅!感兴趣的可以订阅本专栏哦!这个专栏是为那些对Web开发感兴趣、刚刚踏入前端领域的朋友们量身打造的。无论你是完全的新手还是

JVM面试题(三)

提示:文章写完后,目录可以自动生成,如何生成可参考右边的帮助文档文章目录前言二、java中垃圾收集的方法有哪些?1.标记-清除:2.复制算法:3.标记-整理4.分代收集三、java内存模型四、简述java类加载机制?五、类加载器双亲委派模型机制?六、什么是类加载器,类加载器有哪些?七、简述java内存分配与回收策率以及

[echarts] 两侧堆叠柱状图

http://echarts.zhangmuchen.top/#/detail?cid=xOQSXIOQiKconstmyData=['福田区','罗湖区','南山区','盐田区','宝安区','龙岗区','坪山区','龙华区','光明区','大鹏区'];//全彩屏,双基色屏,简易屏,条形屏constoffLine=[

热文推荐