NestJS 微服代码组织

组织代码之前看 NestJS 社区有什么?

  • 具有 workspace 的功能包管理工具 pnpm/yarn/npm 等
  • NestJS CLi 提供的 monorepo 模式
  • Nx 一个全栈管理框架
  • Turbo monorepo 管理工具

以下文章都建立在 pnpm + workspace 基础上, 以 gRPC 为例的微服务。

以 api-gateway 方式暴露 api

此模式的特点是: api-gateway 方式实现 api,但是具体的业务逻辑放在微服务汇总,api-gateway 实现的内容需要通过 gRPC 调用远程微服务函数实现。

特点:

  • 使用 api-gateway 服务对外暴露 api。
  • 使用 微服务 完成业务逻辑。
  • 使用 tcp/gRPC 等在 api-gateway 服务器之间进行通信。
  • 自己就是一整模块功能的实现。

缺点:

  • 功能不单一,有业务聚合性。

进阶:

  • 聚合接口:有些模块不需要实现自己的业务,但是需要对外暴露接口,此需要聚合其他业务的微服务,使得此时开发的层级加深。

一个目录结构:

ts 复制代码
.
├── REAMEME.md
├── package.json
├── packages
│   ├── api-gateway
│   └── ms-user
├── pnpm-lock.yaml
└── pnpm-workspace.yaml

服务与微服务

此模式的特点是:微服务与服务一起对外暴露,服务一般对外暴露 api, 而 微服务一般用来暴露内部通信使用。

特点

  • 自己就是一个 api-gateway,功能专一
  • 一般需要实现两套 api, http api 对外,给 nginx 等方向代理,gRPC 等微服务,对内,提供给其他微服务。

缺点

  • 每一个模块就是一个项目,单人的管理难度增大。

看起来目录结构:

tree 复制代码
.
├── REAMEME.md
├── nginx
│   └── nginx.conf
├── package.json
├── packages
│   ├── ms-link
│   ├── ms-tag
│   └── ms-user
├── pnpm-lock.yaml
└── pnpm-workspace.yaml

管理微服务

启动微服务

使用 pnpm 的平行运行脚本能力

sh 复制代码
{
    "scripts": {
        "dev:be": "pnpm -r --parallel --filter=./packages/* run start:dev",
    }
}

要运行 packages 目录下的所有项目,启动命令是 run start:dev, pnpm 会以颜色作为区分输出不同的醒目的输出内容。

启动具有 debug 功能的微服务

此处以 VS Code 为例,添加 launch.json 文件, 同时还需要在 pnpm 的根目录添加脚本配置

  • 根目录脚本
ts 复制代码
{
    "scripts": {
        "dev:api-gateway": "pnpm run --filter=api-gateway start:dev",
        "dev:ms-user": "pnpm run --filter=ms-user start:dev",
    }
}
  • VS Code 对应的配置
json 复制代码
{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "launch",
      "name": "api-gateway",
      "runtimeExecutable": "pnpm",
      "args": ["run", "dev:api-gateway"],
      "skipFiles": ["<node_internals>/**"],
      "console": "integratedTerminal"
    },
    {
      "type": "node",
      "request": "launch",
      "name": "dev:ms-user",
      "runtimeExecutable": "pnpm",
      "args": ["run", "dev:ms-user"],
      "skipFiles": ["<node_internals>/**"],
      "console": "integratedTerminal"
    }
  ]
}

在后就可以在 VS Code 调试中找到配置可选的调试工具了。

小结

本文主要探索了 NestJS 微服代码组织探索,两种模式:一种是 api-gateway 实现业务逻辑,另外一种是全部微服务化使用 nginx 实现反向代理。然后再 VS Code 中实现了启动调试微服务的能力。希望这些探索能够帮助大家。

相关推荐
Mh2 小时前
我是如何设计品牌站组件库的?
前端·css·设计模式
程序员大阳2 小时前
副队长Vue3教程(2)--Vite 搭建 Vue 项目,认识目录结构
前端·javascript·vue.js·vite·创建项目·目录结构·项目结构
濮水大叔3 小时前
Cabloy/Zova 与 Next.js 的 SSR 水合差异
前端·typescript·next.js
码事漫谈3 小时前
以后人人都可以成为导演
后端
SoaringHeart3 小时前
Flutter最佳实践:用 flutter_html 渲染富文本
前端·flutter
Resean02233 小时前
Spring 源码分析(二)配置类的解析与扫描
java·后端·spring
一只爱撸猫的程序猿3 小时前
五周、两个开源仓库、九次拦截之后:AI 时代程序员缺的到底是什么
人工智能·后端·开源
Flynt4 小时前
Chrome给AI编程助手塞了203篇前端规范,我拆包实测:检索0.77秒是真快,扫描器有点挑食
前端·chrome·ai编程
北城笑笑5 小时前
Vue 110 ,若依SSE流式接口限次空500排查与解决
前端·javascript·vue.js·后端·vue
程序员韩星5 小时前
OpenAI 兼容接口返回 404,先查请求地址,再查模型名
前端·人工智能·http