使用 Fastify 和 GitHub Actions 在生产环境中自动部署 Node.js 应用程序

在现代 Web 开发中,快速部署应用程序是至关重要的一个环节。为了实现高效的部署流程,我们可以借助一些工具和服务,例如 FastifyGitHub Actions

Fastify 是 Node.js 的一个快速、低开销的 Web 框架,相较于其他框架,它在性能方面表现十分优异,且易于使用。而 GitHub Actions 是一个 CI/CD 工具,可以用于自动化测试、构建和部署等操作。

在本文中,我们会介绍如何使用 Fastify 和 GitHub Actions 将 Node.js 应用程序自动部署到生产环境中。

1. 准备工作

在开始实现自动化部署之前,我们需要完成一些准备工作。首先,需要确保已经安装了 Node.js 和 Git。同时,我们需要一个 GitHub 账号来创建一个代码仓库(Repository)。

  1. 安装 Node.js:可以在官网下载对应平台的安装包,并完成安装。

  2. 安装 Git:可以在官网下载对应平台的安装包,并完成安装。

  3. 创建 GitHub 仓库:在GitHub首页中点击右上角的加号,选择“New repository”,填写仓库名称即可创建。

2. 编写 Fastify 应用程序

在开始部署前,我们需要先编写一个简单的 Fastify 应用程序来测试。在本例中,我们会创建一个简单的 Web 服务,用于展示一个 Hello World 页面。下面是示例代码:

const fastify = require('fastify')()

fastify.get('/', async (request, reply) => {
  return { message: 'Hello World!' }
})

const start = async () => {
  try {
    await fastify.listen(3000)
    console.log('Fastify server running on port 3000')
  } catch (err) {
    console.error(err)
    process.exit(1)
  }
}
start()

运行上述代码后,应用程序会在本地 3000 端口启动,访问 http://localhost:3000 可以看到 Hello World! 页面。

3. 配置 GitHub Actions

接下来,我们需要配置 GitHub Actions,使其能够自动构建、测试和部署我们的应用程序。在 GitHub 仓库中,点击页面顶部的“Actions”,进入到 Actions 面板。然后,点击“New workflow”,创建一个新的 Workflow 文件。文件名可以任意命名,本例中我们使用的是 deploy.yml。

name: Deploy

on:
  push:
    branches:
      - master

jobs:
  deploy:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout Code
      uses: actions/checkout@v2

    - name: Install Node.js
      uses: actions/setup-node@v2-beta
      with:
        node-version: '12.x'

    - name: Install Dependencies
      run: npm install

    - name: Build Application
      run: npm run build

    - name: Deploy Application
      uses: peaceiris/actions-gh-pages@v3
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: ./build

上述代码定义了一个 Workflow,指定了在 push 代码到 master 分支时触发,然后进行构建、测试和部署。因为我们使用的是 Fastify,所以我们不需要运行测试步骤。最后,在 Deploy Application 步骤中,我们使用了 peaceiris/actions-gh-pages Action,它会将构建生成的文件上传到 GitHub Pages。这一步非常重要,因为我们需要将应用程序放到一个公共服务器上,使得外界可以通过 URL 访问该应用。

4. 构建并部署应用程序

现在,我们已经完成了全部准备工作,可以开始构建并部署应用程序了。让我们按照以下步骤进行:

  1. 将上述代码保存到一个名为 app.js 的文件中。

  2. 在应用程序代码所在的目录中,运行以下命令:

    npm init -y
    npm install fastify

    这样可以初始化并安装 Fastify 库作为依赖项。

  3. 创建一个名为 index.html 的文件,并将以下代码复制到文件中:

    <!doctype html>
    <html>
      <head>
        <title>Hello World!</title>
      </head>
      <body>
        <h1>Hello World!</h1>
        <p>Welcome to Fastify!</p>
      </body>
    </html>
  4. 在 package.json 文件中添加以下两个脚本:

    "scripts": {
      "start": "node app.js",
      "build": "mkdir build && cp index.html build && cp -r public/* build"
    }

    上述脚本在执行 npm run build 命令时,会创建一个名为 build 的目录,并将 index.html 文件和 public 目录中的所有文件复制到该目录中。

  5. 切换到 GitHub 仓库的“Settings”页面,并启用 GitHub Pages,将 Source 选项设置为 master 分支中的 /docs 目录。

  6. 将应用程序部署到 GitHub Pages:

    • 运行以下命令添加代码到 Git 并推送到 GitHub 仓库:

      git init
      git remote add origin https://github.com/<username>/<repository>.git
      git add .
      git commit -m "Initial commit"
      git push -u origin master

      这里需要将命令中的 和 替换为实际的值。

    • 在 GitHub Actions 面板中,可以看到自动构建操作正在执行。如果一切顺利,应用程序将自动部署到 GitHub Pages。

  7. 访问 GitHub Pages 站点,即可看到 Fastify 应用程序的 Hello World 页面。

5. 总结

在本文中,我们介绍了如何使用 Fastify 和 GitHub Actions 在生产环境中自动部署 Node.js 应用程序。首先,我们编写了一个简单的 Fastify 应用程序,然后在 GitHub 仓库中配置了一段部署代码,最后通过 GitHub Pages 实现了自动部署。使用这种方法,我们可以极大地提高部署效率,同时节省了大量时间和精力。

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