Hapi Starter Kit 项目教程

1. 项目的目录结构及介绍

Hapi Starter Kit 的目录结构设计旨在提供一个清晰的组织方式，使得开发者能够快速理解和导航项目。以下是主要的目录结构及其介绍：

hapi-starter-kit/
├── config/
│   ├── default.js
│   ├── development.js
│   ├── production.js
│   └── ...
├── src/
│   ├── api/
│   │   ├── controllers/
│   │   ├── routes/
│   │   └── services/
│   ├── lib/
│   ├── plugins/
│   └── server.js
├── test/
│   ├── integration/
│   └── unit/
├── .gitignore
├── .eslintrc.js
├── package.json
└── README.md

• config/: 包含项目的配置文件，如默认配置、开发环境配置和生产环境配置。
• src/: 项目的源代码目录，包含API控制器、路由和服务，以及服务器启动文件。
• test/: 包含集成测试和单元测试。
• .gitignore: Git忽略文件列表。
• .eslintrc.js: ESLint配置文件，用于代码风格检查。
• package.json: 项目依赖和脚本配置。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件位于 src/server.js，它是整个应用的入口点。以下是 server.js 的主要内容和功能介绍：

// src/server.js
const Hapi = require('@hapi/hapi');
const config = require('config');
const routes = require('./api/routes');

const init = async () => {
    const server = Hapi.server({
        port: config.get('server.port'),
        host: config.get('server.host')
    });

    // 注册插件
    await server.register(require('./plugins'));

    // 添加路由
    server.route(routes);

    await server.start();
    console.log(`Server running on ${server.info.uri}`);
};

process.on('unhandledRejection', (err) => {
    console.log(err);
    process.exit(1);
});

init();

• 引入依赖: 引入 Hapi 框架、配置模块和路由模块。
• 创建服务器实例: 使用配置文件中的端口和主机名创建 Hapi 服务器实例。
• 注册插件: 注册项目中定义的插件。
• 添加路由: 将定义的路由添加到服务器实例中。
• 启动服务器: 启动服务器并输出服务器运行信息。

3. 项目的配置文件介绍

配置文件位于 config/ 目录下，用于管理不同环境下的配置参数。以下是配置文件的主要内容和功能介绍：

// config/default.js
module.exports = {
    server: {
        port: 3000,
        host: 'localhost'
    },
    database: {
        host: 'localhost',
        port: 27017,
        name: 'mydatabase'
    }
};

// config/development.js
module.exports = {
    server: {
        port: 3001
    },
    database: {
        host: 'dev-db-server'
    }
};

// config/production.js
module.exports = {
    server: {
        port: 8080
    },
    database: {
        host: 'prod-db-server'
    }
};

• 默认配置: 包含服务器和数据库的默认配置参数。
• 开发环境配置: 覆盖默认配置中的部分参数，适用于开发环境。
• 生产环境配置: 覆盖默认配置中的部分参数，适用于生产环境。

通过这些配置文件，可以轻松管理不同环境下的配置，确保应用在不同环境下的一致性和可维护性。