使用NestJS开发Node.js应用的方法


Posted in Javascript onDecember 03, 2018

NestJS 最早在 2017.1 月立项,2017.5 发布第一个正式版本,它是一个基于 Express,使用 TypeScript 开发的后端框架。设计之初,主要用来解决开发 Node.js 应用时的架构问题,灵感来源于 Angular。在本文中,我将粗略介绍 NestJS 中的一些亮点。

组件容器

使用NestJS开发Node.js应用的方法

NestJS 采用组件容器的方式,每个组件与其他组件解耦,当一个组件依赖于另一组件时,需要指定节点的依赖关系才能使用:

import { Module } from '@nestjs/common';
import { CatsController } from './cats.controller';
import { CatsService } from './cats.service';
import { OtherModule } from '../OtherModule';

@Module({
 imports: [OtherModule],
 controllers: [CatsController],
 providers: [CatsService],
})
export class CatsModule {}

依赖注入(DI)

与 Angular 相似,同是使用依赖注入的设计模式开发

使用NestJS开发Node.js应用的方法

当使用某个对象时,DI 容器已经帮你创建,无需手动实例化,来达到解耦目的:

// 创建一个服务
@Inject()
export class TestService {
 public find() {
 return 'hello world';
 }
}

// 创建一个 controller
@Controller()
export class TestController {
 controller(
 private readonly testService: TestService
 ) {}
 
 @Get()
 public findInfo() {
 return this.testService.find()
 }
}

为了能让 TestController 使用 TestService 服务,只需要在创建 module 时,作为 provider 写入即可:

@Module({
 controllers: [TestController],
 providers: [TestService],
})
export class TestModule {}

当然,你可以把任意一个带 @Inject() 的类,注入到 module 中,供此 module 的 Controller 或者 Service 使用。

背后的实现基于 Decorator + Reflect Metadata,详情可以查看深入理解 TypeScript - Reflect Metadata 。

细粒化的 Middleware

在使用 Express 时,我们会使用各种各样的中间件,譬如日志服务、超时拦截,权限验证等。在 NestJS 中,Middleware 功能被划分为 Middleware、Filters、Pipes、Grards、Interceptors。

例如使用 Filters,来捕获处理应用中抛出的错误:

@Catch()
export class AllExceptionsFilter implements ExceptionFilter {
 catch(exception: any, host: ArgumentsHost) {
 const ctx = host.switchToHttp();
 const response = ctx.getResponse();
 const request = ctx.getRequest();
 const status = exception.getStatus();

 // 一些其他做的事情,如使用日志

 response
  .status(status)
  .json({
  statusCode: status,
  timestamp: new Date().toISOString(),
  path: request.url,
  });
 }
}

使用 interceptor,拦截 response 数据,使得返回数据格式是 { data: T } 的形式:

import { Injectable, NestInterceptor, ExecutionContext } from '@nestjs/common';
import { Observable } from 'rxjs';
import { map } from 'rxjs/operators';

export interface Response<T> {
 data: T;
}

@Injectable()
export class TransformInterceptor<T>
 implements NestInterceptor<T, Response<T>> {
 intercept(
 context: ExecutionContext,
 call$: Observable<T>,
 ): Observable<Response<T>> {
 return call$.pipe(map(data => ({ data })));
 }
}

使用 Guards,当不具有 'admin' 角色时,返回 401:

import { ReflectMetadata } from '@nestjs/common';
export const Roles = (...roles: string[]) => ReflectMetadata('roles', roles);

@Post()
@Roles('admin')
async create(@Body() createCatDto: CreateCatDto) {
 this.catsService.create(createCatDto);
}

数据验证

得益于class-validator 与class-transformer 对传入参数的验证变的非常简单:

// 创建 Dto
export class ContentDto {
 @IsString()
 text: string
}

@Controller()
export class TestController {
 controller(
 private readonly testService: TestService
 ) {}
 
 @Get()
 public findInfo(
 @Param() param: ContentDto  // 使用
 ) {
 return this.testService.find()
 }
}

当所传入参数 text 不是 string 时,会出现 400 的错误。

GraphQL

GraphQL 由 facebook 开发,被认为是革命性的 API 工具,因为它可以让客户端在请求中指定希望得到的数据,而不像传统的 REST 那样只能在后端预定义。

NestJS 对 Apollo server 进行了一层包装,使得能在 NestJS 中更方便使用。

在 Express 中使用 Apollo server 时:

const express = require('express');
const { ApolloServer, gql } = require('apollo-server-express');

// Construct a schema, using GraphQL schema language
const typeDefs = gql`
 type Query {
 hello: String
 }
`;

// Provide resolver functions for your schema fields
const resolvers = {
 Query: {
 hello: () => 'Hello world!',
 },
};

const server = new ApolloServer({ typeDefs, resolvers });

const app = express();
server.applyMiddleware({ app });

const port = 4000;

