Laravel – ログイン処理の流れ

2021-09-06 / tau / コメントする

ログインフォーム表示

ルーティング定義

ルーティングファイルにAuth::routes();を記述することでユーザー認証関係のルーティングが自動設定される。その中には、以下のログインフォームへのルーティングが含まれる。

メソッド：GET
URL：login
アクション：Auth\LoginController@showLoginForm
ルート名：login

showLoginFormアクション

LoginControllerコントローラーはAuthenticatesUsersトレイトを利用していて、その中でshowLoginFormアクションが定義されている。

.....
use Illuminate\Foundation\Auth\AuthenticatesUsers;
.....

class LoginController extends Controller
{
    .....
    use AuthenticatesUsers;
    .....
}

.....

use Illuminate\Foundation\Auth\AuthenticatesUsers;

.....

class LoginController extends Controller

{

.....

use AuthenticatesUsers;

.....

}

AuthenticatesUsersトレイトのshowLoginForm()アクションメソッドは以下の通りで、auth.registerビューをレンダリングしている。

auth.registerビューは初期状態では存在しないのでコマンドで生成するかカスタムで作成する必要がある。

trait AuthenticatesUsers
{
    .....
    public function showLoginForm()
    {
        <span class="pl-k">return</span> <span class="pl-en"><span class="pl-token" data-hydro-click="{&quot;event_type&quot;:&quot;code_navigation.click_on_symbol&quot;,&quot;payload&quot;:{&quot;action&quot;:&quot;click_on_symbol&quot;,&quot;repository_id&quot;:7548986,&quot;ref&quot;:&quot;6.x&quot;,&quot;language&quot;:&quot;PHP&quot;,&quot;originating_url&quot;:&quot;https://github.com/laravel/framework/blob/6.x/src/Illuminate/Foundation/Auth/AuthenticatesUsers.php&quot;,&quot;user_id&quot;:null}}" data-hydro-click-hmac="ef26ce1776afd7f9cd106dc44ebf6df058d74ede58cd7afd624f89705e45f651">view</span></span>(<span class="pl-s">'auth.login'</span>);
    }
    .....
}

trait AuthenticatesUsers

{

.....

public function showLoginForm()

{

<span class="pl-k">return</span> <span class="pl-en"><span class="pl-token" data-hydro-click="{"event_type":"code_navigation.click_on_symbol","payload":{"action":"click_on_symbol","repository_id":7548986,"ref":"6.x","language":"PHP","originating_url":"https://github.com/laravel/framework/blob/6.x/src/Illuminate/Foundation/Auth/AuthenticatesUsers.php","user_id":null}}" data-hydro-click-hmac="ef26ce1776afd7f9cd106dc44ebf6df058d74ede58cd7afd624f89705e45f651">view</span></span>(<span class="pl-s">'auth.login'</span>);

}

.....

}

フォームからのPOSTとログイン実行

ルーティング定義

ルーティングファイルにAuth::routes();を記述することで、以下のルーティングが定義される。

メソッド：POST
URI：login
アクション：Auth\LoginController@login

loginアクション

showLoginFormアクションと同じく、loginアクションもAuthenticatesUsersトレイトで定義されている。

trait AuthenticatesUsers
{
    <span class="pl-k">use</span> <span class="pl-v">RedirectsUsers</span>, <span class="pl-v">ThrottlesLogins</span>;
    .....
    public function login(Request $request)
    {
        $this->validateLogin($request);

        // If the class is using the ThrottlesLogins trait, we can automatically throttle
        // the login attempts for this application. We'll key this by the username and
        // the IP address of the client making these requests into this application.
        if (method_exists($this, 'hasTooManyLoginAttempts') &&
            $this->hasTooManyLoginAttempts($request)) {
            $this->fireLockoutEvent($request);

            return $this->sendLockoutResponse($request);
        }

        if ($this->attemptLogin($request)) {
            return $this->sendLoginResponse($request);
        }

        // If the login attempt was unsuccessful we will increment the number of attempts
        // to login and redirect the user back to the login form. Of course, when this
        // user surpasses their maximum number of attempts they will get locked out.
        $this->incrementLoginAttempts($request);

        return $this->sendFailedLoginResponse($request);
    }
    ....
}

trait AuthenticatesUsers

{

<span class="pl-k">use</span> <span class="pl-v">RedirectsUsers</span>, <span class="pl-v">ThrottlesLogins</span>;

.....

public function login(Request $request)

{

$this->validateLogin($request);

// If the class is using the ThrottlesLogins trait, we can automatically throttle

// the login attempts for this application. We'll key this by the username and

// the IP address of the client making these requests into this application.

if (method_exists($this, 'hasTooManyLoginAttempts') &&

$this->hasTooManyLoginAttempts($request)) {

$this->fireLockoutEvent($request);

return $this->sendLockoutResponse($request);

}

if ($this->attemptLogin($request)) {

return $this->sendLoginResponse($request);

}

// If the login attempt was unsuccessful we will increment the number of attempts

// to login and redirect the user back to the login form. Of course, when this

// user surpasses their maximum number of attempts they will get locked out.

$this->incrementLoginAttempts($request);

return $this->sendFailedLoginResponse($request);

}

....

}

このアクションの動作は以下の通り。

バリデーション

最初はログインフォームのバリデーション。

 $this->validateLogin($request);

1	$this->validateLogin($request);

validateLogin()メソッドは同じAuthenticatesUsersトレイトで定義されている

protected function validateLogin(Request $request)
{
    $request->validate([
        $this->username() => 'required|string',
        'password' => 'required|string',
    ]);
}

protected function validateLogin(Request $request)

{

$request->validate([

$this->username() => 'required|string',

'password' => 'required|string',

]);

}

連続エラー時の抑止処理

次はログインエラーが連続したときのログイン抑止処理。ここで捕捉されなければ後段のログイン認証に移る。

if (method_exists($this, 'hasTooManyLoginAttempts') &&
    $this->hasTooManyLoginAttempts($request)) {
    $this->fireLockoutEvent($request);

    return $this->sendLockoutResponse($request);
}

if (method_exists($this, 'hasTooManyLoginAttempts') &&

$this->hasTooManyLoginAttempts($request)) {

$this->fireLockoutEvent($request);

return $this->sendLockoutResponse($request);

}

ここで呼ばれているhasTooManyLoginAttempts()、fireLockoutEvent()、sendLockoutResponse()の各メソッドは全てThrottlesLoginsトレイトで定義されている

hasTooManyLoginAttempts()はログイントライ回数のがmaxAttempts()(デフォルトでは5回)を越えているかどうかをチェック

protected function hasTooManyLoginAttempts(Request $request)
{
    return $this->limiter()->tooManyAttempts(
        $this->throttleKey($request), $this->maxAttempts()
    );
}

protected function hasTooManyLoginAttempts(Request $request)

{

return $this->limiter()->tooManyAttempts(

$this->throttleKey($request), $this->maxAttempts()

);

}

fireLockoutEvent()はLockoutイベントを発火させる

Illuminate\Foundation\Auth\ThrottlesLogins
PHP

protected function fireLockoutEvent(Request $request) { event(new Lockout($request)); }

1
2
3
4

