使用 Fastify 和 Express Gateway 构建 API 网关

API 网关是现代应用架构中非常重要的一环,它可以帮助我们实现反向代理、认证、路由、负载均衡等功能。本文将介绍如何使用 Fastify 和 Express Gateway 快速构建一个功能强大的 API 网关。

Fastify 简介

Fastify 是一个高度专注于提高性能的 Web 框架,它具有以下特点:

  • 快速:Fastify 的性能非常出色,它使用了很多高效的技巧来提高性能,比如结合了 V8 引擎的优化特性、使用了自定义的 JSON 解析器等等。
  • 低开销:Fastify 的内存消耗非常低,它只会加载必要的组件,而且它完全支持异步处理方式,这样可以避免多余的等待和阻塞。
  • 易扩展:Fastify 采用了插件机制,开发者可以很方便地添加自己的插件,也可以使用现有的插件来处理各种任务。

Express Gateway 简介

Express Gateway 是一个基于 Express 的 API 网关,它完全开放源代码,支持文档自动生成、可视化配置、多种认证方式等等。

Express Gateway具有以下特点:

  • 易用性强:Express Gateway 提供了一个非常易于使用的 UI 界面,可以帮助我们快速地完成各种配置任务。
  • 低耦合度:每个插件都是独立的组件,开发者可以根据需求来选择合适的插件组合。
  • 强大的插件机制:Express Gateway 的插件机制非常强大,除了集成了很多各种常见的插件,还可以快速的自建插件。

构建步骤

安装并启动 Fastify

首先,我们需要创建一个基本的 Fastify 应用。安装 Fastify 并编写示例代码:

const fastify = require('fastify')()

fastify.get('/', (req, res) => {
  res.send({ hello: 'world' })
})

fastify.listen(3000, (err, address) => {
  if (err) { console.error(err) }
  console.log(`Server listening on ${address}`)
})

安装并启动 Express Gateway

接着,我们需要安装并启动 Express Gateway,这里使用 Express Gateway 的官方示例来进行演示。在命令行输入以下命令启动 Express Gateway:

npx express-gateway init
cd my-gateway
eg gateway create
eg service create
eg route create
eg plugin install express-gateway-plugin-header-transform

安装完成后,可以在浏览器中通过默认的地址 http://localhost:8080/ 来访问 Express Gateway 的管理界面。

使用 Fastify 插件

接下来,我们需要为 Fastify 添加一个路由插件,这样才能够在 Express Gateway 中对其进行配置。这里我们使用 fastify-route-namespace 插件来为 Fastify 添加路由:

npm i fastify-route-namespace

在 Fastify 应用中进行如下配置:

const fastify = require('fastify')()
const routeNamespace = require('fastify-route-namespace')

fastify.register(routeNamespace)

fastify.route({
  method: 'GET',
  url: '/',
  handler: async (req, res) => {
    res.send({ hello: 'world' })
  },
  namespace: 'example'
})

fastify.listen(3000, (err, address) => {
  if (err) { console.error(err) }
  console.log(`Server listening on ${address}`)
})

效果如下:

curl http://localhost:3000/example/

将 Fastify 添加到 Express Gateway 中

最后,我们需要将 Fastify 添加到 Express Gateway 中,以实现反向代理和其他功能。

在 Express Gateway 的管理界面中,我们可以通过 UI 界面来完成添加操作,也可以通过 JSON 文件的方式来进行手动配置。

这里我们将在 Express Gateway 的插件列表中添加一个 reverse-proxy 插件,并将新的服务路由到 Fastify 应用中。配置文件如下:

{
  "$schema": "http://express-gateway.io/schemas/1.x.x/gateway-config.json",
  "apiEndpoints": {
    "example": {
      "host": "*",
      "port": 3000,
      "protocol": "http"
    }
  },
  "serviceEndpoints": {
    "fastify": {
      "url": "http://localhost:3000"
    }
  },
  "policies": [
    "cors",
    "proxy"
  ],
  "pipelines": {
    "example": {
      "apiEndpoints": [
        "example"
      ],
      "policies": [
        {
          "proxy": [
            {
              "action": {
                "serviceEndpoint": "fastify",
                "changeOrigin": true,
                "path": "/example", 
                "timeout": 3000
              }
            }
          ]
        }
      ]
    }
  }
}

现在可以访问 http://localhost:8080/example/ 来访问 Fastify 应用中的内容。

总结

本文介绍了如何使用 Fastify 和 Express Gateway 来构建一个完整的 API 网关,我们了解了 Fastify 的优势和易用性,并且熟悉了如何在 Express Gateway 中配置 Fastify。通过本文,希望读者可以轻松地实现自己的 API 网关,实现反向代理、认证、路由、负载均衡等各种功能。

来源:JavaScript中文网 ,转载请注明来源 本文地址:https://www.javascriptcn.com/post/65b46c6cadd4f0e0ffd57ce2