Spring Boot后端返还JSON数据 + 统一异常处理（返还JSON错误）

2023-12-24 14:20
文章标签 java 数据 异常 json spring 统一 处理 错误 boot 后端 返还

本文主要是介绍Spring Boot后端返还JSON数据 + 统一异常处理（返还JSON错误），希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

1 背景

现在项目都是前后端分离，前后端通过JSON交换数据，这时，后端就需要提供健全的api接口供前端调用。本文主要介绍自己封装的JsonResult与Spring Boot的统一异常处理，项目地址在这里。

2 JsonResult

JsonResult是自己封装的一个返还Json，主要由返还码、返还信息，以及返还数据构成，其中提供了静态方法success、failed可供controller层直接调用。废话不多说，直接上代码供大家参考。

package com.lm.common;import org.apache.commons.lang3.builder.ToStringBuilder;import java.io.Serializable;
import java.util.Objects;/*** @author lming.41032@gmail.com* @date 18-11-7 下午12:25*/
public class JsonResult implements Serializable {private static final long serialVersionUID = 5598308977637490090L;private int status;private String message;private Object data;public int getStatus() {return status;}public void setStatus(int status) {this.status = status;}public String getMessage() {return message;}public void setMessage(String message) {this.message = message;}public void setData(Object data) {this.data = data;}public Object getData() {return data;}public static JsonResult success() {return success(null);}public static JsonResult success(Object data) {JsonResult jsonResult = new JsonResult();jsonResult.setStatus(200);jsonResult.setMessage("SUCCESS");if (data != null) {jsonResult.setData(data);}return jsonResult;}public static JsonResult failed() {return failed("FAILED");}public static JsonResult failed(String message) {JsonResult jsonResult = new JsonResult();jsonResult.setStatus(500);jsonResult.setMessage(message);return jsonResult;}@Overridepublic boolean equals(Object o) {if (this == o) {return true;}if (!(o instanceof JsonResult)) {return false;}JsonResult result = (JsonResult) o;return status == result.status &&Objects.equals(message, result.message) &&Objects.equals(data, result.data);}@Overridepublic int hashCode() {return Objects.hash(status, message, data);}@Overridepublic String toString() {return new ToStringBuilder(this).append("status", status).append("message", message).append("data", data).toString();}}

以下就是一个模拟登录成功返还的Json信息.

{"status":200,"message":"SUCCESS","data":{"id":1,"userName":"lmm","password":"123"}
}

3 统一异常处理（返还Json）

在前后端分离项目中，无论后台程序出现了什么问题，我们都要返还一个错误的Json信息。这个错误的信息可以包括错误码，错误信息等，这样不仅仅方便前端处理，也方便后期运维、开发人员快速的定位到错误。下面就是一个错误的Json信息。

	{"status":700,"message":"用户不存在！","data":null}

首先我们需要定义一个基本异常，它主要包包含错误码，错误信息。我们也可以在这个基本异常中预先定义一些异常如参数错误、没有权限等。

package com.lm.common;/*** @author lming.41032@gmail.com* @date 18-11-7 上午11:46*/
public class BaseException extends Exception {private static final long serialVersionUID = -3392027101671055457L;public static final int ERROR_CODE_ILLEGAL_ARGUMENTS = 600;// 错误码private int code;//错误信息private String errorMessage;public BaseException(int code) {super("error code" + code);this.code = code;}public BaseException(int code, Throwable throwable) {super(throwable);this.code = code;}public BaseException(int code, String errorMessage) {super(errorMessage);this.code = code;this.errorMessage = errorMessage;}public int getCode() {return code;}public String getErrorMessage() {return errorMessage;}
}

一个系统由多个模块组成，每个模块中都可能会抛出各种各样的异常，这时我们就需要在模块中定义属于本模块中的异常，这些异常需继承BaseException。比如用户登录模块，可能就会抛出用户不存在、密码错误等异常，这时我们定义一个UserException异常，如下所示。

package com.lm.user;import com.lm.common.BaseException;/*** @author lming.41032@gmail.com* @date 18-11-7 上午11:53*/
public class UserException extends BaseException {public static final int ERROR_CODE_NOT_EXIT = 700;public static final int ERROR_CODE_PASSWORD_EEEOR = 701;public UserException(int code) {super(code);}
}

定义完异常后，我们需要对异常进行处理，这样后台抛出异常后，将直接返还错误Json。我们定义一个统一异常处理类（GlobalExceptionHandle），用@ControllerAdvice注解该类，用注解@ExceptionHandler来定义要处理的异常类型。用@ResponseBody来使返还的数据为Json格式。

