koa +ts 搭建简单项目

Step 1 创建基础和安装依赖

mkdir 
cd 
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 访问页面。

参考：
链接：https://www.jianshu.com/p/1a91f36e5153

我是在这里 https://www.jianshu.com/p/1a91f36e5153找的，要感谢原作者。

但是出了问题，困扰我很久。但是在这篇文章中我已经改了。下面是执行npm start 命令时报错的地方：

TypeError: Unexpected MODIFIER at 1, expected END
    at mustConsume (/home/ksuser/Downloads/projectwjl/text01/lastbed/node_modules/path-to-regexp/dist/index.js:114:15)
    at parse (/home/ksuser/Downloads/projectwjl/text01/lastbed/node_modules/path-to-regexp/dist/index.js:173:9)
    at stringToRegexp (/home/ksuser/Downloads/projectwjl/text01/lastbed/node_modules/path-to-regexp/dist/index.js:331:27)
    at pathToRegexp (/home/ksuser/Downloads/projectwjl/text01/lastbed/node_modules/path-to-regexp/dist/index.js:405:12)
    at new Layer (/home/ksuser/Downloads/projectwjl/text01/lastbed/node_modules/koa-router/lib/layer.js:43:17)
    at Router.register (/home/ksuser/Downloads/projectwjl/text01/lastbed/node_modules/koa-router/lib/router.js:570:17)
    at Router. [as get] (/home/ksuser/Downloads/projectwjl/text01/lastbed/node_modules/koa-router/lib/router.js:200:12)
    at Object. (/home/ksuser/Downloads/projectwjl/text01/lastbed/dist/index.js:7:8)
    at Module._compile (internal/modules/cjs/loader.js:1015:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1035:10)
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] start: `tsc && node dist/index.js`
npm ERR! Exit status 1
npm ERR! 
npm ERR! Failed at the [email protected] start script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /home/ksuser/.npm/_logs/2022-02-07T09_04_41_653Z-debug.log

找了很久很久，好吧，问题出在了 原作者是

router.get('/*, async (ctx) => {
    ctx.body = 'Hello World!';
});   我把*删了，重新tsc了一下。就启动成功了

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');

成功页面：

如何实现热更新

这时，有一个问题 —— 当我们文件发生改变时，我们需要终止命令，然后重启命令。这样，开发起来太繁琐了。能不能当文件发生改变时，自动重新编译和启动项目。于是，我们想到了使用 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控制台进入调试窗口进行调试