AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

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

2023-11-09 113
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 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格式数据互相转换。

  1. 序列化和反序列化：将Java对象序列化成JSON格式，或将JSON格式的数据反序列化成Java对象。
  2. 自定义配置和注解：可以使用Jackson提供的注解和自定义配置来控制JSON序列化和反序列化的细节，比如格式、日期时间格式、空值处理等。
  3. 支持多种数据格式：Jackson不仅支持JSON格式，同时也支持XML、Google Protocol Buffers等多种数据格式，可以方便地进行数据交换和转换。
  4. 集成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;
    }

578f08cf41804bde8bee84f180f59c4d.png

文章标签：
数据格式
JSON
Java
前端开发
Spring
关键词：
Spring MVC机制
Spring mvc json
JSON springmvc
JSON机制
Spring MVC异常处理机制
Alone秋
目录
相关文章
Quan_Chen
|
7月前
|
前端开发 Java 测试技术
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@RequestParam
本文介绍了 `@RequestParam` 注解的使用方法及其与 `@PathVariable` 的区别。`@RequestParam` 用于从请求中获取参数值（如 GET 请求的 URL 参数或 POST 请求的表单数据），而 `@PathVariable` 用于从 URL 模板中提取参数。文章通过示例代码详细说明了 `@RequestParam` 的常用属性，如 `required` 和 `defaultValue`，并展示了如何用实体类封装大量表单参数以简化处理流程。最后，结合 Postman 测试工具验证了接口的功能。
Quan_Chen
347 0
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@RequestParam
Quan_Chen
|
7月前
|
JSON 前端开发 Java
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@RequestBody
`@RequestBody` 是 Spring 框架中的注解，用于将 HTTP 请求体中的 JSON 数据自动映射为 Java 对象。例如，前端通过 POST 请求发送包含 `username` 和 `password` 的 JSON 数据，后端可通过带有 `@RequestBody` 注解的方法参数接收并处理。此注解适用于传递复杂对象的场景，简化了数据解析过程。与表单提交不同，它主要用于接收 JSON 格式的实体数据。
Quan_Chen
531 0
Quan_Chen
|
7月前
|
前端开发 Java 微服务
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@PathVariable
`@PathVariable` 是 Spring Boot 中用于从 URL 中提取参数的注解，支持 RESTful 风格接口开发。例如，通过 `@GetMapping(&quot;/user/{id}&quot;)` 可以将 URL 中的 `{id}` 参数自动映射到方法参数中。若参数名不一致，可通过 `@PathVariable(&quot;自定义名&quot;)` 指定绑定关系。此外，还支持多参数占位符，如 `/user/{id}/{name}`，分别映射到方法中的多个参数。运行项目后，访问指定 URL 即可验证参数是否正确接收。
Quan_Chen
345 0
Quan_Chen
|
7月前
|
JSON 前端开发 Java
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@RequestMapping
@RequestMapping 是 Spring MVC 中用于请求地址映射的注解，可作用于类或方法上。类级别定义控制器父路径，方法级别进一步指定处理逻辑。常用属性包括 value（请求地址）、method（请求类型，如 GET/POST 等，默认 GET）和 produces（返回内容类型）。例如：`@RequestMapping(value = &quot;/test&quot;, produces = &quot;application/json; charset=UTF-8&quot;)`。此外，针对不同请求方式还有简化注解，如 @GetMapping、@PostMapping 等。
Quan_Chen
298 0
Quan_Chen
|
7月前
|
JSON 前端开发 Java
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@RestController
本文主要介绍 Spring Boot 中 MVC 开发常用的几个注解及其使用方式，包括 `@RestController`、`@RequestMapping`、`@PathVariable`、`@RequestParam` 和 `@RequestBody`。其中重点讲解了 `@RestController` 注解的构成与特点：它是 `@Controller` 和 `@ResponseBody` 的结合体，适用于返回 JSON 数据的场景。文章还指出，在需要模板渲染（如 Thymeleaf）而非前后端分离的情况下，应使用 `@Controller` 而非 `@RestController`
Quan_Chen
229 0
waylau
|
3月前
|
前端开发 Java API
Spring Cloud Gateway Server Web MVC报错“Unsupported transfer encoding: chunked”解决
本文解析了Spring Cloud Gateway中出现“Unsupported transfer encoding: chunked”错误的原因，指出该问题源于Feign依赖的HTTP客户端与服务端的`chunked`传输编码不兼容，并提供了具体的解决方案。通过规范Feign客户端接口的返回类型，可有效避免该异常，提升系统兼容性与稳定性。
waylau
199 0
Unfailed_realme
|
3月前
|
JSON 前端开发 Java
Spring MVC 核心组件与请求处理机制详解
本文解析了 Spring MVC 的核心组件及请求流程，核心组件包括 DispatcherServlet（中央调度）、HandlerMapping（URL 匹配处理器）、HandlerAdapter（执行处理器）、Handler（业务方法）、ViewResolver（视图解析），其中仅 Handler 需开发者实现。 详细描述了请求执行的 7 步流程：请求到达 DispatcherServlet 后，经映射器、适配器找到并执行处理器，再通过视图解析器渲染视图（前后端分离下视图解析可省略）。 介绍了拦截器的使用（实现 HandlerInterceptor 接口 + 配置类）及与过滤器的区别
Unfailed_realme
220 0
Unfailed_realme
|
3月前
|
SQL Java 数据库连接
Spring、SpringMVC 与 MyBatis 核心知识点解析
我梳理的这些内容，涵盖了 Spring、SpringMVC 和 MyBatis 的核心知识点。 在 Spring 中，我了解到 IOC 是控制反转，把对象控制权交容器；DI 是依赖注入，有三种实现方式。Bean 有五种作用域，单例 bean 的线程安全问题及自动装配方式也清晰了。事务基于数据库和 AOP，有失效场景和七种传播行为。AOP 是面向切面编程，动态代理有 JDK 和 CGLIB 两种。 SpringMVC 的 11 步执行流程我烂熟于心，还有那些常用注解的用法。 MyBatis 里，#{} 和 ${} 的区别很关键，获取主键、处理字段与属性名不匹配的方法也掌握了。多表查询、动态
Unfailed_realme
116 0
糊涂糊涂123
|
3月前
|
JSON 前端开发 Java
第05课：Spring Boot中的MVC支持
第05课：Spring Boot中的MVC支持
糊涂糊涂123
180 0
蓝易云
|
9月前
|
SQL Java 数据库连接
对Spring、SpringMVC、MyBatis框架的介绍与解释
Spring 框架提供了全面的基础设施支持，Spring MVC 专注于 Web 层的开发，而 MyBatis 则是一个高效的持久层框架。这三个框架结合使用，可以显著提升 Java 企业级应用的开发效率和质量。通过理解它们的核心特性和使用方法，开发者可以更好地构建和维护复杂的应用程序。
蓝易云
387 29

