如何在NestJS中添加对Stripe的WebHook验证详解

 更新时间:2023年08月08日 10:03:56   作者:阿兵  
这篇文章主要为大家介绍了如何在NestJS中添加对Stripe的WebHook验证详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

背景介绍

Nest 是一个用于构建高效,可扩展的NodeJS 服务器端应用程序的框架。它使用渐进式JavaScript, 内置并完全支持TypeScript, 但仍然允许开发人员使用纯JavaScript 编写代码。并结合了OOP(面向对象编程),FP(函数式编程)和 FRP(函数式响应编程)的元素。

Stripe 是一家美国金融服务和软件即服务公司,总部位于美国加利福尼亚州旧金山。主要提供用于电子商务网站和移动应用程序的支付处理软件和应用程序编程接口。2020年8月4日,《苏州高新区 · 2020胡润全球独角兽榜》发布,Stripe 排名第5位。

注:接下来的内容需要有NodeJS 及NestJS 的使用经验,如果没有需要另外学习如何使用。

代码实现

1. 去除自带的Http Body Parser.

因为Nest 默认会将所有请求的结果在内部直接转换成JavaScript 对象,这在一般情况下是很方便的,但如果我们要对响应的内容进行自定义的验证的话就会有问题了,所以我们要先替换成自定义的。

首先,在根入口启动应用时传入参数禁用掉自带的Parser.

import {NestFactory} from '@nestjs/core';
import {ExpressAdapter, NestExpressApplication} from '@nestjs/platform-express';
// 应用根
import {AppModule} from '@app/app/app.module';
// 禁用bodyParser
const app = await NestFactory.create<NestExpressApplication>(
  AppModule,
  new ExpressAdapter(),
  {cors: true, bodyParser: false},
);

2. Parser 中间件

然后定义三个不同的中间件:

  • 给Stripe 用的Parser
// raw-body.middleware.ts
import {Injectable, NestMiddleware} from '@nestjs/common';
import {Request, Response} from 'express';
import * as bodyParser from 'body-parser';
@Injectable()
export class RawBodyMiddleware implements NestMiddleware {
  use(req: Request, res: Response, next: () => any) {
    bodyParser.raw({type: '*/*'})(req, res, next);
  }
}
// raw-body-parser.middleware.ts
import {Injectable, NestMiddleware} from '@nestjs/common';
import {Request, Response} from 'express';
@Injectable()
export class RawBodyParserMiddleware implements NestMiddleware {
  use(req: Request, res: Response, next: () => any) {
    req['rawBody'] = req.body;
    req.body = JSON.parse(req.body.toString());
    next();
  }
}
  • 给其他地方用的普通的Parser
// json-body.middleware.ts
import {Request, Response} from 'express';
import * as bodyParser from 'body-parser';
import {Injectable, NestMiddleware} from '@nestjs/common';
@Injectable()
export class JsonBodyMiddleware implements NestMiddleware {
  use(req: Request, res: Response, next: () => any) {
    bodyParser.json()(req, res, next);
  }
}

基于上面的两个不同的场景,在根App 里面给注入进去:

import {Module, NestModule, MiddlewareConsumer} from '@nestjs/common';
import {JsonBodyMiddleware} from '@app/core/middlewares/json-body.middleware';
import {RawBodyMiddleware} from '@app/core/middlewares/raw-body.middleware';
import {RawBodyParserMiddleware} from '@app/core/middlewares/raw-body-parser.middleware';
import {StripeController} from '@app/events/stripe/stripe.controller';
@Module()
export class AppModule implements NestModule {
  public configure(consumer: MiddlewareConsumer): void {
    consumer
      .apply(RawBodyMiddleware, RawBodyParserMiddleware)
      .forRoutes(StripeController)
      .apply(JsonBodyMiddleware)
      .forRoutes('*');
  }
}

这里我们对实际处理WebHook 的相关Controller 应用了RawBodyMiddleware, RawBodyParserMiddleware 这两个中间件,它会在原来的转换结果基础上添加一个未转换的键,将Raw Response 也返回到程序内以作进一步处理;对于其他的地方,则全部使用一个默认的,和内置那个效果一样的Json Parser.

3. Interceptor 校验器

接下来,我们写一个用来校验的Interceptor. 用来处理验证,如果正常则通过,如果校验不通过则直接拦截返回。

