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

    目录

    一.JSON

    1.1.介绍

     1.2.SpringMVC之JSON数据返回

    1.2.1.导入依赖

    1.2.2.配置spring-mvc.xml

    1.2.3.@ResponseBody注解使用

    1.2.4.常用注解

    二.统一异常处理

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

    2.2.异常处理思路

    2.2.异常处理方式一

    2.3.异常处理方式二

    2.4.异常处理方式三

     好啦，今天的分享就到这了，希望能够帮到你呢！😊😊  

    一.JSON

    1.1.介绍

    JSON（JavaScript Object Notation）是一种轻量级的数据交换格式，旨在易于阅读和编写，同时也易于解析和生成。它由 Douglas Crockford 在 2001 年创造，并逐渐成为一种通用格式。

    JSON 使用键值对的方式组织数据，可以表示简单的数据类型（如字符串、数值、布尔值和空值），以及复杂的数据类型（如对象和数组）。

    以下是 JSON 的一些特点和优势：

    1. 简洁清晰：JSON 使用简单的键值对结构，易于理解和编写。

    2. 可读性强：JSON 数据可以很容易地被人类阅读和理解，也便于调试和排查问题。

    3. 平台无关性：JSON 是一种独立于编程语言和平台的通用数据格式，可以在不同的环境中进行数据交换。

    4. 跨语言交互：由于 JSON 的普及，几乎所有的编程语言都支持 JSON 的解析和生成，使得不同语言之间的数据交互更加便捷。

    5. 支持复杂结构：JSON 可以嵌套表示复杂的数据结构，例如对象中嵌套对象、数组中嵌套数组等。

    6. 轻量高效：JSON 的数据量通常比 XML 更小，解析速度更快。

    简单来说：

    JSON 在 Web 开发中得到广泛应用，特别是与前端进行数据交互，例如通过 AJAX 请求获取或发送 JSON 数据。同时，也被用作配置文件、日志记录、API 接口的数据传输等场景。在大多数编程语言中，都有现成的库或工具，能够方便地处理 JSON 数据。

     1.2.SpringMVC之JSON数据返回

    1.2.1.导入依赖

    2.     com.fasterxml.jackson.core
    3.     jackson-databind
    4.     2.9.3
    7.     com.fasterxml.jackson.core
    8.     jackson-core
    9.     2.9.3
    12.     com.fasterxml.jackson.core
    13.     jackson-annotations
    14.     2.9.3
    15.

    1.2.2.配置spring-mvc.xml

    1. "org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter">
    2.     "messageConverters">
    3.         
    4.         	"mappingJackson2HttpMessageConverter"/>
    5.         
    6.     
    8. "mappingJackson2HttpMessageConverter"
    9. class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
    10.     
    11.     "supportedMediaTypes">
    12.         
    13.             text/html;charset=UTF-8
    14.             text/json;charset=UTF-8
    15.             application/json;charset=UTF-8
    16.         
    17.

    1.2.3.@ResponseBody注解使用

     @ResponseBody 注解是 Spring MVC 框架中的一个注解，用于指示某个方法的返回值应该直接作为响应体返回，而不是视图名称或模型对象。它常用于 RESTful API 开发，将方法的返回值直接序列化为 JSON 或其他格式的数据返回给客户端。

    JsonController：
    1. package com.junlinyi.web;
    2.  
    3. import com.junlinyi.biz.WorkBiz;
    4. import com.junlinyi.model.Work;
    5. import com.junlinyi.utils.PageBean;
    6. import org.springframework.beans.factory.annotation.Autowired;
    7. import org.springframework.stereotype.Controller;
    8. import org.springframework.web.bind.annotation.RequestMapping;
    9. import org.springframework.web.bind.annotation.ResponseBody;
    10.  
    11. import javax.servlet.http.HttpServletRequest;
    12. import java.util.HashMap;
    13. import java.util.List;
    14. import java.util.Map;
    15.  
    16. /**
    17.  * @author junlinyi
    18.  * @site www.junlinyi.com
    19.  * @company 君氏集团
    20.  * @create  2022-08-17 9:41
    21.  */
    22. @Controller
    23. @RequestMapping("/work/json")
    24. public class JsonController {
    25.     @Autowired
    26.     private WorkBiz workBiz;
    27.  
    28.     /**
    29.      * 返回List
    30.      *
    31.      * @param req
    32.      * @param work
    33.      * @return
    34.      */
    35.     @ResponseBody
    36.     @RequestMapping("/list")
    37.     public List list(HttpServletRequest req, Work work) {
    38.         PageBean pageBean = new PageBean();
    39.         pageBean.setRequest(req);
    40.         List lst = this.workBiz.listPager(work, pageBean);
    41.         return lst;
    42.     }
    43.  
    44.     /**
    45.      * 返回T
    46.      *
    47.      * @param req
    48.      * @param work
    49.      * @return
    50.      */
    51.     @ResponseBody
    52.     @RequestMapping("/load")
    53.     public Work load(HttpServletRequest req, Work work) {
    54.         if (work.getDid() != null) {
    55.             List lst = this.workBiz.listPager(work, null);
    56.             return lst.get(0);
    57.         }
    58.         return null;
    59.     }
    60.  
    61.  
    62.     /**
    63.      * 返回List
    64.      *
    65.      * @param req
    66.      * @param work
    67.      * @return
    68.      */
    69.     @ResponseBody
    70.     @RequestMapping("/mapList")
    71.     public List mapList(HttpServletRequest req, Work work) {
    72.         PageBean pageBean = new PageBean();
    73.         pageBean.setRequest(req);
    74.         List lst = this.workBiz.mapListPager(work, pageBean);
    75.         return lst;
    76.     }
    77.  
    78.     /**
    79.      * 返回Map
    80.      *
    81.      * @param req
    82.      * @param work
    83.      * @return
    84.      */
    85.     @ResponseBody
    86.     @RequestMapping("/mapLoad")
    87.     public Map mapLoad(HttpServletRequest req, Work work) {
    88.         if (work.getDid() != null) {
    89.             List lst = this.workBiz.mapListPager(work, null);
    90.             return lst.get(0);
    91.         }
    92.         return null;
    93.     }
    94.  
    95.  
    96.     @ResponseBody
    97.     @RequestMapping("/all")
    98.     public Map all(HttpServletRequest req, Work work) {
    99.         PageBean pageBean = new PageBean();
    100.         pageBean.setRequest(req);
    101.         List lst = this.workBiz.listPager(work, pageBean);
    102.         Map map = new HashMap();
    103.         map.put("lst", lst);
    104.         map.put("pageBean", pageBean);
    105.         return map;
    106.     }
    107.  
    108.     @ResponseBody//返回单个字符串，而不是页面
    109.     @RequestMapping("/jsonStr")
    110.     public String jsonStr(HttpServletRequest req, Work work) {
    111.         return "workEdit";
    112.     }
    113.  
    114.  
    115. }
    在WorkBizImpl加入以下代码：
    1. @Override
    2.     public List mapListPager(Work work, PageBean pagebean) {
    3.         return workMapper.mapListPager(work);
    4.     }

    在mapper.xml加入代码：

     在WorkBiz加入代码：

    List mapListPager(Work work, PageBean pagebean);

     在WorkMapper加入代码：

    List mapListPager(Work work);

    所有方法 效果测试从上至下：

     

     

     

     

     

     把所有的@ResponseBody注释掉，我只测试了最后一个：直接跳页面workEdit.jsp：其它的有兴趣的话可以去玩一下哦

     把所有的@ResponseBody注释掉，写在上面跟分开写效果一样：

     然而@ResponseBody  @Controller 这两个可以合成一个 @RestController同样一样返回的是JOSN数据

    1.2.4.常用注解

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

     在Work中属性加入@JsonIgnore可以影藏该属性的JOSN数据：

     效果：改图可以看出该属性dtp已经影藏了

    二.统一异常处理

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

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

    2.2.异常处理思路

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

    2.2.异常处理方式一

    首现我们自己在所建立方法中随便写一个错，方便我们来测试看你怎么玩如图：

     将以下代码加入到spring-mvc.xml中：

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

    1.  
    2.     "org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
    3.         
    4.         "defaultErrorView" value="error"/>
    5.         
    6.         "exceptionAttribute" value="ex"/>
    7.         
    8.         "exceptionMappings">
    9.             
    10.                 "java.lang.RuntimeException">error
    11.             
    12.             
    13.         
    14.

    建立 error.jsp：

    1. <%@ page contentType="text/html;charset=UTF-8" language="java" %>
    4.     Title
    7. 错误信息界面。。。
    8. ${ex}

     测试：

     

    2.3.异常处理方式二

    也是一样我们自己在所建立方法中随便写一个错，方便我们来测试，看你怎么玩如图：

     代码：

    1. package com.junlinyi.exception;
    2.  
    3. public class GlobalException extends RuntimeException {
    4.     public GlobalException() {
    5.     }
    6.  
    7.     public GlobalException(String message) {
    8.         super(message);
    9.     }
    10.  
    11.     public GlobalException(String message, Throwable cause) {
    12.         super(message, cause);
    13.     }
    14.  
    15.     public GlobalException(Throwable cause) {
    16.         super(cause);
    17.     }
    18.  
    19.     public GlobalException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
    20.         super(message, cause, enableSuppression, writableStackTrace);
    21.     }
    22. }

     创建一个异常类加入进去：

    1. package com.junlinyi.component;
    2.  
    3. import com.junlinyi.exception.GlobalException;
    4. import org.springframework.stereotype.Component;
    5. import org.springframework.web.servlet.HandlerExceptionResolver;
    6. import org.springframework.web.servlet.ModelAndView;
    7.  
    8. import javax.servlet.http.HttpServletRequest;
    9. import javax.servlet.http.HttpServletResponse;
    10.  
    11. @Component
    12. public class GlobalExceptionHandler implements HandlerExceptionResolver {
    13.     @Override
    14.     public ModelAndView resolveException(HttpServletRequest httpServletRequest,
    15.                                          HttpServletResponse httpServletResponse,
    16.                                          Object o, Exception e) {
    17.         ModelAndView mv = new ModelAndView();
    18.         mv.setViewName("error");// WEB_INF/jsp/error.jsp
    19.         if (e instanceof GlobalException){
    20.             GlobalException globalException = (GlobalException) e;
    21.             mv.addObject("ex",globalException.getMessage());
    22.             mv.addObject("msg","全局异常....");
    23.         }else if (e instanceof RuntimeException){
    24.             RuntimeException runtimeException = (RuntimeException) e;
    25.             mv.addObject("ex",runtimeException.getMessage());
    26.             mv.addObject("msg","运行时异常....");
    27.         }else{
    28.             mv.addObject("ex",e.getMessage());
    29.             mv.addObject("msg","其它时异常....");
    30.         }
    31.         return mv;
    32.     }
    33. }

     效果图：

     

     

    2.4.异常处理方式三

    新建立异常类代码：

    1. package com.junlinyi.component;
    2.  
    3. import com.junlinyi.exception.GlobalException;
    4. import org.springframework.web.bind.annotation.ControllerAdvice;
    5. import org.springframework.web.bind.annotation.ExceptionHandler;
    6. import org.springframework.web.bind.annotation.ResponseBody;
    7.  
    8. import java.util.HashMap;
    9. import java.util.Map;
    10.  
    11. @ControllerAdvice
    12. public class GlobalExceptionResolver {
    13.  
    14. //    跳转错误页面
    15. //    @ExceptionHandler
    16. //    public ModelAndView handler(Exception e){
    17. //        ModelAndView mv = new ModelAndView();
    18. //        mv.setViewName("error");
    19. //        if (e instanceof GlobalException){
    20. //            GlobalException globalException = (GlobalException) e;
    21. //            mv.addObject("ex",globalException.getMessage());
    22. //            mv.addObject("msg","全局异常....");
    23. //        }else if (e instanceof RuntimeException){
    24. //            RuntimeException runtimeException = (RuntimeException) e;
    25. //            mv.addObject("ex",runtimeException.getMessage());
    26. //            mv.addObject("msg","运行时异常....");
    27. //        }
    28. //        return mv;
    29. //    }
    30.  
    31. // 返回错误json数据
    32.     @ResponseBody
    33.     @ExceptionHandler
    34.     public Map handler(Exception e){
    35.         Map map = new HashMap();
    36.         if (e instanceof GlobalException){
    37.             GlobalException globalException = (GlobalException) e;
    38.             map.put("ex",globalException.getMessage());
    39.             map.put("msg","全局异常....");
    40.         }else if (e instanceof RuntimeException){
    41.             RuntimeException runtimeException = (RuntimeException) e;
    42.             map.put("ex",runtimeException.getMessage());
    43.             map.put("msg","运行时异常....");
    44.         }else {
    45.             map.put("ex",e.getMessage());
    46.             map.put("msg","其它异常....");
    47.         }
    48.         return map;
    49.     }
    50. }

     效果图：

     

     注释的代码效果跟异常处理方式二一样

     好啦，今天的分享就到这了，希望能够帮到你呢！😊😊  

  • 相关阅读:
    电子行业MES管理系统的几个主要功能
    基于JAVA的电子书城系统（Web）
    Qt程序的自定义安装卸载方案
    HTML+CSS大作业【传统文化艺术耍牙15页】学生个人网页设计作品
    【数据结构】——优先级队列（堆）
    堆以及堆的实现
    计算机毕业设计Python+djang高校教室管理系统(源码+系统+mysql数据库+Lw文档）
    第1关：构造函数与析构函数的实现
    一款好看的markdown编辑器：md-editor-v3
    From High-Level Deep Neural Models to FPGAs
  • 原文地址：https://blog.csdn.net/m0_74915426/article/details/132852892