目录
1、简介
2、服务提供者
3、路由
4、资源
5、前端资源
6、发布文件组
首页 后端开发 php教程 [ Laravel 5.2 文档 ] 服务 -- 包开发

[ Laravel 5.2 文档 ] 服务 -- 包开发

Jun 20, 2016 pm 12:37 PM

1、简介

包是添加功能到Laravel 的主要方式。包可以提供任何功能,小到处理日期如  Carbon,大到整个 BDD 测试框架如  Behat。

当然,有很多不同类型的包。有些包是独立的,意味着可以在任何框架中使用,而不仅是 Laravel。比如 Carbon 和 Behat 都是独立的包。所有这些包都可以通过在 composer.json文件中请求以便被 Laravel 使用。

另一方面,其它包只能特定和 Laravel 一起使用,这些包可能有路由,控制器、视图和配置用于加强 Laravel 应用的功能,本章主要讨论只能在 Laravel 中使用的包。

2、服务提供者

服务提供者是包和 Laravel 之间的连接点。服务提供者负责绑定对象到 Laravel 的服务容器并告知 Laravel 从哪里加载包资源如视图、配置和本地化文件。

服务提供者继承自 Illuminate\Support\ServiceProvider类并包含两个方法: register和 boot。 ServiceProvider基类位于Composer包 illuminate/support。

要了解更多关于服务提供者的内容,查看其文档。

3、路由

要定义包的路由,只需要在包服务提供者中的 boot方法中引入路由文件。在路由文件中,可以使用 Route门面注册路由,和Laravel应用中注册路由一样:

/** * Perform post-registration booting of services. * * @return void */public function boot(){    if (! $this->app->routesAreCached()) {        require __DIR__.'/../../routes.php';    }}
登录后复制

4、资源

4.1 视图

要在Laravel中注册包视图,需要告诉Laravel视图在哪,可以使用服务提供者的 loadViewsFrom方法来实现。 loadViewsFrom方法接收两个参数:视图模板的路径和包名称。例如,如果你的包名称是“courier”,添加如下代码到服务提供者的 boot方法:

/** * Perform post-registration booting of services. * * @return void */public function boot(){    $this->loadViewsFrom(__DIR__.'/path/to/views', 'courier');}
登录后复制

包视图通过使用类似的 package::view语法来引用。所以,你可以通过如下方式加载 courier包上的 admin视图:

Route::get('admin', function () {    return view('courier::admin');});
登录后复制

覆盖包视图

当你使用 loadViewsFrom方法的时候,Laravel实际上为视图注册了两个存放位置:一个是 resources/views/vendor目录,另一个是你指定的目录。所以,以 courier为例:当请求一个包视图时,Laravel首先检查开发者是否在 resources/views/vendor/courier提供了自定义版本的视图,如果该视图不存在,Laravel才会搜索你调用 loadViewsFrom方法时指定的目录。这种机制使得终端用户可以轻松地自定义/覆盖包视图。

发布视图

如果你想要视图能够发布到应用的 resources/views/vendor目录,可以使用服务提供者的 publishes方法。该方法接收包视图路径及其相应的发布路径数组作为参数:

/** * Perform post-registration booting of services. * * @return void */public function boot(){    $this->loadViewsFrom(__DIR__.'/path/to/views', 'courier');    $this->publishes([        __DIR__.'/path/to/views' => base_path('resources/views/vendor/courier'),    ]);}
登录后复制

现在,当包用户执行Laravel的Artisan命令 vendor:publish时,你的视图包将会被拷贝到指定路径。

4.2 翻译

如果你的包包含翻译文件,你可以使用 loadTranslationsFrom方法告诉Laravel如何加载它们,例如,如果你的包命名为“courier”,你应该添加如下代码到服务提供者的 boot方法:

/** * Perform post-registration booting of services. * * @return void */public function boot(){    $this->loadTranslationsFrom(__DIR__.'/path/to/translations', 'courier');}
登录后复制

包翻译使用形如 package::file.line的语法进行引用。所以,你可以使用如下方式从 messages文件中加载 courier包的 welcome行:

echo trans('courier::messages.welcome');
登录后复制

发布翻译文件

如果你想要发布包翻译到应用的resources/lang/vendor目录,你可以使用服务提供者的publishes方法,该方法接收一个包路径和相应发布路径数组参数,例如,要发布courier包的翻译文件,可以这么做:

/** * Perform post-registration booting of services. * * @return void */public function boot(){    $this->loadTranslationsFrom(__DIR__.'/path/to/translations', 'courier');    $this->publishes([        __DIR__.'/path/to/translations' => resource_path('lang/vendor/courier'),    ]);}
登录后复制

这样,包用户可以执行Artisan命令vendor:publish将包翻译文件发布到应用的指定目录。

4.3 配置

通常,你想要发布包配置文件到应用根目录下的 config目录,这将允许包用户轻松覆盖默认配置选项,要发布一个配置文件,只需在服务提供者的 boot方法中使用 publishes方法即可:

/** * Perform post-registration booting of services. * * @return void */public function boot(){    $this->publishes([        __DIR__.'/path/to/config/courier.php' => config_path('courier.php'),    ]);}
登录后复制

现在,当包用户执行Laravel的Artisan命令 vendor:publish时,你的文件将会被拷贝到指定位置,当然,配置被发布后,可以通过和其它配置选项一样的方式进行访问:

$value = config('courier.option');
登录后复制

默认包配置

你还可以选择将自己的包配置文件合并到应用的拷贝版本,这允许用户只引入他们在应用配置文件中实际想要覆盖的配置选项。要合并两个配置,在服务提供者的 register方法中使用 mergeConfigFrom方法即可:

