Routr：双端路由功能的JavaScript库

1. 项目介绍

Routr 是一个开源的 JavaScript 库，为客户端和服务器端提供路由相关功能。它遵循与 Express 相同的路由规则，但与传统的回调函数不同，Routr 将路由映射到字符串名称，这些名称可以作为应用程序状态，并在应用中后续使用。这使得在如 Flux 这样的架构中，当前路由可以作为一个状态存储在商店中。

2. 项目快速启动

安装

首先，确保你的环境已经安装了 Node.js 和 npm。

npm install routr

创建路由

创建一个新的路由器实例，并定义一些路由规则。

const Router = require('routr');

const router = new Router([
  {
    name: 'view_user',
    path: '/user/:id',
    method: 'get',
    foo: { bar: 'baz' }
  },
  {
    name: 'view_user_post',
    path: '/user/:id/post/:post',
    method: 'get'
  }
]);

匹配路由

使用提供的 URL 来匹配路由。

const route = router.getRoute('/user/garfield?foo=bar');

if (route) {
  console.log('[Route found]:', route);
}

路由输出

如果找到路由，它将输出以下信息：

• route.name: "view_user"
• route.url: "/user/garfield"
• route.params: {id: "garfield"}
• route.config: {path: "/user/:id", method: "get", foo: { bar: "baz"}}
• route.query: { foo: 'bar' }

生成路径

从路由名称和参数生成路径。

const path = router.makePath('view_user_post', {id: 'garfield', post: 'favoriteFood'}, {meal: 'breakfast'});

path 将是 "/user/garfield/post/favoriteFood?meal=breakfast"。

生产环境

在生产环境中，建议使用 envify 和 uglify 工具来删除特定环境的代码，以提高性能。

if (process.env.NODE_ENV !== 'production') {
  // 非生产环境下的代码
}

3. 应用案例和最佳实践

使用 Routr 库时，建议创建清晰的路由名称，并保持路由配置的一致性。通过在非生产环境中使用 Object.freeze 来确保路由对象的不可变性。以下是一个使用 Webpack 构建项目的示例配置：

plugins: [
  new webpack.DefinePlugin({
    'process.env': {
      NODE_ENV: JSON.stringify('production')
    }
  }),
  new webpack.optimize.UglifyJsPlugin()
]

对于 Browserify，可以使用以下命令行：

$ browserify index.js -t [ envify --NODE_ENV production ] | uglifyjs -c > bundle.js

4. 典型生态项目

Routr 作为一个轻量级路由库，可以与多种前端框架和库搭配使用，例如 React、Vue 或 Angular。它也支持 Node.js 的服务器端应用，与其他中间件如 Express 或 Koa 配合工作，以构建强大的 web 服务。在开源生态中，Routr 可以作为构建模块化前端应用的一部分，为开发者提供灵活的路由管理方案。