本文将介绍如何使用 Hapi 框架来搭建一个完整且可扩展的 RESTful API，我们将会覆盖以下主题：
- Hapi 简介
- 安装和创建 Hapi 项目
- 路由和请求处理
- 参数验证
- 数据库集成
- 分层架构
- 错误处理和日志记录
Hapi 简介
Hapi 是一个 Node.js 的开源框架，用于构建 Web 应用程序和服务。它具有非常多的特性，包括可扩展性、高度可配置性、插件体系、路由、请求传输、验证等等，是构建 RESTful API 的一个不错的选择。
安装和创建 Hapi 项目
首先，你需要安装 Node.js 和 npm（作为 Node.js 的默认包管理工具）。然后，你可以在你的终端中使用以下命令创建一个新的 Hapi 项目：
npm init -y npm install hapi
这将会创建一个新的 package.json 文件和安装 Hapi 框架到你的项目中。
路由和请求处理
在 Hapi 中，你可以通过定义路由和处理请求来处理 HTTP 请求。在你的 index.js 中，你可以使用以下代码来设置路由：
// javascriptcn.com 代码示例
const Hapi = require('@hapi/hapi');
const init = async () => {
const server = Hapi.server({
port: 3000,
host: 'localhost'
});
server.route({
method: 'GET',
path: '/',
handler: (request, h) => {
return 'Hello, World!';
}
});
await server.start();
console.log(`Server running at: ${server.info.uri}`);
};
init();在以上示例中，我们定义了一个 GET 路由，路径为 /，并且在请求到达时返回 “Hello, World!”。你可以使用任何 HTTP 方法和路径来定义路由，并提供一个处理函数 handler 来处理请求。
参数验证
在 RESTful API 中，参数验证非常重要，这可以避免服务端的错误，并保护你的应用程序免受攻击。
在 Hapi 中，你可以使用 Joi 来定义参数验证规则。以下是一个示例：
// javascriptcn.com 代码示例
const Joi = require('joi');
server.route({
method: 'POST',
path: '/users',
options: {
validate: {
payload: Joi.object({
name: Joi.string().required(),
age: Joi.number().integer().min(18).max(99).required(),
email: Joi.string().email().required(),
})
},
handler: (request, h) => {
return 'User created';
}
}
});在上面的示例中，我们仅允许包含字段 name，age 和 email 的 POST 请求，同时确保它们符合定义的规则。如果请求中有任何问题，将会返回一个错误响应，否则将会继续进行处理。
数据库集成
在真实的应用程序中，你需要将你的应用程序集成到一个数据库中。这可以通过使用 Hapi 插件（如 hapi-sequelizejs）来实现。以下是一个基于 Sequelize 的示例：
npm install sequelize mysql2 hapi-sequelizejs
// javascriptcn.com 代码示例
const Hapi = require('@hapi/hapi');
const { Sequelize } = require('sequelize');
const hapiSequelize = require('hapi-sequelizejs');
const sequelize = new Sequelize('database', 'username', 'password', {
host: 'localhost',
dialect: 'mysql'
});
const init = async () => {
const server = Hapi.server({
port: 3000,
host: 'localhost'
});
await server.register({
plugin: hapiSequelize,
options: [
{
name: 'user',
models: [__dirname + '/models/**/*.js'],
sequelize,
sync: true,
forceSync: false
}
]
});
server.route({
method: 'POST',
path: '/users',
options: {
validate: {
payload: Joi.object({
name: Joi.string().required(),
age: Joi.number().integer().min(18).max(99).required(),
email: Joi.string().email().required(),
})
},
handler: async (request, h) => {
const { name, age, email } = request.payload;
const user = await server.app.models.user.create({ name, age, email });
return user;
}
}
});
await server.start();
console.log(`Server running at: ${server.info.uri}`);
};
init();在以上示例中，我们定于了一个 Hapi 插件 hapi-sequelizejs 并将 MySQL 数据库集成到项目中。我们还使用 Sequelize 定义了连接的参数，并在 options 对象中提供了 ORM 模型的位置，并创建了一个 user 模型。
在 POST 请求中，我们使用 server.app.models 对象从数据库中创建了一个新的 user 记录。
分层架构
在构建应用程序时，分层架构是一个非常重要的概念，它可以将应用程序进行分离，使代码更加可扩展和可维护。在 RESTful API 中，通常有控制器层、服务层、数据访问层和模型层。
以下是一个示例：
// javascriptcn.com 代码示例
class UserService {
constructor(userModel) {
this.userModel = userModel;
}
async list() {
return this.userModel.findAll();
}
async create(data) {
return this.userModel.create(data);
}
async findById(id) {
return this.userModel.findByPk(id);
}
async update(id, data) {
const user = await this.userModel.findByPk(id);
if (!user) {
throw new Error('User not found');
}
return user.update(data);
}
async delete(id) {
const user = await this.userModel.findByPk(id);
if (!user) {
throw new Error('User not found');
}
return user.destroy();
}
}
server.route({
method: 'GET',
path: '/users',
handler: async (request, h) => {
const userModel = request.server.app.models.user;
const userService = new UserService(userModel);
const users = await userService.list();
return users;
}
});在以上示例中，我们创建了一个 UserService 来处理业务逻辑，并在路由中调用该服务。服务通过传递数据库模型来处理数据访问，并返回格式化的响应。
错误处理和日志记录
在构建应用程序时，错误处理和日志记录也是非常重要的。在 Hapi 中，你可以通过使用 Boom 和 good 插件来实现。
以下是一个示例：
npm install good good-console good-squeeze npm install boom
// javascriptcn.com 代码示例
const Hapi = require('@hapi/hapi');
const Boom = require('boom');
const Good = require('@hapi/good');
const GoodConsole = require('@hapi/good-console');
const GoodSqueeze = require('good-squeeze');
const options = {
ops: {
interval: 1000
},
reporters: {
console: [
{
module: 'good-squeeze',
name: 'Squeeze',
args: [
{
log: '*',
response: '*',
error: '*'
}
]
},
{
module: 'good-console'
},
'stdout'
]
}
};
const init = async () => {
const server = Hapi.server({
port: 3000,
host: 'localhost'
});
await server.register({
plugin: Good,
options
});
server.route({
method: 'GET',
path: '/users/{id}',
handler: async (request, h) => {
const { id } = request.params;
const userModel = request.server.app.models.user;
const userService = new UserService(userModel);
const user = await userService.findById(id);
if (!user) {
return Boom.notFound('User not found');
}
return user;
}
});
server.route({
method: 'GET',
path: '/404',
handler: async (request, h) => {
return Boom.notFound('Not found');
}
});
server.route({
method: 'GET',
path: '/500',
handler: async (request, h) => {
throw new Error('Internal server error');
}
});
await server.start();
console.log(`Server running at: ${server.info.uri}`);
};
init();在以上示例中，我们使用 Good 插件来记录日志。我们定义了三个路由：一个成功的 GET 路由，一个错误的 404 路由和一个错误的 500 路由。如果请求的资源不存在，将会返回一个 Boom.notFound 响应。如果服务器端错误，将会返回一个 500 错误响应，并且将错误信息记录到日志文件中。
总结
使用 Hapi 框架可以轻松地构建可扩展且可维护的 RESTful API。通过仔细设计、分层架构和错误处理，你可以创建出一个非常健壮的应用程序。该文章只是基于 Hapi 框架的简单示例，你可以通过查看 Hapi 文档和示例来探究更多的特性和用法。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/6519864095b1f8cacd1b050e