Yokai

Yokai

简单、模块化且可观测的 Go 后端应用框架。

• 目标
• 文档
• 概览
  • 架构
  • 基础
  • 扩展
• 开始使用
• 展示
• 贡献

目标

使用 Go 构建后端应用非常棒。

但要构建生产级应用，你需要投入大量精力并编写样板代码，这会引入与应用逻辑无关的复杂性（例如依赖注入、配置管理、可观测性检测等）。

为了解决这个问题，Yokai 的创建秉持以下目标：

• 简单：易于使用、配置和测试，让你能够快速迭代，并交付易于维护的应用。
• 模块化：可以通过现有的 Yokai 模块或自定义模块进行扩展，从而构建可持续演进的应用。
• 可观测：内置日志记录、追踪和指标检测功能，助力构建可靠的应用。

换句话说，Yokai 让你专注于应用逻辑，其余工作则由它负责。

文档

Yokai 的文档可在 https://ankorstore.github.io/yokai 查阅。

概览

架构

• Yokai 核心模块预加载日志记录、追踪、指标和健康检查检测功能，并提供一个私有 HTTP 服务，以满足基础设施和调试需求。
• 可以添加 Yokai 扩展模块来丰富应用功能，例如公共 HTTP / gRPC 服务、工作进程、ORM 等。你还可以添加贡献模块或自定义模块。
• 这些模块可在 Yokai 依赖注入系统中使用，你可以依托该系统构建应用逻辑。

基础

Yokai 基于健壮且广为人知的 Go 库构建，例如：

• Echo，用于 HTTP 服务
• gRPC-go，用于 gRPC 服务
• Viper，用于配置管理
• OTEL，用于可观测性检测
• Fx，用于依赖注入系统
• 等等。

扩展

Yokai 的扩展系统支持通过以下模块丰富应用功能：

• Yokai 内置模块
• Yokai 贡献模块
• 自定义模块

开始使用

Yokai 提供开箱即用的应用模板，供你启动项目：

• gRPC 应用
• HTTP 应用
• MCP 应用
• 工作进程应用

展示

Yokai 提供了一个 展示仓库，其中包含可直接运行的 demo applications，方便你了解其运行效果：

• gRPC 演示应用
• HTTP 演示应用
• MCP 演示应用
• worker 演示应用

贡献

此仓库使用 release-please 自动化 Yokai 模块的发布流程。

重要

你必须提供 原子提交和约定式提交，因为发布流程依赖这些提交来确定要发布的版本并生成发布说明。