regexparam 使用教程

regexparam 使用教程

regexparamA tiny (394B) utility that converts route patterns into RegExp. Limited alternative to `path-to-regexp` 🙇‍♂️项目地址:https://gitcode.com/gh_mirrors/re/regexparam

项目介绍

regexparam 是一个轻量级的 JavaScript 工具，用于将路由模式转换为正则表达式。它的体积非常小（仅394字节），是 path-to-regexp 的一个有限替代品。通过 regexparam，你可以将一个路径字符串（例如 /users/:id）转换为一个正则表达式。返回的对象包含 { keys, pattern }，其中 pattern 是正则表达式，keys 是参数名称的数组。

项目快速启动

安装

你可以通过 npm 安装 regexparam：

npm install --save regexparam

使用示例

以下是一个简单的使用示例：

import regexparam from 'regexparam';

const result = regexparam('/users/:id');
console.log(result); // { keys: ['id'], pattern: /^\/users\/(?:([^\/]+?))\/?$/i }

const match = result.pattern.exec('/users/123');
console.log(match); // ['/users/123', '123']

应用案例和最佳实践

路由匹配

在构建服务器端或客户端路由系统时，regexparam 可以用来解析和匹配路由。例如，在 Express 应用中，你可以使用 regexparam 来处理动态路由：

import express from 'express';
import regexparam from 'regexparam';

const app = express();

const route = regexparam('/posts/:year/:month/:title');

app.get(route.pattern, (req, res) => {
  const params = route.keys.reduce((acc, key, index) => {
    acc[key] = req.params[index];
    return acc;
  }, {});
  res.send(params);
});

app.listen(3000, () => {
  console.log('Server is running on port 3000');
});

动态路径生成

在某些情况下，你可能需要根据动态参数生成路径。regexparam 可以帮助你解析这些参数并生成相应的路径：

const route = regexparam('/posts/:year/:month/:title');
const path = '/posts/2023/04/hello-world';
const match = route.pattern.exec(path);

if (match) {
  const [_, year, month, title] = match;
  console.log({ year, month, title }); // { year: '2023', month: '04', title: 'hello-world' }
}

典型生态项目

trouter

trouter 是一个基于 regexparam 的服务器端 HTTP 路由器。它扩展了 regexparam 的功能，提供了更强大的路由处理能力：

import Trouter from 'trouter';
import regexparam from 'regexparam';

const app = new Trouter();

app.add('GET', '/users/:id', (req, res) => {
  const route = regexparam('/users/:id');
  const match = route.pattern.exec(req.url);
  if (match) {
    const [_, id] = match;
    res.end(`User ID: ${id}`);
  }
});

app.listen(3000);

matchit

matchit 是另一个类似 regexparam 的库，但它依赖于字符串比较而不是正则表达式。它也是一个轻量级的路由解析工具：

import matchit from 'matchit';

const route = matchit('/users/:id');
const match = route.exec('/users/123');

if (match) {
  console.log(match.params); // { id: '123' }
}

通过这些生态项目，你可以构建更复杂和强大的路由系统，同时保持代码的简洁和高效。

regexparamA tiny (394B) utility that converts route patterns into RegExp. Limited alternative to `path-to-regexp` 🙇‍♂️项目地址:https://gitcode.com/gh_mirrors/re/regexparam