Laravel 서비스 컨테이너(IocContainer) 해석

이 글에서는 주로 참조 가치가 있는 Laravel 서비스 컨테이너(IocContainer)에 대해 소개합니다. 이제는 모든 사람과 공유합니다. 도움이 필요한 친구들이 참고할 수 있습니다.

Laravel의 핵심은 "서비스"라고 불리는 IocContainer입니다. "컨테이너" 문서에서 서비스 컨테이너는 클래스 종속성을 관리하고 종속성 주입을 수행하기 위한 강력한 도구입니다. Route, Eloquent ORM, Request, Response 등과 같은 Laravel의 기능적 모듈은 실제로는 아무것도 없는 클래스 모듈에서 제공됩니다. 예, 이 클래스는 실제로 등록부터 인스턴스화까지 laravel 서비스 컨테이너를 담당하고 최종적으로 사용됩니다.

서비스 컨테이너가 무엇인지 명확하게 알지 못한다면 서비스 컨테이너의 내용을 이해할 수 있는 블로그 게시물을 추천합니다: Laravel의 마법 같은 서비스 컨테이너

서비스 컨테이너에는 두 가지 개념이 있습니다. : 제어 역전(IOC) 및 종속성 주입(DI) :

종속성 주입과 제어 역전은 동일한 것에 대한 다른 설명이며 서로 다른 관점에서 설명합니다. 종속성 주입은 애플리케이션의 관점에서 설명됩니다. 애플리케이션은 컨테이너에 의존하여 필요한 외부 리소스를 생성하고 주입합니다. 제어 역전은 컨테이너의 관점에서 설명됩니다. 컨테이너는 애플리케이션을 제어하고, 컨테이너는 역으로 애플리케이션에 필요한 외부 리소스를 애플리케이션에 주입합니다.

Laravel에서 프레임워크는 다양한 내장 서비스를 서비스 컨테이너에 바인딩합니다. 또한 사용자 정의 서비스를 컨테이너에 바인딩할 수도 있습니다. 애플리케이션이 특정 서비스를 사용해야 하는 경우 서비스 컨테이너는 서비스를 확인하고 서비스 간의 종속성을 자동으로 해결한 다음 사용할 수 있도록 애플리케이션에 넘겨줍니다.

이 기사에서는 Laravel

서비스 바인딩

서비스 바인딩 및 구문 분석이 Laravel에서 구현되는 방법에 대해 설명합니다. 서비스를 컨테이너에 바인딩하는 데 일반적으로 사용되는 방법에는 인스턴스, 바인드, 싱글톤 및 별칭이 있습니다. 별도로 살펴보겠습니다.

instance

기존 개체를 서비스 컨테이너에 바인딩합니다. 이후에 서비스가 이름으로 확인되면 컨테이너는 항상 바인딩된 인스턴스를 반환합니다.

$api = new HelpSpot\API(new HttpClient);
$this->app->instance('HelpSpot\Api', $api);

는 서비스 컨테이너의 $instnces 속성에 객체를 등록합니다

［
     'HelpSpot\Api' => $api//$api是API类的对象，这里简写了
 ］

bind

서비스를 서비스 컨테이너에 바인딩합니다

바인딩 방법에는 세 가지가 있습니다.

1.绑定自身
$this->app->bind('HelpSpot\API', null);

2.绑定闭包
$this->app->bind('HelpSpot\API', function () {
    return new HelpSpot\API();
});//闭包直接提供类实现方式
$this->app->bind('HelpSpot\API', function ($app) {
    return new HelpSpot\API($app->make('HttpClient'));
});//闭包返回需要依赖注入的类
3. 绑定接口和实现
$this->app->bind('Illuminate\Tests\Container\IContainerContractStub', 'Illuminate\Tests\Container\ContainerImplementationStub');

첫 번째 경우에는 실제로 바인드 메소드 서비스를 바인딩하기 전에 getClosure()를 통해 서비스에 대한 클로저를 생성합니다. 바인드 메소드의 소스 코드를 살펴보겠습니다.

public function bind($abstract, $concrete = null, $shared = false)
{
    $abstract = $this->normalize($abstract);
    
    $concrete = $this->normalize($concrete);
    //如果$abstract为数组类似['Illuminate/ServiceName' => 'service_alias']
    //抽取别名"service_alias"并且注册到$aliases[]中
    //注意：数组绑定别名的方式在5.4中被移除，别名绑定请使用下面的alias方法
    if (is_array($abstract)) {
        list($abstract, $alias) = $this->extractAlias($abstract);

        $this->alias($abstract, $alias);
    }

    $this->dropStaleInstances($abstract);

    if (is_null($concrete)) {
        $concrete = $abstract;
    }
    //如果只提供$abstract，则在这里为其生成concrete闭包
    if (! $concrete instanceof Closure) {
        $concrete = $this->getClosure($abstract, $concrete);
    }

    $this->bindings[$abstract] = compact('concrete', 'shared');

    if ($this->resolved($abstract)) {
        $this->rebound($abstract);
    }
}


