# Laravel 5.1 から 8.1 にバージョンアップ

仕事の関係で laravel のアップグレード作業をしましたが、簡単にできると思ったけど意外とハマったことを記録します。
laravel5.7 か 8 から使い始めたので 5.1 ってそんなに変わらないだろうと単純に思ったことが一番のミス。特に認証周りですが、laravel のデフォルト auth 機能使っていたらそんなに問題ないかもしれませんが、カスタマイズドライバーの自己流認証に出会って、いろいろ大変でした。当たり前ですが、5.1 触ったことない人間はまず 5.1 と 5.2 のドキュメントを読んで変更該当箇所のロジックを理解して修正した方がスムーズに行くはずです。

# 5.1 から 5.2

5.1 から 5.2 へのアップグレード (opens new window)

# 認証

  • config/app.php
  • config/auth.php
  • app/Providers/AuthServiceProvider.php

# 設定ファイル

  • config/auth.php
<?php

return [

    'defaults' => [
        'guard' => 'web',
        'passwords' => 'users',
    ],
    'guards' => [
        'web' => [
            'driver' => 'session',
            'provider' => 'users',
        ],
        'api' => [
            'driver' => 'token',
            'provider' => 'users',
        ],
    ],
    'providers' => [
        'users' => [
            'driver' => 'webEloquent',
            'model' => App\Models\User::class,
        ],
    ],
];

# カスタイムドライバ

ユーザを取得するカスタムメソッドを定義する Auth::extend メソッドを使っている場合、カスタムユーザプロバイダを定義するための Auth::provider を使ってください。カスタムプロバイダを定義したら、新しい auth.php 設定ファイルの providers 配列の中でそれを設定してください。

カスタム認証プロバイダについての詳細は、認証の完全なドキュメント (opens new window)で調べてください。

app/Providers/AuthServiceProvider.php

    public function boot(GateContract $gate)
    {
        parent::registerPolicies($gate);

        $this->app['request']->server->set('HTTPS', env('APP_ENV') == 'production');
        $this->app['auth']->provider('webEloquent', function ($app) {
            return
                new webEloquentUserProvider(
                    new \Illuminate\Hashing\Hasher,
                    \Config::get('auth.providers.users.model')
                );
        });
    }

# サービスプロバイダ

app.php 設定ファイルのサービスプロバイダリストから

  • Illuminate\Foundation\Providers\ArtisanServiceProvider
  • Illuminate\Routing\ControllerServiceProvider

を削除

# 5.2 から 5.3

5.2 から 5.3.0 へのアップグレード (opens new window)

# Providers

App\Providers\EventServiceProvider.php 修正

    public function boot()
    {
        parent::boot();
    }

In RouteServiceProvider.php line 25:

Declaration of App\Providers\RouteServiceProvider::boot(Illuminate\Routing\Router $router) should be compatible with Illuminate
\Foundation\Support\Providers\RouteServiceProvider::boot()

App\Providers\RouteServiceProvider.php 修正

    public function boot()
    {
        parent::boot();
    }

In ValidatorServiceProvider.php line 19:

Declaration of App\Providers\ValidatorServiceProvider::boot(Illuminate\Routing\Router $router) should be compatible with Illuminate\Foundation\Support\Providers\RouteServiceProvider::boot()

App\Providers\ValidatorServiceProvider.php 修正

    public function boot()
    {
        // $attributes設定すると、各自のRequest Classのattributesの設定を、
        // 設定しないと、resource/lang/ja(app.localeの設定)/validation.phpのattributesの設定を見に行く。
        Validator::resolver(function($translator, $data, $rules, $messages, $attributes) {
            return new CustomValidator($translator, $data, $rules, $messages, $attributes);
        });

    }

# 配列

配列ヘルパーキーと値順序変更 💩

first last whereメソッドに渡すクロージャの、最初の引数として「値」が渡されます。

Arr::first($array, function ($value, $key) {
    return ! is_null($value);
});

# コレクション

コレクションメソッドキーと値順序変更 :hankey

first last containsコレクションメソッドでは、指定されたコールバッククロージャの 第1引数に「値」 が渡されます。

$collection->first(function ($value, $key) {
    return ! is_null($value);
});

# 設定

config/app.php設定ファイルの中に、以下の設定オプションを追加してください。

'name' => 'アプリケーション名',

# コントローラー

コンストラクターの中からセッションアクセス

Laravel5.3 では、セッションや認証済みユーザにコントローラのコンストラクタではアクセスできません。なぜなら、ミドルウェアがまだ実行されていないからです。

