在PHP 7.4中使用预加载–Opcache Preloading

PHP 7.4增加了预加载(Opcache Preloading)的支持,这一功能可以显著提高PHP程序的运行性能。

它是如何工作的:

  • 为了预加载文件,您需要编写一个自定义PHP脚本
  • 此脚本在服务器启动时执行一次
  • 所有预加载的文件都在内存中可用于所有请求
  • 在重新启动服务器之前,对预加载的文件所做的更改不会生效

简单来说就是把PHP代码完全加载到内存中来达到提升性能的目的。

让我们深入研究一下。

关于Opcache更多解释

虽然预加载是在opcache上构建的,但它并不完全相同。Opcache将获取您的PHP源文件,将其编译为“操作码”,并将这些编译后的文件存储在磁盘上。

您可以将“操作码”视为代码的低级表示,可以在运行时轻松解释执行。因此,opcache会跳过源文件转换到PHP解释器在运行时实际需要的内容的步骤。这是一个非常大的进步!

但是,还有更多的东西可以获得。Opcached文件不了解其他文件。如果你有一个类A继承于类B,你仍然需要在运行时将它们链接在一起。此外,opcache执行检查以查看源文件是否已被修改,并将基于此文件使其缓存无效。

所以这就是预加载发挥作用的地方:它不仅将源文件编译为操作码,还将相关的类,trait和接口链接在一起。然后,它将保留这个“已编译”的可运行代码blob - 即:PHP解释器可用的代码 - 到内存中。

当请求到达服务器时,它现在可以使用已经加载到内存中的部分代码库,而没有任何开销。

那么,我们谈论的是“代码库的哪些部分”?

在实践中预加载

为了使预加载工作,开发人员必须告诉服务器要加载哪些文件。这是通过一个简单的PHP脚本完成的,所以没有什么难的。

规则很简单:

  • 您提供了一个预加载脚本,并使用opcache.preload在您的php.ini文件中链接到它。
  • 要预加载的每个 PHP 文件都应从预加载脚本中传递到opcache_compile_file()require_once().

假设您想要预加载一个框架,例如Laravel。您的脚本必须遍历目录中的所有PHP文件vendor/laravel,并逐个包含它们。

以下是您在php.ini中链接到此脚本的方法:

opcache.preload_user=www-data

opcache.preload=/path/to/project/preload.php

这是一个假设实现:

$files = /* An array of files you want to preload */;

foreach ($files as $file) {
    opcache_compile_file($file);
}

 

注:如果在symfony4.4中使用,请使用 opcache.preload=/var/www/html/sf44/var/cache/prod/srcApp_KernelProdContainer.preload.php

警告:无法预加载未链接的类

等一下,有一个警告!为了预先加载文件,还必须预先加载它们的依赖项 - 接口,trait和父类。

如果类依赖项有任何问题,您会在服务器启动时注意到它:

Can't preload unlinked class 
Illuminate\Database\Query\JoinClause: 
Unknown parent 
Illuminate\Database\Query\Builder

因为opcache_compile_file()只解析文件,但不执行它。这意味着如果一个类具有未预加载的依赖项,则其本身也不能被预加载。

这不是一个致命的问题,您的服务器将正常工作; 但是你不会拥有你真正想要的所有预加载文件。

幸运的是,有一种方法来确保链接的文件也加载: 您可以使用require_once来代替opcache_compile_file,让注册的自动加载器(可能是composer)来处理其余的工作。因为如果使用opcache_compile_file()而不是require_once(),则可能会限制预加载类的数量,并且不会再收到错误。

$files = /* All files in eg. vendor/laravel */;

foreach ($files as $file) {
    require_once($file);
}

仍然会有一些警告,例如,如果您尝试预加载 Laravel,则框架中的某些类具有对其他类的依赖项,这些类尚不存在。例如,filesystem cache 类\Illuminate\Filesystem\Cache依赖于\League\Flysystem\Cached\Storage\AbstractCache,如果您从未使用filesystem caches,则可能在你的项目中没有安装它。

尝试预加载所有内容时,您可能会遇到“找不到类”错误。幸运的是,在默认的Laravel安装中,只有少数几个此类,可以轻易忽略。为了方便起见,我编写了一个小小的preloader类,以使忽略文件更容易,如下所示:

class Preloader
{
    private array $ignores = [];

    private static int $count = 0;

    private array $paths;

    private array $fileMap;

    public function __construct(string ...$paths)
    {
        $this->paths = $paths;

        // We'll use composer's classmap
        // to easily find which classes to autoload,
        // based on their filename
        $classMap = require __DIR__ . '/vendor/composer/autoload_classmap.php';

        $this->fileMap = array_flip($classMap);
    }
    
    public function paths(string ...$paths): Preloader
    {
        $this->paths = array_merge(
            $this->paths,
            $paths
        );

        return $this;
    }

    public function ignore(string ...$names): Preloader
    {
        $this->ignores = array_merge(
            $this->ignores,
            $names
        );

        return $this;
    }

