Laravel - 她和她的猫 https://her-cat.com/tags/laravel/ Laravel的文章列表 - 她和她的猫 她和她的猫 https://her-cat.com/assets/favorite.jpeg https://her-cat.com/assets/favorite.jpeg Hugo -- 0.148.1 zh Sun, 08 Jun 2025 11:58:52 +0800 Laravel 的 Facades 实现原理 https://her-cat.com/posts/2019/12/29/the-realization-principle-of-laravel-facades/ Sun, 29 Dec 2019 23:52:41 +0800 https://her-cat.com/posts/2019/12/29/the-realization-principle-of-laravel-facades/ 在使用 Laravel 框架进行开发项目的时候，`Facades` 是一个经常能用到的模块，比如在使用缓存(Cache)、日志(Log) 等组件 前言

在使用 Laravel 框架进行开发项目的时候，Facades 是一个经常能用到的模块，比如在使用缓存(Cache)、日志(Log) 等组件的地方。

use Illuminate\Support\Facades\Cache;

$name = Cache::get('name');

use use Illuminate\Support\Facades\Log;

Log::info('this is log content');

Facades 的主要优点就是不需要记住各个组件所在目录对应的的命名空间，因为 Illuminate\Support\Facades\ 这一段都是固定的，变化的只是后面的组件名称。

早在刚接触 Laravel 的时候，就对 Facades 充满了疑惑，为什么要这样用，直接用组件真正的命名空间不行吗，代码追踪过去又没有组件实现代码，只有一个静态方法 getFacadeAccessor 返回了组件的名称(cache、log)，但是在使用的时候又能调用到组件真正的方法。

class Cache extends Facade
{
    /**
     * Get the registered name of the component.
     *
     * @return string
     */
    protected static function getFacadeAccessor()
    {
        return 'cache';
    }
}

那么真相只能在父类 Facade 里面了。

但是鉴于平时工作都在搬砖，做一名快乐的 CURD Boy，秉承着实用主义及又不是不能用的理念，所以当时并没有去深究代码（实际上是因为太菜了看不懂）。

那为什么现在又开始研究怎么它实现的呢？是我变强了吗？不！是因为需要用上它了…(实用主义万岁)

当时在写一个基于 overtrue/socialite 实现的 her-cat/colourlife-oauth2 扩展包，为了兼容 Laravel 的 Facades 用法，不得不了解一下 Facades 的实现原理（其实仔细看两遍文档就能知道个大概了）。

实现原理

言归正传，就拿 Cache 来举例子，Facades\Cache 的文件内容就在上面，Cache 继承了抽象类 Facade 并实现了 getFacadeAccessor 静态方法，该方法返回了 Cache 组件（就是真正的缓存类）在 Laravel 容器中注册的名称，也就是 cache，这样我们就能从容器中取出 Cache 组件 的实例对象了，整个 Facades 实现也就是从容器中取出实例对象，让实例对象执行被调用的方法。

vendor/laravel/framework/src/Illuminate/Foundation/Application.php：

    /**
     * Register the core class aliases in the container.
     *
     * @return void
     */
    public function registerCoreContainerAliases()
    {
        foreach ([
            // ...
            'cache' => [\Illuminate\Cache\CacheManager::class, \Illuminate\Contracts\Cache\Factory::class],
            // ...
        ] as $key => $aliases) {
            foreach ($aliases as $alias) {
                $this->alias($key, $alias);
            }
        }
    }

当我们运行 Cache::get('name') 的时候，会先触发父类 Facade 的魔术方法 __callStatic，因为 Facade 并没有 get 方法。

    /**
     * Handle dynamic, static calls to the object.
     *
     * @param  string  $method
     * @param  array   $args
     * @return mixed
     *
     * @throws \RuntimeException
     */
    public static function __callStatic($method, $args)
    {
        $instance = static::getFacadeRoot();

        if (! $instance) {
            throw new RuntimeException('A facade root has not been set.');
        }

        return $instance->$method(...$args);
    }

