Koa后端小项目编程记录 - 项目搭建

前言

对于小型it项目，没必要使用市面上成熟的后端框架来做。之前使用node开发后端项目时，使用了阿里的Midwayjs来做过项目，使用上确实很流畅丝滑，但是我现在项目不大，就从头开始写一个，成册记录。

本篇介绍koa工程的基础搭建。

一、前期准备

1. 电脑上安装node环境；
2. 使用vscode或者其他软件作为编辑器（本项目使用vscode）；
3. 包管理器命令随意，既可以npm，也可以选择使用yarn、cnpm都行；
4. 掌握typescript知识也要熟悉typescript的语法；
5. 知道koa如何使用；
6. 要有一点shell脚本知识；
7. 本项目以Mac电脑环境做演示说明。

二、项目搭建

1. 创建文件夹，工程代码都放在这个文件中；
2. 打开终端，使用cd命令进入到刚创建的空文件路径下，使用以下命令创建一个package.json文件 ：

npm init

如上图所示，会生成包管理文件package.json文件，可以一步步设置项目的基本描述信息。

三、入口文件

创建一个app.ts文件，用作项目的入口文件，后面项目启动运行都从这个入口文件开始。

四、引入typescript支持

引入typesript依赖，以及tsc编译器，tsc是将ts文件编译成js的编译器，ts-node依赖库可以直接编译ts文件：

npm install --save-dev typescript ts-node @types/node

五、引入eslint代码格式库

eslint支持对typescript语法的lint规则，具体配置可以参考eslint官网：
https://typescript-eslint.io/getting-started

npm install --save-dev eslint @eslint/js @types/eslint__js typescript typescript-eslint

六、创建tsconfig.json文件

1. tsconfig.json文件可以定义ts编译的一些规则，可以通过以下终端命令来生成：

npx tsc --init

（如果电脑中没有安装npx工具的话，可以通过npm安装一下）
全局安装npx的终端命令：

npm install -g npx

2. 修改tsconfig.json文件，设置一些基本属性：
   
   rootDir设置ts文件所在的最外层目录；
   其他如有任何需要，可以逐步修改文件中的配置。

七、安装koa以及koa-router

npm install koa koa-router 

八、定义script脚本执行命令

使用编辑器打开项目文件夹，点击并且编辑package.json文件：

...
"scripts": {
    "dev": "ts-node app.ts",
    "build": "tsc"
  },
...

在"scripts"配置项中，写入如图所示的配置，那么执行文件时，就可以直接执行：
npm run dev来启动项目。

在根目录下创建一个src的空文件夹，后续所有的文件将在src文件夹下创建开始。

九、工程目录

至此，基础的工程搭建算是完成。

十、测试运行

测试工程时，可以在app.ts中打印语句进行测试。

console.log("Hello world!");

然后在终端执行脚本命令：

npm run dev

如果在终端看到输出Hello world!，那么即表示工程的基础搭建已经完成。

第一章到此。