SpringMvc第六战-【SpringMvcJSON返回&异常处理机制】

╰半夏微凉° 2024-03-03 06:33 77阅读 0赞

前言：

小编讲述了：JSR303的**概念，应用场景和在具体实例**的使用；和[拦截器][Link 1]的应用

今天小编来讲述的为cJSON返回&异常处理机制，json返回就不用多说，毕竟大部分数据都是通过Json来传递数据的，异常返回的作用小编也就不多说了反正很重要！

**目录**

一.SpringMVC之JSON数据返回

1.在pom.xml导入Json依赖

2.配置(spring-mvc.xml)处理中文乱码以及避免IE执行AJAX时，返回JSON出现下载文件

3.@ResponseBody注解使用

4.导入JsonController（模拟数据生成）

4.1查询所有Json数据以数组形式输出

4.2查询单个Json对象

4.3通过mapList查询所有Json数据以数组形式输出

4.4通过mapLoad查询单个Json对象

4.5查询混合对象Json对象含有Json数组

4.6返回jsso字符串

5.优化将每一个方法的@ResponseBody注释

5.1注释后情况

5.2重新注释

编辑编辑

5.3通过加入JsonIgnore隐藏字段名

6.Jackson

6.1.介绍

6.2.常用注解

二.异常处理机制

1.为什么要全局异常处理（重点）

2.异常处理思路

3.SpringMVC异常分类

4.异常出现以及解决

1.异常的出现

2.解决办法（一）配置文件解决

2.1配置文件在spring-mvc.xml中

2.2构建error.jsp界面用于错误信息回显

3.解决办法（二）通过构建全局异常类

3.1.创建异常类

3.2构建一个响应类

3.3效果展示

4.解决办法（三）通过注解【@adviceContenter,@exceptionHandler】

4.1返回错误json数据 @ExceptionHandler

4.2打印结果

4.3返回界面

4.4测试结果

编辑

--------------------

## 一.SpringMVC之JSON数据返回 ##

### 1.在pom.xml导入Json依赖 ###

<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)处理中文乱码以及避免IE执行AJAX时，返回JSON出现下载文件 ###

<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">
    
    <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注解使用 ###

> `@ResponseBody`注解的作用是将**Controller的方法返回的对象通过适当的转换器转换为指定的格式之后，写入到response对象的body区，通常用来返回`JSON`数据或者是XML数据**。
> 
> > 注意：在使用此注解之后不**会再走视图解析器，而是直接将数据写入到输入流中，他的效果等同于通过response对象输出指定格式的数据。**

### 4.导入JsonController（模拟数据生成） ###

package com.lz.controller;
    
    import com.lz.Biz.BookBiz;
    import com.lz.model.Book;
    import com.lz.utlis.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("/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.listPager(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.listPager(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);
            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 clazz){
            PageBean pageBean = new PageBean();
            pageBean.setRequest(req);
            List<Book> lst = this.bookBiz.listPager(clazz, 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){
            return "clzEdit";
        }
    
    
    }

#### 4.1查询所有Json数据以数组形式输出 ####

![9b2d540f267f4686b12d6017b082f59d.gif][]

#### 4.2查询单个Json对象 ####

![c664b63db6b047eb9c0bb43a5da7db76.gif][]

#### 4.3通过mapList查询所有Json数据以数组形式输出 ####

![f526877160414eccbb8969fdd2476e8c.gif][]

#### 4.4通过mapLoad查询单个Json对象 ####

![d9e999aa507e492a88e889aa3fe376fe.gif][]

#### 4.5查询混合对象Json对象含有Json数组 ####

![4db99b0267c3498bbc69cbbd68756f59.gif][]

#### 4.6返回jsso字符串 ####

![1e57b8b7ca78468daaadcbc186b78c78.gif][]

### 5.优化将每一个方法的@ResponseBody注释 ###

#### 5.1注释后情况 ####

![2f5bfbece9ec4567b0cc69c1c9745004.png][]

#### 5.2重新注释 ####

#### ![d28ce4a5e5674e71972b751f2c459c12.png][]![539f1855881d4f058e420b997750cb44.png][] ####

#### 5.3通过加入JsonIgnore隐藏字段名 ####

![47183b71682e44beb574b7292dd1afaa.png][]

![6fd301c0d9364f03bb51895f2551e1d0.png][]

### 6.Jackson ###

#### 6.1.介绍 ####

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

**特点**

*  容易使用，提供了高层次外观，简化常用的用例。
 *  无需创建映射，API提供了默认的映射大部分对象序列化。
 *  性能高，快速，低内存占用
 *  创建干净的json
 *  不依赖其他库
 *  代码开源

#### 6.2.常用注解 ####

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

## 二.异常处理机制 ##

### 1.为什么要全局异常处理（重点） ###

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

### 2.异常处理思路 ###

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

![782a9e27427349028df5d0eeefd81a43.png][]

### 3.SpringMVC异常分类 ###

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

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

使用@ControllerAdvice + @ExceptionHandler

