serverless-pg 使用教程

1. 项目介绍

serverless-pg 是一个针对无服务器架构（FaaS，Function-as-a-Service）设计的 PostgreSQL 连接管理库。它基于 node-pg 模块，提供了在无服务器环境中管理数据库连接的功能。这个库可以自动回收“僵尸”连接，防止因为并发用户过多而导致数据库连接数迅速达到上限，从而避免应用中断。

2. 项目快速启动

首先，确保你的环境中已经安装了 Node.js。

安装

通过 npm 安装 serverless-pg：

npm i serverless-postgres

配置

在项目中创建一个新的文件，例如 index.js，并配置你的数据库连接信息。确保你的环境变量中包含了数据库的用户名、密码、主机、数据库名和端口。

const ServerlessClient = require('serverless-postgres');
const client = new ServerlessClient({
  user: process.env.DB_USER,
  host: process.env.DB_HOST,
  database: process.env.DB_NAME,
  password: process.env.DB_PASSWORD,
  port: process.env.DB_PORT,
  debug: true,
  delayMs: 3000,
});

使用

在你的 Lambda 函数或者其他无服务器函数处理程序中，使用 client 对象来执行数据库操作。

exports.handler = async (event, context) => {
  await client.connect();
  const result = await client.query(`SELECT 1+1 AS result`);
  await client.clean();
  return {
    body: JSON.stringify({
      message: result.rows[0]
    }),
    statusCode: 200
  };
};

确保在函数执行结束后调用 client.clean() 来清理连接。

3. 应用案例和最佳实践

连接过滤

为了防止终止不属于该库创建的连接，可以使用 application_name 配置项来区分不同的客户端。

const client = new ServerlessClient({
  application_name: 'my_client',
  // ...其他配置
});

插件使用

如果需要支持其他兼容 PostgreSQL 的数据库引擎，如 Redshift、Google Cloud Spanner 等，可以编写自己的插件。

class MyPlugin extends Postgres {
  constructor() {
    super();
    // ...自定义插件逻辑
  }
}

const client = new ServerlessClient({
  plugin: new MyPlugin(),
  // ...其他配置
});

4. 典型生态项目

serverless-pg 可以与 AWS Lambda、Google Cloud Functions 等无服务器平台无缝集成。它可以作为无服务器架构中数据库连接管理的核心组件，与各种前端框架、API 网关和服务端框架（如 Express.js）协同工作，为无服务器应用提供高效稳定的数据库服务。