Arkitect 开源项目教程

Arkitect 开源项目教程

arkitectPut your architectural rules under test!项目地址:https://gitcode.com/gh_mirrors/ar/arkitect

项目介绍

Arkitect 是一个用于测试架构规则的开源项目。它允许开发者将架构规则置于测试之下，确保代码库遵循预定义的架构规范。Arkitect 通过提供一种方式来定义和验证架构规则，帮助团队维护代码的一致性和质量。

项目快速启动

安装

首先，确保你已经安装了 Composer，然后通过以下命令安装 Arkitect：

composer require --dev phparkitect/arkitect

配置

创建一个配置文件 arkitect.php，并添加以下内容：

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

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

    $rule = Rule::allClasses()
        ->that(new ResideInOneOfTheseNamespaces('App\Services'))
        ->should(new HaveNameMatching('*Service'))
        ->because('we want to identify services easily');

    $config->add($classSet, $rule);
};

运行

通过以下命令运行 Arkitect：

vendor/bin/arkitect check

应用案例和最佳实践

应用案例

Arkitect 可以用于各种项目，特别是大型项目或需要严格遵守架构规范的项目。例如，在一个电子商务平台中，可以使用 Arkitect 来确保所有的服务类都以 Service 结尾，并且位于 App\Services 命名空间下。

最佳实践

1. 定义清晰的规则：确保你的架构规则清晰且易于理解。
2. 定期运行检查：将 Arkitect 检查作为 CI/CD 流程的一部分，确保每次提交都符合架构规范。
3. 逐步引入规则：不要一次性引入太多规则，而是逐步增加，以便团队适应。

典型生态项目

Arkitect 可以与其他 PHP 生态项目结合使用，例如：

1. PHPStan：用于静态代码分析，与 Arkitect 结合可以提供更全面的代码质量保证。
2. PHPUnit：用于单元测试，确保代码的正确性。
3. Psalm：另一个静态代码分析工具，可以与 Arkitect 一起使用，提供多角度的代码检查。

通过结合这些工具，可以构建一个强大的代码质量保证体系，确保项目的长期稳定性和可维护性。

arkitectPut your architectural rules under test!项目地址:https://gitcode.com/gh_mirrors/ar/arkitect