protected function getClosure($abstract, $concrete)
{
    // $c 就是$container，即服务容器，会在回调时传递给这个变量
    return function ($c, $parameters = []) use ($abstract, $concrete) {
        $method = ($abstract == $concrete) ? 'build' : 'make';

        return $c->$method($concrete, $parameters);
    };
}

bind는 다음과 같이 서비스 컨테이너의 $bounds 속성에 서비스를 등록합니다.

$bindings = [
    'HelpSpot\API' =>  [//闭包绑定
        'concrete' => function ($app, $paramters = []) {
            return $app->build('HelpSpot\API');
        },
        'shared' => false//如果是singleton绑定，这个值为true
    ]        
    'Illuminate\Tests\Container\IContainerContractStub' => [//接口实现绑定
        'concrete' => 'Illuminate\Tests\Container\ContainerImplementationStub',
        'shared' => false
    ]
]

singleton

public function singleton($abstract, $concrete = null)
{
    $this->bind($abstract, $concrete, true);
}

singleton 이 메서드는 바인딩 메서드의 변형으로 한 번만 구문 분석하면 되는 클래스 또는 인터페이스를 바인딩합니다. 컨테이너 호출의 경우 서비스는 동일한 인스턴스를 반환합니다

alias

서비스 및 서비스 별칭을 컨테이너에 등록합니다.

public function alias($abstract, $alias)
{
    $this->aliases[$alias] = $this->normalize($abstract);
}

alias 메서드는 위에서 언급한 바인드 메서드에 사용되며 등록됩니다. 서비스 별칭 및 서비스 클래스 해당 관계는 서비스 컨테이너의 $aliases 속성에 등록됩니다.
예:

$this->app->alias('\Illuminate\ServiceName', 'service_alias');

서비스를 바인딩한 후 사용 시

$this->app->make('service_alias');

를 통해 서비스 개체를 구문 분석할 수 있습니다. 이렇게 하면 만들 때 긴 클래스 이름을 작성할 필요가 없으며, 사용 경험도 마찬가지입니다. make 메소드는 매우 개선되었습니다.

서비스 분석

make: 서비스 컨테이너에서 서비스 개체를 구문 분석합니다. 이 메서드는 구문 분석하려는 클래스 이름이나 인터페이스 이름을 매개 변수로 받습니다.

/**
 * Resolve the given type from the container.
 *
 * @param  string  $abstract
 * @param  array   $parameters
 * @return mixed
 */
public function make($abstract, array $parameters = [])
{
    //getAlias方法会假定$abstract是绑定的别名，从$aliases找到映射的真实类型名
    //如果没有映射则$abstract即为真实类型名，将$abstract原样返回
    $abstract = $this->getAlias($this->normalize($abstract));

    // 如果服务是通过instance()方式绑定的，就直接解析返回绑定的service
    if (isset($this->instances[$abstract])) {
        return $this->instances[$abstract];
    }

    // 获取$abstract接口对应的$concrete(接口的实现)
    $concrete = $this->getConcrete($abstract);

    if ($this->isBuildable($concrete, $abstract)) {
        $object = $this->build($concrete, $parameters);
    } else {
        //如果时接口实现这种绑定方式，通过接口拿到实现后需要再make一次才能
        //满足isBuildable的条件 ($abstract === $concrete)
        $object = $this->make($concrete, $parameters);
    }

    foreach ($this->getExtenders($abstract) as $extender) {
        $object = $extender($object, $this);
    }

    //如果服务是以singleton方式注册进来的则，把构建好的服务对象放到$instances里，
    //避免下次使用时重新构建
    if ($this->isShared($abstract)) {
        $this->instances[$abstract] = $object;
    }

    $this->fireResolvingCallbacks($abstract, $object);

    $this->resolved[$abstract] = true;

    return $object;
}

protected function getConcrete($abstract)
{
    if (! is_null($concrete = $this->getContextualConcrete($abstract))) {
        return $concrete;
    }

    // 如果是$abstract之前没有注册类实现到服务容器里，则服务容器会认为$abstract本身就是接口的类实现
    if (! isset($this->bindings[$abstract])) {
        return $abstract;
    }

    return $this->bindings[$abstract]['concrete'];
}

protected function isBuildable($concrete, $abstract)
{        
    return $concrete === $abstract || $concrete instanceof Closure;
}

