level-2/dice

一个针对PHP的极简依赖注入容器（DIC）。请注意：3.0+版本仅与PHP 7.0兼容。2.0分支兼容PHP 5.6。

维护者

详细信息

github.com/Level-2/Dice

主页

源代码

问题

安装次数: 530,487

依赖者: 19

建议者: 0

安全: 0

星标: 432

关注者: 35

分支: 68

公开问题: 21

4.0.4 2022-03-28 21:20 UTC

Requires

  • php: >=7.0.0

Requires (Dev)

BSD-2-Clause e04c98d96bcc932a917b2b7e7944887e4839056a

  • Tom Butler <tom.woop@r.je>

dependency injectiondidependency injection containerioc

This package is auto-updated.

Last update: 2024-09-18 02:50:02 UTC

README

Dice是一个专注于轻量、快速且配置尽可能少的PHP依赖注入容器。

项目目标

  1. 要轻量级，不只是一个包含数十个文件的庞大库（Dice是一个100行代码的单个类），同时支持比其他更复杂的容器提供的所有功能（及更多）

  2. 要“简单工作”。基本功能应该能够在零配置的情况下工作

  3. 当需要配置时，它应该是尽可能最小化和可重用的，并且易于使用。

  4. 速度！（请参阅性能部分）

安装

只需将轻量级的Dice.php包含到您的项目中，即可使用而无需任何其他配置

简单示例

<?php
class A {
	public $b;

	public function __construct(B $b) {
		$this->b = $b;
	}
}

class B {

}

require_once 'Dice.php';
$dice = new \Dice\Dice;

$a = $dice->create('A');

var_dump($a->b); //B object

?>

完整文档

有关完整文档，请参阅Dice PHP依赖注入容器主页

PHP版本兼容性

Dice与PHP 7.0及以上版本兼容，Dice有支持PHP 5.6的存档版本，但不再维护。

性能

Dice使用反射，这通常被错误地标记为“慢”。反射比加载和解析配置文件要快得多。这里有一组基准测试这里和这里（要自己下载基准测试工具，请参阅此存储库）和Dice在大多数情况下都比其他容器快。

在实际测试中（测试6），Dice与Pimple（需要编写大量的配置代码）并驾齐驱，尽管Symfony\DependencyInjection在创建对象方面更快，但它有更大的开销，并且您需要在每次页面加载时创建超过500个对象，直到它比Dice更快。Phalcon的情况也是如此，加载Phalcon扩展的开销意味着除非您在每次HTTP请求中创建超过一千个对象，否则这种开销不值得。

致谢

最初由Tom Butler（@TomBZombie）开发，感谢daniel-meister（@daniel-meister）、Garrett W.（@garrettw）、maxwilms（@maxwilms）对错误修复、建议和改进。

更新

2018年11月15日 4.0版本发布 - 不兼容

Dice现在是不可变的，并且对其他不可变对象的支持更好。

新功能

1. Dice是不可变的

这避免了Dice实例在应用程序中传递和重新配置时出现的可变性相关问题。唯一的区别是addRules和addRule返回一个具有更新规则的新Dice实例，而不是改变现有实例的状态。

// Pre-4.0 code:
$dice->addRule('PDO', ['shared' => true]);

$db = $dice->create('PDO');

// 4.0 code:
$dice = $dice->addRule('PDO', ['shared' => true]);

$db = $dice->create('PDO');

从实际角度来看，在大多数情况下，只需在任何$dice->addRule()调用前加上$dice = ，它就会像以前一样工作。

2. 支持对象方法链

不可变对象的一些功能是它们提供对象链。

考虑以下对象

$httpRequest = new HTTPRequest();
$httpRequest = $httpRequest->url('http://example.org')->method('POST')->postdata('foo=bar');

在之前的版本中，Dice无法构建配置的对象。从4.0版本开始，Dice支持使用call规则和Dice::CHAIN_CALL常量进行方法链调用。

$dice = $dice->addRule('HTTPRequest',
                ['call' => [
                    ['url', ['http://example.org'], Dice::CHAIN_CALL],
                    ['method', ['POST'], Dice::CHAIN_CALL ],
                    ['postdata', ['foo=bar'], Dice::CHAIN_CALL]
                 ]
                ]
);

Dice会将HTTP请求对象替换为链式调用的结果。这对于工厂类也很有用。

$dice = $dice->addRule('MyDatabase',
                [
                	'instanceOf' => 'DatabaseFactory',
                	'call' => [
                		['get', ['Database'], Dice::CHAIN_CALL]
                 ]
                ]
);

$database = $dice->create('MyDatabase');
//Equivalent of:

$factory = new DatabaseFactory();
$database = $factory->get('Database');

2018年6月3日 3.0版本发布 - 不兼容向后版本

新功能

1. 为了替换JSON加载器，已经移除了addRules方法。

$dice->addRules([
	'\PDO' => [
		'shared' => true
	],
	'Framework\Router' => [
		'constructParams' => ['Foo', 'Bar']
	]
]);

添加此功能是为了使JSON加载器变得多余。从JSON文件中加载规则可以通过以下代码轻松实现：

$dice->addRules(json_decode(file_get_contents('rules.json')));

2. 改进JSON文件支持：常量和超全局变量

为了提高对在外部JSON文件中定义的规则的支持，现在可以将常量和超全局变量传递给Dice创建的对象。

例如，将$_SERVER超全局变量传递给路由器实例，并在JSON文件中使用以下方式调用PDO的setAttribute方法，并设置PDO::ATTR_ERRMODE和PDO::ERRMODE_EXCEPTION：

rules.json

{
	"Router": {
		"constructParams": [
			{"Dice::GLOBAL": "_SERVER"}
		]
	},
	"PDO": {
		"shared": true,
		"constructParams": [
			"mysql:dbname=testdb;host=127.0.0.1",
			"dbuser",
			"dbpass"
		],
		"call": [
					[
						"setAttribute",
						[
							{"Dice::CONSTANT": "PDO::ATTR_ERRMODE"},
							{"Dice::CONSTANT": "PDO::ERRMODE_EXCEPTION"}
						]
					]
		]
	}
}
$dice->addRules(json_decode(file_get_contents('rules.json')));

不兼容的变更

  1. Dice 3.0需要PHP 7.0或更高版本，不再支持PHP 5.6。

  2. Dice不再支持用'instance'键表示实例。例如：

$dice->addRule('ClassName', [
	'constructParams' => ['instance' => '$NamedPDOInstance']
]);

如问题#125中所述，如果数组有一个'instance'键，则无法将数组传递给构造函数。相反，应使用新的\Dice\Dice::INSTANCE常量。

$dice->addRule('ClassName', [
	'constructParams' => [\Dice\Dice::INSTANCE => '$NamedPDOInstance']
]);

为了使常量更易输入，可以使用use \Dice\Dice;并引用Dice::INSTANCE

10/06/2016

** 不兼容变更 **

根据问题110，现在使用instanceOf命名实例将继承它们所属类的规则。

$rule = [];
$rule['shared'] = true;

$dice->addRule('MyClass', $rule);

$rule = [];
$rule['instanceOf'] = 'MyClass';
$rule['constructParams'] = ['Foo', 'Bar'];

$dice->addRule('$MyNamedInstance', $rule);

$dice->create('$MyNamedInstance')现在将创建一个遵循应用于MyClass和$MyNamedInstance的规则的新类，因此实例将是共享的。

之前只使用命名实例的规则。

要恢复旧的行为，请在命名实例上设置inherit为false。

$rule = [];
$rule['shared'] = true;

$dice->addRule('MyClass', $rule);

$rule = [];
$rule['instanceOf'] = 'MyClass';
$rule['constructParams'] = ['Foo', 'Bar'];


//Prevent the named instance inheriting rules from the class named in `instanceOf`:
$rule['inherit'] = false;

$dice->addRule('$MyNamedInstance', $rule);

29/10/2014

  • 根据问题#15，Dice现在只有在它们被\Dice\Instance包装时才会调用闭包。**请注意，这是一个不兼容的变更**。

之前Dice在传递作为替代、构造参数以及调用方法时运行闭包。

$rule->substitutions['A'] = function() {
	return new A;
};

$rule->call[] = ['someMethod', function() {
// '2' will be provided as the first argument when someMethod is called
return 2;
}];

$rule->constructParams[] = function() {
	//'abc' will be providedas the first constructor parameter
	return 'abc';
};

由于闭包总是被调用和执行，因此此行为已更改，因为它使得无法将闭包作为构造参数或调用方法提供。

为了克服这一点，Dice现在只有在它们被\Dice\Instance包装时才会调用闭包。

$rule->substitutions['A'] = ['instance' => function() {
	return new A;
}];

$rule->call[] = ['someMethod', ['instance' => function() {
// '2' will be provided as the first argument when someMethod is called
return 2;
}]]);

$rule->constructParams[] =  ['instance' => function() { {
	//'abc' will be providedas the first constructor parameter
	return 'abc';
}]);

04/09/2014

  • 推送PHP5.6分支。这比使用PHP5.6特性的版本略高效。对于PHP5.4-PHP5.5，请参阅相关分支。此版本将在PHP5.6更广泛使用之前得到维护。

26/08/2014

  • 添加PHP5.6分支。利用PHP5.6特性整理了代码。PHP5.6发布后，这将移动到master分支。

28/06/2014

  • 大大提高了效率。Dice现在是PHP最快的依赖注入容器！

06/06/2014

27/03/2014

  • 移除了assign()方法，因为它与使用$rule->shared提供的功能重复。
  • 移除了$dice->create()中的$callback参数，因为使用$rule->shareInstances可以更好地实现此功能的唯一实际用途。
  • 整理了代码，移除了未使用或未记录的功能。Dice现在更加轻量级和快速。
  • 修复了当使用$rule->call时，每个方法调用都会使用构造函数上的替换规则的问题。
  • 更新了Dice文档，以使用简短数组语法。

01/03/2014

  • 添加了Xml加载器和Loader Callback类的测试用例。
  • 添加了JSON加载器和测试用例。
  • 已将所有测试用例添加到测试套件中
  • 改为使用PHP5.4数组语法。PHP5.3兼容版本现已在PHP5.3分支中提供。
  • 修复了每次创建类时，使用命名实例会触发自动加载器并引发无效类名的问题。

28/02/2014

  • 添加了基本命名空间支持。文档更新将很快跟进。同时，将XML加载器移动到其自己的文件中，如果使用它，需要单独包含。
  • 请注意：更改**不向下兼容**。但是，通过以下查找/替换操作可以轻松修复：
	new Dice => new \Dice\Dice
	new DiceInstance => new \Dice\Instance
	new DiceRule => new \Dice\Rule