Step 1 创建基础和安装依赖
mkdir <project-name>
cd <project-name>
git init // 初始化 git 配置文件
mkdir src
// 安装依赖
npm init // 初始化 package.json
npm i koa koa-router
npm i --save-dev typescript ts-node nodemon
npm i --save-dev @types/koa @types/koa-router
Step 2 修改编译配置
添加 tsconfig.json
配置,为了使用原生的 Async/Await,我们将编译的目标版本设置为 es2017
:
{
"compilerOptions": {
"module": "commonjs",
"target": "es2017",
"noImplicitAny": true,
"moduleResolution": "node",
"sourceMap": true,
"outDir": "dist", // TS文件编译后会放入到此文件夹内
"baseUrl": ".",
"paths": {
"*": [
"node_modules/*",
"src/types/*"
]
}
},
"include": [
"src/**/*"
]
}
Step 3 创建 koa 应用
我们在 src目录下创建文件 server.ts
import * as Koa from 'koa';
import * as Router from 'koa-router';
const app = new Koa();
const router = new Router();
router.get('/*', async (ctx) => {
ctx.body = 'Hello World!';
});
app.use(router.routes());
app.listen(3000);
console.log('Server running on port 3000');
Step 4 启动项目
我们添加一些脚本到 package.json
中,脚本如下
"scripts": {
"start": "tsc && node dist/server.js"
}
然后我们使用以下命令,启动项目
npm start
tsc
命令会根据 tsconfig.json
中配置,对我们 ts
文件进行编译,并将生成的文件放入 dist
目录下。然后我们使用 node server.js
命令,启动服务。
启动后,我们可以通过 http://localhost:3000 访问页面。
如何实现热更新
这时,有一个问题 —— 当我们文件发生改变时,我们需要终止命令,然后重启命令。这样,开发起来太繁琐了。能不能当文件发生改变时,自动重新编译和启动项目。于是,我们想到了使用 nodemon
来监控文件的改变, 使用ts-node
(类似,执行了 tsc && node dist/server.js)启动项目。
我们将启动脚本改成如下:
"scripts": {
"start": "tsc && node dist/server.js",
"watch-server": "nodemon --watch 'src/**/*' -e ts,tsx --exec 'ts-node' ./src/server.ts"
}
然后执行 npm run watch-server
启动项目,尝试修改 server.ts
文件,我们可以发现文件可以自动编译了。
如何使用 chrome 的 debug 模式
开发时,我们有时希望可以进行断点调试。我们想到了使用node的--inspect
参数启动node项目,然后通过chrome 进行调试。
我们修改一下启动命令:
"watch-server": "nodemon --inspect --watch 'src/**/*' -e ts,tsx --exec 'node -r ts-node/register' ./src/server.ts",
启动项目后,我们可以通过chrome控制台进入调试窗口进行调试