Laravel 5.3 下添加自定义 Facade 的步骤

背景:Laravel 5.3 的官方文档中对于 Facade 的介绍不算详细,尤其对于如何创建自己的 Facade 就更是只字未提,导致许多和我一样对于 Laravel 不是特别熟悉的朋友在这个问题上浪费了很多时间。在此,将自己连续2天折腾后所得的经验分享出来,希望能帮到别人。

首先提醒大家两点:

  • 一定要注意理清 namespace 部分的命名,注意字母大小写之类;如果你使用的 IDE 有自动完成功能时就更要小心,因为有时自动完成的结果可能是错的。这倒不是 IDE 的错,而是很多时候存在多个命名相近的 namespace,不小心就选错了。
  • 确保你的 namespace 是可以被 composer 正常解析和引用的。如果修改了 composer.json 后记得运行 composer dump-autoload 命令。

我在这两点上吃了不少亏,浪费了一些时间。

接下来我一步一步写一个自定义 Facade 的例子。

1、目录结构

我在 /app 下建立了一个自定义目录,结构如下:

/app
|- Custom
    |- Classes 这里放置自定义 Facade 所需的类
    |- Facades 这里放置自定义 Facade

2、创建自定义 Facade 所需的类

文件位置:app/Custom/Classes/MLS.php

<?php
namespace App\Custom\Classes;

class MLS
{
    public function test()
    {
        return 'MLS Test';
    }
}

上面这个 class 我只想实现一个功能,就是在调用 test() 方法时返回一个字符串。

3、创建自定义 Facade

文件位置:app/Custom/Facades/MLS.php

<?php
namespace App\Custom\Facades;

use Illuminate\Support\Facades\Facade; 

class MLS extends Facade
{
    protected static function getFacadeAccessor() {
        return 'mls';
    }
}

这个 class 没有什么可说的,就算不理解也请先当作一个规矩来照做。唯一会让初学者迷惑的是这个 return 'mls'; 有人可能会问“mls”是什么,为什么只是一个字符串。这个问题如果想透彻的解释,那就必须从理解 Laravel 中的“容器”说开来,但可惜我对这个概念也是一知半解,不能误人子弟。如果大家对此感兴趣,可以去找一些讲解“容器”和 Facade 原理的文章,这里先不提,继续往下看。

4、将自定义的 Facade 和自定义的 Class 绑定起来。

该步骤又分为2部分:

部分1:创建与自定义 Facade 对应的 ServerProvider。

在命令行下运行:

$ php artisan make:provider MLSServiceProvider

成功后会创建一个新文件:app/Providers/MLSServiceProvider.php,然后我们在 register() 部分添点东西,如下:

<?php
namespace App\Providers;

use App\Custom\Classes\MLS; //注意这里,引入了我们的自定义 Class
use Illuminate\Support\ServiceProvider;

class MLSServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap the application services.
     *
     * @return void
     */
    public function boot()
    {
        //
    }

    /**
     * Register the application services.
     *
     * @return void
     */
    public function register()
    {
        //注意这里的 bind 写法,这是 Laravel 5.3 的正确写法;网上搜索到的很多资料都是不知何年何月的老版本的写法,如果你照抄就只会很郁闷。
        $this->app->bind('mls', function() {
            return new MLS();
        });
    }
}

看到 bind() 部分了吗?对应写的也是“mls”,和自定义 Facade 中返回的一样。其实前后联系起来看就是,这个“mls”只是 Laravel 容器中的一个“代号”,前面的 Facade 返回“mls”是告诉”中介“,也就是 我们自定义的 ServiceProvider:“如果有人虚要调用我时,请使用我的代号是 mls”,然后 ServiceProvider 在 register() 这里则告诉框架:“我介绍一个叫 MLS 的类入伙了,它的代号是 mls!“。这样,框架在你调用 Facade 时就会在自己的”容器“里找到代号为”mls“的自定义类给你,你才能使用这个自定义类里的方法。

