yii2框架源码分析系列(4)之Service Locator

回顾

上篇介绍了yii2的DI容器Container,主要通过类构造器注入和属性注入来达到反向依赖,从而实现解耦,今天继续介绍下用于解耦的服务定位器Service Locator

Service Locator

在yii2中Service Locator由yii\di\ServiceLocator来实现。 从代码组织上,yii2将Service Locator放到与DI同一层次来对待,都组织在 yii\di 命名空间下

类属性和方法

ServiceLocator类中包含以下一些属性和方法

// 保存对应id的组件实例
private $_components = []

// 保存对应id的组件定义和配置
private $_definitions = []

// 注册组件
public function set()

// 批量注册组件
public function setComponents()

// 获取组件实例
public function get()

源码解析

首先看下set()方法

    public function set($id, $definition)
    {
        // 重新注册,之前的实例无效
        unset($this->_components[$id]);
        
        // 当$definition为null时,表示取消注册,删除$id对应的配置
        if ($definition === null) {
            unset($this->_definitions[$id]);
            return;
        }
        
        if (is_object($definition) || is_callable($definition, true)) {
            // 对象或者方法
            $this->_definitions[$id] = $definition;
        } elseif (is_array($definition)) {
            // 数组,需要检查是否有配置类名
            if (isset($definition['class'])) {
                $this->_definitions[$id] = $definition;
            } else {
                throw new InvalidConfigException("The configuration for the \"$id\" component must contain a \"class\" element.");
            }
        } else {
            throw new InvalidConfigException("Unexpected configuration type for the \"$id\" component: " . gettype($definition));
        }
    }

可以看到set()方法不仅支持注册,也支持取消注册,注册的流程主要就是存储id以及对应的配置到_definitions数组中,setComponents()方法是通过循环调用set()方法进行批量处理,很简单,这里不再细说,接下来看下获取组件实例get()方法

    public function get($id, $throwException = true)
    {
        // 已存在实例,直接返回
        if (isset($this->_components[$id])) {
            return $this->_components[$id];
        }

        if (isset($this->_definitions[$id])) {
            // 获取对应id的组件配置
            $definition = $this->_definitions[$id];
            if (is_object($definition) && !$definition instanceof Closure) {
                // 是对象且不是Closure对象,直接返回
                return $this->_components[$id] = $definition;
            }

            // 通过Yii::createObject()来创建实例,这里就会用到Container
            return $this->_components[$id] = Yii::createObject($definition);
        } elseif ($throwException) {
            throw new InvalidConfigException("Unknown component ID: $id");
        }

        return null;
    }

get()方法的流程也很简单,无非就是对不同的配置进行对应的处理,细节如何生成实例,直接交给我们的类构造器Yii::createObject()和DI容器Container去实现就行啦
yii2中一个比较典型的使用Service Locator 的例子就是config配置中的components,先搂一眼,后面还会详细来说

$config = [
    'id' => 'basic',
    'basePath' => dirname(__DIR__),
    'bootstrap' => ['log'],
    'components' => [
        'request' => [
            // !!! insert a secret key in the following (if it is empty) - this is required by cookie validation
            'cookieValidationKey' => 'PCsOg_dM2lUY4iFEpeFrAfkKMrDQv-wR',
            'enableCsrfValidation' => false,
        ],
        'cache' => [
            'class' => 'yii\caching\FileCache',
        ],
        'user' => [
            'identityClass' => 'app\models\User',
            'enableAutoLogin' => true,
        ],
        'errorHandler' => [
            //'errorAction' => 'site/error',
            'class' => 'app\exception\ErrorHandler',
        ],
        'mailer' => [
            'class' => 'yii\swiftmailer\Mailer',
            'useFileTransport' => true,
        ],
        'log' => [
            'traceLevel' => YII_DEBUG ? 3 : 0,
            'targets' => [
                [
                    'class' => 'yii\log\FileTarget',
                    'levels' => ['error', 'warning'],
                ],
            ],
        ],
        'urlManager' => [
            'enablePrettyUrl' => true,
            'showScriptName' => false,
            'rules' => [
            ],
        ],

    ],
    'params' => $params,
];

先不管里面内容是什么,我们只需要知道,config中的components就会通过Service Locator来注册组件

总结

yii2的服务定位器大概就介绍到这里了,相比于Container要好理解的多,服务定位器在注册组件和获取组件的过程中又会使用到Container,两者相辅相成,yii2框架中很多地方都会用到这两位大佬,至于细节上面的联系,后面慢慢介绍的过程中再来解开层层面纱

补充

这里还有一点要注意下,get()方法调用Yii::createObject()方法时只传递了$definition这一个参数,没有传递$params参数

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

推荐阅读更多精彩内容