$method 是被调用的方法的名称(这个时候的值是 get)，$args 就是参数数组（array(1) { [0]=> string(4) "name" }），通过 getFacadeRoot 方法获取到 Cache 组件 的实例对象，然后以 $args 作为参数，调用实例的 get 方法，最后返回方法执行结果。

以上就是方法就是 Facade 的实现原理了，接下来再看看 getFacadeRoot 方法。

    /**
     * Get the root object behind the facade.
     *
     * @return mixed
     */
    public static function getFacadeRoot()
    {
        return static::resolveFacadeInstance(static::getFacadeAccessor());
    }

这个方法本身没有什么代码，就是调用了 resolveFacadeInstance 方法，通过组件名称从 Laravel 容器中取出对应的实例对象，这个组件名称就是通过 Facades\Cache 类的 getFacadeAccessor 方法获取的，这里的返回值就是 cache。

接下来就到了最后一个方法：resolveFacadeInstance。

    /**
     * Resolve the facade root instance from the container.
     *
     * @param  object|string  $name
     * @return mixed
     */
    protected static function resolveFacadeInstance($name)
    {
        if (is_object($name)) {
            return $name;
        }

        if (isset(static::$resolvedInstance[$name])) {
            return static::$resolvedInstance[$name];
        }

        if (static::$app) {
            return static::$resolvedInstance[$name] = static::$app[$name];
        }
    }

此时 $name 的值是 cache。如果 $name 是一个对象的话，就直接返回 $name，$resolvedInstance 是一个用来保存已解析过的实例对象的数组，判断 $name 是否已经从 Laravel 容器中解析过，如果已经解析过就直接返回。

注意：这里是的判断是在这一次请求的生命周期内是否解析过，下次请求进来的时候还是会从 Laravel 容器中取出来。

如果 Laravel 容器如果不是空的话，就通过 $name 从 Laravel 容器中取出 Cache 组件 的实例对象，将 $name 作为 key 存入解析过的实例对象的数组中，并返回。

精简版实现及测试代码

好了，Facades 的实现代码到这里就完了，最后再附上精简版的 Facades 及测试代码。

Facade 抽象类：

namespace App\Core;

abstract class Facade
{
    /**
     * 用于存放实例对象的数组（实际上在 Laravel 中并不是数组，而是 Application 对象）
     * @var array
     */
    protected static $app = [];

    /**
     * 用于保存解析过的实例对象的数组
     *
     * @var array
     */
    protected static $resolvedInstance = [];

    /**
     * 获取 facade 绑定的实例对象
     *
     * @return mixed
     */
    public static function getFacadeRoot()
    {
        return static::resolveFacadeInstance(static::getFacadeAccessor());
    }

    /**
     * 获取组件在容器中注册的名称
     *
     * @return string
     *
     * @throws \Exception
     */
    protected static function getFacadeAccessor()
    {
        throw new \Exception('Facade does not implement getFacadeAccessor method.');
    }

    /**
     * 从容器中获取组件的实例对象
     *
     * @param  object|string  $name
     * @return mixed
     */
    protected static function resolveFacadeInstance($name)
    {
        if (is_object($name)) {
            return $name;
        }

        if (isset(static::$resolvedInstance[$name])) {
            return static::$resolvedInstance[$name];
        }

        if (static::$app) {
            return static::$resolvedInstance[$name] = static::$app[$name];
        }
    }

    /**
     * Handle dynamic, static calls to the object.
     *
     * @param  string  $method
     * @param  array   $args
     * @return mixed
     *
     * @throws \Exception
     */
    public static function __callStatic($method, $args)
    {
        $instance = static::getFacadeRoot();

        if (! $instance) {
            throw new \Exception('A facade root has not been set.');
        }

        return $instance->$method(...$args);
    }

    /**
     * 设置组件实例对象（Laravel源码并无该方法，为了演示 Facade 加上的）
     *
     * @param $name
     * @param $obj
     */
    public static function setComponentInstance($name, $obj)
    {
        self::$app[$name] = $obj;
    }
}

继承了 Facade 的类：

namespace App\Facades;

use App\Core\Facade;

/**
 * @method static mixed get($key)
 */
class Cache extends Facade
{
    public static function getFacadeAccessor()
    {
        return 'cache';
    }
}