/** * Register bindings in the container. * * @return void */public function register(){    $this->mergeConfigFrom(        __DIR__.'/path/to/config/courier.php', 'courier'    );}
登录后复制

5、前端资源

你的包可能包含JavaScript、CSS和图片,要发布这些前端资源到应用根目录下的 public目录,使用服务提供者的 publishes方法。在本例中,我们添加一个前端资源组标签 public,用于发布相关的前端资源组:

/** * Perform post-registration booting of services. * * @return void */public function boot(){    $this->publishes([        __DIR__.'/path/to/assets' => public_path('vendor/courier'),    ], 'public');}
登录后复制

现在,当包用户执行 vendor:publish命令时,前端资源将会被拷贝到指定位置,由于你需要在每次包更新时重写前端资源,可以使用 --force标识:

php artisan vendor:publish --tag=public --force
登录后复制

如果你想要确保前端资源已经更新到最新版本,可添加该命令到 composer.json文件的 post-update-cmd列表。

6、发布文件组

你可能想要分开发布包前端资源组和资源,例如,你可能想要用户发布包配置的同时不发布包前端资源,可以通过在调用时给它们打上“标签”来实现分离。下面我们在包服务提供者的 boot方法中定义两个公共组:

/** * Perform post-registration booting of services. * * @return void */public function boot(){    $this->publishes([        __DIR__.'/../config/package.php' => config_path('package.php')    ], 'config');    $this->publishes([        __DIR__.'/../database/migrations/' => database_path('migrations')    ], 'migrations');}
登录后复制

现在用户可以在使用Artisan命令 vendor:publish时通过引用标签名来分开发布这两个组:

php artisan vendor:publish --provider="Vendor\Providers\PackageServiceProvider" --tag="config"
登录后复制
本站声明
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热AI工具

Undresser.AI Undress

Undresser.AI Undress

人工智能驱动的应用程序,用于创建逼真的裸体照片

AI Clothes Remover

AI Clothes Remover

用于从照片中去除衣服的在线人工智能工具。

Undress AI Tool

Undress AI Tool

免费脱衣服图片

Clothoff.io

Clothoff.io

AI脱衣机

Video Face Swap

Video Face Swap

使用我们完全免费的人工智能换脸工具轻松在任何视频中换脸!

热工具

记事本++7.3.1

记事本++7.3.1

好用且免费的代码编辑器

SublimeText3汉化版

SublimeText3汉化版

中文版,非常好用

禅工作室 13.0.1

禅工作室 13.0.1

功能强大的PHP集成开发环境

Dreamweaver CS6

Dreamweaver CS6

视觉化网页开发工具

SublimeText3 Mac版

SublimeText3 Mac版

神级代码编辑软件(SublimeText3)

在PHP API中说明JSON Web令牌(JWT)及其用例。 在PHP API中说明JSON Web令牌(JWT)及其用例。 Apr 05, 2025 am 12:04 AM

JWT是一种基于JSON的开放标准,用于在各方之间安全地传输信息,主要用于身份验证和信息交换。1.JWT由Header、Payload和Signature三部分组成。2.JWT的工作原理包括生成JWT、验证JWT和解析Payload三个步骤。3.在PHP中使用JWT进行身份验证时,可以生成和验证JWT,并在高级用法中包含用户角色和权限信息。4.常见错误包括签名验证失败、令牌过期和Payload过大,调试技巧包括使用调试工具和日志记录。5.性能优化和最佳实践包括使用合适的签名算法、合理设置有效期、

会话如何劫持工作,如何在PHP中减轻它? 会话如何劫持工作,如何在PHP中减轻它? Apr 06, 2025 am 12:02 AM

会话劫持可以通过以下步骤实现:1.获取会话ID,2.使用会话ID,3.保持会话活跃。在PHP中防范会话劫持的方法包括:1.使用session_regenerate_id()函数重新生成会话ID,2.通过数据库存储会话数据,3.确保所有会话数据通过HTTPS传输。

描述扎实的原则及其如何应用于PHP的开发。 描述扎实的原则及其如何应用于PHP的开发。 Apr 03, 2025 am 12:04 AM

SOLID原则在PHP开发中的应用包括:1.单一职责原则(SRP):每个类只负责一个功能。2.开闭原则(OCP):通过扩展而非修改实现变化。3.里氏替换原则(LSP):子类可替换基类而不影响程序正确性。4.接口隔离原则(ISP):使用细粒度接口避免依赖不使用的方法。5.依赖倒置原则(DIP):高低层次模块都依赖于抽象,通过依赖注入实现。

在PHPStorm中如何进行CLI模式的调试? 在PHPStorm中如何进行CLI模式的调试? Apr 01, 2025 pm 02:57 PM

在PHPStorm中如何进行CLI模式的调试?在使用PHPStorm进行开发时,有时我们需要在命令行界面(CLI)模式下调试PHP�...

如何在系统重启后自动设置unixsocket的权限? 如何在系统重启后自动设置unixsocket的权限? Mar 31, 2025 pm 11:54 PM

如何在系统重启后自动设置unixsocket的权限每次系统重启后,我们都需要执行以下命令来修改unixsocket的权限:sudo...

解释PHP中的晚期静态绑定(静态::)。 解释PHP中的晚期静态绑定(静态::)。 Apr 03, 2025 am 12:04 AM

静态绑定(static::)在PHP中实现晚期静态绑定(LSB),允许在静态上下文中引用调用类而非定义类。1)解析过程在运行时进行,2)在继承关系中向上查找调用类,3)可能带来性能开销。

框架安全功能:防止漏洞。 框架安全功能:防止漏洞。 Mar 28, 2025 pm 05:11 PM

文章讨论了框架中的基本安全功能,以防止漏洞,包括输入验证,身份验证和常规更新。

See all articles