url的正则表达式path-to-regexp在Angular中的使用

前端有的时候需要对http请求进行处理,比如有的 api 不需要带 token 访问,有的直接请求第三方接口。之前处理的方式是简单的包含判断,后来发现这样不够严谨也容易出问题。
正确的做法是用正则去匹配,但是自己写的也难保不会出错,所以就找了第三方库:path-to-regexp。

什么是 path-to-regexp?

将字符串路径转换为正则表达式的工具。
比如:/user/:id 转换为 /^\/user\/((?:[^\/]+?))(?:\/(?=$))?$/i
这样只需要规定想匹配的api就行了,而不需要花费大量时间去写或者调试正则。

参数

它有三个参数:path,keys,options
path: 传入的url
类型:String, Array, RegExp

keys:追加在 path 中解析到的命名参数
类型:Array

// 传入的 keys 为[1,2],url 中 bar 为参数,会将bar解析出来追加到 keys 中
var keys = [1,2]
var re = pathToRegexp('/foo/:bar', keys)
// re = /^\/foo\/([^\/]+?)\/?$/i
// keys = [1,2,{ name: 'bar', prefix: '/', delimiter: '/', optional: false, repeat: false, pattern: '[^\\/]+?' }]

options: 可设置大小写是否敏感,匹配给定的开头或结尾,编码等
具体可点击 path-to-regexp 查看。
类型:Object

API

  1. pathToRegexp
    创建一个pathToRegexp对象。
pathToRegexp("/user/:id");
  1. parse()
    解析 url 参数
const params = parse("/user/:id");
console.log(params);
// 打印结果为:
[
 '/user',
  {
    name: 'id',
    prefix: '/',
    delimiter: '/',
    optional: false,
    repeat: false,
    partial: false,
    pattern: '[^\\/]+?'
 } 
]
  1. compile()
    填充参数
const toPathRaw = compile("/user/:id");
toPathRaw({ id: 1 })
//  结果为:
// "/user/1"
  1. match()
    url 匹配
const mm = match("/user/:id", { decode: decodeURIComponent });
console.log(mm("/user")) // false
console.log(mm("/user/123")); // { path: '/user/123', index: 0, params: { id: '123' } }

如果路由字符串是没有经过 url 转义的,则可能导致一些未知的问题,所以在适当的时候,应该考虑对原始的路由串进行 encode 处理。

Angular 使用 path-to-regexp

安装:

npm install path-to-regexp --save

在 angular10 中,Angular CLI 检测到你的浏览器端应用依赖了 CommonJS 模块,就会发出警告,所以需要在 angular.json 文件中 build 区添加 allowedCommonJsDependencies 配置:

"build":  {  
  "builder":  "@angular-devkit/build-angular:browser",  
  "options":  {  
    "allowedCommonJsDependencies":  [  
        "path-to-regexp"  
      ]  ...  
    }  ...  
},

在 ts 文件中引用:

import { pathToRegexp, match, parse, compile } from 'path-to-regexp';
//   需要哪个引入哪个即可

使用 path-to-regexp:

// 不需要登陆
filterUrl = ['login']

// 直接访问第三方
filterNetUrl = ['https', 'http'];

// 判断是否为直接访问第三方接口的api
 this.filterNetUrl.find(fu => {
      const mm = match(fu);
      if(mm(url)) {
      // 处理逻辑
      }
 })

// 判断是否为不需要登陆访问的api
 this.filterUrl.find(fu => {
  const mm = match(`/api/${fu}`);
    if(mm(url)) {
     // 处理逻辑
    }
 })

这样就可以根据不同 api 类型处理不同 http 请求。

总结:
path-to-regexp 是一个强大的处理前端路由的工具,对于一些复杂的路由或者判断使用它可以规避很多潜在的问题。

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

推荐阅读更多精彩内容