diogo/symfony
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[DI] generate preload.php file for PHP 7.4 in cache folder

Browse Source
This commit is contained in:
Nicolas Grekas 2019-06-13 18:28:50 +02:00
parent d6ac45262c
commit c4dad0de5d
8 changed files with 175 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/Symfony/Component/DependencyInjection/CHANGELOG.md
View File

@ -4,6 +4,7 @@ CHANGELOG
4.4.0
-----
* added support for opcache.preload by generating a preloading script in the cache folder
* added support for dumping the container in one file instead of many files
* deprecated support for short factories and short configurators in Yaml
* deprecated `tagged` in favor of `tagged_iterator`

61
src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php
View File

@ -82,6 +82,7 @@ class PhpDumper extends Dumper
private $locatedIds = [];
private $serviceLocatorTag;
private $exportedVariables = [];
private $baseClass;
/**
* @var ProxyDumper
@ -151,11 +152,11 @@ class PhpDumper extends Dumper
if (0 !== strpos($baseClass = $options['base_class'], '\\') && 'Container' !== $baseClass) {
$baseClass = sprintf('%s\%s', $options['namespace'] ? '\\'.$options['namespace'] : '', $baseClass);
$baseClassWithNamespace = $baseClass;
$this->baseClass = $baseClass;
} elseif ('Container' === $baseClass) {
$baseClassWithNamespace = Container::class;
$this->baseClass = Container::class;
} else {
$baseClassWithNamespace = $baseClass;
$this->baseClass = $baseClass;
}
$this->initializeMethodNamesMap('Container' === $baseClass ? Container::class : $baseClass);
@ -222,7 +223,7 @@ class PhpDumper extends Dumper
$proxyClasses = $this->inlineFactories ? $this->generateProxyClasses() : null;
$code =
$this->startClass($options['class'], $baseClass, $baseClassWithNamespace).
$this->startClass($options['class'], $baseClass, $preload).
$this->addServices($services).
$this->addDeprecatedAliases().
$this->addDefaultParametersMethod()
@ -296,6 +297,33 @@ EOF;
$time = $options['build_time'];
$id = hash('crc32', $hash.$time);
if ($preload) {
$code[$options['class'].'.preload.php'] = <<<EOF
<?php
// This file has been auto-generated by the Symfony Dependency Injection Component
// You can reference it in the "opcache.preload" php.ini setting on PHP >= 7.4 when preloading is desired
use Symfony\Component\DependencyInjection\Dumper\Preloader;
require dirname(__DIR__, 3).'/vendor/autoload.php';
require __DIR__.'/Container{$hash}/{$options['class']}.php';
\$classes = [];
EOF;
foreach ($preload as $class) {
$code[$options['class'].'.preload.php'] .= sprintf("\$classes[] = '%s';\n", $class);
}
$code[$options['class'].'.preload.php'] .= <<<'EOF'
Preloader::preload($classes);
EOF;
}
$code[$options['class'].'.php'] = <<<EOF
<?php
{$namespaceLine}
@ -426,7 +454,7 @@ EOF;
if (!$r = $this->container->getReflectionClass($class, false)) {
return;
}
if ($this->container instanceof $class) {
if (is_a($class, $this->baseClass, true)) {
return;
}
$file = $r->getFileName();
@ -434,6 +462,8 @@ EOF;
return;
}
$lineage[$class] = substr($exportedFile, 1, -1);
if ($parent = $r->getParentClass()) {
$this->collectLineage($parent->name, $lineage);
}
@ -446,6 +476,7 @@ EOF;
$this->collectLineage($parent->name, $lineage);
}
unset($lineage[$class]);
$lineage[$class] = substr($exportedFile, 1, -1);
}
@ -522,13 +553,17 @@ EOF;
}
foreach (array_diff_key(array_flip($lineage), $this->inlinedRequires) as $file => $class) {
$file = preg_replace('#^\\$this->targetDirs\[(\d++)\]#', sprintf('\dirname(__DIR__, %d + $1)', $this->asFiles), $file);
$code .= sprintf(" include_once %s;\n", $file);
}
}
foreach ($this->inlinedDefinitions as $def) {
if ($file = $def->getFile()) {
$code .= sprintf(" include_once %s;\n", $this->dumpValue($file));
$file = $this->dumpValue($file);
$file = '(' === $file[0] ? substr($file, 1, -1) : $file;
$file = preg_replace('#^\\$this->targetDirs\[(\d++)\]#', sprintf('\dirname(__DIR__, %d + $1)', $this->asFiles), $file);
$code .= sprintf(" include_once %s;\n", $file);
}
}
@ -1016,7 +1051,7 @@ EOTXT
return $return.sprintf('new %s(%s)', $this->dumpLiteralClass($this->dumpValue($class)), implode(', ', $arguments)).$tail;
}
private function startClass(string $class, string $baseClass, string $baseClassWithNamespace): string
private function startClass(string $class, string $baseClass, ?array &$preload): string
{
$namespaceLine = !$this->asFiles && $this->namespace ? "\nnamespace {$this->namespace};\n" : '';
@ -1064,8 +1099,8 @@ EOF;
$code .= " \$this->containerDir = \$containerDir;\n";
}
if (Container::class !== $baseClassWithNamespace) {
$r = $this->container->getReflectionClass($baseClassWithNamespace, false);
if (Container::class !== $this->baseClass) {
$r = $this->container->getReflectionClass($this->baseClass, false);
if (null !== $r
&& (null !== $constructor = $r->getConstructor())
&& 0 === $constructor->getNumberOfRequiredParameters()
@ -1085,7 +1120,7 @@ EOF;
$code .= $this->addMethodMap();
$code .= $this->asFiles && !$this->inlineFactories ? $this->addFileMap() : '';
$code .= $this->addAliases();
$code .= $this->addInlineRequires();
$code .= $this->addInlineRequires($preload);
$code .= <<<EOF
}
@ -1285,7 +1320,7 @@ EOF;
return $code;
}
private function addInlineRequires(): string
private function addInlineRequires(?array &$preload): string
{
if (!$this->hotPathTag || !$this->inlineRequires) {
return '';
@ -1304,6 +1339,7 @@ EOF;
foreach ($inlinedDefinitions as $def) {
if (\is_string($class = \is_array($factory = $def->getFactory()) && \is_string($factory[0]) ? $factory[0] : $def->getClass())) {
$preload[$class] = $class;
$this->collectLineage($class, $lineage);
}
}
@ -1314,11 +1350,12 @@ EOF;
foreach ($lineage as $file) {
if (!isset($this->inlinedRequires[$file])) {
$this->inlinedRequires[$file] = true;
$file = preg_replace('#^\\$this->targetDirs\[(\d++)\]#', sprintf('\dirname(__DIR__, %d + $1)', $this->asFiles), $file);
$code .= sprintf("\n include_once %s;", $file);
}
}
return $code ? sprintf("\n \$this->privates['service_container'] = function () {%s\n };\n", $code) : '';
return $code ? sprintf("\n \$this->privates['service_container'] = static function () {%s\n };\n", $code) : '';
}
private function addDefaultParametersMethod(): string

99
src/Symfony/Component/DependencyInjection/Dumper/Preloader.php Normal file
View File

@ -0,0 +1,99 @@
<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Symfony\Component\DependencyInjection\Dumper;
/**
* @author Nicolas Grekas <p@tchwork.com>
*
* @internal
*/
class Preloader
{
public static function preload(array $classes)
{
set_error_handler(function ($t, $m, $f, $l) {
if (error_reporting() & $t) {
if (__FILE__ !== $f) {
throw new \ErrorException($m, 0, $t, $f, $l);
}
throw new \ReflectionException($m);
}
});
$prev = [];
$preloaded = [];
try {
while ($prev !== $classes) {
$prev = $classes;
foreach ($classes as $c) {
if (!isset($preloaded[$c])) {
$preloaded[$c] = true;
self::doPreload($c);
}
}
$classes = array_merge(get_declared_classes(), get_declared_interfaces(), get_declared_traits());
}
} finally {
restore_error_handler();
}
}
private static function doPreload(string $class)
{
if (\in_array($class, ['self', 'static', 'parent'], true)) {
return;
}
try {
$r = new \ReflectionClass($class);
if ($r->isInternal()) {
return;
}
$r->getConstants();
$r->getDefaultProperties();
if (\PHP_VERSION_ID >= 70400) {
foreach ($r->getProperties() as $p) {
if (($t = $p->getType()) && !$t->isBuiltin()) {
self::doPreload($t->getName());
}
}
}
foreach ($r->getMethods() as $m) {
foreach ($m->getParameters() as $p) {
if ($p->isDefaultValueAvailable() && $p->isDefaultValueConstant()) {
$c = $p->getDefaultValueConstantName();
if ($i = strpos($c, '::')) {
self::doPreload(substr($c, 0, $i));
}
}
if (($t = $p->getType()) && !$t->isBuiltin()) {
self::doPreload($t->getName());
}
}
if (($t = $m->getReturnType()) && !$t->isBuiltin()) {
self::doPreload($t->getName());
}
}
} catch (\ReflectionException $e) {
// ignore missing classes
}
}
}

