以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

相关文章

Spring Boot整合Redis注解实现增删改查功能(Redis注解使用)

《SpringBoot整合Redis注解实现增删改查功能(Redis注解使用)》文章介绍了如何使用SpringBoot整合Redis注解实现增删改查功能,包括配置、实体类、Repository、Se... 目录配置Redis连接定义实体类创建Repository接口增删改查操作示例插入数据查询数据删除数据更

使用python生成固定格式序号的方法详解

《使用python生成固定格式序号的方法详解》这篇文章主要为大家详细介绍了如何使用python生成固定格式序号,文中的示例代码讲解详细,具有一定的借鉴价值,有需要的小伙伴可以参考一下... 目录生成结果验证完整生成代码扩展说明1. 保存到文本文件2. 转换为jsON格式3. 处理特殊序号格式(如带圈数字)4

Java使用Swing生成一个最大公约数计算器

《Java使用Swing生成一个最大公约数计算器》这篇文章主要为大家详细介绍了Java使用Swing生成一个最大公约数计算器的相关知识,文中的示例代码讲解详细,感兴趣的小伙伴可以了解一下... 目录第一步:利用欧几里得算法计算最大公约数欧几里得算法的证明情形 1:b=0情形 2:b>0完成相关代码第二步:加

win10安装及配置Gradle全过程

《win10安装及配置Gradle全过程》本文详细介绍了Gradle的下载、安装、环境变量配置以及如何修改本地仓库位置,通过这些步骤,用户可以成功安装并配置Gradle,以便进行项目构建... 目录一、Gradle下载1.1、Gradle下载地址1.2、Gradle下载步骤二、Gradle安装步骤2.1、安

Java中流式并行操作parallelStream的原理和使用方法

《Java中流式并行操作parallelStream的原理和使用方法》本文详细介绍了Java中的并行流(parallelStream)的原理、正确使用方法以及在实际业务中的应用案例,并指出在使用并行流... 目录Java中流式并行操作parallelStream0. 问题的产生1. 什么是parallelS

MySQL数据库双机热备的配置方法详解

《MySQL数据库双机热备的配置方法详解》在企业级应用中,数据库的高可用性和数据的安全性是至关重要的,MySQL作为最流行的开源关系型数据库管理系统之一,提供了多种方式来实现高可用性,其中双机热备(M... 目录1. 环境准备1.1 安装mysql1.2 配置MySQL1.2.1 主服务器配置1.2.2 从

Linux join命令的使用及说明

《Linuxjoin命令的使用及说明》`join`命令用于在Linux中按字段将两个文件进行连接,类似于SQL的JOIN,它需要两个文件按用于匹配的字段排序,并且第一个文件的换行符必须是LF,`jo... 目录一. 基本语法二. 数据准备三. 指定文件的连接key四.-a输出指定文件的所有行五.-o指定输出

Linux jq命令的使用解读

《Linuxjq命令的使用解读》jq是一个强大的命令行工具,用于处理JSON数据,它可以用来查看、过滤、修改、格式化JSON数据,通过使用各种选项和过滤器,可以实现复杂的JSON处理任务... 目录一. 简介二. 选项2.1.2.2-c2.3-r2.4-R三. 字段提取3.1 普通字段3.2 数组字段四.

Linux kill正在执行的后台任务 kill进程组使用详解

《Linuxkill正在执行的后台任务kill进程组使用详解》文章介绍了两个脚本的功能和区别,以及执行这些脚本时遇到的进程管理问题,通过查看进程树、使用`kill`命令和`lsof`命令,分析了子... 目录零. 用到的命令一. 待执行的脚本二. 执行含子进程的脚本,并kill2.1 进程查看2.2 遇到的

详解SpringBoot+Ehcache使用示例

《详解SpringBoot+Ehcache使用示例》本文介绍了SpringBoot中配置Ehcache、自定义get/set方式,并实际使用缓存的过程,文中通过示例代码介绍的非常详细,对大家的学习或者... 目录摘要概念内存与磁盘持久化存储:配置灵活性:编码示例引入依赖:配置ehcache.XML文件:配置