从 9.x 升级到 10.0

预计升级时间:10 分钟
注意
我们试图记录每一个可能的破坏性变更。由于其中一些破坏性变更位于框架的底层部分,因此只有其中一部分变更实际上会影响你的应用程序。想节省时间吗?你可以使用 Laravel Shift 来帮助自动升级你的应用程序。

更新依赖项

影响可能性:高

要求 PHP 8.1.0
Laravel 现在要求 PHP 8.1.0 或更高版本。

要求 Composer 2.2.0
Laravel 现在要求 Composer 2.2.0 或更高版本。

更新 Composer 依赖项
你应该在应用程序的 php composer.json 文件中更新以下依赖项:

php laravel/framework 更新到 php ^10.0
php laravel/sanctum 更新到 php ^3.2
php doctrine/dbal 更新到 php ^3.0
php spatie/laravel-ignition 更新到 php ^2.0
如果你从 2.x 发布系列升级到 Sanctum 3.x,请参考 Sanctum升级指南

此外,如果你想使用 PHPUnit 10,则应该从应用程序的 php phpunit.xml 配置文件的 php <coverage> 部分中删除 php processUncoveredFiles 属性。然后,更新应用程序的 php composer.json 文件中的以下依赖项:

php nunomaduro/collision 更新到 php ^7.0
php phpunit/phpunit 更新到 php ^10.0
最后,检查应用程序使用的任何其他第三方包,并验证你正在使用 Laravel 10 支持的适当版本。

最小稳定性
你应该将应用程序的 php composer.json 文件中的 php minimum-stability 设置更新为 php stable

  1. "minimum-stability": "stable",

应用程序

绑定公共路径
影响可能性:低

如果你的应用程序将通过 php path.public 绑定到容器来自定义其「公共路径」,则应该更新你的代码以调用 php Illuminate\Foundation\Application 对象提供的 php usePublicPath 方法:

  1. app()->usePublicPath(__DIR__.'/public');

授权

registerPolicies方法

影响可能性:低

框架会自动调用 php AuthServiceProviderphp registerPolicies 方法。因此,你可以从应用程序的 php AuthServiceProviderphp boot 方法中删除对此方法的调用。

缓存

Redis 缓存标签
影响可能性:中等

Redis 的 缓存标签 支持已被重新编写,以提供更好的性能和存储效率。在 Laravel 的之前的版本中,如果使用 Redis 作为应用程序的缓存驱动程序,则会在缓存中累积旧的缓存标签。

然而,为了正确地删除过时的缓存标记项,Laravel 新的 php cache:prune-stale-tags Artisan 命令应该在你的应用程序的 php App\Console\Kernel 类中 预定:

  1. $schedule->command('cache:prune-stale-tags')->hourly();

数据库

数据库表达式
影响可能性:中等

Laravel 10.x 重新编写了数据库 “表达式” (通常是通过 php DB::raw 生成),以便在未来提供额外的功能。需要注意的是,语法的原始字符串值现在必须通过表达式的 php getValue(Grammar $grammar) 方法检索。现在不再支持将表达式强制转换为字符串使用 php (string)

通常,这不会影响最终用户的应用程序;但是,如果你的应用程序正在手动将数据库表达式强制转换为字符串使用 php (string) 或直接调用表达式的 php __toString 方法,则应该更新你的代码以调用 php getValue 方法:

  1. use Illuminate\Support\Facades\DB;
  2. $expression = DB::raw('select 1');
  3. $string = $expression->getValue(DB::connection()->getQueryGrammar());

查询异常构造函数
影响可能性:非常低

php Illuminate\Database\QueryException 构造函数现在接受一个字符串连接名称作为其第一个参数。如果你的应用程序正在手动抛出此异常,则应相应调整你的代码。

ULID 列
影响可能性:低

当迁移调用 php ulid 方法而没有任何参数时,列现在将被命名为 php ulid。在 Laravel 的以前版本中,调用此方法而没有任何参数会创建一个错误命名为 php uuid 的列:

  1. $table->ulid();

