NestJS微服务代码组织那些事

见解分享

2023-05-19 19:33:18

NestJS 微服务的代码组织指南

在微服务架构中，将庞大应用程序分解为较小的、独立的服务至关重要。NestJS 是构建微服务的强大框架，它提供了卓越的功能和组织选项。

工具与技术

以下是帮助你组织 NestJS 微服务代码的实用工具和技术：

工作空间包管理工具： pnpm、yarn 或 npm 能够管理不同微服务的依赖关系。
Nx Monorepo 模式： NestJS CLI 提供的 Nx 允许你将所有代码存储在一个代码库中，从而简化管理。
T 全栈管理框架： T 涵盖了微服务应用程序的整个生命周期，包括开发、部署和维护。

使用工作空间包管理工具

使用工作空间包管理工具，请遵循以下步骤：

安装 pnpm/yarn/npm。
创建一个 "workspaces" 文件夹。
为每个微服务创建一个子文件夹。
在每个子文件夹中创建 "package.json" 文件。
指定微服务的依赖关系。
运行 "pnpm/yarn/npm install"。

使用 Nx Monorepo 模式

通过 Nx 组织代码，遵循这些步骤：

安装 Nx。
创建一个 "nx.json" 文件。
指定微服务的工作空间。
在每个工作空间中创建 "tsconfig.json" 文件。
指定编译器选项。
运行 "nx build"。

使用 T 全栈管理框架

利用 T 管理应用程序，请执行以下操作：

安装 T。
创建一个 ".t" 文件夹。
创建一个 "config.json" 文件。
指定配置信息。
运行 "t start"。

代码示例

使用 Nx Monorepo 模式组织代码：

// nx.json
{
  "projects": {
    "api-gateway": {
      "type": "application",
      "root": "apps/api-gateway",
      "sourceRoot": "apps/api-gateway/src",
      "targets": {
        "build": {
          "executor": "@nrwl/nest:build",
          "options": {
            "outputPath": "dist/apps/api-gateway"
          }
        },
        "deploy": {
          "executor": "@nrwl/nest:deploy"
        }
      }
    },
    "auth-service": {
      "type": "application",
      "root": "apps/auth-service",
      "sourceRoot": "apps/auth-service/src",
      "targets": {
        "build": {
          "executor": "@nrwl/nest:build",
          "options": {
            "outputPath": "dist/apps/auth-service"
          }
        },
        "deploy": {
          "executor": "@nrwl/nest:deploy"
        }
      }
    }
  }
}

// package.json
{
  "name": "auth-service",
  "dependencies": {
    "@nestjs/common": "^8.0.0",
    "@nestjs/core": "^8.0.0",
    "@nestjs/jwt": "^8.0.0"
  }
}