Laravel工程化项目核心概念：ServiceProvider

ServiceProvider是Laravel框架的核心机制之一，也是它的组件规范，框架的启动初始化重要的一步是ServiceProvider的初始化，ServiceProvider主要用于组件的启动类的类的注入及实例化。文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/30579.html

查看vendor/laravel/framework/src/Illuminate下的源代码会发现，基本上每个组件都有一个xxServiceProvider的类。文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/30579.html

例如： verndor/laravel/framework/src/Illuminate/Log/LogServiceProvider.php文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/30579.html

class LogServiceProvider extends ServiceProvider
{
/**
* Register the service provider.
*
* @return void
*/
public function register()
{
$this->app->singleton('log', function ($app) {
return new LogManager($app);
});
}
}
这里register方法完成log跟LogManager的绑定工作，也就是我们对log的操作实际是对LogManager的操作，当我们在程序中可以这样使用：文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/30579.html

// 这只是个例子，不推荐这样使用
app('log')->info('this is test msg', []);
以上就完成了日志的记录。文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/30579.html

原理
Laravel在框架的Bootstrap阶段通过 src/Illuminate/Foundation/Bootstrap/RegisterProvider.php、BootProviders.php。 两个类完成ServiceProvider的注册、启动工作：文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/30579.html

public function registerConfiguredProviders()
{
$providers = Collection::make($this->make('config')->get('app.providers'))
->partition(function ($provider) {
return strpos($provider, 'Illuminate\\') === 0;
});文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/30579.html

$providers->splice(1, 0, [$this->make(PackageManifest::class)->providers()]);文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/30579.html

(new ProviderRepository($this, new Filesystem, $this->getCachedServicesPath()))
->load($providers->collapse()->toArray());
}文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/30579.html

public function boot()
{
if ($this->isBooted()) {
return;
}文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/30579.html

// Once the application has booted we will also fire some "booted" callbacks
// for any listeners that need to do work after this initial booting gets
// finished. This is useful when ordering the boot-up processes we run.
$this->fireAppCallbacks($this->bootingCallbacks);文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/30579.html

array_walk($this->serviceProviders, function ($p) {
$this->bootProvider($p);
});文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/30579.html

$this->booted = true;文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/30579.html

$this->fireAppCallbacks($this->bootedCallbacks);
}
框架会扫描config/app.php中注册的ServiceProvider并依次执行它们的register()、boot() 方法，对于上面的LogServiceProvider来说，就执行了 LogManager与log的绑定工作了。类比的可以看下QueueServiceProvider.php RedisServiceProvider.php 完成了哪些工作。文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/30579.html

自定义ServiceProvider
Laravel的ServiceProvider在app/config/app.php中引入，如果不需要的可以去掉。文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/30579.html

举栗子：现在我们需要一个检测项目.env文件是否存在的功能，可以通过自定义一个EnvCheckServiceProvider来做，因为这个工作需要在框架请求处理之前完成。文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/30579.html

新增ServiceProvider
php artisan make:provider EnvCheckServiceProvider
class EnvCheckServiceProvider extends ServiceProvider
{
/**
* Register services.
*
* @return void
*/
public function register()
{
if (!file_exists(base_path('.env'))) {
throw new \Exception(".env file not found. Please add this file. ");
}
}文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/30579.html

/**
* Bootstrap services.
*
* @return void
*/
public function boot()
{
//
}
}
在config/app.php 中加入 EnvCheckServiceProvider.php文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/30579.html

'providers' => [
//xxxxx其它provider
\App\Providers\EnvCheckServiceProvider::class,文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/30579.html

]文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/30579.html

我们测试把目录下的.env删除掉，再访问之前的接口就会发现报错了文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/30579.html

ServiceProvider的使用场景
当你的功能需要在请求处理前就要完成的时候，比如某个类的实例化、某个请求环境的检测、某个文件的创建等等，可以使用ServiceProvider来完成。文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/30579.html