Krabs: 多租户Next.js应用程序的Express/Fastify中间件安装与使用指南

1. 项目目录结构及介绍

Krabs是一个旨在支持多租户架构的Node.js中间件，专为基于Express.js或Fastify的Next.js应用设计。以下是典型的项目结构示例及其组件说明：

krabs-app/
├── node_modules/       # 依赖包存放目录（npm或yarn安装后自动生成）
├── package.json        # 项目配置文件，包括依赖和脚本命令
├── yarn.lock OR package-lock.json # 依赖版本锁定文件
├── krabs.js 或 krabs.config.js # Krabs配置文件，定义不同网站租户
├── next.config.js      # Next.js的配置文件，可选，用于定制Next.js行为
├── public/             # 静态资源文件夹
├── pages/              # Next.js页面路由存放处
│   ├── _app.js         # 全局App组件，共享逻辑
│   ├── _document.js    # 自定义HTML文档逻辑
│   ├── website-1/      # 第一个租户的页面
│   │   └── index.js    # 租户1的主页
│   └── website-2/      # 第二个租户的页面
│       └── index.js    # 租户2的主页
├── src/                # 若有，自定义应用源代码
├── index.js            # 启动服务器的主入口文件
└── README.md           # 项目说明文档

说明:

• krabs.js 或 krabs.config.js: 包含了租户的配置信息，如不同环境下的域名映射等。
• index.js: 应用程序的启动点，集成Krabs中间件。

2. 项目的启动文件介绍

index.js 示例:

const express = require('express');
const next = require('next');
const krabs = require('krabs'); // 对于Express.js
// 如果是Fastify则应引入 fastify-krabs

const dev = process.env.NODE_ENV !== 'production';
const app = next({ dev });
const handle = app.getRequestHandler();

async function startServer() {
    try {
        await app.prepare();
        const server = express(); // 或使用fastify替代

        // 配置Krabs中间件处理请求
        server.get('*', (req, res) => krabs(req, res, handle, app));

        // 启动服务
        server.listen(3000, (err) => {
            if (err) throw err;
            console.log(`> Ready on http://localhost:3000`);
        });
    } catch (ex) {
        console.error(ex.stack);
        process.exit(1);
    }
}

startServer();

在Fastify中，启动逻辑相似，只是引入和配置方式稍有差异。

3. 项目的配置文件介绍

krabs.js 示例:

module.exports = [
    {
        tenants: [
            {
                name: 'website-1',
                domains: [
                    {
                        development: '/dev*[a-z]*\.local\.website-1\.com/',
                        staging: 'stage.website-1.com',
                        production: 'website-1.com',
                    },
                ],
            },
            {
                name: 'website-2',
                domains: [
                    {
                        development: 'local.website-2.com',
                        staging: 'stage.website-2.com',
                        production: '[\\w|\\d|-|_]+\.website-2.com',
                    },
                ],
            },
        ],
    },
];

配置文件定义了多个租户及其对应的开发、预发布和生产环境的域名。每个租户的内容可以根据实际需求进行调整。

至此，通过上述三个关键部分的设置，您可以配置并运行一个支持多站点的Next.js应用，利用Krabs实现虚拟主机的管理和多租户逻辑。记得在本地环境中设置hosts以映射不同的域名到您的开发机IP地址，以便测试不同租户的页面。