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

2023-09-13 18:03:57

                                                 🎬 艳艳耶✌️:个人主页

                                                🔥 个人专栏 :《【推荐】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;
    }
}

结果展示:

                                                              今日分享结束!                                                                   

更多推荐

可视化图表组件之股票数据分析应用

股市是市场经济的必然产物,在一个国家的金融领域之中有着举足轻重的地位。在过去,人们对于市场走势的把握主要依赖于经验和直觉,往往容易受到主观因素的影响,导致决策上出现偏差。如今,通过数据可视化呈现,便可将历年数据和市场情报进行深度挖掘、分析,从中找到规律和趋势,帮助用户做出更准确的判断。回顾2022年A股市场的表现可谓是

Python爬虫从端到端抓取网页

网页抓取和RESTAPI简介网页抓取是使用计算机程序以自动方式从网站提取和解析数据的过程。这是创建用于研究和学习的数据集的有用技术。虽然网页抓取通常涉及解析和处理HTML文档,但某些平台还提供RESTAPI来以机器可读格式(如JSON)检索信息。在本教程中,我们将使用网络抓取和RESTAPI创建真实的数据集。如何运行代

Git学习笔记1

任务要求:1、使用git提交代码到仓库;2、实现自动代码发布系统;1、了解DevOps的发展历程和思想;2、学会git版本控制;3、会使用github公有仓库和gitlab私有仓库;4、了解CI/CD;5、使用jenkins实现自动发布;DevOps是一种实现Dev(开发)与Ops(运维)工作流有效联合的思想。最终目标

深入探索OCR技术:前沿算法与工业级部署方案揭秘

深入探索OCR技术:前沿算法与工业级部署方案揭秘注:以上图片来自网络1.OCR技术背景1.1OCR技术的应用场景OCR是什么OCR(OpticalCharacterRecognition,光学字符识别)是计算机视觉重要方向之一。传统定义的OCR一般面向扫描文档类对象,现在我们常说的OCR一般指场景文字识别(SceneT

服务器数据恢复-热备盘同步过程中硬盘离线的RAID5数据恢复案例

服务器数据恢复环境:华为OceanStor某型号存储,11块硬盘组建了一组RAID5阵列,另外1块硬盘作为热备盘使用。基于RAID5阵列的LUN分配给linux系统使用,存放Oracle数据库。服务器故障:RAID5阵列1块硬盘由于未知原因离线,热备盘激活开始同步数据,在热备盘同步的过程中又有1块硬盘离线,RAID5阵

一起学数据结构(7)——树及二叉树的基本概念及存储

前面的关于数据结构的文章中,介绍了顺序表,链表,栈,队列等数据结构。对于以上数据结构,均是一对一的关系。本篇文章将对于一对多的数据结构——树进行解析。目录1.树的定义及基本概念:1.1树的定义:1.2树的基本概念及术语:2.树的存储:3.二叉树的概念及结构:3.1二叉树的概念:3.2两种特殊的二叉树:3.2.1满二叉树

Learn Prompt-ChatGPT 精选案例:写作&博客

在ChatGPT的帮助下,文本内容的产出,尤其是撰写博客文章的过程得到了进一步的简化。你可以让ChatGPT激发你的灵感,也可以让它美化你的文章内容。这里我们希望能通过prompt写出一篇以“ChatGPT对社会各行各业的影响”为主题的博客。本页我们希望你可以使用ChatGPT网页版,利用ChatGPT写作的过程应该是

「聊设计模式」之模板方法模式(Template Method)

🏆本文收录于《聊设计模式》专栏,专门攻坚指数级提升,助你一臂之力,带你早日登顶🚀,欢迎持续关注&&收藏&&订阅!前言在软件开发中,设计模式是经典的解决方案,它们被广泛应用于面向对象的程序设计中。其中,模板方法模式(TemplateMethod)是一种常用的行为型设计模式,它定义一个操作中的算法骨架,而将一些步骤延迟

推进“数智+数治”,中期科技智慧公厕驱动城市公厕更新升级发展

随着城市化的快速发展和人口的不断增加,公共厕所这一基础设施的更新升级成为了亟待解决的问题。过去的传统公厕往往存在着环境脏乱差、无法保证使用者的舒适度等诸多问题。而智慧公厕则能够通过互联网和物联网的技术手段,实现智能化的运行管理,为市民提供更加便捷、舒适的使用体验。如中期科技「智慧公厕-智慧厕所」,拥有厕位智能监测与引导

【Python深度学习】深度学习框架Tensorflow、Pytorch介绍

深度学习已经成为了人工智能领域的一股重要力量,而深度学习框架则是在这个领域中进行研究和应用的必备工具。常见的深度学习框架包括TensorFlow、PyTorch、Keras、Theano和Caffe等,其中TensorFlow和PyTorch是最受欢迎的两个框架。本文将着重介绍这两个框架的优缺点以及应用领域。1.Ten

企业架构LNMP学习笔记40

框架配置实现读写分离:1)修改项目配置文件:return[//数据库类型'type'=>'mysql',//服务器地址//1、主从数据库的连接地址主在前从在后'hostname'=>'192.168.17.100,192.168.17.105',//2、主从数据库的名称、用户、密码一样的话,只配置一份即可。如果不一样,

热文推荐