encore

Encore是一个用于构建分布式系统的开发平台，具有自动化的基础设施

Encore包括从本地开发到云端的端到端工具：

开源后端框架（支持TypeScript和Go），允许您直接在应用程序代码中声明式地定义API和基础设施语义。
开源本地开发环境，包含追踪、服务目录等多种工具。
云平台，可在您自己的AWS和GCP云上自动化DevOps和基础设施配置。

🏁 尝试Encore： 快速入门指南

💻 查看示例应用： 示例应用程序库

🚀 探索使用Encore构建的产品： 展示区

⭐ 为本仓库点星以帮助传播。

👋 有问题吗？ 加入Discord上友好的开发者社区。

📞 看看Encore是否适合您的项目： 预约1对1介绍。

🍿 介绍视频

观看介绍视频，快速了解Encore概念和代码示例。

Encore简介

云服务使我们能够构建高度可扩展的应用程序，但往往导致糟糕的开发者体验——迫使开发人员在开发过程中管理大量复杂性，并进行大量重复的手动工作。

Encore专为解决这个问题而设计，为后端开发提供了一套完整的工具集——从本地开发和测试，到云基础设施管理和DevOps。

Encore概览

工作原理

Encore的开源后端框架支持TypeScript和Go，让您可以在应用程序代码中将服务、数据库、定时任务和发布/订阅等资源定义为类型安全的对象。

使用后端框架，您只需定义基础设施语义——即_影响应用程序行为的事物_——而不是_特定_云服务的配置。Encore解析您的应用程序并构建其逻辑架构和基础设施需求的图谱，然后自动生成样板代码并为每个环境编排相关基础设施。这意味着您的应用程序代码可以用于本地运行、在预览环境中测试，以及在AWS和GCP的云环境中配置和部署。

这完全消除了对单独的基础设施配置（如Terraform）的需求，提高了代码库和基础设施的标准化程度，并使您的应用程序默认可在云提供商之间移植。

当您的应用程序部署到云中时，不存在对Encore的运行时依赖，并且云中不运行任何专有代码。

示例：Hello World

定义微服务和API端点非常简单，只需不到10行代码就可以定义一个可生产就绪的可部署服务和API端点。

使用TypeScript后端框架，它看起来是这样的：

import { api } from "encore.dev/api";

export const get = api(
  { expose: true, method: "GET", path: "/hello/:name" },
  async ({ name }: { name: string }): Promise<Response> => {
    const msg = `Hello ${name}!`;
    return { message: msg };
  }
);

interface Response {
  message: string;
}

使用Go后端框架，它看起来是这样的：

package hello

//encore:api public path=/hello/:name
func World(ctx context.Context, name string) (*Response, error) {
	msg := fmt.Sprintf("Hello, %s!", name)
	return &Response{Message: msg}, nil
}

type Response struct {
	Message string
}

示例：使用发布/订阅

如果您想要一个发布/订阅主题，可以直接在应用程序代码中声明它，Encore将自动为每个环境配置基础设施并生成必要的样板代码：

本地开发使用NSQ
GCP环境使用GCP Pub/Sub
AWS环境使用SNS/SQS

使用TypeScript后端框架，它看起来是这样的：

import { Topic } "encore.dev/pubsub"

export interface SignupEvent {
    userID: string;
}

export const signups = new Topic<SignupEvent>("signups", {
    deliveryGuarantee: "at-least-once",
});

使用Go后端框架，它看起来是这样的：

import "encore.dev/pubsub"
 
type User struct { /* 字段... */ }
 
var Signup = pubsub.NewTopic[*User]("signup", pubsub.TopicConfig{
  DeliveryGuarantee: pubsub.AtLeastOnce,
})
 
// 通过调用方法发布消息
Signup.Publish(ctx, &User{...})

在文档中了解更多

查看如何在文档中使用后端框架：

服务和API： Go / TypeScript
数据库： Go / TypeScript
定时任务： Go / TypeScript
发布/订阅： Go / TypeScript
缓存： Go / TypeScript（即将推出）

