node 生产的env文件怎么注入_干货：手把手教你用Node.js 搭建一个 API 接口服务

点击上方“深圳湾码农“，回复“2”进交流群

加入我们一起学习，天天进步

前言

因为最近打算自己搭建一个自己的博客系统，用来记录日常的学习和提升一下写作水平，所以能就打算自己搭建一下前后端项目。在网上找了下，也没有找到合适(现成)的项目，所以就打算自己动手来搭建一下。这篇文章主要描述如何搭建一个node的API接口服务。

技术栈简述

网上的node框架也挺多的，用的较多的有egg，express，koa等框架，框架间各有利弊，最后均衡下来，还是决定使用可拓展性比较强的koa2来搭建项目，加上最近在学习typescript，最后决定使用的技术栈就是 koa+typescript+mysql+mongodb来搭建项目。

为什么要用node

最主要的一点是其他语言咱也不会啊。。。

言归正传，Node.js是一个运行在服务端的框架，它底层使用的是V8引擎，它的速度非常快，并且作为一个前端的后端服务语言，还有其他吸引人的地方：

1. 异步I/O
2. 事件驱动
3. 单线程
4. 跨平台

而且，最最最最重要的一点就是，node是由JavaScript开发的，极大的降低了前端同学的学习成本。

Koa

koa是Express的原班人马打造的一个新的框架。相对于express来说koa更小，更有表现力更加健壮。当然，前面说的都是虚的，其实真正吸引我的是koa通过es6的写法，利用async函数，解决了express.js中地狱回调的问题，并且koa不像express一样自带那么多中间件，对于一个私有项目来说，无疑是极好的，还有一个特点就是koa独特的中间件流程控制，也就是大家津津乐道的koa洋葱模型。

关于洋葱模型，大概归纳起来就是两点

1. context的保存和传递
2. 中间件的管理和next的实现

(图片来源于网络)

上面两张图很清晰的展示了洋葱模型的工作流程，当然，具体的原理实现的话与本篇无关，就不在深入描述了，有兴趣的同学可以自己到网上搜一下哈。

Typescript

网上特别多关于“为什么要用Typescript开发”，“Typescript开发的好处和坏处”，“为什么不用Typescript开发”等等的争论和文章，有兴趣的同学也可以去说道说道哈。

本次项目用ts主要是出于以下几点考虑：

• 本人在持续的学习ts中，“纸上得来终觉浅，绝知此事要躬行”，需要更多的ts实战才能加深对ts的了解
• 自己的项目，想用什么就用什么
• 写起来逼格会相对高一些
• Ts有诸多js中没有的东西，譬如泛型接口抽象等等
• 良好的模块管理
• 强类型语言,个人感觉比js开发服务端项目更合适
• 有良好的错误提示机制,可以避免很多开发阶段的低级错误
• 约束开发习惯，使得代码更优雅规范

最后记住一点，适合自己的才是最好的

Mysql

MySQL 是最流行的关系型数据库管理系统，在 WEB 应用方面 MySQL 是最好的 RDBMS(Relational Database Management System：关系数据库管理系统)应用软件之一

Mongodb

为什么用了mysql还要用mongodb呢？其实主要是因为使用的是jwt来做一个身份认证，由于用到中间件没有提供刷新过期时间的API，而又想要实现一个自动续命的功能，所以使用mongodb来辅助完成自动续命的功能。并且，一些用户身份信息或埋点信息可以存在mongo中

PM2

PM2是node进程管理工具，可以利用它来简化很多node应用管理的繁琐任务，如性能监控、自动重启、负载均衡等，而且使用非常简单

项目搭建

我主要把项目分为：框架，日志，配置，路由，请求逻辑处理，数据模型化这几个模块

以下是一个项目的目录结构：

  ├── app                         编译后项目文件
  ├── node_modules                依赖包
  ├── static                      静态资源文件
  ├── logs                       服务日志
  ├── src                         源码
  │   ├── abstract                    抽象类
  │   ├── config                      配置项
  │   ├── controller                  控制器
  │   ├── database                    数据库模块
  │   ├── middleware                  中间件模块
  │   ├── models                    数据库表模型
  │   ├── router                      路由模块 - 接口
  │   ├── utils                       工具
  │   ├── app.ts                  koa2入口
  ├── .eslintrc.js                eslint 配置
  ├── .gitignore                  忽略提交到git目录文件
  ├── .prettierrc                 代码美化
  ├── ecosystem.config.js         pm2 配置
  ├── nodemon.json                nodemon 配置
  ├── package.json                依赖包及配置信息文件
  ├── tsconfig.json               typescript 配置
  ├── README.md                   描述文件

话不多说，接下来跟着代码来看项目

创建一个koa应用

俗话说的好：人无头不走。项目中也会有个牵着项目走的头，这就是入口app.ts，接下来咱就结合代码看看它是怎么做这个头的

import Koa, { ParameterizedContext } 

到了这一步，我们就已经可以启动一个简单的项目了

1. npm run tsc 编译ts文件
2. node app.js 启动项目

接下来在浏览器输入http://localhost:3000就能在控制台看到访问日志了。当然，做到这一步还是不够的，因为我们开发过程中总是伴随着调试，所以需要更方便的开发环境。