### 4.异常出现以及解决 ###

#### 1.异常的出现 ####

![e7d1381ca8e742eebfecdbe0552167e7.png][]

![6430ed3d1a5447359af33f33078324da.png][]

#### 2.解决办法（一）配置文件解决 ####

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

##### **2.1配置文件在spring-mvc.xml中** #####

**![4e1fe466c45c48d6ab42a4fa499fbb2f.png][]**

<bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
        
        <property name="defaultErrorView" value="error"/>
         
        <property name="exceptionAttribute" value="ex"/>
         
        <property name="exceptionMappings">
            <props>
                <prop key="java.lang.RuntimeException">error</prop>
            </props>
        	
        </property>
    </bean>

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

##### 2.2构建error.jsp界面用于错误信息回显 #####

![fb334e6c6d0d48e7b06d0ca276b3b404.png][]![7bfc4d68aebc495f8be0c30979345d65.png][]

#### 3.解决办法（二）通过构建全局异常类 ####

##### 3.1.创建异常类 #####

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

##### 3.2构建一个响应类 #####

package com.lz.component;
    
    import com.lz.execption.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");
            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;
        }
    }

##### 3.3效果展示 #####

![065c1baba0a74ce08cc645999be5bb40.png][]

![b6837c9970274887b59bb0bc5d99554a.png][]![933c5f0eac5d4258b1d3cdca2d1f2819.png][]

#### 4.解决办法（三）通过注解【@adviceContenter,@exceptionHandler】 ####

##### 4.1返回错误json数据 @ExceptionHandler #####

@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;
        }

##### 4.2打印结果 #####

![cd8616d749564c97a607f8ce889db749.png][]

##### 4.3返回界面 #####

跳转错误页面
        @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;
        }

##### 4.4测试结果 #####

##### ![0efb1b40a5ba4f138bf92b812a14cf71.png][] #####

#####  #####

[Link 1]: https://so.csdn.net/so/search?q=%E6%8B%A6%E6%88%AA%E5%99%A8&spm=1001.2101.3001.7020
[9b2d540f267f4686b12d6017b082f59d.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/03/a3045525b51849f485c96affd1174e8f.png
[c664b63db6b047eb9c0bb43a5da7db76.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/03/78b067c8b9bb4afbb7f536ef343f3231.png
[f526877160414eccbb8969fdd2476e8c.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/03/31c5f954248f43a49b260b2838d882ff.png
[d9e999aa507e492a88e889aa3fe376fe.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/03/ea2c850940614f73a768d34a4a52e19d.png
[4db99b0267c3498bbc69cbbd68756f59.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/03/beb8cfabdd564586bcd44ad03d66ebf6.png
[1e57b8b7ca78468daaadcbc186b78c78.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/03/0c113a7f84864a7da3e54bd402818d5e.png
[2f5bfbece9ec4567b0cc69c1c9745004.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/03/62c75f436386449da0d39f9c03a2a1a8.png
[d28ce4a5e5674e71972b751f2c459c12.png]: https://img-blog.csdnimg.cn/d28ce4a5e5674e71972b751f2c459c12.png
[539f1855881d4f058e420b997750cb44.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/03/15977a5b51f64e7c8d20dde7ad2138d1.png
[47183b71682e44beb574b7292dd1afaa.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/03/8553e8ec4b0045e488ab6af93e91044d.png
[6fd301c0d9364f03bb51895f2551e1d0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/03/202e14efb6334eb8a7f52fef8aa86d44.png
[782a9e27427349028df5d0eeefd81a43.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/03/c72fbee9abcb49548d8c50ae3d0dfce0.png
[e7d1381ca8e742eebfecdbe0552167e7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/03/c50110d0dcf34a229d49b61535b4fad2.png
[6430ed3d1a5447359af33f33078324da.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/03/a894af45be3d4f96b46c801d84959ae5.png
[4e1fe466c45c48d6ab42a4fa499fbb2f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/03/95c9d08152c049caa160a53c33ecf84c.png
[fb334e6c6d0d48e7b06d0ca276b3b404.png]: https://img-blog.csdnimg.cn/fb334e6c6d0d48e7b06d0ca276b3b404.png
[7bfc4d68aebc495f8be0c30979345d65.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/03/8c3b9612b28f48b194ac39cfb6ceefac.png
[065c1baba0a74ce08cc645999be5bb40.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/03/e8cb39381634447299e0fb568533c2ab.png
[b6837c9970274887b59bb0bc5d99554a.png]: https://img-blog.csdnimg.cn/b6837c9970274887b59bb0bc5d99554a.png
[933c5f0eac5d4258b1d3cdca2d1f2819.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/03/7f522d3af89a4a8dadf8a1b66018fc66.png
[cd8616d749564c97a607f8ce889db749.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/03/ca8f19120e9d45dda93acf79d38e370e.png
[0efb1b40a5ba4f138bf92b812a14cf71.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/03/2902df356195423299957887004a0db9.png