    public function load(): void
    {
        // We'll loop over all registered paths
        // and load them one by one
        foreach ($this->paths as $path) {
            $this->loadPath(rtrim($path, '/'));
        }

        $count = self::$count;

        echo "[Preloader] Preloaded {$count} classes" . PHP_EOL;
    }

    private function loadPath(string $path): void
    {
        // If the current path is a directory,
        // we'll load all files in it 
        if (is_dir($path)) {
            $this->loadDir($path);

            return;
        }

        // Otherwise we'll just load this one file
        $this->loadFile($path);
    }

    private function loadDir(string $path): void
    {
        $handle = opendir($path);

        // We'll loop over all files and directories
        // in the current path,
        // and load them one by one
        while ($file = readdir($handle)) {
            if (in_array($file, ['.', '..'])) {
                continue;
            }

            $this->loadPath("{$path}/{$file}");
        }

        closedir($handle);
    }

    private function loadFile(string $path): void
    {
        // We resolve the classname from composer's autoload mapping
        $class = $this->fileMap[$path] ?? null;

        // And use it to make sure the class shouldn't be ignored
        if ($this->shouldIgnore($class)) {
            return;
        }

        // Finally we require the path,
        // causing all its dependencies to be loaded as well
        require_once($path);

        self::$count++;

        echo "[Preloader] Preloaded `{$class}`" . PHP_EOL;
    }

    private function shouldIgnore(?string $name): bool
    {
        if ($name === null) {
            return true;
        }

        foreach ($this->ignores as $ignore) {
            if (strpos($name, $ignore) === 0) {
                return true;
            }
        }

        return false;
    }
}

通过在同一个预加载脚本中添加此类,我们现在能够加载整个 Laravel 框架,如下所示:

// …

(new Preloader())
    ->paths(__DIR__ . '/vendor/laravel')
    ->ignore(
        \Illuminate\Filesystem\Cache::class,
        \Illuminate\Log\LogManager::class,
        \Illuminate\Http\Testing\File::class,
        \Illuminate\Http\UploadedFile::class,
        \Illuminate\Support\Carbon::class,
    )
    ->load();

目前,核心中有一个 bug,它阻止require_once正常工作。希望它能很快修好。

确认预加载是否生效

这当然是最重要的问题:所有文件是否都正确加载?只需通过重新启动服务器来测试它,并在 PHP 脚本中用opcache_get_status()输出查看。您将看到它有一个名为 preload_statistics 的key,它将列出所有预加载的函数、类和脚本;以及预加载文件消耗的内存。

Composer支持

最有前途的自动化解决方案来自composer,现在已经被大多数现代PHP项目所使用。

人们正在努力添加预加载配置选项到composer.json中,进而为您生成预加载文件!目前此功能仍在进行中,但可以在此处进行关注

 

服务器要求

关于使用预加载时的devops方面,还有两个更重要的事情需要提及。

您已经知道需要在php.ini中指定一个条目才能使预加载工作。这意味着如果您使用共享主机,则无法根据需要自由配置PHP

实际上,您需要一个专用(虚拟)服务器才能为单个项目优化预加载的文件。所以记住这一点。

还要记住每次要重新加载内存中的文件时,都需要重新启动服务器(php-fpm)。这对大多数人来说似乎是显而易见的,但仍值得一提。

注:从PHP7.4.2开始,windows不再支持preloading.

性能

现在谈到最重要的问题:预加载实际上是否提高了性能?

答案是肯定的,当然:Ben Morel分享了一些基准,可以在与之前相关的同一个composer问题中找到。

有趣的是,您可以决定只预加载“热门类”:代码库中经常使用的类。Ben的基准测试表明,只加载大约100个热门类,实际上比预加载所有产生更好的性能提升。这是性能提升13%和17%的差异。

应该预先加载哪些类依赖于您的特定项目。在开始时尽可能简单地预加载是明智的。如果您确实需要增加几个百分比,则必须在运行时监控代码。

所有这些当然也可以自动化,并且可能在将来完成。

现在,最重要的是要记住,comopser会添加支持,这样你就不必自己制作预加载文件了,而且这个功能很容易在服务器上设置,因为你可以完全控制它。

PHP 7.4 的opcache preloading 太赞了,最新严格测试:
用 ubiquity 框架,读数据库的数据,性能比不用preloading时有高达50-60%的性能提升!!!

 

注意:

因为在PHP.ini中设置了preloading后:会对其它的站点造成影响。

可能会造成另一个站的代码,影响这个站的代码。所以在多站点共存的状态下。

需要设置php-fpm 多进程池来解决。

参考https://blog.p2hp.com/archives/5789
一定要在所有站点的  /etc/php/7.4/fpm/pool.d/xxx.conf
添加 php_admin_value[opcache.preload] = /path/preload.php指令。
不要在php.ini中添加 opcache.preload= /path/preload.php指令。

 

参考  https://stitcher.io/blog/preloading-in-php-74

转载请注明来自Lenix的博客,地址 https://blog.p2hp.com/archives/6573

在PHP 7.4中使用预加载–Opcache Preloading
标签: