Skip to content

升级指南

高影响更改

中等影响更改

低影响更改

从 10.x 升级到 11.0

预计升级时间:15 分钟

lightbulb

我们尝试记录每一个可能的破坏性更改。由于这些破坏性更改有些在框架的隐蔽部分,只有一部分更改可能会影响到您的应用程序。想节省时间?您可以使用 Laravel Shift 来帮助自动化您的应用程序升级。

更新依赖

影响可能性:高

PHP 8.2.0 必需

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

curl 7.34.0 必需

Laravel 的 HTTP 客户端现在要求 curl 7.34.0 或更高版本。

Composer 依赖

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

  • laravel/framework 更新为 ^11.0
  • nunomaduro/collision 更新为 ^8.1
  • laravel/breeze 更新为 ^2.0(如果已安装)
  • laravel/cashier 更新为 ^15.0(如果已安装)
  • laravel/dusk 更新为 ^8.0(如果已安装)
  • laravel/jetstream 更新为 ^5.0(如果已安装)
  • laravel/octane 更新为 ^2.3(如果已安装)
  • laravel/passport 更新为 ^12.0(如果已安装)
  • laravel/sanctum 更新为 ^4.0(如果已安装)
  • laravel/scout 更新为 ^10.0(如果已安装)
  • laravel/spark-stripe 更新为 ^5.0(如果已安装)
  • laravel/telescope 更新为 ^5.0(如果已安装)
  • livewire/livewire 更新为 ^3.4(如果已安装)
  • inertiajs/inertia-laravel 更新为 ^1.0(如果已安装)

如果您的应用程序使用 Laravel Cashier Stripe、Passport、Sanctum、Spark Stripe 或 Telescope,您需要将它们的迁移发布到您的应用程序中。Cashier Stripe、Passport、Sanctum、Spark Stripe 和 Telescope 不再自动加载它们自己迁移 目录中的迁移。因此,您应该运行以下命令将它们的迁移发布到您的应用程序:

bash
php artisan vendor:publish --tag=cashier-migrations
php artisan vendor:publish --tag=passport-migrations
php artisan vendor:publish --tag=sanctum-migrations
php artisan vendor:publish --tag=spark-migrations
php artisan vendor:publish --tag=telescope-migrations

此外,您应该查看每个包的升级指南,以确保您了解任何其他破坏性更改:

如果您手动安装了 Laravel 安装程序,您应该通过 Composer 更新安装程序:

bash
composer global require laravel/installer:^5.6

最后,如果您之前已将 doctrine/dbal Composer 依赖项添加到您的应用程序中,您可以将其移除,因为 Laravel 不再依赖此包。

应用结构

Laravel 11 引入了新的默认应用结构,默认文件更少。即,新 Laravel 应用程序包含更少的服务提供者、中间件和配置文件。

但是,我们不建议升级到 Laravel 11 的 Laravel 10 应用程序尝试迁移其应用结构,因为 Laravel 11 已经过精心调整,以支持 Laravel 10 的应用结构。

身份验证

密码重新哈希

影响可能性:低

Laravel 11 将在身份验证期间自动重新哈希用户的密码,如果您的哈希算法的“工作因子”自上次哈希以来已更新。

通常,这不会干扰您的应用程序;但是,如果您的 User 模型的“密码”字段名称与 password 不同,您应该通过模型的 authPasswordName 属性指定字段名称:

php
protected $authPasswordName = 'custom_password_field';

或者,您可以通过在应用程序的 config/hashing.php 配置文件中添加 rehash_on_login 选项来禁用密码重新哈希:

php
'rehash_on_login' => false,

UserProvider 合同

影响可能性:低

Illuminate\Contracts\Auth\UserProvider 合同新增了一个 rehashPasswordIfRequired 方法。该方法负责在应用程序的哈希算法工作因子发生变化时重新哈希并存储用户的密码。

如果您的应用程序或包定义了实现此接口的类,您应该在实现中添加新的 rehashPasswordIfRequired 方法。可以在 Illuminate\Auth\EloquentUserProvider 类中找到参考实现:

php
public function rehashPasswordIfRequired(Authenticatable $user, array $credentials, bool $force = false);

Authenticatable 合同

影响可能性:低

