Result 和 自定义异常 在前后端交互中的作用

2024-09-07 01:04

本文主要是介绍Result 和 自定义异常 在前后端交互中的作用,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

Result 和自定义异常在前后端交互中扮演着重要的角色。它们可以帮助我们规范化接口返回值,提高错误处理的可读性和可维护性。

Result的作用

Result通常是一个封装了请求结果的类,它包含了请求的状态码、消息和数据。在前端和后端的交互中,Result的作用主要体现在以下几个方面:

  1. 统一返回格式:通过Result类,后端可以将请求的结果统一封装成一个固定的格式返回给前端,这样前端可以更容易地解析和处理返回的数据。例如,无论请求成功还是失败,前端都可以通过解析Result对象来获取状态码和消息,从而做出相应的处理。

  2. 错误码和消息:Result类通常包含错误码和错误消息,这使得前端能够根据不同的错误码做出不同的响应。例如,如果用户登录失败,后端可以通过Result返回一个特定的错误码和消息,前端可以根据这些信息提示用户具体的错误原因。

  3. 简化前端处理:通过使用Result,前端不需要对每个请求的结果进行复杂的判断,只需要检查Result中的状态码即可。这大大简化了前端的逻辑,提高了代码的可维护性。

自定义异常的作用

自定义异常是指根据业务需求创建的异常类,它们可以帮助后端更精确地处理和传递错误信息。在前后端交互中,自定义异常的作用主要体现在以下几个方面:

  1. 精确的错误处理:自定义异常允许开发人员针对特定的业务需求创建新的异常类型,从而使错误处理更加精确。例如,当用户尝试访问一个不存在的资源时,后端可以抛出一个自定义的ResourceNotFoundException异常,前端可以根据这个异常类型做出相应的处理。

  2. 增强代码可读性:通过使用自定义异常,代码的可读性和维护性得到了增强。每个自定义异常类通常都有一个明确的含义,这使得开发人员在阅读代码时能够更容易地理解异常的来源和原因。

  3. 统一异常处理:在Spring Boot等框架中,可以通过全局异常处理机制来捕获和处理自定义异常。这样,无论异常发生在何处,都会得到恰当的处理,避免了异常的泄露和错误的传播。例如,通过使用@ControllerAdvice注解,可以定义一个全局的异常处理器,统一处理所有自定义异常,并将错误信息返回给前端。

  4. 友好的用户提示:自定义异常可以包含详细的错误信息,这些信息可以被传递给前端,从而为用户提供更友好的提示。例如,当用户提交的表单数据不合法时,后端可以抛出一个自定义的InvalidFormDataException,并附带具体的错误信息,前端可以根据这些信息提示用户如何修正错误。

前后端交互的流程

前端发送请求:

  • 前端发送 HTTP 请求到后端接口。

后端处理请求:

  • 后端接收到请求后,进行业务逻辑处理。如果出现错误,抛出自定义异常。

异常处理:

  • 全局异常处理机制捕获自定义异常,并将其转换为 Result 对象。

返回 Result:

  • 后端将 Result 对象返回给前端。

前端处理返回值:

  • 前端接收到 Result 对象,根据状态码和错误信息,做出相应的处理。

示例

示例中,Result类用于封装API的返回结果,ResourceNotFoundException是一个自定义异常,用于处理特定的错误情况。UserController负责处理用户相关的请求,并在必要时抛出自定义异常。GlobalExceptionHandler则统一处理这些异常,并返回标准化的错误信息。

 Result类

/*** Result类用于封装API请求的返回结果。* @param <T> 返回数据的类型*/
public class Result<T> {private int code; // 状态码private String message; // 消息说明private T data; // 返回的数据public Result(int code, String message, T data) {this.code = code;this.message = message;this.data = data;}public int getCode() {return code; // 获取状态码}public String getMessage() {return message; // 获取消息}public T getData() {return data; // 获取数据}
}

 自定义异常