本地开发环境

本地开发使用nodemon来实现自动重启，因为node不能直接识别ts，所以需要用ts-node来运行ts文件。

// nodemon.json
{
  "ext": "ts",
  "watch": [ // 需要监听变化的文件
    "src/**/*.ts",
    "config/**/*.ts",
    "router/**/*.ts",
    "public/**/*",
    "view/**/*"
  ],
  "exec": "ts-node --project tsconfig.json src/app.ts" // 使用ts-node来执行ts文件
}
// package.json
"scripts": {
  "start": "cross-env NODE_ENV=development nodemon -x"
}

本地调试

因为有的时候需要看到请求的信息，那我们又不能在代码中添加console.log(日志)这样效率低又不方便，所以我们需要借助编辑器来帮我们实现debug的功能。这边简单描述一下怎么用vscode来实现debug的。

• tsconfig.json中开启sourceMap
• 为ts-node注册一个vsc的debug任务，修改项目的launch.json文件，添加一个新的启动方式
• launch.json

{
  "name": "Current TS File",
  "type": "node",
  "request": "launch",
  "args": [
    "${workspaceRoot}/src/app.ts" // 入口文件
  ],
  "runtimeArgs": [
    "--nolazy",
    "-r",
    "ts-node/register"
  ],
  "sourceMaps": true,
  "cwd": "${workspaceRoot}",
  "protocol": "inspector",
  "console": "integratedTerminal",
  "internalConsoleOptions": "neverOpen"
}

• F9 代码中断点
• F5 开始调试代码

引入接口路由

上面我们已经创建了一个koa应用了，接下来就使用需要引入路由了：

// app.ts

定义数据库模型

1. 使用sequlize作为mysql的中间件

// 实例化sequelize

根据上面的代码，我们就已经定义好一个user表了，其他表也可以按照这个来定义。不过这个项目除了使用mysql，也还有用到mongo，接下来看看mongodb怎么用

2. 使用mongoose作为mongodb的中间件

// mongoose入口

实现接口

好了，上面我们已经定义好表模型了，接下来就是激动人心的接口实现了。我们通过一个简单的埋点接口来实现一下，首先需要分析埋点工具实现的逻辑：

1. 因为埋点信息都是非关系型的，所以使用mongodb来存储埋点信息
2. 因为这个就是一个单纯的记录接口，所以需要设计的比较通用 - 即除了关键几个字段，调用方传什么就保存什么
3. 埋点行为对用户来说是无感知的，所以不设计反馈信息，如果埋点出错也是由内部处理

好了，了解这个埋点的功能之后，就开始来实现这个简单的接口了：

// route.ts 定义一个addAccLog的接口

说到这边，不得不提一句哈，就是路由可以引入装饰器写法，这样能减少重复工作和提高效率，有兴趣的同学可以看我上一篇博客哈。这边贴一下装饰器写法的代码：

'/AccLogController')

这一对比，是不是看出装饰器的好处了呢。

jwt身份验证

这边使用jsonwebtoken来做jwt校验

import { sign, decode, verify } 

这样，我们就完成了一个jwt授权的模块了，我们用也很简单，以addAccLog接口为例

class AccLogRoute {

接口文档

既然我们已经写好接口了，那总要有一份可参阅的文档输出，这时候就想到了swagger，接下来咱们就把swagger引入到我们的项目中吧。

• 入口

// swagger入口

• 配置示例 - 这边一定要注意格式

 @swagger Tips: 必须要声明,不然代码不会把此处生成为文档
 definitions:
   Login: // 接口名
     required: // 必填参数
       - username
       - password
     properties: // 可选参数
       username:
         type: string
       password:
         type: string
       path:
         type: string

• swagger官方配置工具
• 推荐一个vscode插件 - facility插件，用来快速生成注释

Mock数据

使用mock来生成测试数据

日志

日志模块本来打算是用log4.js来做的，后来感觉做的日志模块还没达到预期，所以就决定先暂时用pm2的日志系统来代替log4。这边就先不贴log4相关的代码了

部署

使用pm2来部署项目,这边展示一下配置文件

Tips

• error_file 错误日志输出
• out_file 正常日志输出
• script 入口文件 - 以打包过后的js文件作为入口

// pm2.json

配置好pm2之后，我们只要在package.json中配置pm2 start pm2.json就可以实现启动pm2进程了

结束语

虽然是一个简单的接口服务器，但是需要考虑的东西也是很多，而且因为很多插件都是第一次接触，所以整个项目实现的过程还是蛮坎坷的，基本上是那种摸石头过河。不过痛并快乐着吧，虽然困难很多，但是过程中也学到了不少新的知识点，大概了解了一个简单的后端服务项目所承载的重量。

原文地址：https://juejin.im/post/5eb3e1b4e51d45244e7c2d09

作者:T谷子

推荐全栈程序员必备微信号 

▼

---

深圳湾码农微信号：ydhlwnxs 推荐理由： 在多学一点知识，就可以少写一行代码！专注于技术资源分享，经验交流，最新技术解读，另有海量免费电子书以及成套学习资源，关注深圳湾码农，做技术的先驱者。  ▼长按下方↓↓↓二维码识别关注

点个 在看，2020暴富