Illuminate\Contracts\Auth\Authenticatable 合同新增了一个 getAuthPasswordName 方法。该方法负责返回您的可认证实体的密码列的名称。

如果您的应用程序或包定义了实现此接口的类,您应该在实现中添加新的 getAuthPasswordName 方法:

php
public function getAuthPasswordName()
{
    return 'password';
}

Laravel 附带的默认 User 模型自动接收此方法,因为该方法包含在 Illuminate\Auth\Authenticatable 特性中。

AuthenticationException

影响可能性:非常低

Illuminate\Auth\AuthenticationException 类的 redirectTo 方法现在需要一个 Illuminate\Http\Request 实例作为第一个参数。如果您手动捕获此异常并调用 redirectTo 方法,您应该相应地更新您的代码:

php
if ($e instanceof AuthenticationException) {
    $path = $e->redirectTo($request);
}

注册时的电子邮件验证通知

影响可能性:非常低

如果您的应用程序的 EventServiceProvider 没有注册此监听器,并且您不希望 Laravel 自动为您注册它,则 Registered 事件的 SendEmailVerificationNotification 监听器现在会自动注册。如果您的应用程序的 EventServiceProvider 没有注册此监听器,您应该在应用程序的 EventServiceProvider 中定义一个空的 configureEmailVerification 方法:

php
protected function configureEmailVerification()
{
    // ...
}

缓存

缓存键前缀

影响可能性:非常低

之前,如果为 DynamoDB、Memcached 或 Redis 缓存存储定义了缓存键前缀,Laravel 会在前缀后附加 :。在 Laravel 11 中,缓存键前缀不再接收 : 后缀。如果您希望保持之前的前缀行为,您可以手动将 : 后缀添加到您的缓存键前缀。

集合

Enumerable 合同

影响可能性:低

Illuminate\Support\Enumerable 合同的 dump 方法已更新为接受可变参数 ...$args。如果您正在实现此接口,您应该相应地更新您的实现:

php
public function dump(...$args);

数据库

SQLite 3.26.0+

影响可能性:高

如果您的应用程序使用 SQLite 数据库,则需要 SQLite 3.26.0 或更高版本。

Eloquent 模型 casts 方法

影响可能性:低

基础 Eloquent 模型类现在定义了一个 casts 方法,以支持属性类型的定义。如果您的应用程序的某个模型定义了 casts 关系,可能会与基础 Eloquent 模型类现在存在的 casts 方法发生冲突。

修改列

影响可能性:高

在修改列时,您现在必须在更改后显式包含要保留的所有修饰符。任何缺失的属性将被删除。例如,要保留 unsigneddefaultcomment 属性,您必须在更改列时显式调用每个修饰符,即使这些属性是通过先前的迁移分配给列的。

例如,假设您有一个迁移创建了一个 votes 列,并具有 unsigneddefaultcomment 属性:

php
Schema::create('users', function (Blueprint $table) {
    $table->integer('votes')->unsigned()->default(1)->comment('投票计数');
});

稍后,您编写一个迁移,将列更改为 nullable

php
Schema::table('users', function (Blueprint $table) {
    $table->integer('votes')->nullable()->change();
});

在 Laravel 10 中,此迁移将保留列上的 unsigneddefaultcomment 属性。然而,在 Laravel 11 中,迁移现在还必须包括先前定义在列上的所有属性。否则,它们将被删除:

php
Schema::table('users', function (Blueprint $table) {
    $table->integer('votes')
        ->unsigned()
        ->default(1)
        ->comment('投票计数')
        ->nullable()
        ->change();
});

change 方法不会更改列的索引。因此,您可以使用索引修饰符在修改列时显式添加或删除索引:

php
// 添加索引...
$table->bigIncrements('id')->primary()->change();

// 删除索引...
$table->char('postal_code', 10)->unique(false)->change();

如果您不想更新应用程序中所有现有的“更改”迁移以保留列的现有属性,您可以简单地 压缩您的迁移

bash
php artisan schema:dump

一旦您的迁移被压缩,Laravel 将在运行任何待处理迁移之前,使用您的应用程序的架构文件“迁移”数据库。

浮点类型

影响可能性:高

doublefloat 迁移列类型已被重写,以在所有数据库中保持一致。