/**
 * @method static mixed info($key)
 */
class Log extends Facade
{
    public static function getFacadeAccessor()
    {
        // 这里与上面不一样，返回的是组件的实例
        return new \App\Components\Log();
    }
}

组件的实现：

namespace App\Components;

class Cache
{
    public function get($key)
    {
        return "key:{$key}, value: her-cat";
    }
}

class Log
{
    public function info($content)
    {
        return "记录的内容:{$content}";
    }
}

测试代码：

namespace App\Test;

// 将 Cache 组件的实例对象存入 static::$app 中
\App\Core\Facade::setComponentInstance('cache', new \App\Components\Cache());

echo \App\Facades\Cache::get('name').PHP_EOL;

// Log 组件并未注册到 static::$app 中
echo \App\Facades\Log::info('哈哈哈哈').PHP_EOL;
]]> 在 Laravel 登录/注册中使用 mews/captcha 扩展包 https://her-cat.com/posts/2018/08/10/use-of-mews-captcha-in-laravel-login-register/ Fri, 10 Aug 2018 21:57:20 +0800 https://her-cat.com/posts/2018/08/10/use-of-mews-captcha-in-laravel-login-register/ 在网站中，为了防止恶意通过数据字典撞库攻击、注册机批量注册账号，会使用一些防范措施，比如图片验证码、手机验证码、手势验证码、Geetest。今天就介绍一下如何使 前言

在网站中，为了防止恶意通过数据字典撞库攻击、注册机批量注册账号，会使用一些防范措施，比如图片验证码、手机验证码、手势验证码、Geetest。今天就介绍一下如何使用 mews/captcha 扩展包防止恶意注册。

用户认证脚手架

Laravel 自带了 用户认证功能，我们将使用此功能来快速构建登录注册。

首先执行生成用户认证脚手架命令：

$ php artisan make:auth

在 .env 中配置数据库连接信息：

...

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=数据库名称
DB_USERNAME=数据库用户名
DB_PASSWORD=数据库密码

...

执行迁移，创建用户认证相关表结构：

$ php artisan migrate

运行结果：

$ php artisan migrate
Migration table created successfully.
Migrating: 2014_10_12_000000_create_users_table
Migrated:  2014_10_12_000000_create_users_table
Migrating: 2014_10_12_100000_create_password_resets_table
Migrated:  2014_10_12_100000_create_password_resets_table

这时候你打开数据库就能看到 migrations、users 两张表，migrations 是用来记录数据库迁移日志的，users 则是用户表，用于登录/注册。

手动在浏览器中打开 http://127.0.0.1:8000/register，就能看到注册界面了。

http://127.0.0.1:8000 使用的是 PHP 内置的服务器，可以使用 php artisan serve 命令来启动 PHP 服务器，你也可以使用自己的运行环境。

注册页面

安装 Captcha

在 上一篇文章 中已经介绍过如何安装 Captcha，这里就不赘述了。

使用 Captcha

修改注册视图文件

首先要在确认密码输入框下面加入一个验证码输入框及图片验证码。

打开 resources/views/auth/register.blade.php 视图文件，添加如下代码：

...

<div class="form-group{{ $errors->has('code') ? ' has-error' : '' }}">
    <label for="password-confirm" class="col-md-4 control-label">Verification Code</label>
    <div class="col-md-3">
        <input id="password-confirm" type="text" class="form-control" name="code" required>
        @if ($errors->has('code'))
            <span class="help-block">
                <strong>{{ $errors->first('code') }}</strong>
            </span>
        @endif
    </div>
    <div class="col-md-3">
        <img src="{{ captcha_src() }}" alt="点击刷新" onclick="this.src='{{ url('captcha/default') }}?s='+Math.random()">
    </div>
</div>

...

刷新注册页面：

包含验证码的注册页面

修改注册控制器

接下来就是在校验参数的方法中增加校验验证码的规则，打开 app/Http/Controllers/Auth/RegisterController.php，修改 validator 方法：

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:6|confirmed',
        'code' => 'required|captcha',
    ]);
}

验证 Captcha

