@adastradev/serverless-discovery-sdk 中文文档教程

Question

serverless-discovery-sdk-js

您永远想知道如何找到的最后一个无服务器微服务

AWS 无服务器发现 SDK 与发现微服务交互，以发现为无服务器架构编写的微服务的端点。 这类似于集群服务，例如 Consul 或 ZooKeeper，但没有必须监视在线状态的实例或节点的概念。 该库旨在支持在服务器端（用于服务到服务查找）和浏览器/客户端的使用。

该项目包含发现服务的 Typescript/Javascript 绑定； 其他绑定可以在 GitHub 上的 AdAstraDev 组织中找到

Installation

npm install @adastradev/serverless-discovery-sdk

Usage

Service/Cloud Dependencies

Semver 版本控制由发现服务 1.1.x 支持。 在 lookupService 调用中传递 semver 兼容值以接收最新的兼容匹配版本。 服务及其所需版本也可以在 package.json 的 cloudDependencies 字段中指定。

{
  "cloudDependencies": {
    "service1": "1.x",
    "service2": "^1.2.8-testbranch", // A pre-release version for development purposes
    "service3": "3.x.x"
  }
}

Version Postfix values

在某些测试环境中，修改查找版本以避免与生产环境发生冲突可能很有用。 如果 VERSION_POSTFIX 环境变量在运行时，它总是将此附加到查找调用的版本。

如果您要查找高度耦合或没有很好隔离的服务，并将它们用于系统测试，您应该：

• Set the VERSION_POSTFIX environment variable set to -staging
• Pass the environment variable through to the runtime where lookups are happening (lambda, docker, etc.)

如果查找 serviceA，版本 1.1.0，它只会与 1.1.0-staging 对话。 当环境变量存在时，所有查找调用都将遵循类似的模式。

TL;DR：如果您正在查找未很好隔离的服务，并且依赖暂存环境来避免对生产数据库/资源​​进行操作，请在暂存部署/测试中将以下内容添加到您的管道中步。

bitbucket-pipelines.yml：

- export VERSION_POSTFIX='-staging'
# Deployment steps follow...

serverless.yml

provider:
  environment:
    VERSION_POSTFIX: ${env:VERSION_POSTFIX, ''}

Code Example

我建议设置一个实用函数来处理 SDK 的构建和查找调用 - 请参见下面的示例。

import { DiscoverySdk } from '@adastradev/serverless-discovery-sdk';

export default async function lookup(serviceName) {

  const sdk = new DiscoverySdk(
    process.env.DISCOVERY_SERVICE_URL,
    process.env.DISCOVERY_SERVICE_REGION,
    // Non-versioned services will default to lookup via this stage
    process.env.DEFAULT_STAGE,
    undefined,
    // Create map of cloudDependencies from package.json
    new Map(Object.entries(require('../path/to/package.json')['cloudDependencies'])),
  );

  const endpoints = await sdk.lookupService(
    serviceName
  );

  return endpoints[0];

}