TypeScript 开发 HapiJS 应用详解

作者：半夏时间：2026-10-30 22:24:22浏览：464

本文详细介绍如何使用 TypeScript 开发基于 HapiJS 的 Node.js 服务。内容涵盖项目初始化、依赖安装、tsconfig.json 配置、目录结构设计以及编写首个 Hello World 接口。重点讲解了如何利用 Nodemon 实现代码变更时的自动编译与服务重启，从而提升开发效率。

初始化 npm 项目

yarn init

添加依赖

yarn add hapi

添加开发依赖

为了在开发环境中使用 TypeScript，我们需要一个能够监听项目文件变更并实时更新启动服务的工具。这里选择使用 Nodemon，首先添加以下开发依赖：

yarn add typescript -D
yarn add nodemon -D

接下来，我们需要为 node 与 hapi 安装对应的类型定义库：

yarn add @types/node -D
yarn add @types/hapi -D

安装完成后，package.json 文件的内容大致如下所示：

{
  "name": "hapiserver",
  "version": "0.0.1",
  "description": "API server",
  "main": "index.js",
  "author": "Your Name",
  "license": "MIT",
  "dependencies": {
    "hapi": "^18.1.0"
  },
  "devDependencies": {
    "@types/hapi": "^18.0.2",
    "@types/node": "^12.0.2",
    "nodemon": "^1.19.0",
    "typescript": "^3.4.5"
  }
}

注意：你的 dependencies 与 devDependencies 配置中，版本号可能与示例中的有所不同。

配置 TypeScript

设计项目文件目录结构

在项目的根目录下，创建一个名为 src 的目录，用于存放系统的所有源代码文件。接着，创建一个名为 dist 的目录，用于保存由 typescript 编译后生成的 javascript 文件。

注意：文件结构并非强制要求，你可以根据个人习惯和规范进行调整。

.
├── dist
├── node_modules
├── package.json
├── src
└── yarn.lock

tsconfig.json

TypeScript 会查找名为 tsconfig.json 的配置文件，以确定项目的入口文件及编译设置。详细说明可参考 https://www.typescriptlang.org/docs/handbook/tsconfig-json.html。在此，我们先填入以下内容：

{
  "compilerOptions": {
    "outDir": "./dist",
    "allowJs": false,
    "target": "es6",
    "sourceMap": true,
    "module": "commonjs",
    "moduleResolution": "node"
  },
  "include": ["./src/**/*"],
  "exclude": ["node_modules"]
}

在 tsconfig.json 文件中，我们将 outDir 的值设置为 ./dist，这指示编译器将编译后的输出目录指定为 ./dist 文件夹。现在，可以直接在项目根目录执行以下代码，即可将 src 目录下的 TypeScript 代码编译至 dist 目录下的 JavaScript 文件。

node_modules/typescript/bin/tsc

用 TypeScript 开发 Hapi 服务应用

在 src 目录下，创建一个名为 server.ts 的文件，内容如下：

import * as hapi from "hapi";
// 创建一个服务器，监听 `localhost` 上的 `8000` 商品
const server: hapi.Server = new hapi.Server({
  host: "localhost",
  port: 8000
});
// 添加路由
server.route({
  method: "GET",
  path: "/hello",
  handler: function(request, h) {
    return "Hello! TypeScript!";
  }
});
// 启动服务
async function start() {
  try {
    await server.start();
  } catch (err) {
    console.log(err);
    process.exit(1);
  }
  console.log("Server running at:", server.info.uri);
}
// 不要忘记启动服务
start();

由于代码由 TypeScript 编写，目前无法直接运行，需先将其编译为 JavaScript 代码后再执行：

使用以下命令编译代码：

node_modules/typescript/bin/tsc

编译完成后，将得到如下两个文件：

dist
├── server.js
└── server.js.map

此时，执行以下代码以启动服务：

node dist/server.js

启动成功后，终端将显示：

Server running at: http://localhost:8000

使用 curl 测试一下我们的服务：

$ curl -i http://localhost:8000/hello
HTTP/1.1 200 OK
content-type: text/html; charset=utf-8
cache-control: no-cache
content-length: 18
accept-ranges: bytes
Date: Fri, 17 May 2019 01:58:50 GMT
Connection: keep-alive
Hello! TypeScript!

服务已成功启动。

完成所有配置

我们不能每次修改代码后都手动执行编译并重启服务。可以在 package.json 中添加两个命令：

{
  ...
  "scripts": {
    "start": "./node_modules/nodemon/bin/nodemon.js -e ts  --exec \"yarn run compile\"",
    "compile": "tsc && node ./dist/server.js"
  },
  ...
}

现在，只需在项目根目录下执行以下代码，即可启动一个实时编译代码并自动重启服务的开发环境：