故意输入错误的验证码：

错误的验证码

可以看到验证码的输入框变成了红色，但是提示的信息 validation.captcha 有点问题，并不是正确的提示语。

我们需要手动配置验证失败的提示语，打开 resources/lang/en/validation.php 文件，在 key 为 url 后下面一行添加提示语：

'url'                  => 'The :attribute format is invalid.',

'captcha'              => '验证码错误。',

再次输入错误的验证码，就可以看到配置的提示语了：

错误的验证码

最后我们按照规则输入正确的参数，就可以通过验证注册成功了：

注册成功

]]> 使用 mews/captcha 扩展包为 Laravel 应用添加图片验证码 https://her-cat.com/posts/2018/08/09/use-mews-captcha-to-add-image-verification-codes-to-laravel-applications/ Thu, 09 Aug 2018 23:55:38 +0800 https://her-cat.com/posts/2018/08/09/use-mews-captcha-to-add-image-verification-codes-to-laravel-applications/ mews/captcha 是一个图片验证码扩展包，通过它我们能够快速的为 Laravel 增加验证码的功能。 安装扩展包

mews/captcha 是一个图片验证码扩展包，通过它我们能够快速的为 Laravel 增加验证码的功能。

使用 Composer 安装扩展包：

$ composer require mews/captcha

如果是在 Windows 环境中，需要在 php.ini 文件中取消 php_gd2.dll、php_fileinfo.dll、php_mbstring.dll 的注释，这些都是 mews/captcha 依赖的组件。

打开 config/app.php 。

在 key 为 providers 的数组中注册 Captcha 服务提供者。

'providers' => [
    // ...
    Mews\Captcha\CaptchaServiceProvider::class,
]

在 key 为 aliases 的数组中注册 Captcha 别名。

'aliases' => [
    // ...
    'Captcha' => Mews\Captcha\Facades\Captcha::class,
]

生成配置文件 config/captcha.php。

$ php artisan vendor:publish --provider="Mews\Captcha\CaptchaServiceProvider"

打开 config/captcha.php 文件，其中有四种图片验证码的配置，通过修改里面的参数来调整生成的验证码的规则，你可以通过新建一个 key 创建新的配置，这里我们使用的默认的配置(default)。

return [

    // 生成的验证码字符集
    'characters' => '2346789abcdefghjmnpqrtuxyzABCDEFGHJMNPQRTUXYZ',

    'default'   => [
        'length'    => 5,   // 验证码字符长度
        'width'     => 120, // 图片长度
        'height'    => 36,  // 图片高度
        'quality'   => 90,  // 图片质量
    ],

    'flat'   => [...],

    'mini'   => [...],

    'inverse'   => [...]

];

小试牛刀

接下来我们用一个发布帖子的例子来展示如何在 Laravel 中使用 Captcha。

首先在 routes/web.php 文件中添加相关路由。

Route::get('posts/create', 'PostsController@showCreateForm')->name('posts.create');

Route::post('posts', 'PostsController@store')->name('posts.store');

创建 PostsController 控制器。

$ php artisan make:controller PostsController

在 PostsController 中添加路由中对应的方法。

/*
 * 显示发布帖子的表单
 */
public function showCreateForm() 
{
    return view('posts.create');
}

/*
 * 保存一篇新的帖子
 * @param Request $request
 */
public function store(Request $request)
{
    // 验证并存储帖子...
}

创建视图文件 resources/views/posts/create.blade.php，其中 @if ($errors->any()) 代码片段是用输出表单验证失败时的错误提示。

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>发布帖子</title>
</head>
<body>
    @if ($errors->any())
        <ul style="color:red;">
            @foreach ($errors->all() as $error)
                <li>{{ $error }}</li>
            @endforeach
        </ul>
    @endif
    <form action="{{ route('posts.store') }}" method="post">
        帖子标题：<input type="text" name="title">  <br/>
        帖子内容：<input type="text" name="content"> <br/>
        验 证 码：<input type="text" name="code"> <img src="{{ captcha_src() }}" alt="点击刷新" onclick="this.src='{{ url('captcha/default') }}?s='+Math.random()"> <br/>
        <input type="hidden" name="_token" value="{{ csrf_token() }}">
        <input type="submit" value="提交">
    </form>