protected function fireLockoutEvent(Request $request)
{
event(new Lockout($request));
}

sendLockoutResponse()は一定時間ログインを抑止する

    protected function sendLockoutResponse(Request $request)
    {
        $seconds = $this->limiter()->availableIn(
            $this->throttleKey($request)
        );

        throw ValidationException::withMessages([
            $this->username() => [Lang::get('auth.throttle', [
                'seconds' => $seconds,
                'minutes' => ceil($seconds / 60),
            ])],
        ])->status(Response::HTTP_TOO_MANY_REQUESTS);
    }

protected function sendLockoutResponse(Request $request)

{

$seconds = $this->limiter()->availableIn(

$this->throttleKey($request)

);

throw ValidationException::withMessages([

$this->username() => [Lang::get('auth.throttle', [

'seconds' => $seconds,

'minutes' => ceil($seconds / 60),

])],

])->status(Response::HTTP_TOO_MANY_REQUESTS);

}

表示例。秒数は30秒程度で試行ごとに変化した。

Too many login attempts. Please try again in 37 seconds.

認証チェック

上記で、バリデーションと連続トライ回数以内の確認が通ったなら、attemptLogin()で認証チェックを行う。

if ($this->attemptLogin($request)) {
    return $this->sendLoginResponse($request);
}

if ($this->attemptLogin($request)) {

return $this->sendLoginResponse($request);

}

attemptLogin()は同じAuthenticatesUsersトレイトで定義されている。

protected function attemptLogin(Request $request)
{
    return $this->guard()->attempt(
        $this->credentials($request), $request->filled('remember')
    );
}

protected function attemptLogin(Request $request)

{

return $this->guard()->attempt(

$this->credentials($request), $request->filled('remember')

);

}

$this->guard()はファサード関係の複雑な処理を経て、\Illuminate\Auth\SessionGuardクラスのインスタンスとなる
$this->credentials()は以下のように定義されていて、ユーザー名とパスワードが認証に使われる

Illuminate\Foundation\Auth\AuthenticatesUsers
PHP

protected function credentials(Request $request) { return $request->only($this->username(), 'password'); }

1
2
3
4

protected function credentials(Request $request)
{
return $request->only($this->username(), 'password');
}

SessionGuard::attempt()は以下のように認証・ログインを行う

public function attempt(array $credentials = [], $remember = false)
{
    $this->fireAttemptEvent($credentials, $remember);

    $this->lastAttempted = $user = $this->provider->retrieveByCredentials($credentials);

    // If an implementation of UserInterface was returned, we'll ask the provider
    // to validate the user against the given credentials, and if they are in
    // fact valid we'll log the users into the application and return true.
    if ($this->hasValidCredentials($user, $credentials)) {
        $this->login($user, $remember);

        return true;
    }

    // If the authentication attempt fails we will fire an event so that the user
    // may be notified of any suspicious attempts to access their account from
    // an unrecognized user. A developer may listen to this event as needed.
    $this->fireFailedEvent($user, $credentials);

    return false;
}

public function attempt(array $credentials = [], $remember = false)

{

$this->fireAttemptEvent($credentials, $remember);

$this->lastAttempted = $user = $this->provider->retrieveByCredentials($credentials);

// If an implementation of UserInterface was returned, we'll ask the provider

// to validate the user against the given credentials, and if they are in

// fact valid we'll log the users into the application and return true.

if ($this->hasValidCredentials($user, $credentials)) {

$this->login($user, $remember);

return true;

}

// If the authentication attempt fails we will fire an event so that the user

// may be notified of any suspicious attempts to access their account from

// an unrecognized user. A developer may listen to this event as needed.

$this->fireFailedEvent($user, $credentials);

return false;

}

SessionGuard::login()メソッドでは、セッション更新、Rememberトークン処理、ユーザーのセットなどが行われる

ログイン失敗時のカウント

ログイン失敗時には失敗回数をカウントアップする。この結果は連続エラーのチェックで参照される。

// If the login attempt was unsuccessful we will increment the number of attempts
// to login and redirect the user back to the login form. Of course, when this
// user surpasses their maximum number of attempts they will get locked out.
$this->incrementLoginAttempts($request);

return $this->sendFailedLoginResponse($request);

// If the login attempt was unsuccessful we will increment the number of attempts

// to login and redirect the user back to the login form. Of course, when this

// user surpasses their maximum number of attempts they will get locked out.

$this->incrementLoginAttempts($request);

return $this->sendFailedLoginResponse($request);

Laravel – ユーザー登録処理の流れ

2021-09-06 / tau / コメントする

登録フォーム表示

ルーティング定義

ルーティングファイルにAuth::routes();を記述することでユーザー認証関係のルーティングが自動設定される。その中には、以下の登録フォーム表示のルーティングも含まれている。

メソッド：GET
URL：register
アクション：Auth\RegisterController@showRegistrationForm
ルート名：register

アクション

RegisterControllerコントローラーはRegistersUsersトレイトを利用していて、その中でshowRegistrationFormアクションが定義されている。

.....
use Illuminate\Foundation\Auth\RegistersUsers;
.....

class RegisterController extends Controller
{
    .....
    use RegistersUsers;
    .....
}

.....

use Illuminate\Foundation\Auth\RegistersUsers;

.....

class RegisterController extends Controller

{

.....

use RegistersUsers;

.....

}

RegistersUsersトレイトのshowRegistrationForm()アクションメソッドは以下の通りで、auth.registerビューをレンダリングしている。

auth.registerビューは初期状態では存在しないので、コマンドで生成するかカスタムで作成する必要がある。

trait RegistersUsers
{
    .....
    public function showRegistrationForm()
    {
        return view('auth.register');
    }
    .....
}

trait RegistersUsers

{

.....

public function showRegistrationForm()

{

return view('auth.register');

}

.....

}

フォームからのPOSTと登録実行

ルーティング定義

ルーティングファイルへのAuth::routes();の記述によって、以下のルーティングも定義される。

メソッド：POST
URI：register
アクション：Auth\RegisterController@register

アクション

showRegistrationFormアクションと同じく、registerアクションもRegisterControllerでuseされるRegistersUsersトレイトで定義されている。

trait RegistersUsers
{
    use RedirectsUsers;
    .....
    public function register(Request $request)
    {
        $this->validator($request->all())->validate();

        event(new Registered($user = $this->create($request->all())));

        $this->guard()->login($user);

        return $this->registered($request, $user)
                        ?: redirect($this->redirectPath());
    }
    ....
}

trait RegistersUsers

{

use RedirectsUsers;

.....

public function register(Request $request)

{

$this->validator($request->all())->validate();

event(new Registered($user = $this->create($request->all())));

$this->guard()->login($user);

return $this->registered($request, $user)

?: redirect($this->redirectPath());

}

....

}

このアクションの動作は以下の通り。

$this->validator($request->all())->validate();

1	$this->validator($request->all())->validate();

マスアサインメント$request->all()のための$fillableはapp\User.phpモデルで定義しておく

入力されたフィールド群を検証するvalidator()メソッドで検証条件を定義

validator()はRegistersUsersトレイトを利用する親元のRegisterControllersで定義

