如何用typescript开发koa2的二三事

使用TypeScript开发Koa2的旅程：长沙网络推广的经验分享

前言：

最近我在开发一个博客项目，前端采用Vue+TypeScript+Element-UI，后端则选择了Koa2+TypeScript+MongoDB的组合。在开发后台的过程中，遇到了一些问题，查阅了很多资料才得以解决。我决定写下这篇博客，记录下我的经验，并给大家提供一个完整的参考。

一、基本信息

在此列出一些必要的配置信息，以便于大家了解项目的基础环境。需要注意的是，这些配置可能会随着版本的更新而发生变化。

使用的工具和版本包括：

Nodemon：用于本地开发时的热更新，版本 "^1.18.3"。

ts-node：允许直接在Node.js中运行TypeScript代码，版本 "^7.0.1"。

TypeScript：用于项目的静态类型检查，版本 "^3.1.1"。

Node：Node.js的运行环境，版本 "9.0.0"。

二、问题描述

在使用TypeScript开发Koa2时，我遇到了几个主要问题。因为不涉及Webpack的打包编译，所以需要解决编译、实时刷新、重启服务器以及调试等问题。这些都是我在初期开发时非常困扰的地方。

三、解决方案

为了解决上述问题，我采取了一系列的措施。以下是具体的解决方案和解释。

1. 使用"watch"命令启动服务器：通过运行"npm run watch"，使用ts-node在本地启动一个服务器。这个命令会在代码修改时自动重新运行程序，但需要注意的是，它不支持热更新。

2. 编译项目并启动服务器：通过运行"npm run build && npm run start"，首先编译TypeScript项目，然后在编译后的文件入口启动服务器。这个组合命令可以实现编译后的文件热更新，但对于源文件的修改则无法生效。

3. 使用"watch-serve"命令实现实时刷新和调试：这是解决问题的关键！通过运行"npm run watch-serve"，使用nodemon监控项目文件的变动，并使用ts-node执行TypeScript文件。这个命令支持源文件的热更新和调试，可以在代码修改时自动重启服务器，并允许使用debugger进行调试。这对于开发过程中的调试和测试非常有帮助。

一开始可能会对一些命令的使用感到困惑，比如 nodemon 和 ts-node 的配置，但现在终于明白了其中的原理。对于那些不太熟悉的命令和参数，让我们来一一。

nodemon 是一个用于开发时自动重启服务器的工具，它默认监控的文件类型包括 .js、.mjs、.coffee、.litcoffee 和 .json。对于像 .ts 这样的文件类型，我们需要通过 -e 参数来指定。这里的逗号仅仅是用来分隔不同的文件类型。

关于 --exec 这个配置，它允许我们使用 nodemon 来执行和监控其他类型的程序。例如，如果你想用 nodemon 来运行一个 Python 脚本，你可以使用 --exec 参数来指定 Python 解释器，并运行你的 app.py 脚本。这样，nodemon 就会监控 .py 文件的更改，并在有更新时重新启动。这对于那些需要实时更新代码的应用来说非常有用。

这个解决方案确实非常强大，它通过简单的命令和配置，解决了开发过程中的许多常见问题。它不仅提高了开发效率，也使得代码更新和调试变得更加方便。对于那些正在使用 nodemon 或其他类似工具的人来说，这无疑是一个很好的消息。

掌控Nodemon的监视目录：从默认到自定义

Nodemon默认会监视当前的工作目录，但如果你想拥有更多的控制权，可以使用--watch选项来指定特定的路径。例如：

`nodemon --watch app --watch libs app/server.js`

这样，nodemon只有在./app或./libs目录发生更改时才会重新启动。默认情况下，nodemon会遍历子目录，因此无需明确包含子目录。

请注意，不要使用unix的通配符来传递多个目录，例如--watch ./lib/。每个被监视的目录都需要一个--watch标志。

除了对nodemon的监视选项有所了解外，我在npm包和debugger时遇到了一些挑战。当我想通过npm运行debugger时，遇到了关于如何正确配置的问题。特别是在引入了typescript后，一切都变得有些混乱。

我尝试了几种命令，如：

'nodemon --inspect --watch ./app -e ts,tsx --exec ts-node ./app/index.ts'

'nodemon --watch --inspect ./app -e ts,tsx --exec ts-node ./app/index.ts'

'nodemon --watch ./app -e ts,tsx --exec ts-node --inspect ./app/index.ts'

这些尝试并未成功解决问题。经过在stackoverflow和github上的搜索和验证，我逐渐明白了其中的原理。原来，-r参数用于预加载一个模块，我们可以多次使用这个参数。对于我的命令来说，ts-node/register就是一个模块。通过预加载这个模块，我们可以使用node来运行ts程序，并开启debugger模式。

我在编译、热更新和debugger方面的挑战已经克服。希望我的经验和教训能帮助其他开发者少走弯路。也希望大家能多多支持狼蚁SEO。在这个过程中，我深刻体会到深入理解和转化复杂信息的重要性，同时也感受到技术的魅力。未来的道路还长，但我相信只要我们坚持不懈，总会越走越宽。至此为止，让我们一起继续技术的奥秘吧！