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

一篇博文教你SpringMVC中JSON注解&异常处理的使用

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

一、JSON数据返回

1.1.

1.2.Jackson的介绍

1.2.1.什么是Jackson

Jackson是一个流行的Java库，用于处理JSON格式数据的序列化和反序列化。它提供了一组简单易用的API，可以方便地将Java对象与JSON数据进行转换。

1.2.2 常用注解

在使用Jackson进行JSON序列化和反序列化时，可以使用一些常用的注解来控制转换过程。例如：

@JsonFormat 指定序列化日期/时间值时的格式
@JsonIgnore 作用在字段或方法上，用来完全忽略被注解的字段和方法对应的属性

1.2.3Jackson具有以下特点和优势：

  1. 高性能：Jackson是一个高性能的JSON处理库，它使用了一些优化技术，如流式处理和基于缓冲区的读写，以提供非常快速的JSON序列化和反序列化性能。
  2. 灵活性：Jackson提供了多种转换策略和配置选项，可以根据需要进行灵活的定制。它支持对Java对象的字段级别的映射、支持不同的日期格式、支持多态类型处理等。
  3. 支持注解：Jackson支持使用注解来定制JSON序列化和反序列化的行为。通过在Java对象上添加注解，可以指定字段的名称、序列化的顺序、忽略某些字段等。
  4. 多种数据格式支持：除了JSON，Jackson还支持其他多种数据格式的处理，包括XML、YAML等。它可以方便地将Java对象转换为这些格式，或者将这些格式的数据转换为Java对象。
  5. 广泛应用：Jackson在Java开发领域得到了广泛的应用。它已经成为许多主流框架和技术的首选，如Spring MVC、Hibernate、JAX-RS等。

1.3 使用注解

1.3.1 导入依赖

要使用Jackson库，首先需要在项目中导入相应的依赖。

<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>

1.3.2.配置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>

1.3.3.案例演示

演示如何使用Jackson返回JSON数据，我们创建一个简单的控制器方法，并使@ResponseBody注解将其返回的对象转换为JSON格式。

JsonController