class RegisterController extends Controller
{
    .....
    protected function validator(array $data)
    {
        return Validator::make($data, [
            'name' => ['required', 'string', 'max:255'],
            'email' => ['required', 'string', 'email', 'max:255', 'unique:users'],
            'password' => ['required', 'string', 'min:8', 'confirmed'],
        ]);
    }
    .....
}

class RegisterController extends Controller

{

.....

protected function validator(array $data)

{

return Validator::make($data, [

'name' => ['required', 'string', 'max:255'],

'email' => ['required', 'string', 'email', 'max:255', 'unique:users'],

'password' => ['required', 'string', 'min:8', 'confirmed'],

]);

}

.....

}

戻り値のValidatorインスタンスのvalidate()メソッドで検証実行

event(new Registered($user = $this->create($request->all())));

1	event(new Registered($user = $this->create($request->all())));

RegistersUsersトレイトを利用する親元のRegisterControllerのcreate()メソッドを呼んでデータ作成
そのUserインスタンスを与えて登録済みのイベント発行

$this->guard()->login($user);

1	$this->guard()->login($user);

$user登録後にそのユーザーでログイン
ここで現れる$this-guard()は\Illuminate\Auth\SessionGuardクラスのインスタンスを返すが、かなり深掘りしないと流れを掴めない。

return $this->registered($request, $user)
                ?: redirect($this->redirectPath());

1 2	return $this->registered($request, $user) ?: redirect($this->redirectPath());

$this->registered()は登録確認のようだが、同じトレイトで空で定義されている

PHP

