PHP自定义异常：类区分优化技巧

最近发现不少小伙伴都对文章很感兴趣，所以今天继续给大家介绍文章相关的知识，本文《PHP自定义异常：类区分更优的实践方法》主要内容涉及到等等知识点，希望能帮到你！当然如果阅读本文时存在不同想法，可以在评论中表达，但是请勿使用过激的措辞~

本文旨在探讨在PHP中处理自定义异常时，如何优雅地使用字符串标识而非整数代码。针对PHP `Exception` 类默认使用整数作为错误码的限制，我们将介绍一种更符合面向对象原则且易于测试的最佳实践：通过创建特定的自定义异常类来区分不同的错误场景，并结合PHPUnit进行类型断言，从而实现清晰、类型安全且易于维护的异常处理机制，避免依赖上下文数组或不规范的字符串代码。

在PHP开发中，我们经常需要定义自己的异常类型来处理特定的业务逻辑错误。开发者常常希望能够使用描述性的字符串（例如 "user_not_found"）作为异常的“代码”，以便更直观地识别和处理错误。然而，PHP内置的 Exception 类及其子类的 getCode() 方法始终返回一个整数。这导致尝试直接将字符串作为异常代码传入时，它会被隐式转换为整数（通常是 0），从而失去其原有的语义。

字符串代码的挑战与常见替代方案

当直接尝试 throw new CustomException("user_not_found", "User not found"); 时，"user_not_found" 会被作为 code 参数传递，但由于 Exception::__construct 期望一个整数，它将被转换为 0。为了绕过这一限制，一些开发者会采用以下策略：

1. 使用上下文数组（Context Array）：将字符串标识作为额外信息放入异常消息或一个自定义的“上下文”数组中。

   throw new CustomException("User not found", ["debug" => "user_not_found"]);

   然后，在测试时通过捕获异常并检查上下文数组来断言错误类型：

   try {
       $User = new User(100);
       $User->delete_user();
   } catch (\Throwable $e) {
       $this->assertEquals("user_not_found", $e->getContext()["debug"]);
   }

   这种方法虽然可行，但缺点是：

   • 不够直观和类型安全。
   • 需要手动解析上下文，增加了代码的复杂性。
   • getContext() 并非 \Exception 的标准方法，需要自定义异常类来实现。

推荐方案：利用自定义异常类进行类型区分

PHP中处理和区分不同错误场景的最佳实践，是利用其强大的面向对象特性，即通过创建特定的自定义异常类来表示不同的错误类型。这种方法不仅符合PHP的异常处理范式，也使得代码更加清晰、类型安全且易于测试。

核心思想

将每个特定的业务错误场景映射到一个独立的异常类。例如，"用户未找到" 对应 UserNotFoundException，"权限不足" 对应 PermissionDeniedException。这样，异常的“类型”本身就成为了其最明确的标识。

步骤一：创建自定义异常类

首先，为你的应用程序或模块定义一个基础异常类（可选，但推荐），然后为每个具体的错误场景创建继承自 \Exception 或你的基础异常类的特定异常。

<?php

// 可选：定义一个应用层面的基础异常类，便于统一捕获和处理
// class MyApplicationException extends \Exception {}

// 定义特定业务异常：用户未找到
class UserNotFoundException extends \Exception {
    public function __construct(string $message = "用户未找到", int $code = 0, ?\Throwable $previous = null) {
        parent::__construct($message, $code, $previous);
    }
}

// 示例：其他业务异常
class InvalidInputException extends \Exception {
    public function __construct(string $message = "输入无效", int $code = 0, ?\Throwable $previous = null) {
        parent::__construct($message, $code, $previous);
    }
}

步骤二：在业务逻辑中抛出自定义异常

当特定错误条件发生时，直接抛出对应的自定义异常实例。

<?php

// 假设有一个User类
class User {
    private int $id;

    public function __construct(int $id) {
        $this->id = $id;
    }

    public function delete_user(): void {
        // 模拟用户不存在的场景
        if ($this->id === 100) { // 假设ID 100 代表不存在的用户
            throw new UserNotFoundException("ID为 {$this->id} 的用户不存在");
        }
        // 实际删除用户的逻辑
        echo "用户 {$this->id} 已删除。\n";
    }
}