/*** ResourceNotFoundException是一个自定义异常,用于表示请求的资源未找到。*/
public class ResourceNotFoundException extends RuntimeException {public ResourceNotFoundException(String message) {super(message); // 调用父类构造函数}
}

Controller

@RestController 
public class UserController {private final UserService userService; // 用户服务public UserController(UserService userService) {this.userService = userService; // 构造函数注入}/*** 根据用户ID获取用户信息* @param id 用户ID* @return Result<User> 返回用户信息的结果*/@GetMapping("/users/{id}") // 映射GET请求到/users/{id}public Result<User> getUser(@PathVariable Long id) {User user = userService.getUserById(id); // 调用服务获取用户if (user == null) {throw new ResourceNotFoundException("User not found with id: " + id); // 抛出自定义异常}return new Result<>(200, "Success", user); // 返回成功结果}
}

全局异常处理

在全局异常处理器中,可以定义针对自定义异常的处理方法。通过使用@ExceptionHandler注解,框架会自动捕获抛出的自定义异常,并调用相应的处理方法。

@ControllerAdvice 
public class GlobalExceptionHandler {/*** 处理ResourceNotFoundException异常* @param ex 异常对象* @return ResponseEntity<Result<Void>> 返回包含错误信息的Result*/@ExceptionHandler(ResourceNotFoundException.class) // 指定处理的异常类型public ResponseEntity<Result<Void>> handleResourceNotFoundException(ResourceNotFoundException ex) {// 创建包含错误信息的Result对象Result<Void> result = new Result<>(404, ex.getMessage(), null);return ResponseEntity.status(HttpStatus.NOT_FOUND).body(result); // 返回404状态及结果}
}

这篇关于Result 和 自定义异常 在前后端交互中的作用的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1143623

相关文章

无人叉车3d激光slam多房间建图定位异常处理方案-墙体画线地图切分方案

墙体画线地图切分方案 针对问题:墙体两侧特征混淆误匹配,导致建图和定位偏差,表现为过门跳变、外月台走歪等 ·解决思路:预期的根治方案IGICP需要较长时间完成上线,先使用切分地图的工程化方案,即墙体两侧切分为不同地图,在某一侧只使用该侧地图进行定位 方案思路 切分原理:切分地图基于关键帧位置,而非点云。 理论基础:光照是直线的,一帧点云必定只能照射到墙的一侧,无法同时照到两侧实践考虑:关

【前端学习】AntV G6-08 深入图形与图形分组、自定义节点、节点动画(下)

【课程链接】 AntV G6:深入图形与图形分组、自定义节点、节点动画(下)_哔哩哔哩_bilibili 本章十吾老师讲解了一个复杂的自定义节点中,应该怎样去计算和绘制图形,如何给一个图形制作不间断的动画,以及在鼠标事件之后产生动画。(有点难,需要好好理解) <!DOCTYPE html><html><head><meta charset="UTF-8"><title>06

自定义类型:结构体(续)

目录 一. 结构体的内存对齐 1.1 为什么存在内存对齐? 1.2 修改默认对齐数 二. 结构体传参 三. 结构体实现位段 一. 结构体的内存对齐 在前面的文章里我们已经讲过一部分的内存对齐的知识,并举出了两个例子,我们再举出两个例子继续说明: struct S3{double a;int b;char c;};int mian(){printf("%zd\n",s

Spring 源码解读:自定义实现Bean定义的注册与解析

引言 在Spring框架中,Bean的注册与解析是整个依赖注入流程的核心步骤。通过Bean定义,Spring容器知道如何创建、配置和管理每个Bean实例。本篇文章将通过实现一个简化版的Bean定义注册与解析机制,帮助你理解Spring框架背后的设计逻辑。我们还将对比Spring中的BeanDefinition和BeanDefinitionRegistry,以全面掌握Bean注册和解析的核心原理。

Thymeleaf:生成静态文件及异常处理java.lang.NoClassDefFoundError: ognl/PropertyAccessor

我们需要引入包: <dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-thymeleaf</artifactId></dependency><dependency><groupId>org.springframework</groupId><artifactId>sp

深入理解数据库的 4NF:多值依赖与消除数据异常

在数据库设计中, "范式" 是一个常常被提到的重要概念。许多初学者在学习数据库设计时,经常听到第一范式(1NF)、第二范式(2NF)、第三范式(3NF)以及 BCNF(Boyce-Codd范式)。这些范式都旨在通过消除数据冗余和异常来优化数据库结构。然而,当我们谈到 4NF(第四范式)时,事情变得更加复杂。本文将带你深入了解 多值依赖 和 4NF,帮助你在数据库设计中消除更高级别的异常。 什么是

Android fill_parent、match_parent、wrap_content三者的作用及区别

这三个属性都是用来适应视图的水平或者垂直大小,以视图的内容或尺寸为基础的布局,比精确的指定视图的范围更加方便。 1、fill_parent 设置一个视图的布局为fill_parent将强制性的使视图扩展至它父元素的大小 2、match_parent 和fill_parent一样,从字面上的意思match_parent更贴切一些,于是从2.2开始,两个属性都可以使用,但2.3版本以后的建议使

Oracle type (自定义类型的使用)

oracle - type   type定义: oracle中自定义数据类型 oracle中有基本的数据类型,如number,varchar2,date,numeric,float....但有时候我们需要特殊的格式, 如将name定义为(firstname,lastname)的形式,我们想把这个作为一个表的一列看待,这时候就要我们自己定义一个数据类型 格式 :create or repla

消除安卓SDK更新时的“https://dl-ssl.google.com refused”异常的方法

消除安卓SDK更新时的“https://dl-ssl.google.com refused”异常的方法   消除安卓SDK更新时的“https://dl-ssl.google.com refused”异常的方法 [转载]原地址:http://blog.csdn.net/x605940745/article/details/17911115 消除SDK更新时的“

maven发布项目到私服-snapshot快照库和release发布库的区别和作用及maven常用命令

maven发布项目到私服-snapshot快照库和release发布库的区别和作用及maven常用命令 在日常的工作中由于各种原因,会出现这样一种情况,某些项目并没有打包至mvnrepository。如果采用原始直接打包放到lib目录的方式进行处理,便对项目的管理带来一些不必要的麻烦。例如版本升级后需要重新打包并,替换原有jar包等等一些额外的工作量和麻烦。为了避免这些不必要的麻烦,通常我们