基于NestJS搭建node服务应用

NestJS

NestJS是一款用来搭建高效、易于扩展nodejs服务端应用的框架,它是基于typescript编写的,并且完全支持typescript(当然也可以使用纯js),同时还包含了面向对象、函数式编程、函数响应式编程的思想。
NestJS框架是基于express的封装,同时也直接将express的api提供给开发者使用,当然所有的基于express的第三方模块也可以使用。

初始化项目

初始化项目可以使用官方的脚手架:

$ npm i -g @nestjs/cli
$ nest new project-name

也可以直接clone官方提供的代码仓库(如果要使用js,就把其中的typescript-starter改为javascript-starter即可),注意start命令是不会监听代码变动的,需要添加"--watch"参数才可以

$ git clone https://github.com/nestjs/typescript-starter.git project
$ cd project
$ npm install
$ npm run start

成功启动后,就可以在localhost:3000地址看到hello word了。同时在项目目录下面可以看到三个核心的文件:

  • app.controller.ts: 提供了基本的接口路由
  • app.module.ts: 应用的根模块
  • main.ts: 应用的入口文件,调用NestFactory核心函数,生成NestJS的应用实例
    如果之后要创建子模块的时候,controller和module也是最基本的组成文件

不使用NestJS-cli

当然也可以不使用NestJS官方的脚手架,自己搭建框架。下面介绍的是搭建一个基于typescript,底层使用express的 hello world项目所需要的最小包,后续扩张功能可以按需加载更多。
在dependencies里面只需要安装@nestjs/common@nestjs/core@nestjs/platform-express这三个包,devDependencies中安装@nestjs/testing用来编写测试。然后参考cli生成的controller、module、main文件,把代码写出来就可以了。

使用nodemon、ts-node启动本地开发应用

我们可以使用ts-node来编译并启动NestJS应用,找个库可以执行编译typescript,并运行编译后的js。安装好ts-node之后只需要:

node -r ts-node/register src/main.ts

这样就可以启动我们的NestJS应用了。另外如果在tsconfig.json配置文件中设置了paths参数,那么还需要另外安装一个tsconfig-paths包,并在命令里把参数加上:

node -r ts-node/register  -r tsconfig-paths/register -r dotenv/config src/main.ts

但如果需要监听代码改动后,重启项目,那么可以使用nodemon来监听并重启应用。安装nodemon完毕后,可以在项目根目录新建一个nodemon.json配置文件

{
  "watch": ["src/**/*.ts"],
  "ext": "ts",
  "ignore": ["**/*.test.ts"],
  "exec": "node -r ts-node/register  -r tsconfig-paths/register src/main.ts"
}

然后在命令行执行nodemon指令即可启动一个自动更新的开发环境应用了。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,117评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,328评论 1 293
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,839评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,007评论 0 206
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,384评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,629评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,880评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,593评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,313评论 1 243
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,575评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,066评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,392评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,052评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,082评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,844评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,662评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,575评论 2 270