Ray.Di 技术文档

1. 安装指南

1.1 使用 Composer 安装

Ray.Di 可以通过 Composer 进行安装。Composer 是 PHP 的依赖管理工具，确保你已经安装了 Composer。

在终端中运行以下命令来安装 Ray.Di：

composer require ray/di

1.2 手动安装

如果你不使用 Composer，也可以手动下载 Ray.Di 的源代码，并将其放置在你的项目目录中。然后，在你的 PHP 文件中引入自动加载文件：

require 'path/to/Ray.Di/src/autoload.php';

2. 项目的使用说明

2.1 基本概念

Ray.Di 是一个依赖注入（DI）和面向切面编程（AOP）框架，灵感来源于 Google Guice。它通过注解和模块化的配置来管理对象的依赖关系。

2.2 创建模块

模块是 Ray.Di 的核心概念之一。你可以通过继承 AbstractModule 类来创建一个模块，并在 configure 方法中定义绑定关系。

use Ray\Di\AbstractModule;

class AppModule extends AbstractModule
{
    protected function configure()
    {
        $this->bind(MyServiceInterface::class)->to(MyService::class);
    }
}

2.3 注入依赖

在 Ray.Di 中，你可以通过构造函数注入或属性注入来获取依赖对象。

class MyController
{
    private $service;

    public function __construct(MyServiceInterface $service)
    {
        $this->service = $service;
    }

    public function doSomething()
    {
        $this->service->performAction();
    }
}

2.4 创建和使用注入器

注入器（Injector）是 Ray.Di 的核心组件，用于创建和管理对象实例。

use Ray\Di\Injector;

$injector = new Injector(new AppModule);
$controller = $injector->getInstance(MyController::class);
$controller->doSomething();

3. 项目API使用文档

3.1 绑定API

Ray.Di 提供了多种绑定方式，包括：

• to: 将接口绑定到具体的实现类。
• toProvider: 将接口绑定到提供者类。
• toInstance: 将接口绑定到具体的实例。

$this->bind(MyServiceInterface::class)->to(MyService::class);
$this->bind(MyServiceInterface::class)->toProvider(MyServiceProvider::class);
$this->bind(MyServiceInterface::class)->toInstance(new MyService);

3.2 注解API

Ray.Di 支持多种注解，用于标记依赖注入的属性和方法。

• @Inject: 标记需要注入的属性或方法。
• @Named: 用于区分多个相同类型的依赖。

class MyController
{
    /**
     * @Inject
     * @Named("default")
     */
    private $service;
}

3.3 AOP API

Ray.Di 支持面向切面编程，可以通过 MethodInterceptor 接口实现方法拦截器。

use Ray\Aop\MethodInterceptor;
use Ray\Aop\MethodInvocation;

class MyInterceptor implements MethodInterceptor
{
    public function invoke(MethodInvocation $invocation)
    {
        // 前置操作
        $result = $invocation->proceed();
        // 后置操作
        return $result;
    }
}

4. 项目安装方式

4.1 通过 Composer 安装

如前所述，Ray.Di 可以通过 Composer 进行安装：

composer require ray/di

4.2 手动下载源码

你也可以手动下载 Ray.Di 的源码，并将其放置在你的项目目录中。然后，在你的 PHP 文件中引入自动加载文件：

require 'path/to/Ray.Di/src/autoload.php';

通过以上步骤，你可以成功安装并使用 Ray.Di 框架来管理你的 PHP 项目中的依赖注入和面向切面编程。