Laravel Sail

[Laravel 備忘録] コマンドラインプログラムの作成

フレームワークで開発してると、「このfunction本当に挙動あってる?」みたいな瞬間があると思います。(あるよね?)

それを確認するためにTest作れとかいう意見もわかるんですが、そもそもそのテストを作るためにちょっと挙動を確認したいときもあるわけです。

laravelでいうtinkerみたいな対話式プログラムも用意されていますが、僕的にはコマンドラインで echo “hello world”; 以上のことやるの難しいと思うんですよね。

Web出力にvar_dumpとかするにしても、都合の良いページがあればいいですが、var_dumpするためにいちいちコントローラーとか作るのもめんどくさいわけです。

だから僕はそんなときは、コマンドラインプログラムで対応しています。

なので今回はlaravelでコマンドラインプログラム実装する備忘録。

環境

Laravel8、php7、Laravel Sail

やりたいこと

laravelのコマンドラインプログラムでHello Worldを出力する。

まずはCommandファイルを作成

sail artisan make:command Kirin

これで/app/Console/Commands/Kirin.phpが作られる。

Sail未導入ならsail -> phpに置き換えかな

Kirin.phpを修正

直すところは大まかに3つ、$signature、$descripitionとhandle()の中身です。

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;

class Kirin extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
//  コマンド文字列を指定
    protected $signature = 'kirin:test';

    /**
     * The console command description.
     *
     * @var string
     */
//  コマンドの説明(適当でOK)
    protected $description = '頑張って作ったコマンドラインプログラム';

    /**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Execute the console command.
     *
     * @return int
     */
    public function handle()
    {
//      ここに処理を記述
        echo 'Hello world.' . PHP_EOL;
        return Command::SUCCESS;
    }
}

実行

以下のコマンドを実行します。

$ php artisan kirin:test

$php artisan + $signatureで指定した文字列

実行結果

Hello world.

まとめ

Laravelの場合、useやらnamespaceやら色々プログラムを動かすために記述が必要で、こんなのIDEが無いと無理。

コマンドラインプログラムにしておけば、IDEで保管しながらコーディングできるしモデルとか使う場合とかこういうふうにしないとわけわかんなくね?

というひとのためのtipsです。

[Laravel 備忘録] Laravel Sail作成したプロジェクトにLaravel Adminで管理画面導入

小規模プロジェクトの場合、フロント画面しか必要ないようなプロジェクトもある(あるよね?)

そんな時、実装していない機能なんかはDBを直接操作したり、phpMyAdminとかを管理画面代わりに使ったりするケースもある(あるよね?)

でもlaravelにはlaravel adminがある。

https://laravel-admin.org/docs/en/

簡単に言うと、管理画面を自動で実装してくれるツール。

LaravelのModelの定義とかを見て、例えばroleのカラムはプルダウンで選択肢から選んだりできるのでphpMyAdminよりは遥かに便利な管理画面となる。

管理画面からGUIで管理メニュー自体を新たに作ることもできる。

本記事は、これを実装する手順の備忘録である。

Laravelを使ったプロジェクトの作成は以前の記事を参照するべきである。

Laravel Adminもコマンドで導入

sailでlaravelプロジェクトを作った場合はこんな感じで導入。

sail composer require encore/laravel-admin

sail artisan vendor:publish --provider="Encore\Admin\AdminServiceProvider"

sail artisan admin:install

インストールが無事に完了すれば、http://localhost/admin/ にアクセスするとログイン画面がでる。

2020年12月現在、Laravel Adminの推奨環境がLaravel 5.5。

今構築した環境がLaravel 8でPHP7.4、MySQLは5という状態なので推奨環境とは程遠い状態なので動くか不安だったけど動いたでござる。

このままだと管理者がいないので、ログインできないよねと思ったけど、適当にadmin/adminと入力したらログインできた。

ところどころエラーが出ているみたいだけど、動く部分だけで動作するようになってるみたい。

柔軟で素晴らしい考えだと思う。

初期状態だと管理ユーザーを管理する画面が実装されている。

artisanにadminコマンドが追加されている。

管理画面で使うファイルはこのコマンドから作ることになる。

$ sail artisan admin

略
                                                                          
Laravel-admin version 1.8.14