double 列类型现在创建一个没有总位数和小数位数的 DOUBLE 等效列,这是标准 SQL 语法。因此,您可以删除 $total$places 的参数:

php
$table->double('amount');

float 列类型现在创建一个没有总位数和小数位数的 FLOAT 等效列,但可以选择 $precision 规格来确定存储大小为 4 字节单精度列或 8 字节双精度列。因此,您可以删除 $total$places 的参数,并根据数据库的文档指定可选的 $precision

php
$table->float('amount', precision: 53);

unsignedDecimalunsignedDoubleunsignedFloat 方法已被移除,因为 MySQL 已弃用这些列类型的无符号修饰符,并且在其他数据库系统上从未标准化。然而,如果您希望继续使用这些列类型的已弃用无符号属性,您可以将 unsigned 方法链接到列的定义:

php
$table->decimal('amount', total: 8, places: 2)->unsigned();
$table->double('amount')->unsigned();
$table->float('amount', precision: 53)->unsigned();

专用 MariaDB 驱动程序

影响可能性:非常低

Laravel 11 不再总是使用 MySQL 驱动程序连接到 MariaDB 数据库,而是添加了一个专用的 MariaDB 数据库驱动程序。

如果您的应用程序连接到 MariaDB 数据库,您可以将连接配置更新为新的 mariadb 驱动程序,以便在将来受益于 MariaDB 特定功能:

php
'driver' => 'mariadb',
'url' => env('DB_URL'),
'host' => env('DB_HOST', '127.0.0.1'),
'port' => env('DB_PORT', '3306'),
// ...

目前,新的 MariaDB 驱动程序的行为与当前的 MySQL 驱动程序相同,唯一的例外是 uuid 架构构建器方法创建原生 UUID 列,而不是 char(36) 列。

如果您现有的迁移使用 uuid 架构构建器方法,并且您选择使用新的 mariadb 数据库驱动程序,您应该将迁移中对 uuid 方法的调用更新为 char,以避免破坏性更改或意外行为:

php
Schema::table('users', function (Blueprint $table) {
    $table->char('uuid', 36);

    // ...
});

空间类型

影响可能性:低

数据库迁移的空间列类型已被重写,以在所有数据库中保持一致。因此,您可以从迁移中删除 pointlineStringpolygongeometryCollectionmultiPointmultiLineStringmultiPolygonmultiPolygonZ 方法,而使用 geometrygeography 方法:

php
$table->geometry('shapes');
$table->geography('coordinates');

要显式限制存储在 MySQL、MariaDB 和 PostgreSQL 中的列值的类型或空间参考系统标识符,您可以将 subtypesrid 传递给方法:

php
$table->geometry('dimension', subtype: 'polygon', srid: 0);
$table->geography('latitude', subtype: 'point', srid: 4326);

PostgreSQL 语法的 isGeometryprojection 列修饰符已相应移除。

Doctrine DBAL 移除

影响可能性:低

以下与 Doctrine DBAL 相关的类和方法已被移除。Laravel 不再依赖此包,注册自定义 Doctrine 类型不再是创建和更改各种列类型所需的:

  • Illuminate\Database\Schema\Builder::$alwaysUsesNativeSchemaOperationsIfPossible 类属性
  • Illuminate\Database\Schema\Builder::useNativeSchemaOperationsIfPossible() 方法
  • Illuminate\Database\Connection::usingNativeSchemaOperations() 方法
  • Illuminate\Database\Connection::isDoctrineAvailable() 方法
  • Illuminate\Database\Connection::getDoctrineConnection() 方法
  • Illuminate\Database\Connection::getDoctrineSchemaManager() 方法
  • Illuminate\Database\Connection::getDoctrineColumn() 方法
  • Illuminate\Database\Connection::registerDoctrineType() 方法
  • Illuminate\Database\DatabaseManager::registerDoctrineType() 方法
  • Illuminate\Database\PDO 目录
  • Illuminate\Database\DBAL\TimestampType
  • Illuminate\Database\Schema\Grammars\ChangeColumn
  • Illuminate\Database\Schema\Grammars\RenameColumn
  • Illuminate\Database\Schema\Grammars\Grammar::getDoctrineTableDiff() 方法

此外,通过应用程序的 database 配置文件中的 dbal.types 注册自定义 Doctrine 类型不再是必需的。

