Safe8 开源项目教程

Safe8 开源项目教程

safe8All PHP functions, rewritten to throw exceptions instead of returning false, now for php8项目地址:https://gitcode.com/gh_mirrors/sa/safe8

项目介绍

Safe8 是一个开源项目，旨在重写所有 PHP 函数，使其在 PHP 8 中抛出异常而不是返回 false。这有助于提高代码的安全性和可读性，减少错误处理的工作量。项目由 thecodingmachine 维护，采用 MIT 许可证。

项目快速启动

安装

首先，通过 Composer 安装 Safe8：

composer require thecodingmachine/safe

使用示例

以下是一个简单的使用示例，展示了如何使用 Safe 版本的 mkdir 函数：

use function Safe\mkdir;

try {
    mkdir('/path/to/directory');
} catch (\Safe\FilesystemException $e) {
    // 错误处理
    echo $e->getMessage();
}

应用案例和最佳实践

错误处理

在传统的 PHP 代码中，错误处理通常通过检查函数的返回值来实现。使用 Safe8 后，可以更简洁地处理错误：

// 传统方式
if (mkdir($dirPath)) {
    // 成功处理
} else {
    // 错误处理
}

// 使用 Safe8
try {
    \Safe\mkdir($dirPath);
} catch (\Safe\FilesystemException $e) {
    // 错误处理
}

性能考虑

尽管 Safe8 在每次请求中加载 1000+ 函数，但其性能影响非常低。根据测试，使用 Safe8 会增加约 700µs 的请求时间。

典型生态项目

PHPStan 集成

Safe8 提供了 PHPStan 规则，帮助开发者自动检测并使用 Safe 版本的函数。安装并配置 PHPStan 规则后，可以确保在项目中正确使用 Safe 函数：

composer require --dev thecodingmachine/phpstan-safe-rule

在 PHPStan 配置文件中添加规则：

includes:
    - vendor/thecodingmachine/phpstan-safe-rule/phpstan-safe-rule.neon

通过以上步骤，可以确保在项目中全面应用 Safe8，提高代码的安全性和可维护性。

safe8All PHP functions, rewritten to throw exceptions instead of returning false, now for php8项目地址:https://gitcode.com/gh_mirrors/sa/safe8