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.导入依赖

    com.fasterxml.jackson.core
    jackson-databind
    2.9.3


    com.fasterxml.jackson.core
    jackson-core
    2.9.3


    com.fasterxml.jackson.core
    jackson-annotations
    2.9.3
 

1.2.2.配置spring-mvc.xml

    
        
        	
        
    


    
    
        
            text/html;charset=UTF-8
            text/json;charset=UTF-8
            application/json;charset=UTF-8
        
    

1.2.3.@ResponseBody注解使用

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

JsonController：

package com.junlinyi.web;

import com.junlinyi.biz.WorkBiz;
import com.junlinyi.model.Work;
import com.junlinyi.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;

/**
 * @author junlinyi
 * @site www.junlinyi.com
 * @company 君氏集团
 * @create  2022-08-17 9:41
 */
@Controller
@RequestMapping("/work/json")
public class JsonController {
    @Autowired
    private WorkBiz workBiz;

    /**
     * 返回List
     *
     * @param req
     * @param work
     * @return
     */
    @ResponseBody
    @RequestMapping("/list")
    public List list(HttpServletRequest req, Work work) {
        PageBean pageBean = new PageBean();
        pageBean.setRequest(req);
        List lst = this.workBiz.listPager(work, pageBean);
        return lst;
    }

    /**
     * 返回T
     *
     * @param req
     * @param work
     * @return
     */
    @ResponseBody
    @RequestMapping("/load")
    public Work load(HttpServletRequest req, Work work) {
        if (work.getDid() != null) {
            List lst = this.workBiz.listPager(work, null);
            return lst.get(0);
        }
        return null;
    }


    /**
     * 返回List

在WorkBizImpl加入以下代码：

@Override
    public List

在mapper.xml加入代码：

    select
    
    from t_work_gz
    
      
        and dname like concat('%',#{dname},'%')
      
    
  

 在WorkBiz加入代码：

List

 在WorkMapper加入代码：

List

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

 

 

 

 

 

 把所有的@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 接口，全局异常处理器都需要实现该接口。

 
    
        
        
        
        
        
        
            
                error
            
            
        
    

建立 error.jsp：

<%@ page contentType="text/html;charset=UTF-8" language="java" %>


    


错误信息界面。。。
${ex}

 测试：

 

2.3.异常处理方式二

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

 代码：

package com.junlinyi.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);
    }
}

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

package com.junlinyi.component;

import com.junlinyi.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");// WEB_INF/jsp/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","运行时异常....");
        }else{
            mv.addObject("ex",e.getMessage());
            mv.addObject("msg","其它时异常....");
        }
        return mv;
    }
}

 效果图：

 

 

2.4.异常处理方式三

新建立异常类代码：

package com.junlinyi.component;

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

 效果图：

 

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

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