make 메서드를 정렬하여 우리는 빌드 방법은 빌드하는 것입니다. 파싱된 서비스 객체에 대해 객체를 빌드하는 구체적인 프로세스를 살펴보겠습니다. (서비스의 의존성 주입을 구현하기 위해 구성 과정에서 PHP 클래스의 리플렉션이 사용됩니다.)

public function build($concrete, array $parameters = [])
{
    // 如果是闭包直接执行闭包并返回（对应闭包绑定）
    if ($concrete instanceof Closure) {
        return $concrete($this, $parameters);
    }
    
    // 使用反射ReflectionClass来对实现类进行反向工程
    $reflector = new ReflectionClass($concrete);

    // 如果不能实例化，这应该是接口或抽象类，再或者就是构造函数是private的
    if (! $reflector->isInstantiable()) {
        if (! empty($this->buildStack)) {
            $previous = implode(', ', $this->buildStack);

            $message = "Target [$concrete] is not instantiable while building [$previous].";
        } else {
            $message = "Target [$concrete] is not instantiable.";
        }

        throw new BindingResolutionException($message);
    }

    $this->buildStack[] = $concrete;

    // 获取构造函数
    $constructor = $reflector->getConstructor();

    // 如果构造函数是空，说明没有任何依赖，直接new返回
    if (is_null($constructor)) {
        array_pop($this->buildStack);

        return new $concrete;
    }
    
    // 获取构造函数的依赖（形参），返回一组ReflectionParameter对象组成的数组表示每一个参数
    $dependencies = $constructor->getParameters();

    $parameters = $this->keyParametersByArgument(
        $dependencies, $parameters
    );

    // 构建构造函数需要的依赖
    $instances = $this->getDependencies(
        $dependencies, $parameters
    );

    array_pop($this->buildStack);

    return $reflector->newInstanceArgs($instances);
}

//获取依赖
protected function getDependencies(array $parameters, array $primitives = [])
{
    $dependencies = [];

    foreach ($parameters as $parameter) {
        $dependency = $parameter->getClass();

        // 某一依赖值在$primitives中(即build方法的$parameters参数)已提供
        // $parameter->name返回参数名
        if (array_key_exists($parameter->name, $primitives)) {
            $dependencies[] = $primitives[$parameter->name];
        } 
        elseif (is_null($dependency)) {
             // 参数的ReflectionClass为null，说明是基本类型，如'int','string'
            $dependencies[] = $this->resolveNonClass($parameter);
        } else {
             // 参数是一个类的对象， 则用resolveClass去把对象解析出来
            $dependencies[] = $this->resolveClass($parameter);
        }
    }

    return $dependencies;
}

//解析出依赖类的对象
protected function resolveClass(ReflectionParameter $parameter)
{
    try {
        // $parameter->getClass()->name返回的是类名（参数在typehint里声明的类型）
        // 然后递归继续make（在make时发现依赖类还有其他依赖，那么会继续make依赖的依赖
        // 直到所有依赖都被解决了build才结束)
        return $this->make($parameter->getClass()->name);
    } catch (BindingResolutionException $e) {
        if ($parameter->isOptional()) {
            return $parameter->getDefaultValue();
        }

        throw $e;
    }
}

서비스 컨테이너는 laravel의 핵심입니다. 의존성 주입을 통해 객체 간의 상호 의존성을 해결하고 외부 리플렉션도 제어합니다. 특정 동작을 정의합니다(Route, Eloquent, 이들은 외부 모듈이며 자체 동작 사양을 정의합니다. 서비스 컨테이너는 등록부터 사용을 위한 인스턴스화까지 이러한 클래스를 담당합니다).

컨테이너로 클래스를 추출하려면 먼저 클래스를 컨테이너에 등록해야 합니다. Laravel은 이 컨테이너를 서비스 컨테이너라고 부르기 때문에 서비스가 필요하면 먼저 서비스를 컨테이너에 등록하고 바인딩해야 합니다. 그런 다음 서비스를 제공하고 서비스를 컨테이너에 바인딩하는 것이 서비스 공급자(ServiceProvider)입니다. 서비스 제공자는 크게 등록(registration)과 부트(boot, 초기화) 두 부분으로 나누어집니다. 라라벨 서비스 제공자의 내용은 공간 문제로 인해 또 다른 라라벨 핵심 해석 - 서비스 제공자(ServiceProvider)를 참조하세요.

위 내용은 이 글의 전체 내용입니다. 모든 분들의 학습에 도움이 되었으면 좋겠습니다. 더 많은 관련 내용은 PHP 중국어 홈페이지를 주목해주세요!

관련 권장 사항:

Laravel 핵심 해석 요청

Laravel 서비스 공급자(ServiceProvider) 해석

위 내용은 Laravel 서비스 컨테이너(IocContainer) 해석의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!