如果您之前使用 Doctrine DBAL 来检查数据库及其相关表,您可以使用 Laravel 的新原生架构方法(Schema::getTables()Schema::getColumns()Schema::getIndexes()Schema::getForeignKeys() 等)来代替。

已弃用的架构方法

影响可能性:非常低

已弃用的、基于 Doctrine 的 Schema::getAllTables()Schema::getAllViews()Schema::getAllTypes() 方法已被移除,取而代之的是新的 Laravel 原生 Schema::getTables()Schema::getViews()Schema::getTypes() 方法。

在使用 PostgreSQL 和 SQL Server 时,新的架构方法将不接受三部分引用(例如 database.schema.table)。因此,您应该使用 connection() 来声明数据库:

php
Schema::connection('database')->hasTable('schema.table');

架构构建器 getColumnType() 方法

影响可能性:非常低

Schema::getColumnType() 方法现在始终返回给定列的实际类型,而不是 Doctrine DBAL 等效类型。

数据库连接接口

影响可能性:非常低

Illuminate\Database\ConnectionInterface 接口新增了一个 scalar 方法。如果您正在定义此接口的自定义实现,您应该在实现中添加 scalar 方法:

php
public function scalar($query, $bindings = [], $useReadPdo = true);

日期

Carbon 3

影响可能性:中

Laravel 11 同时支持 Carbon 2 和 Carbon 3。Carbon 是一个在 Laravel 和整个生态系统中广泛使用的日期处理库。如果您升级到 Carbon 3,请注意 diffIn* 方法现在返回浮点数,并且可能返回负值以指示时间方向,这与 Carbon 2 有显著变化。请查看 Carbon 的 变更日志文档 以获取有关如何处理这些和其他更改的详细信息。

邮件

Mailer 合同

影响可能性:非常低

Illuminate\Contracts\Mail\Mailer 合同新增了一个 sendNow 方法。如果您的应用程序或包手动实现此合同,您应该在实现中添加新的 sendNow 方法:

php
public function sendNow($mailable, array $data = [], $callback = null);

将服务提供者发布到应用程序

影响可能性:非常低

如果您编写了一个 Laravel 包,手动将服务提供者发布到应用程序的 app/Providers 目录,并手动修改应用程序的 config/app.php 配置文件以注册服务提供者,您应该更新您的包以使用新的 ServiceProvider::addProviderToBootstrapFile 方法。

addProviderToBootstrapFile 方法将自动将您发布的服务提供者添加到应用程序的 bootstrap/providers.php 文件中,因为在新的 Laravel 11 应用程序中,providers 数组不再存在于 config/app.php 配置文件中。

php
use Illuminate\Support\ServiceProvider;

ServiceProvider::addProviderToBootstrapFile(Provider::class);

队列

BatchRepository 接口

影响可能性:非常低

Illuminate\Bus\BatchRepository 接口新增了一个 rollBack 方法。如果您在自己的包或应用程序中实现此接口,您应该在实现中添加此方法:

php
public function rollBack();

数据库事务中的同步作业

影响可能性:非常低

之前,使用 sync 队列驱动程序的同步作业会立即执行,而不管队列连接的 after_commit 配置选项是否设置为 true,或者作业上是否调用了 afterCommit 方法。

在 Laravel 11 中,同步队列作业现在将尊重队列连接或作业的“提交后”配置。

速率限制

每秒速率限制

影响可能性:中

Laravel 11 支持每秒速率限制,而不再仅限于每分钟的粒度。您应该注意与此更改相关的各种潜在破坏性更改。

GlobalLimit 类构造函数现在接受秒而不是分钟。此类未记录,通常不会被您的应用程序使用:

php
new GlobalLimit($attempts, 2 * 60);

Limit 类构造函数现在接受秒而不是分钟。此类的所有文档用法都限于静态构造函数,例如 Limit::perMinuteLimit::perSecond。但是,如果您手动实例化此类,您应该更新您的应用程序以提供秒作为构造函数的参数:

php
new Limit($key, $attempts, 2 * 60);

Limit 类的 decayMinutes 属性已重命名为 decaySeconds,现在包含秒而不是分钟。