app.listen({ port }, () =>
 console.log(`Server ready at http://localhost:${port}${server.graphqlPath}`),
);

在 NestJS 中使用它:

// test.graphql
type Query {
 hello: string;
}


// test.resolver.ts
@Resolver()
export class {
 @Query()
 public hello() {
 return 'Hello wolrd';
 }
}

使用 Decorator 的方式,看起来也更 TypeScript

其他

除上述一些列举外,NestJS 实现微服务开发、配合 TypeORM 、以及 Prisma 等特点,在这里就不展开了。

参考

深入理解 TypeScript - Reflect Metadata

Egg VS NestJS

NestJS 官网

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
javascript 隐藏/显示指定的区域附HTML元素【legend】用法
Mar 05 Javascript
jquery中获得$.ajax()事件返回的值并添加事件的方法
Apr 15 Javascript
关于JavaScript中原型继承中的一点思考
Jul 25 Javascript
jquery Moblie入门—hello world的示例代码学习
Jan 08 Javascript
JS操作图片(增,删,改) 例子
Apr 17 Javascript
js解决select下拉选不中问题
Oct 14 Javascript
使用node+vue.js实现SPA应用
Jan 28 Javascript
javascript实现的图片预览功能
Mar 25 Javascript
vue 实现数字滚动增加效果的实例代码
Jul 06 Javascript
vue实现点击隐藏与显示实例分享
Feb 13 Javascript
JS中使用react-tooltip插件实现鼠标悬浮显示框
May 15 Javascript
vue解决跨域问题(推荐)
Nov 10 Javascript
写gulp遇到的ES6问题详解
Dec 03 #Javascript
使用mpvue搭建一个初始小程序及项目配置方法
Dec 03 #Javascript
JS基于Location实现访问Url、重定向及刷新页面的方法分析
Dec 03 #Javascript
koa2实现登录注册功能的示例代码
Dec 03 #Javascript
react-router 路由切换动画的实现示例
Dec 03 #Javascript
Vue.js 中的 v-model 指令及绑定表单元素的方法
Dec 03 #Javascript
ng-zorro-antd 入门初体验
Dec 03 #Javascript
You might like
php下载文件超时时间的设置方法
2016/10/06 PHP
php获取字符串前几位的实例(substr返回字符串的子串用法)
2017/03/08 PHP
PHP大文件切割上传并带进度条功能示例
2019/07/01 PHP
使用swoole 定时器变更超时未支付订单状态的解决方案
2019/07/24 PHP
JavaScript ECMA-262-3 深入解析.第三章.this
2011/09/28 Javascript
js调用后台、后台调用前台等方法总结
2014/04/17 Javascript
js 中将多个逗号替换为一个逗号的代码
2014/06/07 Javascript
javascript感应鼠标图片透明度显示的方法
2015/02/24 Javascript
JavaScript File分段上传
2016/03/10 Javascript
[原创]JavaScript语法高亮插件highlight.js用法详解【附highlight.js本站下载】
2016/11/01 Javascript
jQuery封装animate.css的实例
2018/01/04 jQuery
layui弹出层按钮提交iframe表单的方法
2018/08/20 Javascript
vue新vue-cli3环境配置和模拟json数据的实例
2018/09/19 Javascript
jquery.pagination.js分页使用教程
2018/10/23 jQuery
python实现从ftp服务器下载文件的方法
2015/04/30 Python
python简单的函数定义和用法实例
2015/05/07 Python
Python编程中用close()方法关闭文件的教程
2015/05/24 Python
python使用正则表达式替换匹配成功的组
2017/11/17 Python
新年快乐! python实现绚烂的烟花绽放效果
2019/01/30 Python
深入浅析python3中的unicode和bytes问题
2019/07/03 Python
python3 tcp的粘包现象和解决办法解析
2019/12/09 Python
pandas实现DataFrame显示最大行列,不省略显示实例
2019/12/26 Python
python 中的[:-1]和[::-1]的具体使用
2020/02/13 Python
pip安装tensorflow的坑的解决
2020/04/19 Python
Python非单向递归函数如何返回全部结果
2020/12/18 Python
Python3利用openpyxl读写Excel文件的方法实例
2021/02/03 Python
Html5剪切板功能的实现代码
2018/06/29 HTML / CSS
Beauty Expert美国/加拿大:购买奢侈美容产品
2018/12/05 全球购物
常用UNIX 命令(Linux的常用命令)
2015/12/26 面试题
2014年医学生毕业自我鉴定
2014/03/26 职场文书
网页美工求职信范文
2014/04/17 职场文书
意向协议书范本
2014/04/23 职场文书
安全在我心中演讲稿
2014/09/01 职场文书
毕业生就业推荐表自我评价
2015/03/02 职场文书
公司档案管理制度
2015/08/05 职场文书
2019年关于小学生课外阅读情况的分析报告
2019/12/02 职场文书