百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术分类 > 正文

Controller 层是抛异常,还是返回友好的错误代码?

ztj100 2024-12-15 18:00 55 浏览 0 评论

在开发过程中,如何在 Controller 层 处理错误是一个非常重要的问题。你是否应该直接抛出异常,还是应该返回一个友好的错误代码?这一决定不仅影响代码的可读性和维护性,还会影响到用户体验与系统的健壮性。今天,我们就来探讨一下这个问题,并给出最佳实践。


一、异常抛出 vs 返回友好的错误代码

1. 异常抛出:优点与缺点

抛出异常通常意味着发生了不正常的行为,或者出现了无法预料的错误。异常通常用于 严重错误系统级别的错误,比如数据库连接失败、外部服务不可用等。

优点:

  • 代码简洁:当异常抛出时,程序会自动跳转到 @ExceptionHandler 或全局异常处理器,让你不需要在每个 Controller 方法中重复写错误处理代码。
  • 可控性强:通过异常机制,你可以有条件地捕获不同类型的错误,灵活地处理复杂的异常逻辑。
  • 能够提供详细的错误信息:通过异常,你可以传递详细的错误信息(例如,出错的原因和堆栈追踪),帮助开发人员进行调试。

缺点:

  • 不够友好:抛出异常通常是为了表达一种程序层面的“故障”或“中断”,但它对于普通用户来说可能并不直观。用户无法理解为什么某个操作失败了。
  • 会导致事务回滚:如果使用 Spring 的事务管理,一旦抛出异常,默认情况下会触发事务回滚,可能导致数据库状态不一致。
  • 影响性能:异常的捕获与处理是有开销的,尤其是在异常频繁发生的场景下,性能可能会受影响。

示例:抛出异常

@GetMapping("/user/{id}")
public User getUser(@PathVariable Long id) {
    User user = userService.findUserById(id);
    if (user == null) {
        throw new UserNotFoundException("用户未找到,ID:" + id);
    }
    return user;
}

2. 返回友好的错误代码:优点与缺点

与抛出异常不同,返回错误代码(或者一个结构化的错误响应)是一种更加“温和”的错误处理方式。它通常用于常见的 业务逻辑错误,比如参数验证失败、请求数据不合法等。

优点:

  • 用户体验友好:通过返回清晰的错误信息和提示码,用户可以更直观地了解错误发生的原因,并采取适当的解决措施。
  • 灵活性高:开发者可以自定义错误码,确保错误信息符合业务需求,而且能够细化到特定的业务场景。
  • 减少性能损耗:返回错误信息比抛出异常的性能开销要小,因为无需通过异常机制进行回溯处理。

缺点:

  • 代码冗余:需要在每个控制器方法中明确返回错误信息,增加了代码重复性。
  • 错误信息不够详细:相比异常堆栈信息,返回的错误代码和消息可能无法提供充分的调试信息。

示例:返回错误代码

@GetMapping("/user/{id}")
public ResponseEntity<Object> getUser(@PathVariable Long id) {
    User user = userService.findUserById(id);
    if (user == null) {
        return ResponseEntity.status(HttpStatus.NOT_FOUND)
                             .body(new ErrorResponse("USER_NOT_FOUND", "用户未找到,ID:" + id));
    }
    return ResponseEntity.ok(user);
}

ErrorResponse 类:

public class ErrorResponse {
    private String code;
    private String message;

    public ErrorResponse(String code, String message) {
        this.code = code;
        this.message = message;
    }
    // getters and setters
}

二、Controller 层处理错误的最佳实践

1. 不同类型的错误使用不同方式

  • 业务逻辑错误:对于 常见的业务错误,如参数错误、用户未授权等,返回结构化的错误代码会更友好。比如:400 Bad Request404 Not Found 等,配合合适的错误消息。
  • 系统级错误:对于 无法预见的系统错误,如数据库连接失败、外部服务不可用等,抛出异常可能更合适,这样可以快速终止不正常的操作,避免不一致的状态。

示例:业务错误返回错误码

@PostMapping("/user")
public ResponseEntity<Object> createUser(@RequestBody User user) {
    if (user.getName() == null || user.getName().isEmpty()) {
        return ResponseEntity.status(HttpStatus.BAD_REQUEST)
                             .body(new ErrorResponse("USER_NAME_EMPTY", "用户名不能为空"));
    }
    userService.saveUser(user);
    return ResponseEntity.status(HttpStatus.CREATED).body(user);
}

示例:系统错误抛出异常

@GetMapping("/external")
public String getExternalData() {
    try {
        String data = externalService.getData();
        return data;
    } catch (ExternalServiceException e) {
        throw new RuntimeException("外部服务调用失败", e);
    }
}

2. 统一错误处理

