乐趣区

使用-TypeScript-开发-HapiJS-应用

初始化 npm 项目

yarn init

添加依赖

yarn add hapi

添加开发依赖

要在开发中使用 TypeScrip,同时至少需要有一个工具,可以一直监听项目文件的变更,并实时的将变更更新至启动的服务中,我选择使用 Nodemon,首先添加以下几个开发依赖

yarn add typescript -D
yarn add nodemon -D

接下来,我们需要为 nodehapi 安装类型定义库:

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"
  }
}

注意 :你的 dependenciesdevDependencies 配置中,版本号可能与我的不同。

配置 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"},
  ...
}

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

yarn start

它的作用是:nodemon 启动一个服务,监听文件的变更,当有任何文件变更之后,执行 yarn run compile 命令(即执行:tsc && node ./dist/server.js,以重启服务。

退出移动版