后端Web框架【免费下载链接】yii2Yii 2: The Fast, Secure and Professional PHP Framework项目地址https://gitcode.com/gh_mirrors/yi/yii2点击查看免费下载扩展Extensions是 Yii 2 生态中面向应用场景、可直接复用与分发的一类软件包例如调试工具栏、图片处理、Redis/MongoDB 支持等都通过扩展形式提供。本文以 docs/guide/structure-extensions.md 为骨架结合 Yii 2 框架源码framework/base/Application.php、framework/base/BootstrapInterface.php等深入讲解扩展的安装、手动部署、开发打包、推荐实践与官方扩展清单帮助你既会用扩展也能写出高质量、可分发、可维护的 Yii 2 扩展。什么是 Yii 扩展扩展是专门为在 Yii 应用中提供开箱即用功能而设计、可再分发的软件包。例如yiisoft/yii2-debug扩展会在应用的每个页面底部添加一个调试工具栏帮助你直观地了解页面是如何被生成的yiisoft/yii2-imagine则封装了基于 Imagine 库的图片处理能力。使用扩展可以显著加速开发进程你也可以将自己的代码打包成扩展与他人分享。Yii 官方对术语有明确区分扩展extension专指 Yii 特有的软件包包 / 库package / library泛指不依赖 Yii、可独立使用的通用软件包。这一区分贯穿整篇文档也是理解 Composer 中type: yii2-extension含义的基础。使用扩展通过 Composer 安装绝大多数扩展都以 Composer 包的形式分发。安装只需两步修改应用的composer.json声明要安装的扩展即 Composer 包运行composer install安装这些扩展。前提是你已经安装了 Composer。默认情况下Composer 从Packagist最大的开源 Composer 包仓库拉取包你也可以创建自己的仓库并在 Composer 中配置使用这在开发仅限项目内部共享的私有扩展时非常有用。Composer 安装的扩展存放在BasePath/vendor目录下其中BasePath是应用的基础路径。由于 Composer 是依赖管理器安装一个包时它会一并安装其全部依赖包。例如安装yiisoft/yii2-imagine在composer.json中加入{ // ... require: { // ... other dependencies yiisoft/yii2-imagine: * } }安装完成后你会在BasePath/vendor下看到yiisoft/yii2-imagine目录同时还会看到imagine/imagine目录——它就是被自动安装的依赖包。说明yiisoft/yii2-imagine是 Yii 开发团队维护的核心扩展。所有核心扩展均托管在 Packagist 上命名形如yiisoft/yii2-xyz其中xyz因扩展而异。使用已安装的扩展安装后的扩展可以像应用自身代码一样直接使用。例如使用yiisoft/yii2-imagine提供的yii\imagine\Image类生成缩略图use Yii; use yii\imagine\Image; // generate a thumbnail image Image::thumbnail(webroot/img/test-image.jpg, 120, 120) -save(Yii::getAlias(runtime/thumb-test-image.jpg), [quality 50]);注意代码中的webroot、runtime都是路径别名alias扩展类由 Yii 类自动加载器负责加载。Yii 的自动加载机制以别名系统为核心BaseYii::$aliases默认注册了yii指向框架目录见 framework/BaseYii.php 第 83 行getAlias()会按“最长前缀优先”的规则把别名翻译成真实路径。扩展安装时其命名空间对应的别名会自动注册详见下文“类自动加载”与“扩展别名”。手动安装扩展少数情况下你可能希望绕过 Composer 手动安装部分或全部扩展步骤如下下载扩展的归档文件并解压到vendor目录安装扩展自带的类自动加载器如果有按说明下载并安装其所有依赖扩展。如果扩展没有自带类自动加载器但遵循 PSR-4 标准。例如扩展安装在vendor/mycompany/myext其类都位于myext命名空间下则在应用配置中加入[ aliases [ myext vendor/mycompany/myext, ], ]Yii 的自动加载器看到myext\Foo这样的类名时会把myext\前缀映射到别名myext进而定位到对应类文件对应逻辑见 framework/BaseYii.php 中getAlias()与自动加载相关的实现。创建扩展当你觉得自己的代码值得分享时就可以考虑创建扩展。扩展可以包含任意类型的代码——辅助类、小组件widget、模块module等都可以。官方推荐将扩展做成Composer 包这样用户能像上文描述的那样轻松安装使用。创建 Composer 包形式扩展的基本步骤为扩展创建一个项目并托管到 VCS 版本控制系统如 GitHub扩展的开发与维护都在该仓库完成在项目根目录创建composer.json文件细节见下节将扩展注册到 Composer 仓库如 Packagist让其他用户能通过 Composer 搜索并安装。composer.json 详解每个 Composer 包根目录下都必须有composer.json它保存包的元数据。完整的字段规范以 Composer 手册为准。以下是yiisoft/yii2-imagine扩展的完整示例{ // package name name: yiisoft/yii2-imagine, // package type type: yii2-extension, description: The Imagine integration for the Yii framework, keywords: [yii2, imagine, image, helper], license: BSD-3-Clause, support: { issues: https://github.com/yiisoft/yii2/issues?labelsext%3Aimagine, forum: https://forum.yiiframework.com/, wiki: https://www.yiiframework.com/wiki/, irc: ircs://irc.libera.chat:6697/yii, source: https://github.com/yiisoft/yii2 }, authors: [ { name: Antonio Ramirez, email: amigo.cobosgmail.com } ], // package dependencies require: { yiisoft/yii2: ~2.0.0, imagine/imagine: v0.5.0 }, // class autoloading specs autoload: { psr-4: { yii\\imagine\\: } } }下面逐一拆解各个关键字段。作为对照框架自身的 framework/composer.json 声明了type: library、autoload中yii\映射到空路径即包根目录并依赖yiisoft/yii2-composer、cebe/markdown、bower-asset/jquery等包可以作为参考范本。包名Package Name每个 Composer 包都应有一个唯一标识自身的包名格式为vendorName/projectName。例如yiisoft/yii2-imagine中vendor 名为yiisoftproject 名为yii2-imagine。不要使用yiisoft作为自己的 vendor 名它被保留给 Yii 核心代码使用。同时建议表示 Yii 2 扩展的包项目名加上yii2-前缀如myname/yii2-mywidget这样用户能一眼识别出它是 Yii 2 扩展。包类型Package Type扩展的type必须声明为yii2-extension这样安装时包才能被识别为 Yii 扩展。当用户运行composer install安装扩展时vendor/yiisoft/extensions.php文件会被自动更新写入新扩展的信息。Yii 应用正是从这个文件得知安装了哪些扩展——该信息可通过yii\base\Application::extensions属性访问。源码印证在 framework/base/Application.php 中extensions属性被注释为“已安装的 Yii 扩展列表”每个元素的结构为[ name extension name, version version number, bootstrap BootstrapClassName, // optional, may also be a configuration array alias [ alias1 to/path1, alias2 to/path2, ], ]如果应用配置中没有显式设置extensions应用初始化时会自动加载vendor/yiisoft/extensions.php见Application::bootstrap()中is_file($file) ? include $file : []的逻辑。依赖Dependencies你的扩展当然依赖 Yii所以必须把yiisoft/yii2列入require。如果还依赖其他扩展或第三方库也要一并列出并为每个依赖包写明合适的版本约束如1.*、stable。扩展发布稳定版本时应使用稳定依赖。大多数 JavaScript/CSS 包由 Bower 或 NPM 管理而非 Composer。Yii 通过 Composer asset plugin 支持用 Composer 管理这类包。如果扩展依赖某个 Bower 包直接在composer.json中声明即可{ // package dependencies require: { bower-asset/jquery: 1.11.* } }上述代码声明扩展依赖jquery这个 Bower 包。一般规则是用bower-asset/PackageName在composer.json中引用 Bower 包用npm-asset/PackageName引用 NPM 包。Composer 安装 Bower/NPM 包时默认分别安装到vendor/bower/PackageName与vendor/npm/Packages目录这两个目录也可用更短的别名bower/PackageName和npm/PackageName引用。关于资源管理的更多细节参见资源Assets一节。Yii 2 框架核心本身也依赖bower-asset/jquery、bower-asset/inputmask、bower-asset/yii2-pjax等包见 framework/composer.json这是这套机制在实际核心代码中的直接体现。类自动加载Class Autoloading为了让 Yii 类自动加载器或 Composer 类自动加载器能加载你的类需要在composer.json中声明autoload项{ // .... autoload: { psr-4: { yii\\imagine\\: } } }可以列出一个或多个根命名空间及其对应的文件路径。扩展安装到应用后Yii 会为列出的每个根命名空间创建一个扩展别名指向该命名空间对应的目录。例如上面的autoload声明会对应一个名为yii/imagine的别名。这个别名注册发生在应用启动时Application::bootstrap()遍历每个扩展的alias项并调用Yii::setAlias($name, $path)见 framework/base/Application.php 第 285-289 行。推荐实践扩展是给别人用的开发时需要额外用心。以下是编写高质量扩展的常见且推荐的做法。命名空间Namespaces为避免命名冲突并让类可自动加载扩展中的类应遵循 PSR-4 或 PSR-0 标准命名。类命名空间应以vendorName\extensionName开头其中extensionName与包名中的项目名类似但不含yii2-前缀。例如yiisoft/yii2-imagine扩展使用yii\imagine作为类命名空间。不要用yii、yii2或yiisoft作为 vendor 名这些名称保留给 Yii 核心代码。引导类Bootstrapping Classes有时你希望扩展在应用的引导bootstrapping阶段执行一些代码。例如响应应用的beginRequest事件来调整环境设置。虽然可以让用户显式地手动挂载事件处理器但更好的做法是自动完成。为此可以创建一个实现yii\base\BootstrapInterface的所谓引导类namespace myname\mywidget; use yii\base\BootstrapInterface; use yii\base\Application; class MyBootstrapClass implements BootstrapInterface { public function bootstrap($app) { $app-on(Application::EVENT_BEFORE_REQUEST, function () { // do something here }); } }然后在扩展的composer.json中列出这个类{ // ... extra: { bootstrap: myname\\mywidget\\MyBootstrapClass } }扩展安装到应用后Yii 会在每次请求的引导阶段自动实例化该引导类并调用其bootstrap()方法。源码印证framework/base/BootstrapInterface.php 中明确说明引导类有两种注册途径——扩展方式由 Composer 安装过程管理即上面extra.bootstrap声明信息最终存入Application::extensions应用代码方式则通过配置Application::bootstrap属性。而 framework/base/Application.php 的bootstrap()方法正是这一机制的落地实现它遍历$this-extensions先注册别名再通过Yii::createObject()实例化bootstrap项若实例实现了BootstrapInterface就调用其bootstrap($this)方法第 291-299 行。与数据库协作Working with Databases扩展可能需要访问数据库。不要假设使用你扩展的应用一定使用Yii::$db作为数据库连接。相反应为需要数据库访问的类声明一个db属性让用户能自定义扩展使用哪个数据库连接。可以参考yii\caching\DbCache类如何声明和使用db属性——在 framework/caching/DbCache.php 中public $db db;即默认指向应用组件 ID 为db的连接用户可通过配置覆盖如db mydb且该属性还支持传入连接对象或配置数组。如果扩展需要创建数据库表或修改数据库结构应该提供迁移migrations来操作数据库结构而不是使用纯 SQL 文件尽量让迁移兼容不同的数据库管理系统DBMS避免在迁移中使用 Active Record。使用资源Using Assets如果扩展是 widget 或 module很可能需要资源assets才能正常工作。例如 module 显示的页面可能包含图片、JavaScript 和 CSS。由于扩展文件都位于同一目录而该目录安装到应用后无法直接通过 Web 访问你有两种选择让资源文件可被 Web 直接访问让用户手动把资源文件复制到某个 Web 可访问的文件夹声明资源包asset bundle依靠资源发布机制自动把资源包中列出的文件复制到 Web 可访问的文件夹。推荐使用第二种方式这样别人用起来更方便。资源使用的更多细节参见资源Assets一节。国际化与本地化i18n l10n你的扩展可能被支持不同语言的应用使用因此如果扩展向终端用户展示内容应尽量做国际化和本地化处理。特别是面向终端用户的消息应包裹在Yii::t()中以供翻译面向开发者的消息如内部异常消息无需翻译数字、日期等展示内容应使用yii\i18n\Formatter并按合适的格式化规则处理。详细内容参见国际化Internationalization一节。测试Testing你希望扩展运行无瑕、不给别人带来麻烦。因此发布前应当测试。建议编写覆盖扩展代码的各种测试用例而不是依赖手动测试。每次发布新版本前运行这些测试确保一切正常。Yii 提供测试支持可帮助你更轻松地编写单元测试、验收测试和功能测试。更多细节参见测试Testing一节。仓库根目录的 tests/ 与 phpunit.xml.dist 提供了框架自身测试的组织方式可作为扩展测试工程的参考。版本管理Versioning每次发布都应给出版本号如1.0.1。建议遵循语义化版本semantic versioning实践来确定版本号。发布Releasing要让别人知道你的扩展需要公开发布首次发布时先在 Composer 仓库如 Packagist注册之后只需在扩展的 VCS 仓库上创建发布标签如v1.0.1并通知 Composer 仓库有新版本用户即可通过 Composer 仓库查找、安装或更新扩展。除代码文件外发布时应考虑附带以下内容帮助他人学习与使用包根目录的 readme 文件说明扩展的功能、安装和使用方法。推荐用 Markdown 编写并命名为readme.md包根目录的 changelog 文件列出每个版本的变化。可用 Markdown 编写命名为changelog.md包根目录的 upgrade 文件给出从旧版本升级的指引。可用 Markdown 编写命名为upgrade.md教程、演示、截图等当扩展功能较多、readme 无法完全覆盖时需要API 文档代码应有良好注释以便他人阅读理解。可参考框架的framework/base/BaseObject.php学习文档注释风格。说明代码注释可以用 Markdown 格式书写。yiisoft/yii2-apidoc扩展提供工具可基于代码注释生成漂亮的 API 文档。说明虽然不是硬性要求但建议扩展遵循一定的编码风格可参考框架核心代码风格见docs/internals/core-code-style.md本仓库中的对应文件位于 docs/internals/ 目录下。官方扩展一览Yii 官方提供以下核心扩展也称“官方扩展”均由 Yii 开发团队开发维护全部注册在 Packagist 上可按上文“使用扩展”一节轻松安装扩展功能yiisoft/yii2-apidoc可扩展、高性能的 API 文档生成器也用于生成框架核心 API 文档yiisoft/yii2-authclient常用认证客户端集合如 Facebook OAuth2 客户端、GitHub OAuth2 客户端yiisoft/yii2-bootstrap封装 Bootstrap 组件与插件的一组 widgetyiisoft/yii2-debug调试支持启用后每个页面底部出现调试工具栏并提供独立页面展示更详细的调试信息yiisoft/yii2-elasticsearchElasticsearch 支持含基础查询/搜索并实现 Active Record 模式可将活动记录存储到 Elasticsearchyiisoft/yii2-faker基于 Faker 生成假数据yiisoft/yii2-gii高度可扩展的 Web 代码生成器可快速生成模型、表单、模块、CRUD 等yiisoft/yii2-httpclientHTTP 客户端yiisoft/yii2-imagine基于 Imagine 的常用图片处理函数yiisoft/yii2-jui封装 JQuery UI 交互与 widget 的一组 widgetyiisoft/yii2-mongodbMongoDB 支持含基础查询、Active Record、迁移、缓存、代码生成等yiisoft/yii2-queue通过队列异步执行任务支持基于 DB、Redis、RabbitMQ、AMQP、Beanstalk 与 Gearman 的队列yiisoft/yii2-redisRedis 支持含基础查询、Active Record、缓存等yiisoft/yii2-shell基于 psysh 的交互式 shellyiisoft/yii2-smarty基于 Smarty 的模板引擎yiisoft/yii2-sphinxSphinx 支持含基础查询、Active Record、代码生成等yiisoft/yii2-symfonymailer基于 Symfony Mailer 的邮件发送功能yiisoft/yii2-twig基于 Twig 的模板引擎此外以下官方扩展面向 Yii 2.1 及以上版本对于 Yii 2.0它们已包含在核心框架中无需另行安装yiisoft/yii2-captcha提供验证码CAPTCHA。在 Yii 2.0 中对应框架内的framework/captcha/组件yiisoft/yii2-jquery提供 jQuery 支持yiisoft/yii2-maskedinput基于 jQuery Input Mask 插件的掩码输入 widgetyiisoft/yii2-mssqlMSSQL 支持yiisoft/yii2-oracleOracle 支持yiisoft/yii2-restREST API 支持对应 Yii 2.0 中的 framework/rest/ 与yii\rest命名空间。总结围绕扩展这一主题Yii 2 建立了一套“Composer 包 yii2-extension类型 vendor/yiisoft/extensions.php注册 别名/自动加载 可选引导类”的完整机制用户侧只需两步即可安装使用开发者侧则通过规范化的composer.json包名、类型、依赖、autoload、extra.bootstrap让扩展被 Yii 识别并自动完成别名注册与引导执行——这些行为都能在 framework/base/Application.php 的bootstrap()方法中找到一一对应的实现。结合命名空间规范、资源发布、i18n、测试与语义化版本等推荐实践你完全可以构建出质量可靠、易于分发的 Yii 2 扩展并借助 Packagist 与更多开发者共享。赞分享后端Web框架【免费下载链接】yii2Yii 2: The Fast, Secure and Professional PHP Framework项目地址https://gitcode.com/gh_mirrors/yi/yii2点击查看免费下载相关推荐Yii 2 扩展Extensions完全指南安装、封装 Composer 扩展包与发布实践Yii 2 扩展Extensions完全指南安装、封装 Composer 扩展包与发布实践 本篇技术指南围绕 Yii 2 框架的扩展Extensions后端Web框架Yii 2 扩展机制完全指南从 Composer 安装到自定义扩展开发Yii 2 扩展机制完全指南从 Composer 安装到自定义扩展开发 本篇技术指南系统讲解 Yii 2 框架的扩展Extension机制它既是一份面向后端Web框架windows-rs Windows Hello 人脸识别三次调用把生物识别接入你的应用windows rs Windows Hello 人脸识别三次调用把生物识别接入你的应用 用户在密码上受的罪够多了记不住、嫌弱、隔三差五强制重置。如果你的应后端Web框架上一篇Rekapi 关键帧操作实战复制、移动、修改与删除的 5 个高效技巧下一篇V1邮件系统深度探索React Email与Resend集成指南创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考