yokai

妖怪

用于后端应用程序的简单、模块化和可观察的 Go 框架。

• 目标
• 文档
• 概述
  • 建筑学
  • 基础
  • 扩展
• 入门
• 陈列室
• 贡献

目标

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

但要构建production-grade应用程序，您需要投入大量精力和样板代码，从而引入甚至与应用程序逻辑无关的复杂性（例如依赖项连接、配置管理、可观察性检测等）。

为了解决这个问题，Yokai 的创建是为了实现以下目标：

• Simple ：它易于使用、配置和测试，使您能够快速迭代并快速交付可维护的应用程序。
• Modular ：它可以使用可用的 Yokai 模块或您自己的模块进行扩展，以构建可进化的应用程序。
• Observable ：它带有内置的日志记录、跟踪和指标工具，可以构建可靠的应用程序。

换句话说，Yokai 让您专注于应用程序逻辑，同时处理其余的事情。

文档

Yokai 的documentation位于 https://ankorstore.github.io/yokai。

概述

建筑学

• Yokai core modules预加载日志记录、跟踪、指标和运行状况检查工具，并公开私有 HTTP 服务器以满足基础设施和调试需求。
• 可以添加 Yokai extensions modules来丰富您的应用程序功能，例如公共 HTTP / gRPC 服务器、worker、ORM 等。您还可以添加 contrib 模块或您自己的模块。
• 这些在 Yokai dependency injection system中可用，您可以依靠它来构建您的应用程序逻辑。

基础

Yokai 是使用robust且well known Go 库构建的，例如：

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

扩展

Yokai 的extension system使您能够通过以下方式enrich您的应用程序功能：

• Yokai built-in模块
• Yokai 贡献模块
• 你自己的模块

入门

Yokai 提供现成的application templates来启动您的项目：

• 适用于 gRPC 应用程序
• 对于 HTTP 应用程序
• 对于工人应用程序

陈列室

Yokai 提供了一个展示室存储库，其中包含demo applications ，可以随时运行，以查看其实际效果：

• gRPC 演示应用程序
• HTTP 演示应用程序
• 工人演示应用程序

贡献

该存储库使用release-please来自动化Yokai的模块发布过程。

重要的

您必须提供原子提交和常规提交，因为发布过程依赖它们来确定要发布的版本并生成发行说明。