Available commands:
 admin:make             Make admin controller
 admin:controller       Make admin controller from giving model
 admin:menu             Show the admin menu
 admin:install          Install the admin package
 admin:publish          re-publish laravel-admin's assets, configuration, language and migration files. If you want overwrite the existing files, you can add the `--force` option
 admin:uninstall        Uninstall the admin package
 admin:import           Import a Laravel-admin extension
 admin:create-user      Create a admin user
 admin:reset-password   Reset password for a specific admin user
 admin:extend           Build a Laravel-admin extension
 admin:export-seed      Export seed a Laravel-admin database tables menu, roles and permissions
 admin:minify           Minify the CSS and JS
 admin:form             Make admin form widget
 admin:permissions      generate admin permission base on table name
 admin:action           Make a admin action
 admin:generate-menu    Generate menu items based on registered routes.
 admin:config           Compare the difference between the admin config file and the original

一般ユーザーを管理する機能を追加

どんなサービスでもほぼ確実に実装するであろう会員管理の機能をLaravel Adminで実装してみよう。

最初からあるUserモデルを扱うコントローラーをartisanで作成。

ドキュメントでは、

php artisan admin:make UserController --model=App\\User

こうなっていますが、Laravel8系からはモデルのディレクトリがapp/Modelsに変更になっているので注意。

※ 参考サイト

https://qiita.com/Dev-kenta/items/25ac692befe6f26f11cf


sailということも考慮してこんな感じで実行するのがいいのかな

sail artisan admin:make UserController --model=App\\Models\\User

実行すると色々メッセージがでるので言われるとおりに/app/Admin/routes.php に変更を加えよう

App\Admin\Controllers\UserController created successfully.

Add the following route to app/Admin/routes.php:

    $router->resource('users', UserController::class);
<?php

use Illuminate\Routing\Router;

Admin::routes();

Route::group([
    'prefix'        => config('admin.route.prefix'),
    'namespace'     => config('admin.route.namespace'),
    'middleware'    => config('admin.route.middleware'),
    'as'            => config('admin.route.prefix') . '.',
], function (Router $router) {

    $router->get('/', 'HomeController@index')->name('home');

    // ここに追加
    $router->resource('users', UserController::class);

});

この状態で管理画面をみる

http://localhost/admin/users

にアクセスするとこんな感じ。

Laravel Breezeの動作確認用に追加したユーザーがちゃんと編集とかできるようになってる。

管理画面からメニューリンクを追加

このままだとURLを直接入力しないとページが表示されないので不便。

管理メニューのmenuのリンクから、http://localhost/admin/auth/menu を開いて以下のようにメニュー自体を追加しよう。

URIはadmin以降のURLを入力(今回はusers)。

その他は適当でOK。色々いじるといいでしょう。

メニュー追加後は、画面の再読み込みとかをしないと反映されないので注意。

ちょっとカスタマイズしてみる

Userの管理画面自体は最低限できているけどこのままだと結構不便なので、UserController.phpを最低限修正しよう。

一覧画面ではパスワードの項目自体非表示に

grid()で一覧表示の項目を変更できる。今回はパスワードとremember_tokenの項目をコメントアウトして対応。

    protected function grid()
    {
        $grid = new Grid(new User());

        $grid->column('id', __('Id'));
        $grid->column('name', __('Name'));
        $grid->column('email', __('Email'));
        $grid->column('email_verified_at', __('Email verified at'));
//        $grid->column('password', __('Password'));
//        $grid->column('remember_token', __('Remember token'));
        $grid->column('created_at', __('Created at'));
        $grid->column('updated_at', __('Updated at'));

        return $grid;
    }

編集時、パスワード項目は変更できないように

form()が追加・編集時のフォームの決め事。ここもコメントアウトして対応。

    /**
     * Make a form builder.
     *
     * @return Form
     */
    protected function form()
    {
        $form = new Form(new User());

        $form->text('name', __('Name'));
        $form->email('email', __('Email'));
        $form->datetime('email_verified_at', __('Email verified at'))->default(date('Y-m-d H:i:s'));
//        $form->password('password', __('Password'));
//        $form->text('remember_token', __('Remember token'));

        return $form;
    }

まとめ

CRUDの基本操作だけで済むならLaravelAdminは超便利ツール。

ただ、枠から外れた操作を実装する場合は、逆にめんどくさいこともあるかも。

GUIでメニュー増やせるのはいいけど、逆にGUIじゃないとメニューすら増やせない(できるかもしれんけど大変)ので、一長一短。

