Effect-AWS 中动态配置 SNS 客户端的实践指南-CSDN博客

本文链接：https://blog.csdn.net/gitblog_07402/article/details/148296786

Effect-AWS 中动态配置 SNS 客户端的实践指南

effect-aws 🚰 Effectful AWS 项目地址: https://gitcode.com/gh_mirrors/ef/effect-aws

在 Effect-AWS 项目中，配置 AWS SNS 客户端时经常会遇到需要动态获取配置信息的情况。本文将深入探讨如何在 Effect 生态系统中优雅地处理这种动态配置场景。

基础配置方式

Effect-AWS 提供了简单的静态配置方式，可以直接传入 region 等参数：

import { SNS } from "@effect-aws/client-sns";

const program = SNS.publish(args);

const result = await pipe(
  program,
  Effect.provide(SNS.layer({ region: "eu-central-1" })),
  Effect.runPromiseExit,
);

这种方式适用于配置信息已知且固定的场景，但在实际应用中，我们往往需要从环境变量或运行时获取这些配置。

动态配置挑战

当配置信息需要从外部动态获取时，情况会变得复杂。例如：

凭证信息需要从专门的凭证提供者获取
Region 信息可能需要从环境变量读取
不同环境（开发/生产）可能需要不同的配置

解决方案

方案一：直接构建 Layer

我们可以直接构建一个包含动态配置的 Layer：

const custom = Layer.effect(SNSService, makeSNSService).pipe(
  Layer.provide(SNSClientInstanceLayer),
  Layer.provide(
    Layer.effect(
      SNSClientInstanceConfig,
      Effect.gen(function* () {
        const credentials = yield* AwsCredentialsProvider;
        const region = yield* Config.string("REGION").pipe(Config.withDefault("eu-central-1"));
        return makeDefaultSNSClientInstanceConfig.pipe(
          Effect.map((defaultConfig) => ({ ...defaultConfig, credentials, region })),
        );
      }),
    ).pipe(Layer.provide(AwsCredentialsProvider.Default)),
  ),
);

这种方式虽然可行，但代码较为冗长，不够简洁。

方案二：使用 Layer.unwrapEffect

更优雅的解决方案是利用 Layer.unwrapEffect：

export const SNSLive = Effect.gen(function* () {
  const credentials = yield* AwsCredentialsProvider;
  const region = yield* Config.string("REGION").pipe(Config.withDefault("eu-central-1"));
  return SNS.layer({ credentials, region });
}).pipe(Layer.unwrapEffect);

这种方法更加简洁，利用了 Effect 的组合特性，将动态获取配置的逻辑封装在一个 Effect 中，然后通过 Layer.unwrapEffect 转换为 Layer。

凭证提供者的实现

在实际项目中，我们通常会实现一个灵活的凭证提供者，根据环境不同使用不同的凭证策略：

class AwsCredentialsProvider extends Context.Tag("AwsCredentialsProvider")<
  AwsCredentialsProvider,
  AwsCredentialIdentityProvider
>() {
  static readonly Default = Layer.effect(
    this,
    Effect.gen(function* () {
      if (!isNodeEnvironment) {
        return yield* Effect.die("只能在Node环境中使用");
      } else {
        const { fromEnv } = yield* Effect.promise(() => import("@aws-sdk/credential-providers"));
        return fromEnv();
      }
    }),
  );
  
  static readonly Development = Layer.effect(
    this,
    Effect.gen(function* () {
      yield* Effect.annotateLogsScoped("service", "AwsCredentialsProvider");

      if (!isNodeEnvironment) {
        return yield* Effect.die("只能在Node环境中使用");
      } else {
        const env = (yield* Config.string("STAGE").pipe(
          Config.withDefault("development"),
        )) as Environment;
        const profile = Match.type<Environment>().pipe(
          Match.when("development", () => "myapp-dev"),
          Match.when("test", () => "myapp-test"),
          Match.when("staging", () => "myapp-dev"),
          Match.when("production", () => "myapp-prod"),
          Match.exhaustive,
        )(env);

        yield* Effect.logDebug(`使用AWS profile ${profile}`);
        const { fromSSO } = yield* Effect.promise(() => import("@aws-sdk/credential-providers"));
        return fromSSO({ profile });
      }
    }).pipe(Effect.scoped),
  );
}

这种实现方式可以根据不同环境自动选择合适的凭证获取方式，大大提高了代码的灵活性和可维护性。