PHP-DI容器中的PHP定义配置详解

PHP-DI容器中的PHP定义配置详解

PHP-DI The dependency injection container for humans 项目地址: https://gitcode.com/gh_mirrors/ph/PHP-DI

引言

在现代PHP开发中，依赖注入(DI)已经成为构建可维护、可测试应用程序的重要模式。PHP-DI作为一款功能强大的依赖注入容器，提供了多种方式来定义和管理依赖关系。本文将重点介绍PHP-DI中最强大的配置方式——PHP定义配置。

PHP定义配置概述

PHP定义配置是PHP-DI提供的三种主要配置方式之一（另外两种是自动装配和注解）。它允许开发者使用PHP代码来明确定义依赖关系，提供了最大的灵活性和控制力。

基本使用方式

PHP定义配置可以通过两种方式注册到容器中：

1. 直接使用数组定义：

$container = new DI\Container([
    'db.host' => 'localhost'
]);

2. 通过配置文件返回数组：

// config.php
return [
    'db.host' => 'localhost'
];

// 主程序
$containerBuilder->addDefinitions('config.php');

懒加载机制

PHP-DI的一个重要特性是懒加载——容器中的对象只有在真正被请求时才会被创建。这种机制可以显著提高性能，特别是在大型应用中。

例外情况：如果直接将对象实例定义为值（如'Foo' => new Foo()），则对象会在每次请求时立即创建，这违背了懒加载原则，因此不推荐这种做法。

定义类型详解

PHP-DI提供了多种类型的定义方式，满足不同场景的需求。

1. 值定义(Values)

最简单的定义类型，用于存储原始值或简单数组：

return [
    'app.debug' => true,
    'database' => [
        'host' => '127.0.0.1',
        'port' => 3306
    ]
];

2. 工厂定义(Factories)

工厂定义允许延迟创建复杂对象，是处理复杂依赖关系的理想选择：

return [
    'Logger' => function (ContainerInterface $c) {
        return new Logger($c->get('log.level'));
    }
];

工厂可以是任何PHP可调用结构，包括类方法：

class LoggerFactory {
    public function create(Config $config) {
        return new Logger($config->getLogLevel());
    }
}

return [
    'Logger' => DI\factory([LoggerFactory::class, 'create'])
];

3. 对象定义(Objects)

使用DI\create()可以更直观地定义对象及其依赖：

return [
    'Database' => DI\create()
        ->constructor(DI\get('db.host'))
        ->method('setLogger', DI\get('Logger'))
];

4. 自动装配对象(Autowired Objects)

结合自动装配功能，可以简化对象定义：

return [
    'LoggerInterface' => DI\autowire('FileLogger')
        ->constructorParameter('filename', 'app.log')
];

5. 别名定义(Aliases)

为已有定义创建别名：

return [
    'db' => DI\get('Database')
];

6. 环境变量(Environment Variables)

从环境变量获取配置：

return [
    'db.url' => DI\env('DATABASE_URL', 'mysql://localhost')
];

7. 字符串表达式(String Expressions)

拼接字符串值：

return [
    'log.file' => DI\string('{log.dir}/app.log')
];

8. 数组定义(Arrays)

定义包含其他依赖的数组：

return [
    'middlewares' => [
        DI\get('AuthMiddleware'),
        DI\get('CacheMiddleware')
    ]
];

9. 通配符定义(Wildcards)

批量定义接口与实现的映射：

return [
    'App\Repositories\*RepositoryInterface' => 
        DI\create('App\Doctrine\*DoctrineRepository')
];

高级技巧

嵌套定义

PHP-DI允许在定义中嵌套其他定义：

return [
    'ComplexService' => DI\create()
        ->constructor(DI\string('{config.path}/data'))
];

动态获取请求条目名

工厂中可以获取当前请求的条目名：

return [
    'DynamicService' => function (RequestedEntry $entry) {
        $className = $entry->getName();
        return new $className();
    }
];

装饰模式

在不修改原有定义的基础上扩展功能：

return [
    'ApiClient' => DI\decorate(function ($previous, $c) {
        return new CachedApiClient($previous, $c->get('Cache'));
    })
];

最佳实践

1. 优先使用数组定义：相比直接在容器上设置，数组定义可以被编译，性能更好
2. 避免直接实例化对象：使用工厂或create()确保懒加载
3. 合理使用自动装配：在简单场景下减少配置量
4. 组织配置文件：按功能模块拆分配置文件，提高可维护性

总结

PHP-DI的PHP定义配置提供了强大而灵活的方式来管理应用依赖。通过掌握各种定义类型及其组合使用，开发者可以构建出既清晰又高效的依赖注入系统。无论是简单值还是复杂对象图，PHP-DI都能提供优雅的解决方案。

PHP-DI The dependency injection container for humans 项目地址: https://gitcode.com/gh_mirrors/ph/PHP-DI