package com.lm.dubboconsumer.common;import com.google.gson.Gson;
import com.lm.common.BaseException;
import com.lm.common.JsonResult;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.MessageSource;
import org.springframework.context.NoSuchMessageException;
import org.springframework.web.bind.MissingServletRequestParameterException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.lang.reflect.UndeclaredThrowableException;
import java.util.Locale;/*** @author lming.41032@gmail.com* @date 18-11-7 下午12:17*/
@ControllerAdvice
public class GlobalExceptionHandle {private static final Logger LOGGER = LoggerFactory.getLogger(GlobalExceptionHandle.class);private final MessageSource messageSource;@Autowiredpublic GlobalExceptionHandle(MessageSource messageSource) {this.messageSource = messageSource;}@ExceptionHandler(value = Exception.class)@ResponseBodypublic JsonResult defaultErrorHandle(HttpServletRequest request, HttpServletResponse response,Exception e, Locale locale) throws IOException {JsonResult result = new JsonResult();int code = 500;String errorMessage = null;Throwable exception = e;if (exception instanceof BaseException) {code = ((BaseException) exception).getCode();errorMessage = ((BaseException) exception).getErrorMessage();} else if (exception instanceof MissingServletRequestParameterException) {code = BaseException.ERROR_CODE_ILLEGAL_ARGUMENTS;} else if (!(exception instanceof BaseException || exception instanceof MissingServletRequestParameterException)) {LOGGER.error("Unknown Exception, URI = " + request.getRequestURI(), e);} else {LOGGER.error("URI = {}, errorCode = {}, errorMessage = {}", request.getRequestURI(), code, errorMessage);}// 如果异常中包含了错误信息，则不会通过错误码获取定义的错误信息if (StringUtils.isBlank(errorMessage)) {String prefix = exception.getClass().getSimpleName();errorMessage = getMessage(prefix + "." + code, locale);if (errorMessage == null) {errorMessage = getMessage(Integer.toString(code), locale);}}result.setStatus(code);result.setMessage(errorMessage);return result;}private String getMessage(String key, Locale locale) {String errorMessage = null;try {errorMessage = messageSource.getMessage(key, null, locale);} catch (NoSuchMessageException exception) {LOGGER.debug("ErrorMessage|NotFound|{}", key);}return errorMessage;}
}

我们前面定义的异常都是都是只定义了错误码，至于错误信息，我们可以在项目resource下建一个error_codes.properties文件,其中=前面是我们自定义异常中的code，而=号右边的就是错误信息了。

500=系统错误，请稍后重试！
600=参数错误！
700=用户不存在！
701=用户已经存在！

error_codes.properties文件创建完后，需要在aplication.yml(aplication.properties)中设置一下。

spring:messages:basename: error_codescache-duration: 600s

4 测试

Service层

package com.lm.dubboprovider.user.impl;import com.lm.common.BaseException;
import com.lm.user.User;
import com.lm.user.UserException;
import com.lm.user.service.UserService;
import org.apache.commons.lang3.StringUtils;
import org.springframework.stereotype.Service;/*** @author lming.41032@gmail.com* @date 18-11-4 下午2:55*/
@Service
public class UserServiceImpl implements UserService {private static final String USERNAME = "lm";private static final String PASSWORD = "123";@Overridepublic Boolean login(String userName, String password) throws BaseException {if (StringUtils.isBlank(userName) || StringUtils.isBlank(password)) {throw new BaseException(BaseException.ERROR_CODE_ILLEGAL_ARGUMENTS);}if (!userName.equals(USERNAME)) {throw new UserException(UserException.ERROR_CODE_NOT_EXIT);}if (USERNAME.equals(userName) && PASSWORD.equals(password)) {return true;}return false;}
}

Controller层

package com.lm.dubboconsumer.user;import com.lm.common.BaseException;
import com.lm.common.JsonResult;
import com.lm.user.User;
import com.lm.user.UserException;
import com.lm.user.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;import javax.servlet.http.HttpServletRequest;/*** @author lming.41032@gmail.com* @date 18-11-5 下午5:10*/
@RestController
@RequestMapping("user")
public class UserRestController {private final UserService userService;@Autowiredpublic UserRestController(UserService userService) {this.userService = userService;}@GetMapping("login")public JsonResult login(HttpServletRequest request) throws UserException, BaseException {String userName = request.getParameter("username");String password = request.getParameter("password");Boolean flag = userService.login(userName, password);if (flag) {return JsonResult.success();} else {throw JsonResult.failed();}}
}

登录成功：
在这里插入图片描述
参数错误：
在这里插入图片描述
用户不存在：
在这里插入图片描述

5 总结

CSDN写博客一定要定时点击保存按钮。

这篇关于Spring Boot后端返还JSON数据 + 统一异常处理（返还JSON错误）的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/532056。

相关文章

Python获取中国节假日数据记录入JSON文件

Python获取中国节假日数据记录入JSON文件

《Python获取中国节假日数据记录入JSON文件》项目系统内置的日历应用为了提升用户体验,特别设置了在调休日期显示“休”的UI图标功能,那么问题是这些调休数据从哪里来呢？我尝试一种更为智能的方法：P... 目录节假日数据获取存入jsON文件节假日数据读取封装完整代码项目系统内置的日历应用为了提升用户体验，
阅读更多...
Java编译生成多个.class文件的原理和作用

Java编译生成多个.class文件的原理和作用

《Java编译生成多个.class文件的原理和作用》作为一名经验丰富的开发者,在Java项目中执行编译后,可能会发现一个.java源文件有时会产生多个.class文件,从技术实现层面详细剖析这一现象... 目录一、内部类机制与.class文件生成成员内部类（常规内部类）局部内部类（方法内部类）匿名内部类二、
阅读更多...
Go标准库常见错误分析和解决办法

Go标准库常见错误分析和解决办法

《Go标准库常见错误分析和解决办法》Go语言的标准库为开发者提供了丰富且高效的工具,涵盖了从网络编程到文件操作等各个方面,然而,标准库虽好,使用不当却可能适得其反,正所谓工欲善其事,必先利其器,本文将... 目录1. 使用了错误的time.Duration2. time.After导致的内存泄漏3. jsO
阅读更多...
SpringBoot实现数据库读写分离的3种方法小结

SpringBoot实现数据库读写分离的3种方法小结

《SpringBoot实现数据库读写分离的3种方法小结》为了提高系统的读写性能和可用性,读写分离是一种经典的数据库架构模式,在SpringBoot应用中,有多种方式可以实现数据库读写分离,本文将介绍三... 目录一、数据库读写分离概述二、方案一：基于AbstractRoutingDataSource实现动态
阅读更多...
Python FastAPI+Celery+RabbitMQ实现分布式图片水印处理系统

Python FastAPI+Celery+RabbitMQ实现分布式图片水印处理系统

《PythonFastAPI+Celery+RabbitMQ实现分布式图片水印处理系统》这篇文章主要为大家详细介绍了PythonFastAPI如何结合Celery以及RabbitMQ实现简单的分布式... 实现思路FastAPI 服务器Celery 任务队列RabbitMQ 作为消息代理定时任务处理完整
阅读更多...
使用Jackson进行JSON生成与解析的新手指南

使用Jackson进行JSON生成与解析的新手指南

《使用Jackson进行JSON生成与解析的新手指南》这篇文章主要为大家详细介绍了如何使用Jackson进行JSON生成与解析处理,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1. 核心依赖2. 基础用法2.1 对象转 jsON（序列化）2.2 JSON 转对象（反序列化）3.
阅读更多...
Springboot @Autowired和@Resource的区别解析

Springboot @Autowired和@Resource的区别解析

《Springboot@Autowired和@Resource的区别解析》@Resource是JDK提供的注解,只是Spring在实现上提供了这个注解的功能支持,本文给大家介绍Springboot@... 目录【一】定义【1】@Autowired【2】@Resource【二】区别【1】包含的属性不同【2】@
阅读更多...
springboot循环依赖问题案例代码及解决办法

springboot循环依赖问题案例代码及解决办法

《springboot循环依赖问题案例代码及解决办法》在SpringBoot中,如果两个或多个Bean之间存在循环依赖（即BeanA依赖BeanB,而BeanB又依赖BeanA）,会导致Spring的... 目录1. 什么是循环依赖？2. 循环依赖的场景案例3. 解决循环依赖的常见方法方法 1：使用 @La
阅读更多...
Java枚举类实现Key-Value映射的多种实现方式

Java枚举类实现Key-Value映射的多种实现方式

《Java枚举类实现Key-Value映射的多种实现方式》在Java开发中,枚举(Enum)是一种特殊的类,本文将详细介绍Java枚举类实现key-value映射的多种方式,有需要的小伙伴可以根据需要... 目录前言一、基础实现方式1.1 为枚举添加属性和构造方法二、http://www.cppcns.co
阅读更多...
Elasticsearch 在 Java 中的使用教程

Elasticsearch 在 Java 中的使用教程

《Elasticsearch在Java中的使用教程》Elasticsearch是一个分布式搜索和分析引擎,基于ApacheLucene构建,能够实现实时数据的存储、搜索、和分析,它广泛应用于全文... 目录1. Elasticsearch 简介2. 环境准备2.1 安装 Elasticsearch2.2 J
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2