使用Encore：从本地到云端的端到端工作流程

Encore为开发过程的每个步骤提供专门的工具，从本地开发和测试到云端DevOps。这里我们将介绍流程各部分的主要功能。

本地开发

当您使用Encore CLI在本地运行应用程序时，Encore会解析您的代码并自动设置必要的本地基础设施。不再需要折腾Docker Compose！

您还可以获得内置工具，用于创建分布式系统和事件驱动应用程序时的高效工作流程：

本地环境与云环境匹配： Encore自动处理服务通信的语义和与不同类型基础设施服务的接口，使本地环境成为云环境的1:1表示。
跨服务类型安全： 使用Encore构建微服务应用时，在进行跨服务API调用时，您可以在IDE中获得类型安全和自动完成功能。
类型感知基础设施： 使用Encore，像Pub/Sub队列这样的基础设施在您的程序中是类型感知的对象。这在构建事件驱动应用时实现了端到端的类型安全。
密钥管理： 为所有环境内置密钥管理。
追踪： 本地开发仪表板提供本地追踪功能，帮助理解应用行为并发现错误。
自动生成API文档和客户端： Encore生成Go、TypeScript、JavaScript和OpenAPI规范的API文档和API客户端。

以下是展示本地开发仪表板的视频：

https://github.com/encoredev/encore/assets/78424526/4d066c76-9e6c-4c0e-b4c7-6b2ba6161dc8

测试

testing

Encore提供了几个内置工具来帮助测试：

内置服务/API模拟： Encore提供内置支持模拟API调用，以及自动为您的服务生成模拟对象的接口。
本地测试基础设施： 在本地运行测试时，Encore自动提供专用测试基础设施以隔离单个测试。
本地测试追踪： 本地开发仪表板为测试提供分布式追踪，提供良好的可见性，便于了解发生的情况并更容易理解测试失败的原因。
预览环境： Encore自动为每个Pull Request配置预览环境，这是进行端到端测试时的有效工具。

DevOps

使用Encore，您可以将工程精力集中在产品上，避免花时间构建开发者平台。

Encore提供的一个核心功能是在您的云中自动配置基础设施。由于您的应用代码是应用基础设施需求的真实来源，因此无需编写Terraform、YAML或在云控制台中点击，您只需连接您的云账户并部署。这种方法还允许您随时更换基础设施，无需进行代码更改或手动更新基础设施配置文件。

部署时，Encore自动使用AWS和GCP上经过实战检验的云服务配置基础设施，例如：

计算： GCP Cloud Run、AWS Fargate、Kubernetes（GKE和EKS）
数据库： GCP Cloud SQL、AWS RDS
发布/订阅： GCP Pub/Sub、AWS SQS/SNS
缓存： GCP Memorystore、Amazon ElastiCache
密钥： GCP Secret Manager、AWS Secrets Manager
等等。

Encore还提供内置的DevOps工具，帮助自动化90%以上的日常DevOps工作：

自动最小权限IAM： Encore解析您的应用代码并设置最小权限IAM以匹配应用的需求。
基础设施跟踪和审批工作流： Encore跟踪所有它配置的基础设施，并在部署过程中提供审批工作流，以便管理员可以验证和批准所有基础设施变更。
云配置双向同步： Encore提供简单的UI进行配置更改，还支持同步您在AWS/GCP云控制台中进行的更改。
成本分析： 提供简单的概览，用于监控Encore在您的云中配置的所有基础设施的成本。
日志和指标： Encore自动提供日志记录、指标，并集成第三方工具，如Datadog和Grafana。
服务目录： Encore自动生成包含完整API文档的服务目录。
架构图： 为帮助入职和协作，Encore为您的应用生成架构图，包括基础设施依赖关系。
通过Encore的Terraform Provider扩展： 使用您需要的任何基础设施服务扩展您的系统，集成很简单，因为所有基础设施都在您的云中配置。Encore还有一个Terraform Provider来简化这个过程。