package com.liyongan.controller;
import com.liyongan.biz.ClazzBiz;
import com.liyongan.model.Clazz;
import com.liyongan.util.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 org.springframework.web.bind.annotation.RestController;
import javax.servlet.http.HttpServletRequest;
import javax.validation.GroupDefinitionException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
//@ResponseBody
//@Controller
@RestController                 //RestController=ResponseBody+Controller
@RequestMapping("/clz/json")
public class JsonController {
    @Autowired
    private ClazzBiz clazzBiz;
    /**
     * 返回List<T>//json数组
     * @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.selectBySnamePager(clazz, pageBean);
        System.out.println(1 / 0);
        return lst;
    }
    /**
     * 返回T//json对象
     * @param req
     * @param clazz
     * @return
     */
//    @ResponseBody
    @RequestMapping("/load")
    public Clazz load(HttpServletRequest req, Clazz clazz){
        if(clazz.getCid() != null){
            List<Clazz> lst = this.clazzBiz.selectBySnamePager(clazz, null);
            return lst.get(0);
        }
        return null;
    }
    /**
     * 返回List<Map>//json数组
     * @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//单个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.selectBySnamePager(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){
        if(true)
            throw new GroupDefinitionException("该死的刁民，总想害朕");
        return "clzEdit";
    }
}

返回各种类型数据

Json数组

Json对象

Json数组

单个map

1.4.@ResponseBody注解使用

@ResponseBody注解的作用是将Controller的方法返回的对象通过适当的转换器转换为指定的格式之后，写入到response对象的body区，通常用来返回JSON数据或者是XML数据。

注意：在使用此注解之后不会再走视图解析器，而是直接将数据写入到输入流中，他的效果等同于通过response对象输出指定格式的数据。

二、异常处理

如果我们不使用异常处理就会出现这样的界面：体验非常的不好。

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

全局异常处理的目的是为了提升系统的稳定性和用户体验。当应用程序抛出异常时，全局异常处理可以捕获并处理这些异常，从而避免将异常信息直接暴露给用户。

2.2 异常处理思路

在设计异常处理机制时，需要考虑以下几个方面：定义自定义异常类、编写异常处理器、配置全局异常处理。

2.3 SpringMVC异常分类

Spring MVC将异常分为两类：可预测的异常和不可预测的异常。可预测的异常是我们在代码中明确捕获并处理的异常，而不可预测的异常是无法预测和处理的异常。

2.4.实例：

2.4.1.异常处理方式①

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

在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>

error.jsp

<%--
  Created by IntelliJ IDEA.
  User: 微微
  Date: 2023/9/13
  Time: 18:12
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>错误异常界面</title>
</head>
<body>
发生错误异常界面！！!
<hr>
${ex}问题是：
${msg}
</body>
</html>

效果：

2.4.2.异常处理方式②

创建一个名为exception的包将GlobalException放入

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

创建一个名为Component的包将的GlobalExceptionHandler类放入

package com.liyongan.controller;
import com.liyongan.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","运行时异常....");
        }
        return mv;
    }
}

效果：

2.4.3.异常处理方式③

创建一个名为Component的包将我们的GlobalExceptionResolver类放入

package com.liyongan.controller;
import com.liyongan.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 {
// 返回错误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;
    }
}

这种方式是将我们的错误信息进行map保存然后转换为JSON格式输出在页面上

2.5.响应封装类

进行优化：GlobalExceptionResolver.java

@ControllerAdvice
public class GlobalExceptionResolver {
    // 响应封装类
    @ResponseBody
    @ExceptionHandler
    public Map handler(Exception e){
        if (e instanceof GlobalException){
            GlobalException globalException = (GlobalException) e;
            return R.ok(500,"全局异常....",globalException.getMessage());
        }else if (e instanceof RuntimeException){
            RuntimeException runtimeException = (RuntimeException) e;
            return R.ok(500,"运行时异常....",runtimeException.getMessage());
        }else {
            return R.ok(500,"其他异常....",e.getMessage());
        }
    }
}

效果：

文章标签：
数据格式
JSON
Java
前端开发
XML
关键词：
Spring mvc json
JSON注解
JSON springmvc
JSON异常处理
springmvc JSON异常处理
〔Lisa〕
目录
相关文章
蓝易云
|
14天前
|
JSON API 数据处理
Swagger动态参数注解：使用@DynamicParameters实现JSON参数的灵活定义
总结起来，通过使用SpringFox提供给我们工具箱里面非常有力量但又不太显眼工具———即使面对复杂多变、非标准化数据格式也能轻松驾驭它们———从而大大增强我们系统与外界沟通交流能力同时也保证系统内部数据处理逻辑清晰明确易于维护升级.
蓝易云
82 10
Quan_Chen
|
7月前
|
前端开发 Java 测试技术
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@RequestParam
本文介绍了 `@RequestParam` 注解的使用方法及其与 `@PathVariable` 的区别。`@RequestParam` 用于从请求中获取参数值（如 GET 请求的 URL 参数或 POST 请求的表单数据），而 `@PathVariable` 用于从 URL 模板中提取参数。文章通过示例代码详细说明了 `@RequestParam` 的常用属性，如 `required` 和 `defaultValue`，并展示了如何用实体类封装大量表单参数以简化处理流程。最后，结合 Postman 测试工具验证了接口的功能。
Quan_Chen
385 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
581 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
382 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
342 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
240 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
241 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
126 0
糊涂糊涂123
|
3月前
|
JSON 前端开发 Java
第05课：Spring Boot中的MVC支持
第05课：Spring Boot中的MVC支持
糊涂糊涂123
199 0
蓝易云
|
9月前
|
SQL Java 数据库连接
对Spring、SpringMVC、MyBatis框架的介绍与解释
Spring 框架提供了全面的基础设施支持，Spring MVC 专注于 Web 层的开发，而 MyBatis 则是一个高效的持久层框架。这三个框架结合使用，可以显著提升 Java 企业级应用的开发效率和质量。通过理解它们的核心特性和使用方法，开发者可以更好地构建和维护复杂的应用程序。
蓝易云
425 29

热门文章

最新文章

  • 1
    【GoGin】（2）数据解析和绑定：结构体分析，包括JSON解析、form解析、URL解析，区分绑定的Bind方法
  • 2
    淘宝关键词搜索与商品详情API接口（JSON数据返回）
  • 3
    Python采集淘宝拍立淘按图搜索API接口及JSON数据返回全流程指南
  • 4
    快应用报错Module Error 分包要求 app.json#minPlatformVersion 不小于 1061, 当前值为 21解决方案-优雅草卓伊凡
  • 5
    【GoGin】（3）Gin的数据渲染和中间件的使用：数据渲染、返回JSON、浅.JSON()源码、中间件、Next()方法
  • 6
    Swagger动态参数注解：使用@DynamicParameters实现JSON参数的灵活定义
  • 7
    【Java】（10）进程与线程的关系、Tread类；讲解基本线程安全、网络编程内容；JSON序列化与反序列化
  • 8
    【Java基础】（1）进程与线程的关系、Tread类；讲解基本线程安全、网络编程内容；JSON序列化与反序列化
  • 9
    构建基于Java的AI智能体：使用LangChain4j与Spring AI实现RAG应用
  • 10
    零代码改造 + 全链路追踪！Spring AI 最新可观测性详细解读
  • 1
    零代码改造 + 全链路追踪！Spring AI 最新可观测性详细解读
    560
  • 2
    基于springboot的儿童家长教育能力提升学习系统
    63
  • 3
    【SpringBoot（四）】还不懂文件上传？JUnit使用？本文带你了解SpringBoot的文件上传、异常处理、组件注入等知识！并且带你领悟JUnit单元测试的使用！
    337
  • 4
    【SpringBoot（二）】带你认识Yaml配置文件类型、SpringMVC的资源访问路径 和 静态资源配置的原理！
    131
  • 5
    【SpringBoot（一）】Spring的认知、容器功能讲解与自动装配原理的入门，带你熟悉Springboot中基本的注解使用
    134
  • 6
    Spring框架优化：提高Java应用的性能与适应性
    69
  • 7
    Spring Boot 3.x 微服务架构实战指南
    343
  • 8
    Spring Boot 整合Nacos 版本兼容适配 史上最详细文档
    491
  • 9
    Spring Boot + Java 21：内存减少 60%，启动速度提高 30% — 零代码
    166
  • 10
    我尝试了所有后端框架 — — 这就是为什么只有 Spring Boot 幸存下来
    154

    • 相关课程

    更多
  • 精通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仓库
    • 下一篇
    阿里云oss简介和如何对接使用