以Yii 2.0风格加载自定义类或命名空间 [配置使用Yii autoloader] [ 2.0 版本 ]

本文主要是介绍以Yii 2.0风格加载自定义类或命名空间 [配置使用Yii autoloader] [ 2.0 版本 ],希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

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

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

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

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

加载自定义类

I. 定义类文件

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

<?phpclass 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属性:

<?phpYii::$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();}}

刷新一下;-)

这篇关于以Yii 2.0风格加载自定义类或命名空间 [配置使用Yii autoloader] [ 2.0 版本 ]的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1025525

相关文章

C#中checked关键字的使用小结

《C#中checked关键字的使用小结》本文主要介绍了C#中checked关键字的使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学... 目录✅ 为什么需要checked? 问题:整数溢出是“静默China编程”的(默认)checked的三种用

SpringBoot全局异常拦截与自定义错误页面实现过程解读

《SpringBoot全局异常拦截与自定义错误页面实现过程解读》本文介绍了SpringBoot中全局异常拦截与自定义错误页面的实现方法,包括异常的分类、SpringBoot默认异常处理机制、全局异常拦... 目录一、引言二、Spring Boot异常处理基础2.1 异常的分类2.2 Spring Boot默

C#中预处理器指令的使用小结

《C#中预处理器指令的使用小结》本文主要介绍了C#中预处理器指令的使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧... 目录 第 1 名:#if/#else/#elif/#endif✅用途:条件编译(绝对最常用!) 典型场景: 示例

jdk1.8的Jenkins安装配置实践

《jdk1.8的Jenkins安装配置实践》Jenkins是一款流行的开源持续集成工具,支持自动构建、测试和部署,通过Jenkins,开发团队可以实现代码提交后自动进行构建、测试,并将构建结果分发到测... 目录Jenkins介绍Jenkins环境搭建Jenkins安装配置Jenkins插件安装Git安装配

自定义注解SpringBoot防重复提交AOP方法详解

《自定义注解SpringBoot防重复提交AOP方法详解》该文章描述了一个防止重复提交的流程,通过HttpServletRequest对象获取请求信息,生成唯一标识,使用Redis分布式锁判断请求是否... 目录防重复提交流程引入依赖properties配置自定义注解切面Redis工具类controller

python版本切换工具pyenv的安装及用法

《python版本切换工具pyenv的安装及用法》Pyenv是管理Python版本的最佳工具之一,特别适合开发者和需要切换多个Python版本的用户,:本文主要介绍python版本切换工具pyen... 目录Pyenv 是什么?安装 Pyenv(MACOS)使用 Homebrew:配置 shell(zsh

Nginx之https证书配置实现

《Nginx之https证书配置实现》本文主要介绍了Nginx之https证书配置的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起... 目录背景介绍为什么不能部署在 IIS 或 NAT 设备上?具体实现证书获取nginx配置扩展结果验证

Mysql中RelayLog中继日志的使用

《Mysql中RelayLog中继日志的使用》MySQLRelayLog中继日志是主从复制架构中的核心组件,负责将从主库获取的Binlog事件暂存并应用到从库,本文就来详细的介绍一下RelayLog中... 目录一、什么是 Relay Log(中继日志)二、Relay Log 的工作流程三、Relay Lo

使用Redis实现会话管理的示例代码

《使用Redis实现会话管理的示例代码》文章介绍了如何使用Redis实现会话管理,包括会话的创建、读取、更新和删除操作,通过设置会话超时时间并重置,可以确保会话在用户持续活动期间不会过期,此外,展示了... 目录1. 会话管理的基本概念2. 使用Redis实现会话管理2.1 引入依赖2.2 会话管理基本操作

Springboot请求和响应相关注解及使用场景分析

《Springboot请求和响应相关注解及使用场景分析》本文介绍了SpringBoot中用于处理HTTP请求和构建HTTP响应的常用注解,包括@RequestMapping、@RequestParam... 目录1. 请求处理注解@RequestMapping@GetMapping, @PostMappin