代わりに、クロージャベースのミドルウェアをコントローラのコンストラクタで直接で意義できます。この機能を使用する前に、アプリケーションが Laravel5.3.4 以上で実行されていることを確認してください。
代わりに、クロージャベースのミドルウェアをコントローラのコンストラクタで直接で意義できます。

    public function __construct()
    {
        $this->middleware(function ($request, $next) {
            $this->projects = Auth::user()->projects;

            return $next($request);
        });
    }

$value = $request->session()->get('key');は OK

# DB コレクション

Fluent なクエリビルダ (opens new window)が普通の配列の代わりに、Illuminate\Support\Collection インスタンスを返すようになりました。

  • AppServiceProvider の boot メソッドで、以下のように morphMap を定義する必要があります。
use Illuminate\Database\Eloquent\Relations\Relation;

Relation::morphMap([
    'user' => User::class,
]);

# 結論

php や laravel だけのアップグレードは難しいものではないが、5.1 から 5.2 へアップグレードする時のカスタマイズ認証のところが一番大変でした。グーグル先生に聞いても答えがなく、5.1 のドキュメントを繰り返して読んで、カスタマイズ認証のやり方を先ず学習してからなんとか 5.2 にアップグレードできました。そもそもこれってメジャーの変更ではないか?でも思いました。それ以降のアップグレードは sessionn あたりや array 配列ヘルパーなどの変更がありました。あと、注意点としてphp artian cache:clear php artisan config:clear php aritsan view:clear 系のキャッシュをクリアはまめにした方が無難ですね。
複数 git ブランチ切り替えて作業する場合はcomposer updateする前に vendor ディレクトリ削除と composer.lock 削除した作業効率的になります。
session が見つからないエラーは何回か出ましたが、結局php artisan key:generateで解消できました。

2020-10-12
  • php
  • laravel

関連記事

Laravel メンテナンスモード
Laravel model で hidden に設定したカラムを一時解除
Laravel でカテゴリー作成 テーブル構築と再帰クエリ
Laravel Queue で非同期処理
Laravel notification メール通知カスタマイズ
Laravel lang バリデーションメッセージを多言語対応
Laravel を API サーバーとしての初期設定
Laravel リクエストログ出力
Carbon で php date 日付の日数・月数差を計算
Laravel 429 Too Many Requests
Laravel Email バリデーションについて
Laravel Sanctum 使って API トークン JWT 認証と SPA 認証
AWS SES メール開封確認  DB に集計
Laravel logger でエラーログを chatwork に自動送信
php CSV データ取得は fgetcsv 使う
Laravel tinker 使って DB データベース接続とコマンド
Laravel Test についてのメモ
Laravel Log の基本設定&使い方
Exception: Class 'ZipArchive' not found
Laravel Sail で Docker 環境構築
PHP 文字列長さ・文字列の幅を取得方法
Codeigniter 画像アップロードとリサイズ
Laravel Lumen Faker 日本語設定
laravel method の基本 get post put options
Laravel schedule 設定
Class 'Imagick' not found Error
Laravel eloquent model の規約
PHP mbconvertkana 全角半角英数カナ変換
Codeigniter APPPATH BASEPATH FCPATH 各種パスと URL 取得
Laravel timestamp() auto update 有効化無効化
Lumen8 で JWT ユーザー認証
Laravel toSql パラメータ付きで出力
Lumen8 で API 開発
php Exception エラーキャッチでメール送信
Smarty HTTP URL 取得できるサーバー関数
Laravel blade foreach loop と current url
laravel session を制する
PHP empty isset is_null の違い
PHP 8 リリース新機能と変更
FlattenException deprecated
php.ini 初期設定のいろいろ
PHP 7.4 にアップグレードして使えなくなる機能
開発時によく使うゼロ埋めパディング作業まとめ
解決!phpMyAdmin テーブル構造の内容が表示されない問題
codeigniter email ライブラリでメール送信 日本語対応
Composer コマンドとオプション
爆速軽量フレームワーク codeigniter PHP 開発
nuxtjs と codeigniter で jwt システム構築
Lumen と Laravel 違い比較
HTML から PDF に変換 PHP ライブラリ mPDF の設定
twig 3 人気 PHP テンプレートエンジンがバージョンアップ
正規表現一覧 よく使う検索・置換のパターン
Apache 初期設定メモ
開発におけるコーディングルール・規約
Laravel Error についてのメモ
laravel に vuejs 使うための初期設定
php curl 使って クリックなしで POST 送信
allowurlinclude の設定で ftp_connect()エラー