</body>
</html>

在浏览器中打开 http://127.0.0.1:8000/posts/create 就可以看到这个页面了，点击验证码可以刷新验证码。

http://127.0.0.1:8000 使用的是 PHP 内置的服务器，可以使用 php artisan serve 命令来启动 PHP 服务器，你也可以使用自己的运行环境。

注册页面

接下来在 store 方法中编写验证表单的的逻辑。

/**
* 保存一篇新的帖子
* @param Request $request
*/
public function store(Request $request)
{
    // 验证表单的规则
    $rules = [
        'title' => 'required|string|max:255',
        'content' => 'required|string|max:1000',
        'code' => 'required|captcha',
    ];

    // 使用 rules 验证表单
    $request->validate($rules);

    // 验证成功则存入数据库
    
    echo '添加成功';
}

这里用到了 Laravel 中的表单验证，不清楚的可以先看一下 表单验证机制详解

'code' => 'required|captcha' 表示 code 这个参数是必需的，并使用 captcha 规则来验证该字段。然后使用 Request 对象中的 validate 方法对请求的参数进行校验。

如果验证失败则会返回到来源页面，并将验证失败的错误信息存到 Session 中，在页面上可以通过 $errors->all() 来获取错误信息。

如果我们什么都不填，直接提交表单，就会看到如下图的提示。

必填参数

如果按照 $rules 的验证规则来填写表单就可以看到 发布成功 ，表示参数都已经通过验证了。

Captcha 相关方法

// 获取验证码图片
captcha(); // Captcha::create();

// 获取验证码图片地址（http://127.0.0.1:8000/captcha/default?Lh6ngrPi）
captcha_src(); // Captcha::src();

// 获取验证码 HTML (<img src="http://127.0.0.1:8000/captcha/default?Lh6ngrPi" >)
captcha_img(); // Captcha::img();

// 使用其它配置
captcha_src('flat'); // Captcha::src('flat');
]]> Laravel 授权策略（Policy）的基本使用 https://her-cat.com/posts/2018/07/03/basic-usage-of-laravel-authorization-policy/ Tue, 03 Jul 2018 23:30:12 +0800 https://her-cat.com/posts/2018/07/03/basic-usage-of-laravel-authorization-policy/ Policy（即策略）是在特定模型或者资源中组织授权逻辑的类，用来处理用户授权动作。比如在博客程序中会有一个 Article 模型，这个模型就会有一个相应的 Policy（即策略）是在特定模型或者资源中组织授权逻辑的类，用来处理用户授权动作。

比如在博客程序中会有一个 Article 模型，这个模型就会有一个相应的 ArticlePolicy 来对用户的操作进行授权，比如在修改一篇文章时，我们会这样写：

$article = Article::find(1)
// 校验这篇是否属于当前用户
if ($article->user_id == Auth::id()) {
    // 修改文章
}
return true;

Policy 其实就是将校验的逻辑从控制器转移到相对应的模型策略 （ArticlePolicy） 中。

生成 Policy

使用 php artisan make:policy ArticlePolicy 命令生成 Policy，保存在 app/Policies 目录下。

注册 Policy

然后在 app/Providers/AuthServiceProvider.php 的 policies 数组中注册该策略，将 Article 模型与对应的 ArticlePolicy 策略进行绑定。

<?php

namespace App\Providers;

use App\Models\Article;
use App\Policies\ArticlePolicy;
use Illuminate\Support\Facades\Gate;
use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;

class AuthServiceProvider extends ServiceProvider
{
    /**
     * 应用的策略映射。
     *
     * @var array
     */
    protected $policies = [
        Article::class => ArticlePolicy::class,
    ];

    /**
     * 注册任意用户认证、用户授权服务。
     *
     * @return void
     */
    public function boot()
    {
        $this->registerPolicies();

        //
    }
}

编写 Policy 校验逻辑

接下来就在 ArticlePolicy 策略中编写校验用户是否拥有修改文章的权限的方法。

