从Nest到Nesk -- 模块化Node框架的实践

首先上一下项目地址(:>):

Nest:https://github.com/nestjs/nest

Nesk:https://github.com/kyoko-df/nesk

Nest初认识

Nest是一个深受angular激发的基于express的node框架,按照官网说明是一个旨在提供一个开箱即用的应用程序体系结构,允许轻松创建高度可测试,可扩展,松散耦合且易于维护的应用程序。

在设计层面虽然说是深受angular激发,但其实从后端开发角度来说类似于大家熟悉的Java Spring架构,使用了大量切面编程技巧,再通过装饰器的结合完全了关注上的分离。同时使用了Typescript(也支持Javascript)为主要开发语言,更保证了整个后端系统的健壮性。

强大的Nest架构

那首先为什么需要Nest框架,我们从去年开始大规模使用Node来替代原有的后端View层开发,给予了前端开发除了SPA以外的前后端分离方式。早期Node层的工作很简单-渲染页面代理接口,但在渐渐使用中大家会给Node层更多的寄托,尤其是一些内部项目中,你让后端还要将一些现有的SOA接口进行包装,对方往往是不愿意的。那么我们势必要在Node层承接更多的业务,包括不限于对数据的组合包装,对请求的权限校验,对请求数据的validate等等,早期我们的框架是最传统的MVC架构,但是我们翻阅业务代码,往往最后变成复杂且很难维护的Controller层代码(从权限校验到页面渲染一把撸到底:))。

那么我们现在看看Nest可以做什么?从一个最简单的官方例子开始看:

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

这里就启动了一个nest实例,先不看这个ValidationPipe,看ApplicationModule的内容:

@Module({ imports: [CatsModule], }) export class ApplicationModule implements NestModule { configure(consumer: MiddlewaresConsumer): void { consumer .apply(LoggerMiddleware) .with('ApplicationModule') .forRoutes(CatsController); } } @Module({ controllers: [CatsController], components: [CatsService], }) export class CatsModule {}

这里看到nest的第一层入口module,也就是模块化开发的根本,所有的controller,component等等都可以根据业务切分到某个模块,然后模块之间还可以嵌套,成为一个完整的体系,借用张nest官方的图:

从Nest到Nesk -- 模块化Node框架的实践

在nest中的component概念其实一切可以注入的对象,对于依赖注入这个概念在此不做深入解释,可以理解为开发者不需要实例化类,框架会进行实例化且保存为单例供使用。

@Controller('cats') @UseGuards(RolesGuard) @UseInterceptors(LoggingInterceptor, TransformInterceptor) export class CatsController { constructor(private readonly catsService: CatsService) {} @Post() @Roles('admin') async create(@Body() createCatDto: CreateCatDto) { this.catsService.create(createCatDto); } @Get() async findAll(): Promise<Cat[]> { return this.catsService.findAll(); } @Get(':id') findOne( @Param('id', new ParseIntPipe()) id, ): Promise<Cat> { return this.catsService.findOne(id); } }

Controller的代码非常精简,很多重复的工作都通过guards和interceptors解决,第一个装饰器Controller可以接受一个字符串参数,即为路由参数,也就是这个Controller会负责/cats路由下的所有处理。首先RolesGuard会进行权限校验,这个校验是自己实现的,大致结构如下:

@Guard() export class RolesGuard implements CanActivate { constructor(private readonly reflector: Reflector) {} canActivate(request, context: ExecutionContext): boolean { const { parent, handler } = context; const roles = this.reflector.get<string[]>('roles', handler); if (!roles) { return true; } // 自行实现 } }

context可以获取controller的相关信息,再通过反射拿到handler上是否有定义roles的元信息,如果有就可以在逻辑里根据自己实现的auth方法或者用户类型来决定是否让用户访问相关handler。

interceptors即拦截器,它可以:

在方法执行之前/之后绑定额外的逻辑

转换从函数返回的结果

转换从函数抛出的异常

根据所选条件完全重写函数 (例如, 缓存目的)

本示例有两个拦截器一个用来记录函数执行的时间,另一个对结果进行一层包装,这两个需求都是开发中很常见的需求,而且拦截器会提供一个rxjs的观察者流来处理函数返回,支持异步函数,我们可以通过map()来mutate这个流的结果,可以通过do运算符来观察函数观察序列的执行状况,另外可以通过不返回流的方式,从而阻止函数的执行,LoggingInterceptor例子如下:

@Interceptor() export class LoggingInterceptor implements NestInterceptor { intercept(dataOrRequest, context: ExecutionContext, stream$: Observable<any>): Observable<any> { console.log('Before...'); const now = Date.now(); return stream$.do( () => console.log(`After... ${Date.now() - now}ms`), ); } }

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/wppzzs.html