小規模プロジェクトならLaravelAdmin、そうじゃないなら独自で管理画面を作るのがいいと思う。

[Laravel 備忘録] Laravel Sail作成したプロジェクトにLaravel Breezeで認証系入れるとこまで

大体どんなシステムでも必要になる認証系の仕組みをLaravel Sailで作成したプロジェクトにBreezeで導入してみるところまでの備忘録

Laravel Sailについては以下参照

コマンドを打ってほとんどの作業が完了

sailコマンドのパスが通っている状態まで進んでいるなら↓でOK

sail composer require laravel/breeze --dev

sail artisan breeze:install

sail npm install

sail npm run dev

sail artisan migrate

やっていることは、

composer を更新して、artisanでbreezeをインストール、npmでnode環境を整えて最後にmigrateかな。

(とにかくこれで動くんであんまり考えてない)

エラーが出てる場合

よく遭遇するエラーのひとつがこれ

SQLSTATE[42000]: Syntax error or access violation: 1071 Specified key was too long; max key length is 767 bytes (SQL: alter table `users` add unique `users_email_unique`(`email`))

MySQLのインデックス最大長が変わったことで発生するエラー

AppServiceProviderに以下の記述を追加すればindexが短くなるので解決

Laravelで開発すると大体最初にいじるのがここですね(笑

use Illuminate\Support\Facades\Schema;

public function boot()
{
  Schema::defaultStringLength(191);
}

修正したら忘れずにmigrateしなおし

http://localhost にアクセスして、認証用のメニューが出ていたらOK

会員登録画面もあるしログインしてダッシュボードも見れる

会員登録画面
ログイン後のダッシュボード

Mailhogの設定

Breezeに含まれるリマインドメール機能を使うにはメールサーバーが必要。開発環境ならMailhogが最初から入っているので.envファイルを修正しておく

.envの例(適当でOK)

MAIL_MAILER=smtp
MAIL_HOST=mailhog
MAIL_PORT=1025
MAIL_USERNAME=admin
MAIL_PASSWORD=123456
MAIL_ENCRYPTION=null
MAIL_FROM_ADDRESS=admin@admin.com
MAIL_FROM_NAME="${APP_NAME}"

これで開発環境だといちいちややこしいメールの挙動もMailhogで確認できる

Mailhogには http://localhost:8025/ でアクセス

リマインドメールが確認できた様子

ところどころ日本語なのは最終的に調整すればいいんじゃないのかなと思う。

一応各箇所で翻訳関数を噛ませているので、翻訳ファイルを用意しておけば一括で変換可能。

おさえておくポイント

Laravelのこういう自動作成機能は便利なんだけど、自動過ぎてどのファイルが変更されたのかわからない弊害もあるので、要所だけまとめておく。

web.php

ルーティングを設定するファイルroutes/web.php

Route::get('/', function () {
    return view('welcome');

});
// ↓認証してないと見られない/dashboardへのrouteが追加されてる(ルート名はdashboard)
Route::get('/dashboard', function () {
    return view('dashboard');
})->middleware(['auth'])->name('dashboard');

require __DIR__.'/auth.php';

この記述を参考に、例えばログインした人しかアクセスできないルートを追加するにはこんな感じにする↓

Route::get('/memberonly', function () {
    return view('memberonly');
})->middleware(['auth']);

Authenticate.php

ログインの有無に応じて処理を判定しているのが app/Http/Middleware/Authenticate.php

    protected function redirectTo($request)
    {
        if (! $request->expectsJson()) {
            return route('login');
        }
    }

特に触ることは無いと思う。ログイン後のURLを変えたい時とか?

ログインユーザーの情報を取得する方法

認証スターターキットをインストールし、ユーザーがアプリケーションへ登録・認証できるようにした後、多くの場合は現在認証済みのユーザーを操作する必要があります。受信リクエストの処理時、Authファサードのuserメソッドを使用して認証済みユーザーにアクセスできます。

use Illuminate\Support\Facades\Auth;

// 現在認証しているユーザーを取得
$user = Auth::user();

// 現在認証しているユーザーのIDを取得
$id = Auth::id();

その他細かくはこちらから
https://readouble.com/laravel/8.x/ja/authentication.html

まとめ

とりあえず会員登録、ログイン認証ができるところまで完了。

なれれば10分もあれば完了するんじゃないかな。