1、Nest.js 项目搭建

Nest.js 5.0 系列教程。

Nest.js 6.0 必看

什么是Nest.js?

Nest.js 是 Node.js 平台下,兼容 TypeScript 和 JavaScript 语法的高性能 Web开发框架。

默认框架底层 HTTP 实例是基于 Express 实现的,可以通过兼容的 HTTP 适配器进行修改。

支持 微服务 (Microservice) 和 web套接字 (WebSockets)

安装

需要 Node.js 版本 >= 6.11.0

使用 npm 安装 Nest CLI ,在终端中输入以下命令:

  $ npm i -g @nestjs/cli

检查 Nest 是否安装正常, 在终端中输入以下命令:

$ nest info

 _   _             _      ___  _____  _____  _     _____
| \ | |           | |    |_  |/  ___|/  __ \| |   |_   _|
|  \| |  ___  ___ | |_     | |\ `--. | /  \/| |     | |
| . ` | / _ \/ __|| __|    | | `--. \| |    | |     | |
| |\  ||  __/\__ \| |_ /\__/ //\__/ /| \__/\| |_____| |_
\_| \_/ \___||___/ \__|\____/ \____/  \____/\_____/\___/


[System Information]
OS Version     : Linux 4.15
NodeJS Version : v9.2.1
NPM Version    : 6.1.0
[Nest Information]
passport version : 1.1.0
common version   : 5.0.0
core version     : 5.0.0

安装缓慢可考虑更改 npm 镜像源,这里推荐使用 nrm , 好处是可以随时切换不同的源, 在终端中输入以下命令:

$ npm i -g nrm

$ nrm ls

  npm ---- https://registry.npmjs.org/
  cnpm --- http://r.cnpmjs.org/
* taobao - https://registry.npm.taobao.org/
  nj ----- https://registry.nodejitsu.com/
  rednpm - http://registry.mirror.cqupt.edu.cn/
  npmMirror  https://skimdb.npmjs.com/registry/
  edunpm - http://registry.enpmjs.org/

$ nrm use taobao

初始化项目

选择好工作目录,在终端中输入以下命令:

$ nest new project

生成的 src 目录中包含下面几个核心文件:

src
├──app.controller.ts    // 带有单个路由的基本控制器示例。
├── app.module.ts    // 定义 AppModule 应用程序的根模块。
└── main.ts    // 应用程序入口文件。它使用 NestFactory 用来创建 Nest 应用实例。

main.ts 中的内容,就是通过 NestFactory 工厂类的 create 方法,创建一个实现了 INestApplication 接口的服务实例:

import { NestFactory } from '@nestjs/core';
import { ApplicationModule } from './app.module';

async function bootstrap() {
    const app = await NestFactory.create(ApplicationModule);
    await app.listen(3000);
}

bootstrap();

更改依赖

可以采用手动传入实例的方式来更改 Nest 框架的底层依赖:

const server = express();
const app = await NestFactory.create(ApplicationModule, server);

运行多个服务

可以轻松创建多个服务器:

const httpsOptions = {
    key: fs.readFileSync("./secrets/private-key.pem"),
    cert: fs.readFileSync("./secrets/public-certificate.pem")
};

const server = express();
const app = await NestFactory.create(ApplicationModule, server);

await app.init();

http.createServer(server).listen(3000);
https.createServer(httpsOptions, server).listen(443);

运行多种服务

const app = await NestFactory.create(ApplicationModule);
const microservice = app.connectMicroservice({ transport: Transport.TCP });

await app.startAllMicroservicesAsync();
await app.listen(3001);

启动项目

在 package.json 的 npm scripts 中配置了框架的多种启动脚本:

"format": "prettier --write \"**/*.ts\"",    // 格式化 TypeScript 文件
"start": "ts-node -r tsconfig-paths/register src/main.ts",    // 启动项目
"start:dev": "nodemon",    // 使用 nodemon 启动开发环境
"prestart:prod": "rm -rf dist && tsc",    // 生产环境预启动
"start:prod": "node dist/main.js",    // 生产环境启动
"start:hmr": "node dist/server",    // 热重载启动
"test": "jest",    // 启动单元测试
"test:cov": "jest --coverage",    // 测试覆盖率
"test:e2e": "jest --config ./test/jest-e2e.json",    // 端到端测试
"webpack": "webpack --config webpack.config.js"    // 启动webpack 文件监听,用以配合热重载

使用以下脚本运行默认的HTTP服务器,在浏览器中访问 http://localhost:3000/ ,能够看到输出 Hello world!

$ npm run start

下一篇:2、Nest.js 创建基本的REST控制器

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

推荐阅读更多精彩内容