import {
  BadRequestException,
  CallHandler,
  ExecutionContext,
  Injectable,
  Logger,
  NestInterceptor,
} from '@nestjs/common';
import Stripe from 'stripe';
import {Observable} from 'rxjs';
import {ConfigService} from '@app/shared/config/config.service';
import {StripeService} from '@app/shared/services/stripe.service';
@Injectable()
export class StripeInterceptor implements NestInterceptor {
  private readonly stripe: Stripe;
  private readonly logger = new Logger(StripeInterceptor.name);
  constructor(
    private readonly configService: ConfigService,
    private readonly stripeService: StripeService,
  ) {
    // 等同于
    // this.stripe = new Stripe(secret, {} as Stripe.StripeConfig);
    this.stripe = stripeService.getClient();
  }
  intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
    const request = context.switchToHttp().getRequest();
    const signature = request.headers['stripe-signature'];
    // 因为Stripe 的验证是不同的WebHook 有不同的密钥的
    // 这里只需要根据业务的需求增加对应的密钥就行
    const CHARGE_SUCCEEDED = this.configService.get(
      'STRIPE_SECRET_CHARGE_SUCCEEDED',
    );
    const secrets = {
      'charge.succeed': CHARGE_SUCCEEDED,
    };
    const secret = secrets[request.body['type']];
    if (!secret) {
      throw new BadRequestException({
        status: 'Oops, Nice Try',
        message: 'WebHook Error: Function not supported',
      });
    }
    try {
      this.logger.log(signature, 'Stripe WebHook Signature');
      this.logger.log(request.body, 'Stripe WebHook Body');
      const event = this.stripe.webhooks.constructEvent(
        request.rawBody,
        signature,
        secret,
      );
      this.logger.log(event, 'Stripe WebHook Event');
    } catch (e) {
      this.logger.error(e.message, 'Stripe WebHook Validation');
      throw new BadRequestException({
        status: 'Oops, Nice Try',
        message: `WebHook Error: ${e.message as string}`,
      });
    }
    return next.handle();
  }
}

4. 应用到Controller

最后,我们把这个Interceptor 加到我们的WebHook Controller 上。

import {Controller, UseInterceptors} from '@nestjs/common';
import {StripeInterceptor} from '@app/core/interceptors/stripe.interceptor';
@Controller('stripe')
@UseInterceptors(StripeInterceptor)
export class StripeController {}

大功告成!

以上就是如何在NestJS中添加对Stripe的WebHook验证详解的详细内容,更多关于NestJS添加Stripe WebHook验证的资料请关注脚本之家其它相关文章!

相关文章

  • Node.js与MongoDB构建后端评论系统实战指南

    Node.js与MongoDB构建后端评论系统实战指南

    Node.js作为一门基于Chrome V8引擎的JavaScript运行环境,它的非阻塞I/O模型和事件驱动架构使得它在处理大量并发连接方面表现优异,成为了构建网络应用的流行选择,本文讲述Node.js与MongoDB构建后端评论系统实战,感兴趣的朋友一起看看吧
    2025-04-04
  • 使用C++为node.js写扩展模块

    使用C++为node.js写扩展模块

    本文给大家介绍的是在window7下使用C++来给node.js编写扩展模块的方法,附上一个简单的hello实例,有需要的小伙伴可以参考下。
    2015-04-04
  • VsCode无法识别node问题解决过程

    VsCode无法识别node问题解决过程

    这篇文章主要给大家介绍了关于VsCode无法识别node问题解决的相关资料,文中通过图文介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2023-07-07
  • Node获取pnpm安装的包源码及代码路径操作

    Node获取pnpm安装的包源码及代码路径操作

    这篇文章主要为大家介绍了Node如何获取pnpm安装的包源码真实代码路径并操作,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-08-08
  • NodeJs的优势和适合开发的程序

    NodeJs的优势和适合开发的程序

    做页游或webqq这样的应用nodejs有优势,但如果做微博、豆瓣、facebook这样的社交网络,nodejs还有优势吗?另外不知道大家是什么原因选择的nodejs?是因为应用需求还是对javascript这门语言的喜欢?
    2016-08-08
  • 创建简单的node服务器实例(分享)

    创建简单的node服务器实例(分享)

    下面小编就为大家带来一篇创建简单的node服务器实例(分享)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-06-06
  • node文字生成图片的示例代码

    node文字生成图片的示例代码

    本篇文章主要介绍了node文字转图片的示例代码,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-10-10
  • Node.js利用Net模块实现多人命令行聊天室的方法

    Node.js利用Net模块实现多人命令行聊天室的方法

    Node.js Net 模块提供了一些用于底层的网络通信的小工具,包含了创建服务器/客户端的方法,下面这篇文章主要给大家介绍了Node.js利用Net模块实现命令行多人聊天室的方法,有需要的朋友们可以参考借鉴,下面来一起看看吧。
    2016-12-12
  • node 解析图片二维码的内容代码实例

    node 解析图片二维码的内容代码实例

    这篇文章主要介绍了node 解析图片二维码的内容代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-09-09
  • Node.js Buffer模块功能及常用方法实例分析

    Node.js Buffer模块功能及常用方法实例分析

    这篇文章主要介绍了Node.js Buffer模块功能及常用方法,结合实例形式分析了Buffer模块的各种常用函数及相关使用技巧,需要的朋友可以参考下
    2019-01-01

最新评论