protected function registered(Request $request, $user) { // }

1
2
3
4

    protected function registered(Request $request, $user)
    {
        //
    }
このため三項演算子のfalse側に書かれているredirect($this->redirectPath())がreturnの戻り値となる

redirectPath()はRegistersUsersトレイトでさらにuseされたRedirectsUsersトレイトで定義されていて、

redirectTo()メソッドが定義されていれば実行
$redirectTo属性が定義されていればそこにリダイレクト

いずれでもなければ/homeにリダイレクト

namespace Illuminate\Foundation\Auth;

trait RedirectsUsers
{
    public function redirectPath()
    {
        if (method_exists($this, 'redirectTo')) {
            return $this->redirectTo();
        }

        return property_exists($this, 'redirectTo') ? $this->redirectTo : '/home';
    }
}

namespace Illuminate\Foundation\Auth;

trait RedirectsUsers

{

public function redirectPath()

{

if (method_exists($this, 'redirectTo')) {

return $this->redirectTo();

}

return property_exists($this, 'redirectTo') ? $this->redirectTo : '/home';

}

初期状態ではこのトレイトの親元RegisterControllerで$redirectToが定義されているので、この内容(RouteServiceProvider::HOME)にリダイレクトされる

Laravel – Userモデル

2021-09-06 / tau / コメントする

概要

Laravelプロジェクト作成時にUserモデルのapp/User.phpファイルが自動作成される。この中で、認証関係について調べてみた。

User.phpファイルの内容

app/User.phpの内容は以下のとおり。

<?php

namespace App;

use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;

class User extends Authenticatable
{
    use Notifiable;

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'name', 'email', 'password',
    ];

    /**
     * The attributes that should be hidden for arrays.
     *
     * @var array
     */
    protected $hidden = [
        'password', 'remember_token',
    ];

    /**
     * The attributes that should be cast to native types.
     *
     * @var array
     */
    protected $casts = [
        'email_verified_at' => 'datetime',
    ];
}

<?php

namespace App;

use Illuminate\Contracts\Auth\MustVerifyEmail;

use Illuminate\Foundation\Auth\User as Authenticatable;

use Illuminate\Notifications\Notifiable;

class User extends Authenticatable

{

use Notifiable;

/**

* The attributes that are mass assignable.

* @var array

protected $fillable = [

'name', 'email', 'password',

];

/**

* The attributes that should be hidden for arrays.

* @var array

protected $hidden = [

'password', 'remember_token',

];

/**

* The attributes that should be cast to native types.

* @var array

protected $casts = [

'email_verified_at' => 'datetime',

];

}

認証関係

UserクラスはModelクラスを(直接には)継承していない
UserクラスはAuthenticatableクラスを継承している
AuthenticatableクラスはIlluminate\Foundation\Auth\Userのエイリアスとして定義されている。

Illuminate\Foundation\Auth\Userクラス

UserモデルクラスがAuthenticatbleクラスとして継承しているIlluminate\Foundation\Auth\Userクラスの要点は以下のとおり。

Modelクラスを継承している(L14)
AuthenticatableContractインターフェイスを適用している(L15)
- AuthenticatableContractはIlluminate\Contracts\Auth\Authenticatableインターフェイスのエイリアス(L15)
AuthenticatableContractインターフェイスのメソッドは、Illuminate\Auth\Authenticatableトレイトで実装(L19, L5)

同じAuthenticatableという名前でインターフェイスとトレイトがあるのがややこしい。

<?php

namespace Illuminate\Foundation\Auth;

use Illuminate\Auth\Authenticatable;
use Illuminate\Auth\MustVerifyEmail;
use Illuminate\Auth\Passwords\CanResetPassword;
use Illuminate\Contracts\Auth\Access\Authorizable as AuthorizableContract;
use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Foundation\Auth\Access\Authorizable;

class User extends Model implements
    AuthenticatableContract,
    AuthorizableContract,
    CanResetPasswordContract
{
    use Authenticatable, Authorizable, CanResetPassword, MustVerifyEmail;
}

<?php

namespace Illuminate\Foundation\Auth;

use Illuminate\Auth\Authenticatable;

use Illuminate\Auth\MustVerifyEmail;

use Illuminate\Auth\Passwords\CanResetPassword;

use Illuminate\Contracts\Auth\Access\Authorizable as AuthorizableContract;

use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;

use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;

use Illuminate\Database\Eloquent\Model;

use Illuminate\Foundation\Auth\Access\Authorizable;

class User extends Model implements

AuthenticatableContract,

AuthorizableContract,

CanResetPasswordContract

{

use Authenticatable, Authorizable, CanResetPassword, MustVerifyEmail;

}

Authenticatableインターフェース

Illuminate\Contracts\Auth\Authenticatableインターフェイスは、識別子やパスワード、セッションに関する6つのメソッドの実装を要請する。

Userクラスでこのインターフェイスを適用する際には、エイリアスでAuthenticatbleContractという別名で扱っている。

<?php

namespace Illuminate\Contracts\Auth;

interface Authenticatable
{
    // userの一意な識別子名をstringで返す
    public function getAuthIdentifierName();

    // userの一意な識別子を返す(mixed型)
    public function getAuthIdentifier();

    // userのパスワードをstringで返す
    public function getAuthPassword();

    // "remember me"セッションのトークンをstringで返す
    public function getRememberToken();

    // "remember me"セッションのトークンをstringで与えて設定する
    public function setRememberToken($value);

    // "remember me"トークンのカラム名をstringで返す
    public function getRememberTokenName();
}

<?php

namespace Illuminate\Contracts\Auth;

interface Authenticatable

{

// userの一意な識別子名をstringで返す

public function getAuthIdentifierName();

// userの一意な識別子を返す(mixed型)

public function getAuthIdentifier();

// userのパスワードをstringで返す

public function getAuthPassword();

// "remember me"セッションのトークンをstringで返す

public function getRememberToken();

// "remember me"セッションのトークンをstringで与えて設定する

public function setRememberToken($value);

// "remember me"トークンのカラム名をstringで返す

public function getRememberTokenName();

}

Authenticatableトレイト

Illuminate\Auth\Authenticatableトレイトは、Authenticatableインターフェイスで要請された6つのメソッドを実装する。

<?php

namespace Illuminate\Auth;

trait Authenticatable
{
    // "remember me"トークンのカラム名
    protected $rememberTokenName = 'remember_token';

    // userの一意な識別子名をstringで返す
    public function getAuthIdentifierName()
    {
        return $this->getKeyName();
    }

    // userの一意な識別子を返す(mixed型)
    public function getAuthIdentifier()
    {
        return $this->{$this->getAuthIdentifierName()};
    }

    // userのパスワードをstringで返す
    public function getAuthPassword()
    {
        return $this->password;
    }

    // "remember me"セッションのトークンをstringで返す
    public function getRememberToken()
    {
        if (! empty($this->getRememberTokenName())) {
            return (string) $this->{$this->getRememberTokenName()};
        }
    }

    // "remember me"セッションのトークンをstringで与えて設定する
    public function setRememberToken($value)
    {
        if (! empty($this->getRememberTokenName())) {
            $this->{$this->getRememberTokenName()} = $value;
        }
    }

    // "remember me"トークンのカラム名をstringで返す
    public function getRememberTokenName()
    {
        return $this->rememberTokenName;
    }
}

<?php

namespace Illuminate\Auth;

trait Authenticatable

{

// "remember me"トークンのカラム名

protected $rememberTokenName = 'remember_token';

// userの一意な識別子名をstringで返す

public function getAuthIdentifierName()

{

return $this->getKeyName();

}

// userの一意な識別子を返す(mixed型)

public function getAuthIdentifier()

{

return $this->{$this->getAuthIdentifierName()};

}

// userのパスワードをstringで返す

public function getAuthPassword()

{

return $this->password;

}

// "remember me"セッションのトークンをstringで返す

public function getRememberToken()

{

if (! empty($this->getRememberTokenName())) {

return (string) $this->{$this->getRememberTokenName()};

}

// "remember me"セッションのトークンをstringで与えて設定する

public function setRememberToken($value)

{

if (! empty($this->getRememberTokenName())) {

$this->{$this->getRememberTokenName()} = $value;

}

// "remember me"トークンのカラム名をstringで返す

public function getRememberTokenName()

{

return $this->rememberTokenName;

}

要約

要約すると、プロジェクトで生成されるUserクラスはIlluminate\Foundation\Auth\Userクラスを継承することによって、

Illuminate\Database\Eloquent\Modelクラスを継承している
Authenticatableインターフェイスの6つのメソッドを実装している
- これにより、ユーザー認証と継続セッションの機能が実装される。

通知関係

UserモデルクラスはIlluminate\Notifications\Notifiableトレイトを実装している。

.....
use Illuminate\Notifications\Notifiable;

class User extends Authenticatable
{
    use Notifiable;
    ....
}

.....

use Illuminate\Notifications\Notifiable;

class User extends Authenticatable

{

use Notifiable;

....

}

属性関係

$fillable

フォームのデータをマスアサインメントで取り込むための設定。

    protected $fillable = [
        'name', 'email', 'password',
    ];

protected $fillable = [

'name', 'email', 'password',

];

$hidden

モデルを変換する際に、指定した属性を含めないための指定。

    protected $hidden = [
        'password', 'remember_token',
    ];

protected $hidden = [

'password', 'remember_token',

];

$cast

データベースの読み込み時にstringから特定のデータ型にキャストするための指定。

    protected $casts = [
        'email_verified_at' => 'datetime',
    ];

protected $casts = [

'email_verified_at' => 'datetime',

];

マイグレーションファイル

Userモデルクラスファイルとともに、以下のマイグレーションファイルもLaravelにより生成される。

<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

class CreateUsersTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('users', function (Blueprint $table) {
            $table->bigIncrements('id');
            $table->string('name');
            $table->string('email')->unique();
            $table->datetime('email_verified_at')->nullable();
            $table->string('password');
            $table->rememberToken();
            $table->datetime('created_at');
            $table->datetime('updated_at');
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::dropIfExists('users');
    }
}

<?php

use Illuminate\Database\Migrations\Migration;

use Illuminate\Database\Schema\Blueprint;

use Illuminate\Support\Facades\Schema;

class CreateUsersTable extends Migration

{

/**

* Run the migrations.

* @return void

public function up()

{

Schema::create('users', function (Blueprint $table) {

$table->bigIncrements('id');

$table->string('name');

$table->string('email')->unique();

$table->datetime('email_verified_at')->nullable();

$table->string('password');

$table->rememberToken();

$table->datetime('created_at');

$table->datetime('updated_at');

});

}

/**

* Reverse the migrations.

* @return void

public function down()

{

Schema::dropIfExists('users');

}

artisan migrateコマンドで生成されたテーブルの構造は以下のとおり。

mysql> DESCRIBE users;
+-------------------+-----------------+------+-----+---------+----------------+
| Field             | Type            | Null | Key | Default | Extra          |
+-------------------+-----------------+------+-----+---------+----------------+
| id                | bigint unsigned | NO   | PRI | NULL    | auto_increment |
| name              | varchar(255)    | NO   |     | NULL    |                |
| email             | varchar(255)    | NO   | UNI | NULL    |                |
| email_verified_at | datetime        | YES  |     | NULL    |                |
| password          | varchar(255)    | NO   |     | NULL    |                |
| remember_token    | varchar(100)    | YES  |     | NULL    |                |
| created_at        | datetime        | NO   |     | NULL    |                |
| updated_at        | datetime        | NO   |     | NULL    |                |
+-------------------+-----------------+------+-----+---------+----------------+
8 rows in set (0.02 sec)

mysql> DESCRIBE users;

+-------------------+-----------------+------+-----+---------+----------------+

+-------------------+-----------------+------+-----+---------+----------------+

| id | bigint unsigned | NO | PRI | NULL | auto_increment |

+-------------------+-----------------+------+-----+---------+----------------+

8 rows in set (0.02 sec)

ユーザー認証

基本的なユーザー認証の設定はこちらを参照。

また、ユーザー登録処理の内容、ログイン処理の内容についてはそれぞれのリンクを参照。

Laravel6 – ユーザー認証

2021-09-06 / tau / コメントする

プロジェクト開始時に作成されるファイル

Userモデル

プロジェクトを作成すると、appディレクトリー下にUser.phpが作成される。

Userモデルの内容についてはこちらを参照。

<?php

namespace App;

use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;

class User extends Authenticatable
{
    use Notifiable;

    // マスアサインメントの対象となる属性
    protected $fillable = [
        'name', 'email', 'password',
    ];

    // 秘匿する属性
    protected $hidden = [
        'password', 'remember_token',
    ];

    // データベース読み込み時にキャストする属性
    protected $casts = [
        'email_verified_at' => 'datetime',
    ];
}

<?php

namespace App;

use Illuminate\Contracts\Auth\MustVerifyEmail;

use Illuminate\Foundation\Auth\User as Authenticatable;

use Illuminate\Notifications\Notifiable;

class User extends Authenticatable

{

use Notifiable;

// マスアサインメントの対象となる属性

protected $fillable = [

'name', 'email', 'password',

];

// 秘匿する属性

protected $hidden = [

'password', 'remember_token',

];

// データベース読み込み時にキャストする属性

protected $casts = [

'email_verified_at' => 'datetime',

];

}

コントローラー

プロジェクトを作成すると、Controllers/Authディレクトリー下に以下の認証用コントローラー群が自動的に作成される。

[vagrant@localhost laravel_photo]$ ls app/Http/Controllers/Auth/ -Al
合計 24
-rw-rw-r--. 1 vagrant vagrant 1024  5月 12 05:47 ConfirmPasswordController.php
-rw-rw-r--. 1 vagrant vagrant  667  5月 12 05:47 ForgotPasswordController.php
-rw-rw-r--. 1 vagrant vagrant 1002  5月 12 05:47 LoginController.php
-rw-rw-r--. 1 vagrant vagrant 1950  5月 12 05:47 RegisterController.php
-rw-rw-r--. 1 vagrant vagrant  844  5月 12 05:47 ResetPasswordController.php
-rw-rw-r--. 1 vagrant vagrant 1130  5月 12 05:47 VerificationController.php

[vagrant@localhost laravel_photo]$ ls app/Http/Controllers/Auth/ -Al

合計 24

-rw-rw-r--. 1 vagrant vagrant 1024 5月 12 05:47 ConfirmPasswordController.php

-rw-rw-r--. 1 vagrant vagrant 667 5月 12 05:47 ForgotPasswordController.php

-rw-rw-r--. 1 vagrant vagrant 1002 5月 12 05:47 LoginController.php

-rw-rw-r--. 1 vagrant vagrant 1950 5月 12 05:47 RegisterController.php

-rw-rw-r--. 1 vagrant vagrant 844 5月 12 05:47 ResetPasswordController.php

-rw-rw-r--. 1 vagrant vagrant 1130 5月 12 05:47 VerificationController.php

ルーティング設定

ユーザー認証のためのルーティング

プロジェクト作成後にUserモデルと必要なコントローラーはLaravelにより作成されるが、ルーティングは設定が必要になる。

ルーティングファイルに以下の1行を記載すると、ユーザー認証用の各種ルーティングがまとめて定義される。

Auth::routes();

1	Auth::routes();

ルーティングリスト

関係するルーティングは以下の通りで、ログイン関係とユーザー登録関係が定義されている。

[vagrant@localhost laravel_photo]$ php artisan route:list
+--------+-----------+------------------------+------------------+------------------------------------------------------------------------+--------------+
| Domain | Method    | URI                    | Name             | Action                                                                 | Middleware   |
+--------+-----------+------------------------+------------------+------------------------------------------------------------------------+--------------+
|        | GET|HEAD  | /                      |                  | Closure                                                                | web          |
|        | GET|HEAD  | api/user               |                  | Closure                                                                | api,auth:api |
.....
|        | GET|HEAD  | login                  | login            | App\Http\Controllers\Auth\LoginController@showLoginForm                | web,guest    |
|        | POST      | login                  |                  | App\Http\Controllers\Auth\LoginController@login                        | web,guest    |
|        | POST      | logout                 | logout           | App\Http\Controllers\Auth\LoginController@logout                       | web          |
|        | GET|HEAD  | password/confirm       | password.confirm | App\Http\Controllers\Auth\ConfirmPasswordController@showConfirmForm    | web,auth     |
|        | POST      | password/confirm       |                  | App\Http\Controllers\Auth\ConfirmPasswordController@confirm            | web,auth     |
|        | POST      | password/email         | password.email   | App\Http\Controllers\Auth\ForgotPasswordController@sendResetLinkEmail  | web          |
|        | GET|HEAD  | password/reset         | password.request | App\Http\Controllers\Auth\ForgotPasswordController@showLinkRequestForm | web          |
|        | POST      | password/reset         | password.update  | App\Http\Controllers\Auth\ResetPasswordController@reset                | web          |
|        | GET|HEAD  | password/reset/{token} | password.reset   | App\Http\Controllers\Auth\ResetPasswordController@showResetForm        | web          |
.....
|        | GET|HEAD  | register               | register         | App\Http\Controllers\Auth\RegisterController@showRegistrationForm      | web,guest    |
|        | POST      | register               |                  | App\Http\Controllers\Auth\RegisterController@register                  | web,guest    |
+--------+-----------+------------------------+------------------+------------------------------------------------------------------------+--------------+

[vagrant@localhost laravel_photo]$ php artisan route:list

+--------+-----------+------------------------+------------------+------------------------------------------------------------------------+--------------+

+--------+-----------+------------------------+------------------+------------------------------------------------------------------------+--------------+

| | GET|HEAD | / | | Closure | web |

.....

| | GET|HEAD | password/reset/{token} | password.reset | App\Http\Controllers\Auth\ResetPasswordController@showResetForm | web |

.....

+--------+-----------+------------------------+------------------+------------------------------------------------------------------------+--------------+

ビューの作成

自動作成の場合

php artisan ui vue --authコマンドでユーザー認証に必要なビューを作成
作成されるビューはresources/views/authディレクトリー下に配置

カスタムビュー作成の場合

authディレクトリーの作成

resources/viewsディレクトリー下にauthディレクトリーを作成
作成したauthディレクトリー下に必要なビューを定められたファイル名と内容で作成

登録用フォームビューの作成～register.blade.php

authディレクトリー下に、以下フォームを含む内容でregister.blade.phpを作成。ビュー名はLaravelが生成するコントローラーで想定されているされるため、これに合わせる必要がある。

たとえばユーザー登録フォームのビュー名はRegisterControllerでuseされているRegistersUsersトレイトのshowRegistrationForm()メソッドにおいて、'auth.register'として呼ばれる。

  <form method="post" action="{{ route('register') }}">
    @csrf
    <div>
      <label>ユーザー名: <input type="text" name="name"></label>
    </div>
    <div>
      <label>メールアドレス: <input type="email" name="email"></label>
    </div>
    <div>
      <label>パスワード: <input type="password" name="password"></label>
    </div>
    <div>
      <label>パスワード: <input type="password" name="password_confirmation"></label>
    </div>

    <div>
      <input type="submit" value="登録">
    </div>
  </form>

@csrf

<div>

<label>ユーザー名: <input type="text" name="name"></label>

</div>

<div>

<label>メールアドレス: <input type="email" name="email"></label>

</div>

<div>

<label>パスワード: <input type="password" name="password"></label>

</div>

<div>

<label>パスワード: <input type="password" name="password_confirmation"></label>

</div>

<div>

</div>

</form>

ブラウザーからURL:ドメイン名/registerでアクセスすると以下のようなフォームが表示される。

カスタマイズしていない状態で登録ボタンを押すと、URL:ドメイン名/homeにリダイレクトされる(後述のように、そのままでは404エラーになる)。

ログインフォームビューの作成～login.blade.php

authディレクトリー下に、以下のフォームを含む内容でlogin.blade.phpを作成。

  <form method="post" action="{{ route('login') }}">
    <div>
      <label>メールアドレス: <input type="email" name="email"></label>
    </div>
    <div>
      <label>パスワード: <input type="password" name="password"></label>
    </div>
    <div>
      <input type="submit" value="ログイン">
    </div>
  </form>

<div>

<label>メールアドレス: <input type="email" name="email"></label>

</div>

<div>

<label>パスワード: <input type="password" name="password"></label>

</div>

<div>

</div>

</form>

ブラウザーからURL:ドメイン名/loginでアクセスすると以下のようなフォームが表示される。

カスタマイズしていない状態で登録ボタンを押すと、URL:ドメイン名/homeにリダイレクトされる。

コントローラー設定

ログイン後の画面遷移

たとえばユーザーログイン後のトップページを'posts/index'とする。

デフォルト設定～404エラー

カスタマイズしていない状態では以下の様になっているが、このままログインすると404エラーとなる。

ルーティングファイル→特に設定なし
コントローラー

Controllers/Auth/LogiinController.php
PHP

protected $redirectTo = RouteServiceProvider::HOME;

1

protected $redirectTo = RouteServiceProvider::HOME;

このときブラウザーのURL表示はhttp://localhost:3000/homeとなっている。

方法1～コントロールファイルを変更

以下の様に$redirectToの定義を編集すると、意図したページに遷移する。

protected $redirectTo = 'posts/index';

または

protected $redirectTo = 'posts';

protected $redirectTo = 'posts/index';

または

protected $redirectTo = 'posts';

方法2～ルーティングファイルに追加

コントローラーが以下の様に生成直後の状態で・・・

protected $redirectTo = RouteServiceProvider::HOME;

1	protected $redirectTo = RouteServiceProvider::HOME;

ルーティングファイルに以下の1行を追加する。

Route::get('home', 'PostController@index');

1	Route::get('home', 'PostController@index');

なお、上記をルーティングファイルに追加すれば、コントローラーの定義は以下でもよい。

protected $redirectTo = 'home';

1	protected $redirectTo = 'home';

ルート名は使えない

ルート名が設定されていても、以下の表現はエラーになる(Constant expression contains invalid operations)。

protected $redirectTo = route('posts.index');

1	protected $redirectTo = route('posts.index');

ユーザー登録後の画面遷移

RegisterControllerでもデフォルトで以下の様に定義されている。

protected $redirectTo = RouteServiceProvider::HOME;

1	protected $redirectTo = RouteServiceProvider::HOME;

LoginControllerと同じようにルーティング設定をすることで、ユーザー登録後の遷移先を設定することができる。

ユーザー認証処理の詳細

ユーザー登録処理の内容、ログイン処理の内容についてはそれぞれのリンクを参照。

2038年問題対応

Laravelでモデルの雛形を生成する場合、MySQLだと作成日時と更新日時のtimestamp型の2038年問題が内包される。

database/migrationsディレクトリー下のマイグレーションファイル、...create_users_table.phpのtimestampsをdatetime型に修正しておくべき。

ログアウト処理

ログアウト処理についてはこちら。

PHP – マジックメソッド – __callStatic()

2021-09-05 / tau / コメントする

__callStatic()はマジックメソッドの一つで、実行させようとしたクラスのstaticメソッドが存在しない時に呼ばれる。

以下の例では、MyClassに__callStatic()メソッドのみが定義されている。__callStatic()の内容は、引数の$methodと$argsを表示させるようにしている。

<?php

class MyClass
{
  public static function __callStatic($method, $args) {
    echo '$method:';
    var_export($method);
    echo PHP_EOL;
    echo '$args:' . PHP_EOL;
    var_export($args);
    echo PHP_EOL;
  }
}

<?php

class MyClass

{

public static function __callStatic($method, $args) {

echo '$method:';

var_export($method);

echo PHP_EOL;

echo '$args:' . PHP_EOL;

var_export($args);

echo PHP_EOL;

}

このクラスに存在しないstaticメソッドを、引数なし、引数1個、2個で実行した場合の実行結果。引数は配列として$argsにセットされ、引数がない場合は空の配列、引数が1個の場合は要素数1(要素番号0)の配列となる。

MyClass::method1();
// $method:'method1'
// $args:
// array (
// )

MyClass::myMethod(1);
// $method:'myMethod'
// $args:
// array (
//   0 => 1,
// )

MyClass::myMethod(1, "two");
// $method:'myMethod'
// $args:
// array (
//   0 => 1,
//   1 => 'two',
// )

MyClass::method1();

// $method:'method1'

// $args:

// array (

// )

MyClass::myMethod(1);

// $method:'myMethod'

// $args:

// array (

// 0 => 1,

// )

MyClass::myMethod(1, "two");

// $method:'myMethod'

// $args:

// array (

// 0 => 1,

// 1 => 'two',

// )

インスタンスに対して存在しないstaticメソッドを呼んで__callStatic()が実行される場合、通常のstaticメソッドと違って'->'はエラーになる。

<?php

class MyClass
{
  public static function static_method() {
    echo "static method\n";
  }

  public static function __callStatic($method, $args) {
    echo "__callStatic called.\n";
  }
}

$instance = new MyClass();

$instance->static_method();
// static method

$instance::static_method();
// static method

$instance::method1('undefined static method');
//__callStatic called.

$instance->method1('undefined static method');
// Uncaught Error: Call to undefined method MyClass::method1()

<?php

class MyClass

{

public static function static_method() {

echo "static method\n";

}

public static function __callStatic($method, $args) {

echo "__callStatic called.\n";

}

$instance = new MyClass();

$instance->static_method();

// static method

$instance::static_method();

// static method

$instance::method1('undefined static method');

//__callStatic called.

$instance->method1('undefined static method');

// Uncaught Error: Call to undefined method MyClass::method1()

PHP – static::とself::

2021-09-04 / tau / コメントする

概要

static::とself::はクラスのスタティックメソッドを指すときに使えるが、それぞれ以下のような違いがある。

staticはそれが実行されるときのクラスを指す
selfはそれが定義されたときのクラスを指す

参照：new staticとnew self

準備

以下のようにParentClassとそれを継承したChildClassを準備する。

いずれも同じ名前のstaticメソッドstatic_method()を持つ
それぞれのクラスはインスタンスメソッドparent_method()、child_method()を持つ
- 何れの内容も同じで、static::static_method()とself::static_method()を実行する

<?php

class ParentClass
{
  public static function static_method() {
    echo 'in ParentClass', PHP_EOL;
  }

  public function parent_method() {
    static::static_method();
    self::static_method();
  }
}

class ChildClass extends ParentClass
{
  public static function static_method() {
    echo 'in ChildClass', PHP_EOL;
  }

  public function child_method() {
    static::static_method();
    self::static_method();
  }
}

<?php

class ParentClass

{

public static function static_method() {

echo 'in ParentClass', PHP_EOL;

}

public function parent_method() {

static::static_method();

self::static_method();

}

class ChildClass extends ParentClass

{

public static function static_method() {

echo 'in ChildClass', PHP_EOL;

}

public function child_method() {

static::static_method();

self::static_method();

}

クラスからstaticメソッドを呼ぶ

クラスからstaticメソッドを呼ぶと、当然それぞれに対応したstatic_method()が実行される。

ParentClass::static_method();
ChildClass::static_method();

// static method of Parent
// static method of Child

ParentClass::static_method();

ChildClass::static_method();

// static method of Parent

// static method of Child

親クラスのメソッドから呼ぶ

親クラスのインスタンスを作って、インスタンスメソッドparent_method()内でstatic、selfでstatic_method()を呼び出す場合。

親クラスのstaticメソッドしか対象がないので、いずれの場合も親クラスのstatic_method()が実行される。

$parent = new ParentClass();
$parent->parent_method();

// in ParentClass
// in ParentClass

$parent = new ParentClass();

$parent->parent_method();

// in ParentClass

子クラスのメソッドから呼ぶ

子クラスのインスタンスを作って、インスタンスメソッドchild_method()内でstatic、selfでstatic_method()を呼び出す場合。

static、selfとも子クラスを指し、子クラスのインスタンスメソッドが実行される。

$child = new ChildClass();
$child->child_method();

// in ChildClass
// in ChildClass

$child = new ChildClass();

$child->child_method();

// in ChildClass

子クラスで親クラスのメソッドから呼ぶ

子クラスのインスタンスを作って、継承元の親クラスのインスタンスメソッドparent_method()からstatic、selfでstatic_method()を呼び出す場合。

$child = new ChildClass();
$child->parent_method();

// in ChildClass
// in ParentClass

$child = new ChildClass();

$child->parent_method();

// in ChildClass

// in ParentClass

staticは実行時のクラスを指すため、Childクラスのstatic_method()が実行される。

一方selfは定義時のクラスを指すため、parent_method()が定義されたParentClassのstatic_method()が実行される。

Laravel – artisan – ルーティングリストの表示

2021-08-30 / tau / コメントする

下記コマンドでルーティングのリストが表示される。

php artisan route:list

ただし、各ルーティングで呼ばれるコントローラー・アクションが定義されていなければならない。

実行例。

[vagrant@localhost laravel_photo]$ php artisan route:list
+--------+-----------+-------------------+---------------+---------------------------------------------+--------------+
| Domain | Method    | URI               | Name          | Action                                      | Middleware   |
+--------+-----------+-------------------+---------------+---------------------------------------------+--------------+
|        | GET|HEAD  | /                 |               | Closure                                     | web          |
|        | GET|HEAD  | api/user          |               | Closure                                     | api,auth:api |
|        | POST      | items             | items.store   | App\Http\Controllers\ItemController@store   | web          |
|        | GET|HEAD  | items             | items.index   | App\Http\Controllers\ItemController@index   | web          |
|        | GET|HEAD  | items/create      | items.create  | App\Http\Controllers\ItemController@create  | web          |
|        | DELETE    | items/{item}      | items.destroy | App\Http\Controllers\ItemController@destroy | web          |
|        | PUT|PATCH | items/{item}      | items.update  | App\Http\Controllers\ItemController@update  | web          |
|        | GET|HEAD  | items/{item}      | items.show    | App\Http\Controllers\ItemController@show    | web          |
|        | GET|HEAD  | items/{item}/edit | items.edit    | App\Http\Controllers\ItemController@edit    | web          |
+--------+-----------+-------------------+---------------+---------------------------------------------+--------------+

[vagrant@localhost laravel_photo]$ php artisan route:list

+--------+-----------+-------------------+---------------+---------------------------------------------+--------------+

+--------+-----------+-------------------+---------------+---------------------------------------------+--------------+

| | GET|HEAD | / | | Closure | web |

| | DELETE | items/{item} | items.destroy | App\Http\Controllers\ItemController@destroy | web |

| | PUT|PATCH | items/{item} | items.update | App\Http\Controllers\ItemController@update | web |

| | GET|HEAD | items/{item} | items.show | App\Http\Controllers\ItemController@show | web |

| | GET|HEAD | items/{item}/edit | items.edit | App\Http\Controllers\ItemController@edit | web |

+--------+-----------+-------------------+---------------+---------------------------------------------+--------------+

Laravel – 名前付きルート

2021-08-30 / tau / コメントする

記述方法

ルーティングのname()メソッドで、ルートに名前を付けることができる。

Route::メソッド('URL', 'コントローラー@アクション')->name('ルート名');

この名前を使ってルーティングのURLを得るには、route()ヘルパーを使う。

route('ルート名')

URLにルートパラメーターを含む場合、route()でパラメーターの値を設定して、これを含むURLを得ることができる。

route('ルート名', ['パラメーター' => 値])

ルートパラメーターが複数ある場合は連想配列の要素として列挙。いずれのパラメーターも省略することはできない。

route('ルート名', ['パラメーター1' => 値1, 'パラメーター2' => 値2])

例

ルーティングで以下のように記述する。

Route::get('/named_route', 'SampleController@named_route')->name('named_route');
Route::get('/named_route/{param}/set', 'SampleController@parameter_set')
  ->name('parameter_set');
Route::get('/named_route/first/{param1}/second/{param2}', 'SampleController@parameter_set')
  ->name('two_parameters');

Route::get('/named_route', 'SampleController@named_route')->name('named_route');

Route::get('/named_route/{param}/set', 'SampleController@parameter_set')

->name('parameter_set');

Route::get('/named_route/first/{param1}/second/{param2}', 'SampleController@parameter_set')

->name('two_parameters');

コントローラーのnamed_route()アクションでビューを呼び出す。

  public function named_route() {
    return view('samples.named_route', [
      'title' => '名前付きルート'
    ]);
  }

public function named_route() {

return view('samples.named_route', [

'title' => '名前付きルート'

]);

}

ビューの中で、route()ヘルパーによってルーティングのURLを表示させる。

<!DOCTYPE html>
<html lang="ja" dir="ltr">
  <head>
    <meta charset="utf-8">
    <title>{{ $title }}</title>
  </head>
  <body>
    <h1>{{ $title }}</h1>

    <p>{{ route('named_route') }}</p>
    <p>{{ route('parameter_set', ['param' => 100]) }}</p>
    <p>{{ route('two_parameters', ['param1' => 100, 'param2' => 200 ])}}</p>
  </body>
</html>

<!DOCTYPE html>

<head>

<title>{{ $title }}</title>

</head>

<body>

<h1>{{ $title }}</h1>

<p>{{ route('named_route') }}</p>

<p>{{ route('parameter_set', ['param' => 100]) }}</p>

<p>{{ route('two_parameters', ['param1' => 100, 'param2' => 200 ])}}</p>

</body>

</html>

結果は以下のように表示される。

名前付きルート
http://localhost:3000/named_route
http://localhost:3000/named_route/100/set
http://localhost:3000/named_route/first/100/second/200

メリット

たとえばアンカータグのURLにルートパラメーターを含む場合、文字列で結合するよりも可読性が高くなる。

URLを変更した場合でも、ルーティングファイルのみ書き換えればよい。

このほか、RESTに基づくリソースルーティングの場合は、自動的に名前が付けられる。

MySQL – timestampの2038年問題

2021-08-30 / tau / コメントする

timestamp型とdatetime型

MySQLの日付・時刻表現にはtimestamp型とdatetime型がある。

MySQLのtimestamp型は内部表現に整数を用いていて、これが32bit精度の場合には、2038-01-19 03:14:07UTCまでしか表現できない。これは日本のタイムゾーンだと2038-01-19 12:14:07JSTに対応する。

一方datetime型は文字列で日時を表現していて、その範囲は1000年～9999年の間とされている。

timestamp型とdatetime型の有効範囲を比較すると以下のとおり。

timestamp	datetime
UTC内部表現で保持	タイムゾーン文字列で保持
1970-01-01 00:00:01UTC～2038-01-19 03:14:07UTC	1000-01-01 00:00:00～9999-12-31 23:59:59

timestamp型の2038年問題

確認環境

timestamp型で上限値より大きな値を登録しようとすると、エラーで登録ができない。このことを確認してみる。環境は以下のとおり。

Windows(64bit版)上のVagrant+VirtualBOXで構築したCentOS7
MySQLのバージョンは8.0.26

$ mysql --version
mysql  Ver 8.0.26 for Linux on x86_64 (MySQL Community Server - GPL)

1 2	$ mysql --version mysql Ver 8.0.26 for Linux on x86_64 (MySQL Community Server - GPL)

確認用のテーブルは以下のとおり。

mysql> DESCRIBE test;
+-------+-----------+------+-----+---------+-------+
| Field | Type      | Null | Key | Default | Extra |
+-------+-----------+------+-----+---------+-------+
| id    | int       | YES  |     | NULL    |       |
| time  | timestamp | YES  |     | NULL    |       |
+-------+-----------+------+-----+---------+-------+
2 rows in set (0.00 sec)

mysql> DESCRIBE test;

+-------+-----------+------+-----+---------+-------+

+-------+-----------+------+-----+---------+-------+

| id | int | YES | | NULL | |

+-------+-----------+------+-----+---------+-------+

2 rows in set (0.00 sec)

上限を超える値の登録は不可

まず上限値一杯の日時を登録してみる。UTCに対して日本のタイムゾーンで表現した2038年1月19日12時14分07秒を登録すると、問題なく登録される。

mysql> INSERT INTO test VALUES(1, '2038-01-19 12:14:07');
Query OK, 1 row affected (0.02 sec)

mysql> SELECT * FROM test;
+------+---------------------+
| id   | time                |
+------+---------------------+
|    1 | 2038-01-19 12:14:07 |
+------+---------------------+
1 row in set (0.00 sec)

mysql> INSERT INTO test VALUES(1, '2038-01-19 12:14:07');

Query OK, 1 row affected (0.02 sec)

mysql> SELECT * FROM test;

+------+---------------------+

| id | time |

+------+---------------------+

| 1 | 2038-01-19 12:14:07 |

+------+---------------------+

1 row in set (0.00 sec)

次に上限値に1秒を加えた日時を登録しようとすると、"Incorrect datetime value"となって登録できない。

mysql> INSERT INTO test VALUES(1, '2038-01-19 12:14:08');
ERROR 1292 (22007): Incorrect datetime value: '2038-01-19 12:14:08' for column 'time' at row 1

1 2	mysql> INSERT INTO test VALUES(1, '2038-01-19 12:14:08'); ERROR 1292 (22007): Incorrect datetime value: '2038-01-19 12:14:08' for column 'time' at row 1

timestamp型に対する加算の場合は9999年まで

次に登録された上限一杯の値に対してインターバルを加えていき、問題が生じるまでその境界を探していった。

その結果、9999年12月31日23時59分59秒999999…までは登録可能だが、10000年1月1日0時0分0秒に達することはできず、その場合にはNULLとなることがわかった。

mysql> SELECT time + INTERVAL 60*60*24*365*7967.23695944317605 SECOND FROM test;
+---------------------------------------------------------+
| time + INTERVAL 60*60*24*365*7967.23695944317605 SECOND |
+---------------------------------------------------------+
| 9999-12-31 23:59:59.999999                              |
+---------------------------------------------------------+
1 row in set (0.00 sec)

mysql> SELECT time + INTERVAL 60*60*24*365*7967.23695944317606 SECOND FROM test;
+---------------------------------------------------------+
| time + INTERVAL 60*60*24*365*7967.23695944317606 SECOND |
+---------------------------------------------------------+
| NULL                                                    |
+---------------------------------------------------------+
1 row in set, 1 warning (0.00 sec)

mysql> SELECT time + INTERVAL 60*60*24*365*7967.23695944317605 SECOND FROM test;

+---------------------------------------------------------+

| time + INTERVAL 60*60*24*365*7967.23695944317605 SECOND |

+---------------------------------------------------------+

| 9999-12-31 23:59:59.999999 |

+---------------------------------------------------------+

1 row in set (0.00 sec)

mysql> SELECT time + INTERVAL 60*60*24*365*7967.23695944317606 SECOND FROM test;

+---------------------------------------------------------+

| time + INTERVAL 60*60*24*365*7967.23695944317606 SECOND |

+---------------------------------------------------------+

| NULL |

+---------------------------------------------------------+

1 row in set, 1 warning (0.00 sec)

32bitの上限を超えた後も値は保持されているが、その次の上限はdatetime型の上限と一致している。以下の何れかと推測される。

内部的には64bit表現だが、入力時には32bitの上限で、演算時にはdatetime型の上限で抑えている
内部的に32bit表現だが、その上限を超えたときにはdatetime型に内部的に切り替えている

まとめ

MySQLのtimestamp型は、2038年の上限値を超える値を登録できない
timestamp型に対する加算を行った場合、datetime型と同じ上限まで値を保持できる
- 加算後にdatetime型の上限を超えた場合の値はNULLになる

64bit整数の場合はtimestampも西暦3000億年弱まで扱い可能だが、一部が64bitシステムでも、データベース、言語、フレームワークの全てが対応していないとまずそうなので、日付時刻を扱う際はdatetime型としておくのが安全なようだ。

Tips – カラムの幅を一杯に広げる

2021-08-29 / tau / コメントする

概要

外枠の中に複数カラムを起き、1つのカラムを最大幅まで伸長するためのCSS。

外枠

外枠を表示領域の80%の幅とし、センタリング。

幅を表示領域の80%に：width: 80%;
左右方向のセンタリング：margin: 0 auto;

width: 80%; margin: 0 auto;

外枠の中に複数カラム

親要素にdisplay: flex;を指定し、伸長する子要素のみflex: 1;を指定。

2カラム～右拡張

外枠(親要素)：display: flex;
左側カラム：幅指定なし→内容に合わせる
右側カラム：flex: 1;→残り幅一杯

margin: 10px;

margin: 10px;flex: 1;
いづれの御時にか、女御、更衣あまた候ひ給ひける中に、いとやむごとなき際にはあらぬが、すぐれて時めき給ふありけり。

3カラム～中央拡張

外枠(親要素)：display: flex;
左側カラム：width: 10%;
中央カラム：flex: 1;→残り幅一杯
右側カラム：width: 10%;

width 10%;

margin: 10px;flex: 1;
いづれの御時にか、女御、更衣あまた候ひ給ひける中に、いとやむごとなき際にはあらぬが、すぐれて時めき給ふありけり。

width 10%;