在调用 php ulid 方法时显式指定列名,可以将列名传递给该方法:

  1. $table->ulid('ulid');

Eloquent

模型 “Dates” 属性
影响可能性:中等

已删除 Eloquent 模型中已过时属性。现在,你的应用程序应该使用php $casts 属性:

  1. protected $casts = [
  2. 'deployed_at' => 'datetime',
  3. ];

关系 getBaseQuery 方法
影响可能性:非常低

php Illuminate\Database\Eloquent\Relations\Relation 类中的 php getBaseQuery 方法已更名为 php toBase

本地化

语言目录
影响可能性:无

虽然不涉及现有应用程序,但 Laravel 应用程序骨架不再默认包含 php lang 目录。相反,在编写新的 Laravel 应用程序时,可以使用 php lang:publish Artisan 命令进行发布:

  1. php artisan lang:publish

日志

Monolog 3
影响可能性:中等

Laravel 的 Monolog 依赖项已更新为 Monolog 3.x。如果你正在直接与 Monolog 交互,则应该查看 Monolog 的 升级指南

如果你正在使用 BugSnag 或 Rollbar 等第三方日志记录服务,请确保将这些第三方包升级到支持 Monolog 3.x 和 Laravel 10.x 版本的版本。

队列

Bus::dispatchNow 方法
影响可能性:低

已删除过时的 php Bus::dispatchNowphp dispatch_now 方法。目前你的应用程序应该分别使用 php Bus::dispatchSyncphp dispatch_sync 方法。

路由

中间件别名
影响可能性:非强制

在新的 Laravel 应用程序中,php App\Http\Kernel 类的 php $routeMiddleware 属性已更名为 php $middlewareAliases,以更好地反映其用途。你可以在现有应用程序中重命名此属性,但不是强制的。

限速器返回值
影响可能性: 低

调用 php RateLimiter::attempt 方法时,该方法现在将返回由提供的闭包返回的值。如果没有返回任何值或返回 php null,则 php attempt 方法将返回 php true

  1. $value = RateLimiter::attempt('key', 10, fn () => ['example'], 1);
  2. $value; // ['example']

Redirect::home 方法
影响可能性: 非常低

已删除不推荐使用的 php Redirect::home 方法。相反,你的应用程序应该重定向到一个明确命名的路由:

  1. return Redirect::route('home');

测试

服务模拟
影响可能性: 中等

已从框架中删除不推荐使用的 php MocksApplicationServices 特性。该特性提供了类似于 php expectsEventsphp expectsJobsphp expectsNotifications 这样的测试方法。

如果你的应用程序使用这些方法,我们建议你过渡到 php Event::fakephp Bus::fakephp Notification::fake。你可以通过相应组件的文档了解有关模拟的更多信息。

验证

闭包验证规则消息
影响可能性: 非常低

当编写基于闭包的自定义验证规则时,调用 php $fail 回调超过一次,现在会将消息附加到数组中,而不是覆盖先前的消息。通常,这不会影响你的应用程序。

此外,php $fail 回调现在返回一个对象。如果你之前对验证闭包的返回类型进行了类型提示,这可能需要你更新你的类型提示:

  1. public function rules()
  2. {
  3. 'name' => [
  4. function ($attribute, $value, $fail) {
  5. $fail('validation.translation.key')->translate();
  6. },
  7. ],
  8. }

其他

我们还鼓励你查看 php laravel/laravel GitHub 存储库 中的更改。虽然这些更改中许多都不是必需的,但你可能希望将这些文件与你的应用程序保持同步。本次升级指南将覆盖部分更改,但其他的更改,例如对配置文件或注释的更改,不会被覆盖。

你可以使用 GitHub 比较工具 轻松查看更改,并选择哪些更新对你重要。但是,GitHub 比较工具显示的许多更改都是由于我们的组织采用了 PHP 本地类型。这些更改是向后兼容的,迁移到 Laravel 10 期间采用它们是可选的。