后端企业应用【免费下载链接】mauticMautic: Open Source Marketing Automation Software.项目地址https://gitcode.com/GitHub_Trending/ma/mautic点击查看免费下载本文以 Mautic 仓库根目录的 AGENTS.md 为骨架系统梳理面向 AI 编码 Agent 的协作规范DDEV 容器化开发环境、PHPUnit/Codeception 测试体系、PHPStan/Rector 静态分析与代码质量工具链、Bundle 架构约定以及 Mautic 7.0 的平台要求与配置管理。读完本文你将掌握在这个 Symfony 7.4 PHP 8.2 巨型代码库中安全执行命令、编写测试、提交 PR 的完整套路并能对照仓库源码理解每一条规则的落地原理。项目概览Bundle 架构下的营销自动化平台Mautic 是一款开源营销自动化Marketing Automation平台当前仓库对应Mautic 7.0发行线技术栈为Symfony 7.4 PHP 8.2。代码按“Bundle”纵向切分app/bundles/核心功能CoreBundle、LeadBundle、CampaignBundle、EmailBundle、FormBundle 等plugins/第三方集成与扩展插件如 GrapesJsBuilderBundle、MauticCrmBundle 等themes/邮件/落地页主题约 40 套如 aurora、blank、sunday 等仓库根目录的 composer.json 将mautic/core-lib声明为^7.0依赖path 仓库指向app并列出全部插件的replace: self.version也就是说插件与主题通过 Composer 安装器分别落入app、plugins/{$name}、themes/{$name}见extra.installer-paths。命令执行规则一切以 ddev 包装器为准AGENTS.md 中最核心、也最容易被 AI Agent 忽略的规则是命令执行规则优先使用ddev包装器来运行 PHP、Composer、Symfony console 和 PHPUnit 命令不要直接在宿主机上运行php、composer、bin/console、bin/phpunit除非用户明确要求。推荐的调用形态ddev exec php bin/phpunit -c app/phpunit.xml.dist ... ddev exec php bin/console ... ddev composer ...原因很实际Mautic 依赖 MySQL/MariaDB、Redis、MailHog、Selenium 等服务DDEV 容器内环境PHP 版本、扩展、环境变量、服务地址与宿主机不一致直接跑bin/console会因缺少数据库连接或扩展而失败。仓库 .ddev/config.yaml 定义了该容器环境php_version: 8.5、webserver_type: apache-fpm、数据库为MariaDB 10.11恰好满足 Mautic 7.0 的MariaDB 10.11.0最低要求并额外安装php-imap扩展。开发环境搭建DDEV 方式推荐自动安装并配置一切ddev startddev start并非只启动容器。结合 .ddev/config.yaml 的post-starthooks 与 .ddev/mautic-setup.sh 可以看到启动后会依次执行修正换行符与脚本权限 → 询问是否由 DDEV 托管安装 → 执行composer install→ 从.ddev/local.config.php.dist生成根目录config/local.php→ 复制测试环境变量 → 运行php bin/console mautic:install site-url --force --no-interaction→cache:warmup→mautic:plugins:reload启用插件 → 构建 GrapesJs 编辑器前端资源。安装完成后默认登录凭据为admin / Maut1cR0cks!并附带 PHPMyAdmin8037 端口与 MailHog8026 端口用于查看 Mautic 发出的所有邮件。手动方式ddev composer install npm ci npm run build ddev exec php bin/console mautic:install site-urlmautic:install site-url是无交互安装命令的入口如果config/local.php已提供数据库与管理员参数见下文“配置管理”它即可在指定站点 URL 下完成安装。安装器代码位于app/bundles/InstallBundle/。测试体系PHPUnit 单元/功能测试 Codeception E2EAGENTS.md 给出的测试命令全部围绕ddev展开# 运行全部 PHPUnit 测试 ddev composer test # 运行指定测试文件 ddev exec php bin/phpunit -c app/phpunit.xml.dist app/bundles/EmailBundle/Tests/Functional/EmailClickTrackingTest.php # 运行指定 Bundle 的测试 ddev exec php bin/phpunit -c app/phpunit.xml.dist app/bundles/CoreBundle/Tests # 运行指定测试方法 ddev exec php bin/phpunit -c app/phpunit.xml.dist --filter testGuessTimezoneFromOffset # E2E 验收测试Codeception ddev composer run e2e-testcomposer test在 composer.json 中的真实定义是bin/phpunit -d memory_limit2G --bootstrap vendor/autoload.php --configuration app/phpunit.xml.dist即 2G 内存上限 加载 vendor 自动加载器。e2e-test则定义为APP_ENVtest bin/codecept run acceptance配合 codeception.yml 与tests/acceptance/下的场景用例如 ContactManagementCest.php、EmailScheduleCest.php执行浏览器级验收。PHPUnit 配置与套件划分app/phpunit.xml.dist 揭示了测试的组织方式强制APP_ENVtest、KERNEL_CLASSAppTestKernel、MAUTIC_ENVtest并预设IS_PHPUNIT常量默认套件Project Test Suite覆盖bundles/*Bundle/Tests并排除三个 Smoke 测试另有Container smoke tests控制器/命令/事件订阅者冒烟、Plugin tests、Middleware tests、Static analysis rule tests针对utils/rector与utils/phpstan的规则测试通过 PHPUnit 扩展注册了SeparateProcess、DbPrefix、SlowTest三个 bootstrap 扩展。功能测试基类 MauticMysqlTestCaseAGENTS.md 指明功能测试需继承Mautic\CoreBundle\Test\MauticMysqlTestCase它提供$this-emEntityManager、$this-client内核客户端与数据库访问。查看 MauticMysqlTestCase.php 的实现可以看到其关键机制setUp()强制db_driver pdo_mysql首次运行自动准备数据库并以admin用户登录建立会话默认开启useCleanupRollback利用事务回滚做测试清理$this-connection-beginTransaction()但注释也提醒了它的局限修改数据库结构的 DDL 查询会隐式提交事务全文搜索看不到未提交变更此时需关掉该开关tearDown()会校验setUp()是否被正确调用setUpInvoked忘记调用parent::setUp()会直接抛 LogicException——这是防止测试副作用的重要防线。以 EmailClickTrackingTest.php 为例一个典型功能测试会创建Lead、Email、Stat含 tracking hash与Page实体并持久化登出后用$this-client-request()模拟携带ct跟踪参数的 GET 请求最后断言Hit记录被正确创建且关联到对应联系人——完整验证了邮件点击跟踪链路的端到端行为。单元测试则继承原生PHPUnit\Framework\TestCase例如 DateTimeHelperTest.php 用#[TestDox]描述用例意图直接断言DateTimeHelper::guessTimezoneFromOffset()对 0、3600、-7200、-18000 秒偏移分别推断出Europe/London、Europe/Paris、America/Goose_Bay、America/New_York——这也正是 AGENTS.md 中--filter testGuessTimezoneFromOffset示例所指向的测试。代码质量工具链PHPStan、PHP-CS-Fixer、Rector、Twig LintAGENTS.md 推荐的四个质量门禁ddev composer phpstan # 静态分析level 6 ddev composer cs # 检查编码规范dry-run ddev composer fixcs # 自动修复编码规范 ddev composer rector # 运行 Rector 重构代码 测试 ddev exec php bin/console lint:twig app plugins # Lint Twig 模板结合 composer.json 的 scripts 段落可以看到这些命令的真实行为phpstan先检查并构建测试缓存容器再以memory_limit5G运行bin/phpstan analyse --ansi。项目在根目录维护 phpstan.neon 与 phpstan-baseline.neon历史问题基线并通过phpstan/extension-installer聚合 Doctrine、Symfony、PHPUnit 等扩展规则csbin/php-cs-fixer fix --dry-run --diff只报告不修改fixcs在 PHP-CS-Fixer 基础上追加bin/ecsEasyCodingStandard自动修复rectorbin/rector process --ansi基于 rector.php 配置批量升级代码仓库utils/rector/与utils/phpstan/还内置了项目自定义的 Rector 规则与 PHPStan 规则及其测试用例Twig 模板则通过lint:twig检查语法覆盖app与plugins两个目录。架构约定Bundle 内部结构与核心 BundleBundle 目录模式每个 Bundle 遵循统一布局AGENTS.md 中的示意结构仓库内如 EmailBundle、CampaignBundle 均按此组织MauticExampleBundle/ ├── Assets/ # 前端资源自动发现 │ ├── css/ │ └── js/ ├── Command/ # 控制台命令 ├── Config/ # Bundle 配置services 在 config.php 中 ├── Controller/ # 控制器继承 CommonController ├── Entity/ # Doctrine ORM 实体 仓库 ├── Event/ # 事件对象 ├── EventListener/ # 事件订阅者 ├── Form/ # 表单类型 ├── Model/ # 服务层继承 AbstractCommonModel ├── Tests/ # 单元 功能测试 │ ├── Unit/ │ └── Functional/ └── Views/ # Twig 模板各目录职责清晰Controller 负责 HTTP 层Model 承载业务服务Entity 映射数据库EventListener 订阅领域事件Assets 中的 css/js 会被自动发现并打包。核心 BundleCoreBundle基础层helpers、安全、基类app/bundles/CoreBundle/ 是全仓库最大的 BundleLeadBundle联系人/公司管理CampaignBundle营销活动构建器与执行引擎EmailBundle邮件营销FormBundle表单构建器IntegrationsBundle第三方集成框架。编码规范AGENTS.md 对代码风格有明确约定对应 ecs.php 与.php-cs-fixer配置PHP 8.2、declare(strict_types1)、PSR-12/Symfony 风格4 空格缩进、短数组语法[]、有序导入ordered imports显式类型与可空类型提示nullable hints尽量少写 DocBlock测试文件命名*Test.php与被测类/功能一一对应提交 PR 前必须composer cs否则 CI 会失败。平台要求与版本约束Mautic 7.0AGENTS.md 明确列出 Mautic 7.0 的硬性门槛PHP 8.2仓库.ddev/config.yaml已用 8.5 验证composer.json的config.platform.php锁定为 8.2.0保证依赖解析以 8.2 为基线MySQL 8.4.0 或 MariaDB 10.11.0已移除基于浏览器的更新只能走 CLI、MauticFactory改用依赖注入。这意味着开发新功能时不要触碰已废弃的全局工厂更新操作一律通过bin/console命令完成。PR 提交检查清单合入 PR 前需要按顺序通过AGENTS.md 原文ddev composer test # PHPUnit 测试全部通过 ddev composer phpstan # 静态分析通过 ddev composer cs # 编码规范检查通过如果改动涉及 UI还必须额外运行ddev composer run e2e-testCodeception 验收套件以覆盖浏览器交互层面的回归。配置管理AGENTS.md 给出了配置文件的分布规则结合仓库可以拼出完整图景本地配置config/local.php被 gitignore用于覆盖数据库、邮件、管理员等本地参数。仓库不直接提交该文件而是由 DDEV 从 .ddev/local.config.php.dist 自动生成——其中预置了db_driverpdo_mysql、db_hostdb、db_port3306、db_name/db_user/db_passworddb、管理员邮箱与密码admin_emailmauticddev.local / admin_passwordMaut1cR0cks!、mailer_dsnsmtp://localhost:1025指向 MailHog等一套可开箱即用的参数环境配置app/config/config_*.php如 config_dev.php、config_prod.php、config_test.php分别面向 dev/prod/test 环境测试环境APP_ENVtest配合app/config/config_test.php与根目录.env.test.local使用。这套“环境配置文件 本地覆盖文件 环境变量”的分层机制是 Mautic 能够在多环境间复用同一份代码、又能让每个开发者/Agent 在本地自由改库改邮件配置而不互相干扰的关键。结语AGENTS.md 看似只是一份给 AI Agent 的提示词实际上浓缩了 Mautic 仓库的工程化公约DDEV 容器是唯一的命令执行环境、功能测试必须继承MauticMysqlTestCase并理解其事务回滚机制、静态分析与编码规范是不可绕过的 CI 门禁、Bundle 布局是新增功能时照抄即可的标准模板。对于想要为 Mautic 贡献代码或在其上做二次开发的开发者与 AI Agent遵循这份规范就是最高效、最不容易踩坑的路径。赞分享后端企业应用【免费下载链接】mauticMautic: Open Source Marketing Automation Software.项目地址https://gitcode.com/GitHub_Trending/ma/mautic点击查看免费下载相关推荐BookStack 开发与测试指南从本地环境搭建到代码规范与自动化测试BookStack 开发与测试指南从本地环境搭建到代码规范与自动化测试 本指南以仓库 dev/docs/development.md https://link后端知识库知识管理文档ndb 贡献指南深度解读从环境搭建、代码规范到测试与 NPM 发布全流程ndb 贡献指南深度解读从环境搭建、代码规范到测试与 NPM 发布全流程 本篇技术指南以 CONTRIBUTING.md https://link.gitco开发工具Pillow 源码开发工作流指南从环境搭建、测试验证到代码规范提交Pillow 源码开发工作流指南从环境搭建、测试验证到代码规范提交 导读 本文以 Pillow 仓库根目录的 AGENTS.md https://link.g图像处理计算机视觉上一篇Sandboxie Classic NSIS 安装器构建指南从环境搭建到 32/64 位安装包产出下一篇Tiny11Builder指南如何构建精简版Windows 11镜像创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考