arkitect

PHPArkitect 项目介绍

PHPArkitect 是一个专为 PHP 项目设计的工具，它旨在帮助开发者维护代码的一致性和稳固性。通过添加架构约束检查，PHPArkitect 允许开发者在代码库中执行自动化规则检测，从而确保代码的结构符合预期的设计原则。

项目安装

PHPArkitect 提供了两种安装方式：使用 Composer 和使用 Phar 文件。对于依赖项可能产生冲突的项目，可以选择使用 Phar 文件，因为它是一个自包含的 PHP 可执行文件。

使用 Composer

要通过 Composer 安装 PHPArkitect，只需在终端执行以下命令：

composer require --dev phparkitect/phparkitect

使用 Phar 文件

如果项目中存在依赖冲突，可以通过下载 Phar 文件来执行 PHPArkitect。使用以下命令下载并运行：

wget https://github.com/phparkitect/arkitect/releases/latest/download/phparkitect.phar
chmod +x phparkitect.phar
./phparkitect.phar check

如何使用

一旦安装完成，可以在命令行中使用 phparkitect check 命令来运行工具。默认情况下，它会在项目根目录下寻找名为 phparkitect.php 的配置文件。开发者也可以通过 --config 参数来指定其他配置文件。默认执行时，会有一个进度条显示当前分析的进度。

使用基线文件

如果代码中有许多当前无法修复的违规，开发者可以使用基线功能来忽略过去的违规。通过运行以下命令生成基线文件：

phparkitect check --generate-baseline

生成的基线文件是 JSON 格式的，默认名为 phparkitect-baseline.json。可以通过 --use-baseline 参数指定不同的基线文件，也可以通过 --skip-baseline 参数来忽略默认基线文件。

配置示例

以下是一个简单的配置文件示例：

<?php
declare(strict_types=1);

use Arkitect\ClassSet;
use Arkitect\CLI\Config;
use Arkitect\Expression\ForClasses\HaveNameMatching;
use Arkitect\Expression\ForClasses\NotHaveDependencyOutsideNamespace;
use Arkitect\Expression\ForClasses\ResideInOneOfTheseNamespaces;
use Arkitect\Rules\Rule;

return static function (Config $config): void {
    $mvcClassSet = ClassSet::fromDir(__DIR__.'/mvc');

    $rules = [];

    $rules[] = Rule::allClasses()
        ->that(new ResideInOneOfTheseNamespaces('App\Controller'))
        ->should(new HaveNameMatching('*Controller'))
        ->because('we want uniform naming');

    $rules[] = Rule::allClasses()
        ->that(new ResideInOneOfTheseNamespaces('App\Domain'))
        ->should(new NotHaveDependencyOutsideNamespace('App\Domain'))
        ->because('we want protect our domain');

    $config->add($mvcClassSet, ...$rules);
};