让你的 laravel 实现环境自检（检查）细读源码之 laravel-self-diagnosis

前言

项目部署有时候是很烦人的，由于环境的不同导致的诸多问题，有时候问题会在安装的时候出现，比如 PHP 的扩展，有时候可能是在运行起来之后的问题，比如数据库连接失败、连接失败、进程维护（Redis 队列需要后台的进程维护，通常是 supervisor）等。前者尚好，后者则会产生意向不到的问题，于是检验程序是否符合预期的状态运行便成为一项必不可少的部署步骤。

那么有没有一款工具能够实现 “自检” 呢？

当然，这是有的，正如标题所述，今天就来看一看，Laravel 项目或者 PHP 项目如何实现自检功能。

安装 `laravel-self-diagnosis`

laravel-self-diagnosis

composer require beyondcode/laravel-self-diagnosis

发布配置文件

php artisan vendor:publish --provider=BeyondCode\\SelfDiagnosis\\SelfDiagnosisServiceProvider

配置解读

environment_aliases
顾名思义，也就是环境别名，你的环境名称也许是 production、development、live、product、develop等，这个环境别名用于针对环境别名做一些兼容。
checks
通用的检查，无论何种环境，你都需要进行的检查。作者封装了诸多的检查环境类。
environment_checks
区别于环境的检查，其检查针对于生产环境与开发环境。

执行检查

php artisan self-diagnosis

image.png

自定义检查

姑且自拟一个域名检查，简单的设置一下虚拟主机域名（虚拟主机域名不再详述，各位自行查阅资料）为：happyphper.test，那么在 .env 对 APP_URL 进行设置

APP_URL=http://happyphper.test

假定我们有一个接口是为了该检查而做的，在 routes/web.php 增加一条这样的路由：

Route::get('/access', function () {
    return 'Accessed';
});

那么创建检查类，姑且称之为 DomainIsAccessible，位于 app/Diagnosis 下。

<?php

namespace App\Diagnosis;

use BeyondCode\SelfDiagnosis\Checks\Check;

class DomainIsAccessible implements Check
{
    /**
     * 域名是否可访问
     *
     * @param array $config
     * @return string
     */
    public function name(array $config): string
    {
        return trans('self-diagnosis::checks.domain_is_accessible.name');
    }

    /**
     * 检查是否域名能够正常访问，并且有正确返回值
     *
     * @param array $config
     * @return bool
     */
    public function check(array $config): bool
    {
        try {
            $content = file_get_contents($config['domain']);
        } catch (\Exception $exception) {
            $content = null;
        }

        return 'Accessed' === $content;
    }

    /**
     * 错误信息
     *
     * @param array $config
     * @return string
     */
    public function message(array $config): string
    {
        return trans('self-diagnosis::checks.domain_is_accessible.message', $config);
    }
}

笔者在此为了方便，使用了 file_get_contents 函数，你也可以使用 curl 或者 shell_exec exec 等完成。

完善一点，还需要添加一些本地化的信息。在 resources/lang/vendor/self-diagnosis/en 下的 checks 文件中，添加一条数据

<?php
return [ 
    // ...
    'domain_is_accessible' => [
        'message' => 'The :domain domain cannot be accessed.',
        'name' => 'The domain is accessed.',
    ],
];

在 config/self-diagnosis.php 中加入自定义的检查类。

<?php
return [
     // ...
    'checks' => [
        // ...
        \App\Diagnosis\DomainIsAccessible::class => [
           'domain' => config('app.url') . '/access'
        ],
    ]
];

此时，自定义的检查类就搞定了。再次执行命令，你会看到这样的效果。

image.png

源码精读

配置检查，比如 app_key ，它其实就是进行了检查类中定义了这样的操作

return config('app.key') !== null;

数据库检查，是使用类库中提供的方法策略。

// Database
DB::connection()->getPdo();
// Redis
Redis::connection($name)->connect()->isConnected();

文件检查是利用了 file_exists() 函数。
PHP 版本的检测是利用了 composer.json 中需求版本，与 PHP 常量 5. PHP_VERSION 正在使用的 PHP 版本，再利用 version_compare() 对比得出的。
package 包检查是利用 composer 的 --dry-run （专用于演示，无副作用）搞定的。
迁移检测是利用了 php artisan migrate --pretend （专用于演示，无副作用）搞定的。
环境变量是否设置是利用了提取 .env 与 .env.example 变量后，进行对比搞定的。

如果你看了源码，你也会感觉，哦，如此这般，竟如此简单。

写在最后

源码的阅读有利于你的编码，和补充一下你未读到的 PHP 知识，笔者就是看了源码，才得到一些之前未领悟到的东西。希望本篇文章有帮助到你，请您也不要吝惜你的喜欢和赞赏。