4
src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services9_as_files.txt
View File

@ -265,7 +265,7 @@ use Symfony\Component\DependencyInjection\Exception\RuntimeException;
// This file has been auto-generated by the Symfony Dependency Injection Component for internal use.
// Returns the public 'method_call1' shared service.
include_once ($this->targetDirs[0].'/Fixtures/includes/foo.php');
include_once \dirname(__DIR__, 1 + 0).'/Fixtures/includes/foo.php';
$this->services['method_call1'] = $instance = new \Bar\FooClass();
@ -300,7 +300,7 @@ use Symfony\Component\DependencyInjection\Exception\RuntimeException;
// This file has been auto-generated by the Symfony Dependency Injection Component for internal use.
// Returns the public 'non_shared_foo' service.
include_once ($this->targetDirs[0].'/Fixtures/includes/foo.php');
include_once \dirname(__DIR__, 1 + 0).'/Fixtures/includes/foo.php';
$this->factories['non_shared_foo'] = function () {
return new \Bar\FooClass();

22
src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services9_inlined_factories.txt
View File

@ -90,8 +90,8 @@ class ProjectServiceContainer extends Container
'decorated' => 'decorator_service_with_name',
];
$this->privates['service_container'] = function () {
include_once $this->targetDirs[0].'/Fixtures/includes/foo.php';
$this->privates['service_container'] = static function () {
include_once \dirname(__DIR__, 1 + 0).'/Fixtures/includes/foo.php';
};
}
@ -287,7 +287,7 @@ class ProjectServiceContainer extends Container
*/
protected function getFoo_BazService()
{
include_once $this->targetDirs[0].'/Fixtures/includes/classes.php';
include_once \dirname(__DIR__, 1 + 0).'/Fixtures/includes/classes.php';
$this->services['foo.baz'] = $instance = \BazClass::getInstance();
@ -331,7 +331,7 @@ class ProjectServiceContainer extends Container
*/
protected function getLazyContextService()
{
include_once $this->targetDirs[0].'/Fixtures/includes/classes.php';
include_once \dirname(__DIR__, 1 + 0).'/Fixtures/includes/classes.php';
return $this->services['lazy_context'] = new \LazyContext(new RewindableGenerator(function () {
yield 'k1' => ($this->services['foo.baz'] ?? $this->getFoo_BazService());
@ -348,7 +348,7 @@ class ProjectServiceContainer extends Container
*/
protected function getLazyContextIgnoreInvalidRefService()
{
include_once $this->targetDirs[0].'/Fixtures/includes/classes.php';
include_once \dirname(__DIR__, 1 + 0).'/Fixtures/includes/classes.php';
return $this->services['lazy_context_ignore_invalid_ref'] = new \LazyContext(new RewindableGenerator(function () {
yield 0 => ($this->services['foo.baz'] ?? $this->getFoo_BazService());
@ -364,7 +364,7 @@ class ProjectServiceContainer extends Container
*/
protected function getMethodCall1Service()
{
include_once ($this->targetDirs[0].'/Fixtures/includes/foo.php');
include_once \dirname(__DIR__, 1 + 0).'/Fixtures/includes/foo.php';
$this->services['method_call1'] = $instance = new \Bar\FooClass();
@ -399,7 +399,7 @@ class ProjectServiceContainer extends Container
*/
protected function getNonSharedFooService()
{
include_once ($this->targetDirs[0].'/Fixtures/includes/foo.php');
include_once \dirname(__DIR__, 1 + 0).'/Fixtures/includes/foo.php';
return new \Bar\FooClass();
}
@ -534,6 +534,14 @@ class ProjectServiceContainer extends Container
}
}
[ProjectServiceContainer.preload.php] => <?php
%A
$classes = [];
$classes[] = 'Bar\FooClass';
%A
[ProjectServiceContainer.php] => <?php
// This file has been auto-generated by the Symfony Dependency Injection Component for internal use.

2
src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services9_lazy_inlined_factories.txt
View File

@ -92,7 +92,7 @@ class ProjectServiceContainer extends Container
});
}
include_once $this->targetDirs[0].'/Fixtures/includes/foo_lazy.php';
include_once \dirname(__DIR__, 1 + 0).'/Fixtures/includes/foo_lazy.php';
return new \Bar\FooClass(new \Bar\FooLazyClass());
}

14
src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services_inline_requires.php
View File

@ -37,11 +37,11 @@ class ProjectServiceContainer extends Container
$this->aliases = [];
$this->privates['service_container'] = function () {
include_once $this->targetDirs[1].'/includes/HotPath/I1.php';
include_once $this->targetDirs[1].'/includes/HotPath/P1.php';
include_once $this->targetDirs[1].'/includes/HotPath/T1.php';
include_once $this->targetDirs[1].'/includes/HotPath/C1.php';
$this->privates['service_container'] = static function () {
include_once \dirname(__DIR__, 0 + 1).'/includes/HotPath/I1.php';
include_once \dirname(__DIR__, 0 + 1).'/includes/HotPath/P1.php';
include_once \dirname(__DIR__, 0 + 1).'/includes/HotPath/T1.php';
include_once \dirname(__DIR__, 0 + 1).'/includes/HotPath/C1.php';
};
}
@ -91,8 +91,8 @@ class ProjectServiceContainer extends Container
*/
protected function getC2Service()
{
include_once $this->targetDirs[1].'/includes/HotPath/C2.php';
include_once $this->targetDirs[1].'/includes/HotPath/C3.php';
include_once \dirname(__DIR__, 0 + 1).'/includes/HotPath/C2.php';
include_once \dirname(__DIR__, 0 + 1).'/includes/HotPath/C3.php';
return $this->services['Symfony\\Component\\DependencyInjection\\Tests\\Fixtures\\includes\\HotPath\\C2'] = new \Symfony\Component\DependencyInjection\Tests\Fixtures\includes\HotPath\C2(new \Symfony\Component\DependencyInjection\Tests\Fixtures\includes\HotPath\C3());
}

2
src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services_non_shared_lazy_as_files.txt
View File

@ -15,7 +15,7 @@ use Symfony\Component\DependencyInjection\Exception\RuntimeException;
// This file has been auto-generated by the Symfony Dependency Injection Component for internal use.
// Returns the public 'non_shared_foo' service.
include_once ($this->targetDirs[0].'/Fixtures/includes/foo_lazy.php');
include_once \dirname(__DIR__, 1 + 0).'/Fixtures/includes/foo_lazy.php';
$this->factories['non_shared_foo'] = function ($lazyLoad = true) {
return new \Bar\FooLazyClass();