详解PHP的Yii框架中扩展的安装与使用
|
扩展是专门设计的在 Yii 应用中随时可拿来使用的， 并可重发布的软件包。例如， yiisoft/yii2-debug 扩展在你的应用的每个页面底部添加一个方便用于调试的工具栏， 帮助你简单地抓取页面生成的情况。 你可以使用扩展来加速你的开发过程。 信息：本文中我们使用的术语 "扩展" 特指 Yii 软件包。而用术语 "软件包" 和 "库" 指代非 Yii 专用的通常意义上的软件包。 使用扩展要使用扩展，你要先安装它。大多数扩展以 Composer 软件包的形式发布， 这样的扩展可采取下述两个步骤来安装： 修改你的应用的 composer.json 文件，指明你要安装的是哪个扩展 （Composer 软件包）。 运行 composer install 来安装指定的扩展。 注意如果你还没有安装 Composer ，你需要先安装。 默认情况，Composer安装的是在 Packagist 中 注册的软件包 - 最大的开源 Composer 代码库。你可以在 Packageist 中查找扩展。 你也可以 创建你自己的代码库 然后配置 Composer 来使用它。 如果是在开发私有的扩展，并且想只在你的其他工程中共享时，这样做是很有用的。 通过 Composer 安装的扩展会存放在 BasePath/vendor 目录下，这里的 BasePath 指你的应用的 base path。因为 Composer 还是一个依赖管理器，当它安装一个包时， 也将安装这个包所依赖的所有软件包。 例如想安装 yiisoft/yii2-imagine 扩展，可按如下示例修改你的 composer.json 文件： "require": { // ... other dependencies } 安装完成后，你应该能在 BasePath/vendor 目录下见到 yiisoft/yii2-imagine 目录。你也应该 见到另一个 imagine/imagine目录，在其中安装了所依赖的包。 信息： yiisoft/yii2-imagine 是 Yii 由开发团队维护一个核心扩展， 所有核心扩展均由 Packagist 集中管理，命名为yiisoft/yii2-xyz，其中的 xyz， 不同扩展有不同名称。 现在你可以使用安装好的扩展了，好比是应用的一部分。如下示例展示了如何使用 yiisoft/yii2-imagine 扩展 提供的yiiimagineImage 类： // 生成一个缩略图Image::thumbnail('@webroot/img/test-image.jpg',120,120) ->save(Yii::getAlias('@runtime/thumb-test-image.jpg'),['quality' => 50]); 信息： 扩展类由 Yii class autoloader 自动加载。 手动安装扩展在极少情况下，你可能需要手动安装一部分或者全部扩展，而不是依赖 Composer。 想做到这一点，你应当： 下载扩展压缩文件，解压到 vendor 目录。 如果有，则安装扩展提供的自动加载器。 按指导说明下载和安装所有依赖的扩展。 如果扩展没有提供类的自动加载器，但也遵循了 PSR-4 standard 标准，那么你可以使用 Yii 提供的类自动加载器来加载扩展类。 你需要做的仅仅是为扩展的根目录声明一个 root alias。 例如，假设在 vendor/mycompany/myext 目录中安装了一个扩展，并且扩展类的命名空间为 myext ， 那么你可以在应用配置文件中包含如下代码： [ '@myext' => '@vendor/mycompany/myext',],]创建扩展在你需要将你的杰作分享给其他人的时候，你可能会考虑创建一个扩展。 扩展可包括任何你喜欢的代码，例如助手类、挂件、模块，等等。 建议你按照 Composer package 的条款创建扩展，以便其他人更容易安装和使用。 以下是将扩展创建为一个 Composer 软件包的需遵循的基本步骤。 为你的扩展建一个工程，并将它存放在版本控制代码库中，例如 github.com 。 扩展的开发和维护都应该在这个代码库中进行。 在工程的根目录下，建一个 Composer 所需的名为 composer.json 的文件。 在一个 Composer 代码库中注册你的扩展，比如在 Packagist 中，以便其他 用户能找到以及用 Composer 安装你的扩展。 composer.json 每个 Composer 软件包在根目录都必须有一个 composer.json 文件。该文件包含软件包的元数据。 你可以在 Composer手册 中找到完整关于该文件的规格。 以下例子展示了 yiisoft/yii2-imagine 扩展的 composer.json 文件。 包名每个 Composer 软件包都应当有一个唯一的包名以便能从其他的软件包中识别出来。 包名的格式为 vendorName/projectName 。例如在包名 yiisoft/yii2-imagine 中，vendor 名和 project 名分别是 yiisoft 和 yii2-imagine 。 不要用 yiisoft 作为你的 vendor 名，由于它被 Yii 的核心代码预留使用了。 我们推荐你用 yii2- 作为你的包名的前缀，表示它是 Yii 2 的扩展，例如，myname/yii2-mywidget。 这更便于用户辨别是否是 Yii 2 的扩展。 包类型将你的扩展指明为 yii2-extension 类型很重要，以便安装的时候 能被识别出是一个 Yii 扩展。 当用户运行 composer install 安装一个扩展时， vendor/yiisoft/extensions.php 文件会被自动更新使之包含新扩展的信息。从该文件中， Yii 应用程序就能知道安装了 哪些扩展 (这些信息可通过 yiibaseApplication::extensions 访问)。 依赖你的扩展依赖于 Yii （理所当然）。因此你应当在 composer.json 文件中列出它 (yiisoft/yii2)。如果你的扩展还依赖其他的扩展或者是第三方库，你也要一并列出来。 确定你也为每一个依赖的包列出了适当的版本约束条件 (比如 1.*,@stable) 。 当你发布一个稳定版本时，你所依赖的包也应当使用稳定版本。 大多数 JavaScript/CSS 包是用 Bower 来管理的，而非 Composer。你可使用 Composer asset 插件 使之可以 通过 Composer 来管理这类包。如果你的扩展依赖 Bower 软件包，你可以如下例所示那样简单地 在 composer.json 文件的依赖中列出它。 上述代码表明该扩展依赖于 jquery Bower 包。一般来说，你可以在 composer.json 中用 bower-asset/PackageName 指定 Bower 包，用 npm-asset/PackageName 指定 NPM 包。 当 Compower 安装 Bower 和 NPM 软件包时，包的内容默认会分别安装到@vendor/bower/PackageName 和 @vendor/npm/Packages 下。这两个目录还可以分别用 @bower/PackageName 和@npm/PackageName 别名指向。 类的自动加载为使你的类能够被 Yii 的类自动加载器或者 Composer 的类自动加载器自动加载，你应当在 composer.json 中指定 autoload 条目，如下所示： "autoload": { "psr-4": { "yiiimagine": "" } } } 你可以列出一个或者多个根命名空间和它们的文件目录。 当扩展安装到应用中后，Yii 将为每个所列出根命名空间创建一个 别名 指向命名空间对应的目录。 例如，上述的 autoload 条目声明将对应于别名 @yii/imagine。 推荐的做法扩展意味着会被其他人使用，你在开发中通常需要额外的付出。 下面我们介绍一些通用的及推荐的做法，以创建高品质的扩展。 命名空间为避免冲突以及使你的扩展中的类能被自动加载，你的类应当使用命名空间， 并使类的命名符合 PSR-4 standard 或者 PSR-0 standard 标准。 你的类的命名空间应以 vendorNameextensionName 起始，其中 extensionName 和项目名相同，除了它没有 yii2- 前缀外。例如，对 yiisoft/yii2-imagine 扩展 来说，我们用 yiiimagine 作为它的类的命名空间。 不要使用 yii、yii2 或者 yiisoft 作为你的 vendor 名。这些名称已由 Yii 内核代码预留使用了。 类的自举引导有时候，你可能想让你的扩展在应用的 自举过程 中执行一些代码。 例如，你的扩展可能想响应应用的 beginRequest 事件，做一些环境的设置工作。 虽然你可以指导扩展的使用者显式地将你的扩展中的事件句柄附加（绑定）到 beginRequest 事件， 但是更好的方法是自动完成。 为实现该目标，你可以创建一个所谓 bootstrapping class （自举类）实现 yiibaseBootstrapInterface 接口。 例如， use yiibaseBootstrapInterface;use yiibaseApplication; class MyBootstrapClass implements BootstrapInterface 然后你将这个类在 composer.json 文件中列出来，如下所示， "extra": { "bootstrap": "mynamemywidgetMyBootstrapClass" } } 当这个扩展安装到应用后，Yii 将在每一个请求的自举过程中 自动实例化自举类并调用其 yiibaseBootstrapInterface::bootstrap() 方法。 操作数据库（编辑：安卓应用网） 【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容! |