// 示例调用
try {
    $user = new User(100);
    $user->delete_user();
} catch (UserNotFoundException $e) {
    echo "捕获到错误: " . $e->getMessage() . "\n";
} catch (\Exception $e) {
    echo "捕获到未知错误: " . $e->getMessage() . "\n";
}

步骤三：使用PHPUnit进行测试

PHPUnit提供了 expectException() 方法，可以直接断言抛出的异常类型，这是最推荐和最简洁的测试方式。

<?php

use PHPUnit\Framework\TestCase;

class UserTest extends TestCase {
    public function testDeleteNonExistingUserThrowsUserNotFoundException(): void {
        // 期望抛出 UserNotFoundException 类型的异常
        $this->expectException(UserNotFoundException::class);
        // 如果需要断言异常消息，可以使用 expectExceptionMessage()
        $this->expectExceptionMessage("ID为 100 的用户不存在");
        // 如果需要断言异常代码（整数），可以使用 expectExceptionCode()
        // $this->expectExceptionCode(0); // 因为我们没有设置特定的整数代码，默认为0

        // 触发异常的代码
        $User = new User(100); // 100 是一个不存在用户的ID
        $User->delete_user(); // 此方法会抛出 UserNotFoundException
    }

    public function testDeleteExistingUserSuccessfully(): void {
        // 期望不抛出任何异常
        $this->expectNotToPerformAssertions(); // 或者直接不设置 expectException

        $User = new User(1); // 假设ID 1 是一个存在的用户
        $User->delete_user();
        // 可以在这里添加其他断言，例如检查数据库状态等
        $this->assertTrue(true); // 仅为示例，表示测试通过
    }
}

通过 expectException(UserNotFoundException::class);，我们直接声明了期望的异常类型，这比检查字符串代码或上下文数组更加类型安全、清晰和高效。

为什么这种方法更优越？

1. 类型安全与可读性：异常类型直接反映了错误的性质，代码意图明确。IDE和静态分析工具可以更好地理解和支持，提供代码补全和错误检查。
2. 解耦与维护性：异常处理逻辑可以直接针对特定类型，无需解析字符串或数组，降低了耦合度。当需要添加新的错误类型时，只需创建新的异常类，而不会影响现有代码。
3. 符合OOP原则：充分利用了继承和多态的优势，使得异常体系结构清晰有层次。
4. PHPUnit原生支持：与PHPUnit的 expectException() 方法无缝集成，提供了简洁高效的测试方式。

何时考虑在自定义异常中存储额外字符串信息？

尽管推荐使用异常类本身作为主要标识，但在某些高级场景下，你可能仍需要在同一类型的异常中进一步细分错误，或者携带额外的调试信息。在这种情况下，可以在自定义异常类中添加自定义属性来存储这些信息。

<?php

class ValidationException extends \Exception {
    protected string $validationErrorCode;

    public function __construct(string $message, string $validationErrorCode, int $code = 0, ?\Throwable $previous = null) {
        parent::__construct($message, $code, $previous);
        $this->validationErrorCode = $validationErrorCode;
    }

    public function getValidationErrorCode(): string {
        return $this->validationErrorCode;
    }
}

// 抛出异常
// throw new ValidationException("邮箱格式不正确", "INVALID_EMAIL_FORMAT");

// 捕获和检查
// try { /* ... */ } catch (ValidationException $e) {
//     if ($e->getValidationErrorCode() === "INVALID_EMAIL_FORMAT") { /* ... */ }
// }

即使在这种情况下，ValidationException 类本身仍然是主要区分，而 validationErrorCode 属性提供了更细粒度的信息。

总结

在PHP中，虽然 Exception::getCode() 只能是整数，但我们完全可以通过定义和使用具体的自定义异常类来达到“字符串代码”的区分效果。这种方法不仅提供了更强的类型安全性、更好的代码可读性和维护性，而且与PHPUnit的测试机制完美契合。通过拥抱面向对象的设计，我们可以构建出更加健壮、清晰和易于测试的PHP应用程序。

今天带大家了解了的相关知识，希望对你有所帮助；关于文章的技术知识我们会一点点深入介绍，欢迎大家关注golang学习网公众号，一起学习编程~