Illuminate\Queue\Middleware\ThrottlesExceptionsIlluminate\Queue\Middleware\ThrottlesExceptionsWithRedis 类构造函数现在接受秒而不是分钟:

php
new ThrottlesExceptions($attempts, 2 * 60);
new ThrottlesExceptionsWithRedis($attempts, 2 * 60);

Cashier Stripe

更新 Cashier Stripe

影响可能性:高

Laravel 11 不再支持 Cashier Stripe 14.x。因此,您应该在 composer.json 文件中将应用程序的 Laravel Cashier Stripe 依赖项更新为 ^15.0

Cashier Stripe 15.0 不再自动加载其自身迁移目录中的迁移。相反,您应该运行以下命令将 Cashier Stripe 的迁移发布到您的应用程序:

shell
php artisan vendor:publish --tag=cashier-migrations

请查看完整的 Cashier Stripe 升级指南 以获取其他破坏性更改。

Spark (Stripe)

更新 Spark Stripe

影响可能性:高

Laravel 11 不再支持 Laravel Spark Stripe 4.x。因此,您应该在 composer.json 文件中将应用程序的 Laravel Spark Stripe 依赖项更新为 ^5.0

Spark Stripe 5.0 不再自动加载其自身迁移目录中的迁移。相反,您应该运行以下命令将 Spark Stripe 的迁移发布到您的应用程序:

shell
php artisan vendor:publish --tag=spark-migrations

请查看完整的 Spark Stripe 升级指南 以获取其他破坏性更改。

Passport

更新 Passport

影响可能性:高

Laravel 11 不再支持 Laravel Passport 11.x。因此,您应该在 composer.json 文件中将应用程序的 Laravel Passport 依赖项更新为 ^12.0

Passport 12.0 不再自动加载其自身迁移目录中的迁移。相反,您应该运行以下命令将 Passport 的迁移发布到您的应用程序:

shell
php artisan vendor:publish --tag=passport-migrations

此外,密码授权类型默认情况下被禁用。您可以通过在应用程序的 AppServiceProviderboot 方法中调用 enablePasswordGrant 方法来启用它:

php
public function boot(): void
{
    Passport::enablePasswordGrant();
}

Sanctum

更新 Sanctum

影响可能性:高

Laravel 11 不再支持 Laravel Sanctum 3.x。因此,您应该在 composer.json 文件中将应用程序的 Laravel Sanctum 依赖项更新为 ^4.0

Sanctum 4.0 不再自动加载其自身迁移目录中的迁移。相反,您应该运行以下命令将 Sanctum 的迁移发布到您的应用程序:

shell
php artisan vendor:publish --tag=sanctum-migrations

然后,在应用程序的 config/sanctum.php 配置文件中,您应该将对 authenticate_sessionencrypt_cookiesvalidate_csrf_token 中间件的引用更新为以下内容:

php
'middleware' => [
    'authenticate_session' => Laravel\Sanctum\Http\Middleware\AuthenticateSession::class,
    'encrypt_cookies' => Illuminate\Cookie\Middleware\EncryptCookies::class,
    'validate_csrf_token' => Illuminate\Foundation\Http\Middleware\ValidateCsrfToken::class,
],

Telescope

更新 Telescope

影响可能性:高

Laravel 11 不再支持 Laravel Telescope 4.x。因此,您应该在 composer.json 文件中将应用程序的 Laravel Telescope 依赖项更新为 ^5.0

Telescope 5.0 不再自动加载其自身迁移目录中的迁移。相反,您应该运行以下命令将 Telescope 的迁移发布到您的应用程序:

shell
php artisan vendor:publish --tag=telescope-migrations

Spatie Once 包

影响可能性:中

Laravel 11 现在提供了自己的 once 函数,以确保给定的闭包仅执行一次。因此,如果您的应用程序依赖于 spatie/once 包,您应该将其从应用程序的 composer.json 文件中移除,以避免冲突。

其他

我们还鼓励您查看 laravel/laravel GitHub 仓库 中的更改。虽然许多更改不是必需的,但您可能希望将这些文件与您的应用程序保持同步。这些更改中的一些将在本升级指南中涵盖,但其他更改,例如配置文件或注释的更改,将不会。您可以轻松地使用 GitHub 比较工具 查看更改,并选择哪些更新对您重要。