SpringMVC之JSON返回及异常处理机制-阿里云开发者社区

SpringMVC之JSON返回及异常处理机制

2023-11-09 50

版权

本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

简介： SpringMVC之JSON返回及异常处理机制

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>

配置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.zhanghao.controller;
import com.zhanghao.biz.ClazzBiz;
import com.zhanghao.model.Clazz;
import com.zhanghao.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 zhanghao
 * @site 
 * @company s集团
 * @create  2023-09-13 19:41
 */
@Controller
@RequestMapping("/clz/json")
public class JsonController {
    @Autowired
    private ClazzBiz clazzBiz;
    /**
     * 返回List<T>
     * @param req
     * @param clazz
     * @return
     */
    @ResponseBody
    @RequestMapping("/list")
    public List<Clazz> list(HttpServletRequest req, Clazz clazz){
        PageBean pageBean = new PageBean();
        pageBean.setRequest(req);
        List<Clazz> lst = this.clazzBiz.listPager(clazz, pageBean);
        return lst;
    }
    /**
     * 返回T
     * @param req
     * @param clazz
     * @return
     */
    @ResponseBody
    @RequestMapping("/load")
    public Clazz load(HttpServletRequest req, Clazz clazz){
        if(clazz.getCid() != null){
            List<Clazz> lst = this.clazzBiz.listPager(clazz, null);
            return lst.get(0);
        }
        return null;
    }
    /**
     * 返回List<Map>
     * @param req
     * @param clazz
     * @return
     */
    @ResponseBody
    @RequestMapping("/mapList")
    public List<Map> mapList(HttpServletRequest req, Clazz clazz){
        PageBean pageBean = new PageBean();
        pageBean.setRequest(req);
        List<Map> lst = this.clazzBiz.mapListPager(clazz, pageBean);
        return lst;
    }
    /**
     * 返回Map
     * @param req
     * @param clazz
     * @return
     */
    @ResponseBody
    @RequestMapping("/mapLoad")
    public Map mapLoad(HttpServletRequest req, Clazz clazz){
        if(clazz.getCid() != null){
            List<Map> lst = this.clazzBiz.mapListPager(clazz, null);
            return lst.get(0);
        }
        return null;
    }
    @ResponseBody
    @RequestMapping("/all")
    public Map all(HttpServletRequest req, Clazz clazz){
        PageBean pageBean = new PageBean();
        pageBean.setRequest(req);
        List<Clazz> lst = this.clazzBiz.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, Clazz clazz){
        return "clzEdit";
    }
}

impl

@Override
    public List<Map> mapListPager(Music music, PageBean pageBean) {
        return musicMapper.mapListPager(music);
    }

musicMapper

List<Map> mapListPager(Music music);

MusicBiz

List<Map> mapListPager(Music music, PageBean pageBean);

musicMapper.xml

<select id="mapListPager" resultType="java.util.Map" parameterType="com.zhanghao.model.Music" >
    select
    *
    from jay_music
    <where>
      <if test="mname != null">
        and mname like concat('%',#{mname},'%')
      </if>
    </where>
  </select>List<Map> mapListPager(Music music);

List集合转Json

Jackson

Jackson是一种Java编程语言的JSON处理工具库，用于将Java对象和JSON格式数据互相转换。

序列化和反序列化：将Java对象序列化成JSON格式，或将JSON格式的数据反序列化成Java对象。
自定义配置和注解：可以使用Jackson提供的注解和自定义配置来控制JSON序列化和反序列化的细节，比如格式、日期时间格式、空值处理等。
支持多种数据格式：Jackson不仅支持JSON格式，同时也支持XML、Google Protocol Buffers等多种数据格式，可以方便地进行数据交换和转换。
集成Spring框架：Spring MVC可以直接集成Jackson，开发者只需简单地配置一些参数，就可以使用Jackson进行JSON数据的转换，简化了开发过程。

总之，Jackson在Spring MVC中的用途主要是为了方便地进行Java对象和JSON格式数据之间的转换，从而实现高效、灵活、易用的Web应用程序开发。

1. @JsonFormat：格式化输出日期类型的值

2. @JsonInclude：控制序列化过程中包含哪些属性

3. @JsonIgnore：忽略某些属性

4. @JsonProperty：指定属性的名称

5. @JsonView：根据视图序列化对象

6. @JsonManagedReference和@JsonBackReference：解决对象循环引用的问题

7. @JsonIdentityInfo：为对象设置唯一标识

8. @JsonTypeInfo：序列化和反序列化时带上类型信息

9. @JsonAutoDetect：指定序列化和反序列化过程中哪些属性可见

10. @JsonCreator：定义一个构造函数用于反序列化

11. @JsonAnyGetter和@JsonAnySetter：序列化和反序列化时动态处理属性

SpringMVC异常分类

1. 控制器方法异常：当控制器方法抛出异常时，SpringMVC会将异常信息包装成一个特殊的响应对象返回给客户端。

2. 数据转换异常：当SpringMVC无法将请求参数转换成对应类型的数据时，会抛出数据转换异常。

3. 数据验证异常：当请求参数不符合预定的验证规则时，会抛出数据验证异常。

4. 消息转换异常：当SpringMVC无法将响应数据转换成客户端需要的类型时，会抛出消息转换异常。

5. 文件上传异常：当文件上传过程中出现问题时，会抛出文件上传异常。

6. MVC配置异常：当SpringMVC配置出现问题时，会抛出MVC配置异常。

7. 未处理的异常：当SpringMVC中出现未处理的异常时，会抛出未处理的异常。

异常处理方式一

<!-- 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>
</beans>

以及一个错误的数据

@RequestMapping("/mapList")
    public List<Map> mapList(HttpServletRequest req, Music  music){
        PageBean pageBean = new PageBean();
        pageBean.setRequest(req);
        List<Map> lst = this.musicBiz.mapListPager(music, pageBean);
        System.out.println(1/0);
        return lst;
    }

errpr.jsp

<%--
  Created by IntelliJ IDEA.
  User: jj
  Date: 2023/9/13
  Time: 19:43
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>error</title>
</head>
<body>
错误信息页面。。。
<hr>
${ex}
</body>
</html>

异常处理方式二

全局异常类

package com.zhanghao.component;
import com.zhanghao.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");
        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 {
        }
        return mv;
    }
}

异常类

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

异常处理方式三

重新写一个异常类

// 返回错误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;
    }