无论是通过返回错误代码还是抛出异常,统一处理异常 是提升代码整洁性和用户体验的关键。Spring 提供了强大的全局异常处理功能(@ControllerAdvice),我们可以通过它来集中管理 Controller 层的异常。

全局异常处理示例

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(UserNotFoundException.class)
    public ResponseEntity<Object> handleUserNotFoundException(UserNotFoundException e) {
        return ResponseEntity.status(HttpStatus.NOT_FOUND)
                             .body(new ErrorResponse("USER_NOT_FOUND", e.getMessage()));
    }

    @ExceptionHandler(Exception.class)
    public ResponseEntity<Object> handleException(Exception e) {
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
                             .body(new ErrorResponse("INTERNAL_ERROR", "系统错误,请稍后再试"));
    }
}

这样,所有控制器中的异常就可以统一处理,避免了重复的错误处理逻辑。


三、总结:如何选择?

  1. 业务错误: 如果是常见的业务问题,如用户输入不合法、数据不存在等,建议使用 返回错误代码 的方式,这样既能避免异常处理的开销,又能提供更加友好的错误信息给用户。
  2. 系统错误: 对于 系统级错误,如外部服务故障、数据库问题等,使用 抛出异常 的方式更加合适。可以通过全局异常处理器统一捕获,并返回系统级错误信息。

最后,统一异常处理结构化错误信息 是提高代码质量和用户体验的关键,选择适合的方式,使得代码更加健壮、可维护。

相关推荐

sharding-jdbc实现`分库分表`与`读写分离`

一、前言本文将基于以下环境整合...

三分钟了解mysql中主键、外键、非空、唯一、默认约束是什么

在数据库中,数据表是数据库中最重要、最基本的操作对象,是数据存储的基本单位。数据表被定义为列的集合,数据在表中是按照行和列的格式来存储的。每一行代表一条唯一的记录,每一列代表记录中的一个域。...

MySQL8行级锁_mysql如何加行级锁

MySQL8行级锁版本:8.0.34基本概念...

mysql使用小技巧_mysql使用入门

1、MySQL中有许多很实用的函数,好好利用它们可以省去很多时间:group_concat()将取到的值用逗号连接,可以这么用:selectgroup_concat(distinctid)fr...

MySQL/MariaDB中如何支持全部的Unicode?

永远不要在MySQL中使用utf8,并且始终使用utf8mb4。utf8mb4介绍MySQL/MariaDB中,utf8字符集并不是对Unicode的真正实现,即不是真正的UTF-8编码,因...

聊聊 MySQL Server 可执行注释,你懂了吗?

前言MySQLServer当前支持如下3种注释风格:...

MySQL系列-源码编译安装(v5.7.34)

一、系统环境要求...

MySQL的锁就锁住我啦!与腾讯大佬的技术交谈,是我小看它了

对酒当歌,人生几何!朝朝暮暮,唯有己脱。苦苦寻觅找工作之间,殊不知今日之事乃我心之痛,难道是我不配拥有工作嘛。自面试后他所谓的等待都过去一段时日,可惜在下京东上的小金库都要见低啦。每每想到不由心中一...

MySQL字符问题_mysql中字符串的位置

中文写入乱码问题:我输入的中文编码是urf8的,建的库是urf8的,但是插入mysql总是乱码,一堆"???????????????????????"我用的是ibatis,终于找到原因了,我是这么解决...

深圳尚学堂:mysql基本sql语句大全(三)

数据开发-经典1.按姓氏笔画排序:Select*FromTableNameOrderByCustomerNameCollateChinese_PRC_Stroke_ci_as//从少...

MySQL进行行级锁的?一会next-key锁,一会间隙锁,一会记录锁?

大家好,是不是很多人都对MySQL加行级锁的规则搞的迷迷糊糊,一会是next-key锁,一会是间隙锁,一会又是记录锁。坦白说,确实还挺复杂的,但是好在我找点了点规律,也知道如何如何用命令分析加...

一文讲清怎么利用Python Django实现Excel数据表的导入导出功能

摘要:Python作为一门简单易学且功能强大的编程语言,广受程序员、数据分析师和AI工程师的青睐。本文系统讲解了如何使用Python的Django框架结合openpyxl库实现Excel...

用DataX实现两个MySQL实例间的数据同步

DataXDataX使用Java实现。如果可以实现数据库实例之间准实时的...

MySQL数据库知识_mysql数据库基础知识

MySQL是一种关系型数据库管理系统;那废话不多说,直接上自己以前学习整理文档:查看数据库命令:(1).查看存储过程状态:showprocedurestatus;(2).显示系统变量:show...

如何为MySQL中的JSON字段设置索引

背景MySQL在2015年中发布的5.7.8版本中首次引入了JSON数据类型。自此,它成了一种逃离严格列定义的方式,可以存储各种形状和大小的JSON文档,例如审计日志、配置信息、第三方数据包、用户自定...

取消回复欢迎 发表评论: