[PHP][Yii2.0] 以Yii 2.0风格加载自定义类或命名空间 [配置使用Yii2 autoloader]

Yii 2.0最显著的特征之一就是引入了命名空间,因此对于自定义类的引入方式也同之前有所不同。这篇文章讨论一下如何利用Yii 2.0的自动加载机制,向系统中引入自定义类和命名空间。本文旨在抛砖引玉,如果有理解不当敬请指正,欢迎大家把自己的方法拿出来分享。
我们希望被引入的类应该达成一下两点:

  1. 在应用中的任这里输入代码意位置可以使用该类名或命名空间,而不用显式调用require()/include()。
  2. 利用Yii的autoloader,仅在类被调用时加载,以遵循Yii按需加载的原则,节省资源。

我们使用Yii 2.0基础模板作为演示环境,项目根目录命名为basic(后文中会写成/),这是根目录结构:

basic
├── assets
├── commands
├── config
├── controllers
├── mail
├── models
├── runtime
├── tests
├── vendor
├── views
└── web

加载自定义类

I. 定义类文件

建立目录 /libs 并建立文件Freedom.php。

<?php

class Freedom
{
    public static function yell()
    {
        echo "I am FREE!";
    }
}

II. 向Yii::$classMap添加映射

打开配置文件/config/web.php,在文件头部向[[Yii::$classMap]]属性添加类映射。

<?php
...

Yii::$classMap['Freedom'] = '@app/libs/Freedom.php';
...
$config = [
...
];
return $config;

注意: 不要对[[Yii::$classMap]]使用=直接赋值,因为该属性中定义了Yii的一些核心类映射,直接赋值会导致这些映射丢失而Yii autoloader加载不到核心类。No zuo no die don't try.

III. 使用自定义类

见证奇迹的时刻。在系统中尝试调用这个类,我们使用SiteController::actionIndex()为例。

<?php
...
use Freedom; // 别忘了导入这个类,或者在后面调用的时候使用"\Freedom"。

class SiteController extends Controller
    ...
    public function actionIndex()
    {
        Freedom::yell();
    }

}

好了,刷新一下试试。

IV. 如果你还关心为什么

那现在我们来需要介绍一下[[Yii::$classMap]]究竟是个毛。这货实际上是一个关联数组,数组键为“去掉前导反斜线的完全权限定类名”,对应值为定义了该类的文件路径,其中文件路径支持路径别名。在代码中调用到尚未加载的类时,Yii的audoloader会扫描这个属性以获得需要加载的类文件名。

所以,我们把刚刚定义的类加入到这个映射数组中,它就可以被Yii延迟加载了。事实上我们可以在任何位置添加这个映射,只要在目标类被调用之前就可以。应用的主配置文件是一个比较理想的位置,因为配置文件加载在Yii.php之后,可以在其中访问到Yii类(有兴趣的同学可以去看一下入口脚本),而且配置数据可以集中在一个文件里。

另外,由于我们定义的类在根命名空间下,所以“去掉前导反斜线的完全权限定类名”就只剩下Freedom了。如果你的类使用了命名空间,只需要在数组键里写上完全限定名称就行了(e.g. ['custom\classes\Freedom'])。


加载整个命名空间

有时候我们需要写一组相互关联的类,如果这些类存在依赖关系的话像上面这样给每个类配置映射会……非(jue)常(b)不(gao)体(si)面(ren)。如果你定义命名空间下的类时遵循 PSR-4 标准,我们可以一次引入整个命名空间。
这次我们要使用的属性是[[\yii\base\Application::$aliases]]。它也是一个关联数组,将一个路径别名映射到一个目录或者另一个已经存在的路径别名。其中数组键是要指定的别名,对应值是目标路径。
我们只需要在建立一个命名空间别名,把它映射到保存这个命名空间下所有类的根目录,就可以了。当然这个根目录以下的文件结构和类定义要遵循PSR-4,不然autoloader是找不到对应文件的。
试一下:

I. 定义命名空间和类文件

我们决定在/libs/vendors目录下定义一组以命名空间组织的类,其根目录命名为free-classes,这组类的全部在命名空间free_classes下。注意这里我故意使根目录名与根命名空间名不一致以表示映射根目录不一定要和命名空间同名。
创建文件/libs/vendors/free-classes/persons/Slave.php,没有目录请自行创建。

<?php
namespace free_classes\persons;

class Slave
{
    public static function isFree()
    {
        var_dump("I'm FREE now, thank you!");
    }
}

创建文件/libs/vendors/free-classes/vehicles/cars/Porsche.php

<?php
namespace free_classes\vehicles\cars;

class Porsche
{
    public static function isFree()
    {
        var_dump('Are you kidding?!');
    }
}

注意: free-classes以下的目录名和结构都要遵循PSR-4标准。

II. 配置[[\yii\web\Application::$aliases]]

这里要说一下,如果我们的命名空间为namespace\subnamespace,那么我们应该设置的路径别名就是@namespace/subnamespace(详解参照 PSR-4 )。
打开配置文件/config/web.php,配置Application的aliaes属性:

<?php

Yii::$classMap['Freedom'] = '@app/libs/Freedom.php';
...
$config = [
    'id' => 'basic',
    ...
    'aliases' => [
        '@free_classes' => '@app/libs/vendors/free-classes'
    ],
    ...
];
return $config;

III. 使用命名空间下的类

又要见证奇迹了,还是选在SiteController::actionIndex()里。

<?php
...
use free_classes\persons\Slave; // 还是别忘了导入
use free_classes\vehicles\cars\Porsche;

class SiteController extends Controller
    ...
    public function actionIndex()
    {
        // Freedom::yell();
        Slave::isFree();
        Porsche::isFree();
    }

}

刷新一下;-)

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,835评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,598评论 1 295
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,569评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,159评论 0 213
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,533评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,710评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,923评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,674评论 0 203
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,421评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,622评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,115评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,428评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,114评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,097评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,875评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,753评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,649评论 2 271

推荐阅读更多精彩内容