热门文章

最新文章

  • 1
    Java入门教程：掌握Spring MVC的双向数据绑定技术
  • 2
    Python采集淘宝评论API接口及JSON数据返回全流程指南
  • 3
    淘宝拍立淘按图搜索与商品详情API的JSON数据返回详解
  • 4
    从JSON到Protobuf，深入序列化方案的选型与原理
  • 5
    干货，淘宝拍立淘按图搜索，淘宝API（json数据返回）
  • 6
    多语言实时数据微店商品详情API：技术实现与JSON数据解析指南
  • 7
    淘宝API对接系列：商品详情与评论数据分析（JSON数据返回）
  • 8
    快应用报错Module Error 分包要求 app.json#minPlatformVersion 不小于 1061, 当前值为 21解决方案-优雅草卓伊凡
  • 9
    干货满满！淘宝商品详情数据，淘宝API（json数据返回）
  • 10
    淘宝关键词搜索与商品详情API接口（JSON数据返回）
  • 1
    Java也能快速搭建AI应用？一文带你玩转Spring AI可落地性
    1946
  • 2
    springcloud/springboot集成NACOS 做注册和配置中心以及nacos源码分析
    3038
  • 3
    🛡️Spring Boot 3 整合 Spring Cloud Gateway 工程实践
    1258
  • 4
    详细介绍SpringBoot启动流程及配置类解析原理
    823
  • 5
    DeepSeek + Higress AI 网关/Spring AI Alibaba 案例征集
    698
  • 6
    支持 40+ 插件，Spring AI Alibaba 简化智能体私有数据集成
    1130
  • 7
    Jeesite5：Star24k,Spring Boot 3.3+Vue3实战开源项目,架构深度拆解！让企业级项目开发效率提升300%的秘密武器
    336
  • 8
    SpringBoot项目打包成war包
    560
  • 9
    【Azure Kafka】使用Spring Cloud Stream Binder Kafka 发送并接收 Event Hub 消息及解决并发报错
    126
  • 10
    Spring框架初识
    135

    • 相关课程

    更多
  • 精通Spring Cloud Alibaba
  • 微服务框架 Spring Cloud 快速入门
  • Java Web开发系列课程 - Spring框架入门
  • JSON 自学手册图文教程
  • Spring Boot 2.5.x开发实战
  • Spring Cloud微服务架构设计与开发实战

    • 相关电子书

    更多
  • 云栖社区特邀专家徐雷Java Spring Boot开发实战系列课程（第20讲）：经典面试题与阿里等名企内部招聘求职面试技巧
  • 微服务架构模式与原理Spring Cloud开发实战
  • 阿里特邀专家徐雷Java Spring Boot开发实战系列课程（第18讲）：制作Java Docker镜像与推送到DockerHub和阿里云Docker仓库
    • 下一篇
    深度 | 从0到3.0，揭秘阿里云洛神云网络的进化之路