<?php

namespace App\Policies;

use App\Models\Article;
use App\User;

class ArticlePolicy
{
    public function update(User $user, Article $article)
    {
        return $user->id == $article->user_id;
    }
}

在 update 方法中判断文章作者id是否等于当前登录的用户id，返回 true 或 false。true 可以进行修改操作，false 则会抛出没有权限。

使用 Policy

然后就是在控制器中的使用了。

<?php

namespace App\Http\Controllers;

use App\Models\Article;
use Illuminate\Http\Request;

class ArticleController extends Controller
{
    public function edit(Request $request, Article $article)
    {
        // 校验用户是否有操作权限
        $this->authorize('update', $article);
        
        // 更新文章
        $article->fill($request->all());
        $article->save();
    }
}

authorize 的第一个参数表示本次验证使用 ArticlePolicy 里面的 update 方法， $article 实例用来判断使用哪一种策略，当然也可以不用指定具体实例，只需要传递一个类名。

$this->authorize('update', Article::class);
]]> Laravel 应用部署到 Nginx 服务器上的第一个坑 https://her-cat.com/posts/2017/08/24/laravel-deploy-nginx-problem/ Thu, 24 Aug 2017 20:33:51 +0800 https://her-cat.com/posts/2017/08/24/laravel-deploy-nginx-problem/ 前言在学习了一段时间 Laravel 后，写了个生成短网址小应用，把应用部署到服务器上的时候就出现了问题..... 前言

在学习了一段时间 Larvel 后，写了个生成短网址小应用，把应用部署到服务器上的时候就出现了问题…..

以此文祭奠我失去的青春…

正文

在服务器上配置完成后，打开浏览器访问域名，返回该地址无法响应请求，什么错误信息都没有。于是建了一个 PHP 文件，访问后正常运行，说明环境是没问题的。经过搜索，有人说要给 storage 权限，执行命令：

sudo chmod -R 777 storage/

还是不能运行，又看到文章说先要让 PHP 显示错误信息。首先要找到你的 php.ini 文件，可以通过 whereis php.ini 来进行搜索，我的路径是 /usr/local/php/etc/php.ini，然后将 display_errors = Off 改成 On。

cd /usr/local/php/etc
vim php.ini

保存以后重启 Nginx 服务：

service nginx restart

刷新页面就可以看到报错信息：

Warning: require(): open_basedir restriction in effect. File(/home/www/ShortUrl/bootstrap/autoload.php) is not within the allowed path(s): (/home/www/ShortUrl/public/:/tmp/:/proc/) in /home/www/ShortUrl/public/index.php on line 22

Warning: require(/home/www/ShortUrl/bootstrap/autoload.php): failed to open stream: Operation not permitted in /home/www/ShortUrl/public/index.php on line 22

Fatal error: require(): Failed opening required '/home/www/ShortUrl/public/../bootstrap/autoload.php' (include_path='.:/usr/local/php/lib/php') in /home/www/ShortUrl/public/index.php on line 22

open_basedir 可以将用户访问文件的活动范围限制在指定的区域，而上面的错误的意思就是 /home/www/ShortUrl/bootstrap/autoload.php 不在允许的路径：/home/www/ShortUrl/public/:/tmp/:/proc/里面。

因为 Laravel 入口文件在 public 目录下面，所以默认访问文件的活动范围只能在 public 目录。但是 Laravel 的代码目录都与 public 同级，也就是在 public 外面，当 index.php 请求代码目录的时候，就会抛出异常。

解决办法就是设置 open_basedir 的值，改变用户访问文件的活动范围。依旧是打开 php.ini 文件，在文件末尾加上一下内容：

[HOST=example.com]
open_basedir=/home/www/ShortUrl/:/tmp/
[PATH=/home/www/ShortUrl/public]
open_basedir=/home/www/ShortUrl/:/tmp/

HOST 就是 Laravel 应用的域名，PATH 就是应用的入口目录。刷新页面，Laravel 就可以正常运行了。

这是一篇过去很久的文章，其中的信息可能已经有所发展或是发生改变。

]]> 58021783493571598 56882619875632128