背景
通常,为了更好地管理和维护项目,项目一般都会以业务范畴进行拆分,比如商品、订单、会员等等,从而产生业务职责不同的众多前端工程(SPA
,单页面应用)。假设现在有个需求,所有的前端工程都需要接入神策埋点Web JS SDK
,如果采用每个前端工程静态页面index.html
各自引入Web JS SDK
的方案,那么每个工程引入之后都需要重新部署一遍,并且以后需要更换第三方埋点SDK
时,前面步骤需要重新来一遍,相当麻烦。而如果在访问所有前端工程前面加一个路由转发层,有点像前端网关,拦截响应,统一引入Web JS SDK
。
七牛云模拟实际项目对象存储服务
前端项目都会部署到对象存储服务中,比如阿里云对象存储服务OSS
,华为云对象存储服务OBS
,这儿我使用七牛云对象存储服务模拟实际的部署环境
一、创建存储空间,创建三级静态资源目录www/cassmall/inquiry
,然后上传一个index.html
模拟实际项目部署
二、给存储空间配置源站域名和CDN
域名(实际配置需要先给域名备案),请求index.html
使用源站域名,请求js
、css
、img
等静态资源使用CDN
域名
这里解释一下为什么到源站获取index.html
,而不是通过CDN
域名获取?假设通过CDN
获取index.html
,当第一次部署单页面应用,假设浏览器访问http://localhost:3000/mall/inquiry/#/xxx
,CDN
上没有index.html
则去源站拉取index.html
,然后CDN
缓存一份;当对index.html
做了修改,第二次部署(部署到源站),浏览器还是访问http://localhost:3000/mall/inquiry/#/xxx
,发现CDN
上已经有index.html
(旧),直接返回给浏览器,而不是返回源站最新的index.html
,毕竟请求index.html
的路径版本号参数,会走CDN
。如果直接使用源站域名请求index.html
,那么每次获取到的都是最新index.html
。
其实,通过CDN
域名获取index.html
也可以,不过需要设置CDN
缓存配置,让其对html
后缀的文件不做缓存处理。
另外,js
、css
、img
、video
这类静态资源我们希望页面能够快速加载,因此通过CDN
加速获取。js
、css
可能改动比较频繁,但在构建后都会根据内容生成hash
重新命名文件,若文件有更改,其hash
也会变化,请求时不会命中CDN
缓存,会回源;若文件没有更改,其hash
不会变化,则会命中CDN
缓存。img
、video
改动不会很频繁,如需要改动,则重新命名上传即可,防止同样名称命中CDN
缓存。
项目创建
首先确定你已经安装了Node.js
, Node.js
安装会附带npx
和一个npm
包运行程序。请确保在您的操作系统上安装了Node.js (>= 10.13.0,v13 除外)
。要创建新的Nest.js
应用程序,请在终端上运行以下命令:
npm i -g @nestjs/cli // 全局安装Nest
nest new web-node-router-serve // 创建项目
执行完创建项目, 会初始化下面这些文件, 并且询问你要是有什么方式来管理依赖包:
如果你有安装yarn
,可以选择yarn
,能更快一些,npm
在国内安装速度会慢一些
接下来按照提示运行项目:
项目结构
进入项目,看到的目录结构应该是这样的:
这里简单说明一下这些核心文件:
src
├── app.controller.spec.ts
├── app.controller.ts
├── app.module.ts
├── app.service.ts
├── main.ts
app.controller.ts |
单个路由的基本控制器(Controller) |
---|---|
app.controller.spec.ts |
针对控制器的单元测试 |
app.module.ts |
应用程序的根模块(Module) |
app.service.ts |
具有单一方法的基本服务(Service) |
main.ts |
应用程序的入口文件,它使用核心函数 NestFactory 来创建 Nest 应用程序的实例。 |
main.ts
文件中包含了一个异步函数,此函数将 引导(bootstrap) 应用程序的启动过程:
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
async function bootstrap() {
const app = await NestFactory.create(AppModule);
await app.listen(3000);
}
bootstrap();
要创建一个 Nest
应用程序的实例,我们使用了 NestFactory
核心类。NestFactory
暴露了一些静态方法用于创建应用程序的实例。其中,create()
方法返回一个应用程序的对象,该对象实现了 INestApplication
接口。在上面的 main.ts
示例中,我们仅启动了 HTTP
侦听器,该侦听器使应用程序可以侦听入栈的 HTTP
请求。
应用程序的入口文件
我们调整一下入口文件main.ts
,端口可以通过命令输入设置:
import { INestApplication } from '@nestjs/common';
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
const PORT = parseInt(process.env.PORT, 10) || 3334; // 端口
async function bootstrap() {
const app = await NestFactory.create(AppModule);
await app.listen(PORT);
}
bootstrap();
配置请求路径与静态资源目录的映射关系
不同环境的对象存储服务域名不一样,需要不同的配置文件,使用第三方模块config
模块管理操作配置文件。安装config
:
yarn add config
在根目录下新建config
目录,目录下新增default.js
、development.js
、production.js
,添加如下配置:
// default.js
module.exports = {
ROUTES: [
{
cdnRoot: 'www/cassmall/inquiry', // 对象存储服务对应的静态资源目录
url: ['/cassmall/inquiry'], // 请求路径
},
{
cdnRoot: 'www/admin/vip',
url: ['/admin/vip'],
},
],
};
// development.js
module.exports = {
OSS_BASE_URL: 'http://r67b3sscj.hn-bkt.clouddn.com/', // 开发环境对象存储服务源站域名
};
// production.js
module.exports = {
OSS_BASE_URL: 'http://r737i21yz.hn-bkt.clouddn.com/', // 生产环境对象存储服务源站域名
};
说一下config.get()
查找环境参数的规则:如果NODE_ENV
为空,使用development.js
,如果没有development.js
,则使用default.js
。 若NODE_ENV
不为空,则到config
目录中找相应的文件,若文件没找到则使用default.js
中的内容。 若在指定的文件中没找到配置项,则去default.js
找。
创建路由控制器
// app.controller.ts
import {
Controller,
Get,
Header,
HttpException,
HttpStatus,
Req,
} from '@nestjs/common';
import { AppService } from './app.service';
import { Request } from 'express';
import config from 'config';
type Route = { gitRepo: string; cdnRoot: string; url: string[] };
const routes = config.get('ROUTES');
const routeMap: { [key: string]: Route } = {};
routes.forEach((route) => {
for (const url of route.url) {
routeMap[url] = route;
}
});
@Controller()
export class AppController {
constructor(private readonly appService: AppService) {}
@Get(Object.keys(routeMap))
@Header('X-UA-Compatible', 'IE=edge,chrome=1')
async route(@Req() request: Request): Promise {
const path = request.path.replace(/\/$/g, '');
const route = routeMap[request.path];
if (!route) {
throw new HttpException(
'没有找到当前url对应的路由',
HttpStatus.NOT_FOUND,
);
}
// 获取请求路径对应的静态页面
return this.appService.fetchIndexHtml(route.cdnRoot);
}
}
esm
引入cjs
第三方模块config
是cjs
规范的模块,使用esm
方式引入cjs
之前需要在tsconfig.json
添加配置:
{
"compilerOptions": {
"allowSyntheticDefaultImports": true, // ESM导出没有设置default,被引入时不报错
"esModuleInterop": true, // 允许使用ESM带入CJS
}
}
当然你可以直接使用cjs
规范引入const config = require('config')
或者改成import * as config from 'config'
引入,不然运行时会报下面错误:
因为esm
导入 cjs
,esm
有 default
这个概念,而 cjs
没有。导致导入的config
值为undefined
任何导出的变量在 cjs
看来都是 module.exports
这个对象上的属性,esm
的 default
导出也只是 cjs
上的 module.exports.default
属性而已。设置esModuleInterop:true;
后tsc
编译时会给module.exports
添加default
属性
// before
import config from 'config';
console.log(config);
// after
"use strict";
var _config = _interopRequireDefault(require("config"));
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
console.log(_config["default"]);
想了解这部分模块化处理,可以参考[tsc、babel、webpack对模块导入导出的处理](https://segmentfault.com/a/11...)
@Get
接受路由路径数组
@Get()
HTTP
请求方法装饰器可以接受路由路径数组类型,告诉控制器可以处理哪些路由路径的请求
/**
* Route handler (method) Decorator. Routes HTTP GET requests to the specified path.
*
* @see [Routing](https://docs.nestjs.com/controllers#routing)
*
* @publicApi
*/
export declare const Get: (path?: string | string[]) => MethodDecorator;
异常处理
当路由配置没有对应路由时抛出异常,如果没有自定义异常拦截处理,则Nest内置异常层会自动处理,生成JSON
响应
const path = request.path.replace(/\/$/g, '');
const route = routeMap[request.path];
if (!route) {
throw new HttpException(
'没有找到当前url对应的路由',
HttpStatus.NOT_FOUND,
);
}
// 异常将会被Nest自动处理,生成下面JSON响应
{
"statusCode": 404,
"message": "没有找到当前url对应的路由"
}
Nest
带有一个内置的异常层,负责处理应用程序中所有未处理的异常。当您的应用程序代码未处理异常时,该层将捕获该异常,然后自动发送适当的用户友好响应。
开箱即用,此操作由内置的全局异常过滤器执行,该过滤器处理类型HttpException
(及其子类)的异常。当异常无法识别(既不是HttpException
也不是继承自的类HttpException
)时,内置异常过滤器会生成以下默认 JSON
响应:
{
"statusCode": 500,
"message": "Internal server error"
}
Nest
自动包装请求处理程序返回
可以看到上面请求处理程序直接返回html
字符串,页面请求得到200
状态码,text/html
类型的响应体,这是怎么回事呢?其实Nest
使用两种不同的选项来操作响应的概念:
标准(推荐) | 使用此内置方法,当请求处理程序返回 JavaScript 对象或数组时,它会自动序列化为 JSON 。然而,当它返回一个 JavaScript 原始类型(例如 , string , )时,Nest 将只发送该值而不尝试对其进行序列化。这使得响应处理变得简单:只需返回值,其余的由 Nest 处理。此外,响应的状态码默认始终为 200 ,除了使用 201 的 POST 请求。我们可以通过在处理程序级别添加装饰器来轻松更改此行为(请参阅状态码)。number boolean @HttpCode(...) |
---|---|
特定于库 | 我们可以使用库特定的(例如,Express )响应对象,它可以使用@Res() 方法处理程序签名中的装饰器(例如,findAll(@Res() response) )注入。通过这种方法,您可以使用该对象公开的本机响应处理方法。例如,使用 Express ,您可以使用类似response.status(200).send() . |
service层获取静态页面
// app.service.ts
import { HttpException, HttpStatus, Injectable } from '@nestjs/common';
import config from 'config';
import { IncomingHttpHeaders } from 'http';
import rp from 'request-promise';
interface CacheItem {
etag: string;
html: string;
}
interface HttpError extends Error {
result?: E;
}
interface HttpClientRes {
err?: HttpError;
statusCode?: number;
result?: T;
headers?: IncomingHttpHeaders;
}
@Injectable()
export class AppService {
// 缓存
private cache: { [url: string]: CacheItem | undefined } = {};
async fetchIndexHtml(cdnRoot: string): Promise {
const ossUrl = `${config.get('OSS_BASE_URL')}${cdnRoot}/index.html`;
const cacheItem = this.cache[ossUrl];
// 请求options
const options = {
uri: ossUrl,
resolveWithFullResponse: true, // 设置获取完整的响应,当值为false时,响应体只有body,拿不到响应体中的headers
headers: {
'If-None-Match': cacheItem && cacheItem.etag,
},
};
// 响应
const httpRes: HttpClientRes = {};
try {
const response = await rp(options).promise();
const { statusCode, headers, body } = response;
httpRes.statusCode = statusCode;
httpRes.headers = headers;
if (statusCode < 300) {
httpRes.result = body;
} else {
const err: HttpError = new Error(
`Request: 请求失败,${response.statusCode}`,
);
err.name = 'StatusCodeError';
err.result = body;
httpRes.err = err;
}
} catch (err) {
httpRes.statusCode = err.statusCode; // 对于 GET 和 HEAD 方法来说,当验证失败的时候(有相同的Etag),服务器端必须返回响应码 304 (Not Modified,未改变)
httpRes.err = err;
}
if (httpRes.statusCode === HttpStatus.OK) {
// 文件有变化,更新缓存,并返回最新文件
const finalHtml = this.htmlPostProcess(httpRes.result);
const etag = httpRes.headers.etag;
this.cache[ossUrl] = {
etag,
html: finalHtml,
};
return finalHtml;
} else if (httpRes.statusCode === HttpStatus.NOT_MODIFIED) {
// 文件没有变化,返回缓存文件
return this.cache[ossUrl].html;
} else {
if (!this.cache[ossUrl]) {
throw new HttpException(
`不能正常获取页面 ${cdnRoot}`,
HttpStatus.NOT_FOUND,
);
}
}
// 兜底
return this.cache[ossUrl].html;
}
// 预处理
htmlPostProcess(html: string) {
return html;
}
}