借助 torpedo,您可以轻松实现此架构,同时加快开发过程。在本指南中,我们将逐步介绍如何使用 torpedo 创建您的第一个项目,从安装到生成实体和用例。
- 鱼雷入门
在我们深入创建项目之前,请确保您的系统上安装了 go。然后,按照安装指南中的说明安装 torpedo
这个 cli 工具将为您处理项目生成、实体创建和用例脚手架。安装完成后,您就可以创建您的第一个项目了。
- 设置你的第一个项目
让我们开始使用我们的第一个使用 torpedo 构建的应用程序吧!我们将开发一款名为 booking fly 的机票预订应用程序。
安装 torpedo 后,创建新项目就像运行一样简单:
此命令将生成文件夹 .torpedo,您应该在其中定义实体和用例。有关此文件夹的更多信息可以在 .torpedo dir struct中找到 定义您的第一个实体
接下来,您需要定义域实体。实体是应用程序业务逻辑中的核心对象,代表用户、产品或订单等事物。
要定义您的第一个实体,请在 .torpedo/entities 目录下创建一个 yaml 文件。例如,让我们创建一个简单的 user 实体:
.torpedo/entities/user.yaml
此外,trip 实体是必需的,因此,让我们创建一个 trip 实体:
.torpedo/entities/trip.yaml
torpedo 将为 user 和 trip 实体生成 go 代码及其相应的 crud 操作,包括存储库接口和任何必要的数据库处理代码。创建用例
实体就位后,就可以使用用例定义它们如何与应用程序的工作流程交互。用例封装了作用于您的实体的业务规则和流程。
在 .torpedo/use_cases 目录下创建一个 yaml 文件来定义您的用例。以下是预订机票的简单用例示例:
.torpedo/use_cases/booking_fly.yaml
此定义告诉 torpedo 创建框架代码来放置自定义逻辑,用于处理给定行程和用户的飞行预订。
torpedo 将构建完整的用例,包括与您的实体的交互。
完成下一步 (#5) 后,请阅读快速入门指南,了解如何在用例中生成的框架用例中编写逻辑
- 将它们连接在一起
定义实体和用例后,torpedo 确保这些组件之间的连接遵循六边形架构原则。用例将通过服务接口与实体交互,而您的适配器(例如数据库或 api)则处理持久性和外部通信。
现在是时候编写您的应用程序规范以将所有内容放在一起了!应用程序定义是最重要的文件,因为这里描述了您的应用程序。以下示例展示了如何定义 booking fly 应用程序:
.torpedo/app.yaml
该命令将生成一个项目脚手架,设置基于六边形架构的目录结构。该项目将包括实体、用例和适配器的核心文件夹。它确保您的业务逻辑和基础设施从一开始就保持解耦。
您现在可以通过添加更多实体、用例甚至自定义适配器来扩展您的项目。 torpedo 的结构使您能够保持代码整洁和模块化,从而随着应用程序的增长轻松扩展应用程序。
另请参阅如何使用生成的用例代码编写自己的逻辑。
运行您的应用程序
设置实体和用例后,您就可以运行应用程序了。 torpedo 包括一个基于 gin gonic 项目的轻量级服务器,您可以运行它来进行测试和开发。只需使用:
您现在可以与应用程序的 api 交互,运行您定义的 crud 操作和用例。下一步是什么?
torpedo 使用六边形架构可以轻松生成干净、结构化的 go 代码。但这仅仅是开始!您可以通过添加更复杂的工作流程、集成外部服务以及自定义框架来满足您的需求,继续探索 torpedo 的功能。
请继续关注 torpedo 即将推出的更多高级功能,并在探索可能性时随时分享您的反馈!
结论
使用 torpedo 创建您的第一个项目既简单又快速。通过利用 yaml 中实体模式和用例定义的强大功能,您可以快速构建健壮的 golang 应用程序,同时保持简洁的架构原则。现在是时候投入并开始构建了!让我们知道您的想法以及 torpedo 如何帮助您未来的项目。