部分2:将新添加的 ServiceProvider 写进框架的配置中

编辑文件 config/app.php,里面有2个数组:providers 和 aliases。首先,在 providers 中添加:

'providers' => [

        略
        App\Providers\RouteServiceProvider::class,

        App\Providers\MLSServiceProvider::class, //我们新建的 Provider

    ],

然后,在 aliases 中添加:

'aliases' => [

        'App' => Illuminate\Support\Facades\App::class,
        略

        'MLS' => App\Custom\Facades\MLS::class, //这里写上我们的自定义 Facade
    ],

注意,aliases,也就是”别名“部分的”MLS“可以是任意我们喜欢的名字,它只是用来指代我们自定义的 Facade。

5、结束了,可以使用我们的自定义 Facade 了。

好,现在假设我们已经设置好了路由规则,并准备好了一个 controller ,比如:app/Http/Controllers/MLSController.php

<?php
namespace App\Http\Controllers;

use MLS; //这里就是在 aliases 添加的别名了,如果别名换了,也请记得更新这里。
use Illuminate\Http\Request;

class MLSController extends Controller
{
    public function foo()
    {
        echo MLS::test(); //现在,我们就可以像使用静态类一样使用我们的自定义 Facade 了。
    }
}

到此,一个简单的自定义 Facade 就添加完成了。

其实,关于 Facade 的争论很大,反对它的人认为它不过是一个针对 Class 的语法糖和快捷方式,甚至认为它最大的意义不过是让程序员不用敲一堆代码才能引用一个 Class,也就是如下的区别:

echo App\Custom\Classes\MLS::test(); //方式1

echo MLS::test(); //方式2

但我个人觉得,哪怕是这种”快捷方式“的设计,在很多时候也会让我们的程序更具灵活性,比如”别名“的设定就可以让我们随时用一个具有相同方法但底层逻辑完成不同的 Class 去替换现有的,而保持代码的修改量最小。这其实也是和 Laravel 框架贯穿始终的”容器“思想相通的,尽管我对容器的概念还没有完全掌握,但这种形式的灵活是我所青睐的。而且,既然选择了用框架,就等同于选择了一种编程思想,就应该去尽可能适应和被这种思想同化,至少在你没有能力另辟蹊径之前。

谢谢大家阅读。

本帖已被设为精华帖!
本帖由系统于 2年前 自动加精
《L03 构架 API 服务器》
你将学到如 RESTFul 设计风格、PostMan 的使用、OAuth 流程,JWT 概念及使用 和 API 开发相关的进阶知识。
《L05 电商实战》
从零开发一个电商项目,功能包括电商后台、商品 & SKU 管理、购物车、订单管理、支付宝支付、微信支付、订单退款流程、优惠券等
讨论数量: 13

@StevenV 不客气,分享自己的些许经验而已。

2年前 评论
anyuzhe

挺好的介绍

2年前 评论

很详细的分享 浅显易懂~~

2年前 评论

我也是研究好久才自定义得自己的facade,我还给自定义的类约定了contract ,不过当时不明智,把contract和类的实现都放到了,laravel的底层中,composer 更新时直接给我覆盖了!???

2年前 评论

@Wsmallnews 只能说 laravel 的文档过于简略,蜻蜓点水。对于没有或没能力仔细研读 API 和源码的人来说有时很吃力。

2年前 评论
keer

学习了,今天也看到这部分内容

2年前 评论

感谢分享!laravel 用的越多 才会发现这个框架的入手难度是真的有点高

2年前 评论

写的不错,很容易上手.

1年前 评论

我说怎么不能这样\Xxxx使用,原来是没加到app.php里的alias里,,,

1年前 评论
sushengbuhuo

跟这篇文章类似 博客:七夕 -- medoo

有个问题 test为 public 也可以静态调用?

1年前 评论

请勿发布不友善或者负能量的内容。与人为善,比聪明更重要!