Railstyle-router NPM

Rails-like routing for Express 3.x

高仿 Rails 路由的几个常用方法，支持 namespace，支持多级嵌套，支持 before_filter。欢迎 Pull Requests。

Installation

$ npm install railstyle-router

Usage

var express = require('express')
require('railstyle-router')

var app = express()

app.configure(function() {
  // 设置 controller 目录的路径
  app.set('controllers', __dirname + '/controllers')
  // 设置 controller 文件名后缀，默认为空
  app.set('controller suffix', '_controller')
})

app.resources('users')
app.match('/login', 'sessions#new')

./controllers/users_controller.js:

// GET /users
exports.index = function(req, res) {
  res.send('index')
}

// GET /users/new
exports.new = function(req, res) {
  res.send('new')
}

// POST /users
exports.create = function(req, res) {
  res.send('create')
}

// GET  /users/:id
exports.show = function(req, res) {
  res.send('show')
}

// GET  /users/:id/edit
exports.edit = function(req, res) {
  res.send('edit')
}

// PUT  /users/:id
exports.update = function(req, res) {
  res.send('update')
}

// DELETE  /users/:id
exports.destroy = function(req, res) {
  res.send('destroy')
}

APIs

.resources(name, options)

默认绑定 index, show, new, edit, create, update, destroy 七个 actions。

options 支持：

path: 重写 URL 路径，不设置则默认同 name 一致
only: 指定需要的 actions，必须传入数组
except: 排除指定的 actions，必须传入数组

举个栗子:chestnut:：

app.resources('users')

GET    /users.:format?            users#index
GET    /users/:id.:format?        users#show
GET    /users/new.:format?        users#new
GET    /users/:id/edit.:format?   users#edit
POST   /users.:format?            users#create
PUT    /users/:id.:format?        users#update
DELETE /users/:id.:format?        users#destroy

app.resources('users', {
  path: 'person',
  only: ['show', 'new', 'create']
})

GET  /person/:id.:format?   users#show
GET  /person/new.:format?   users#new
POST /person.:format?       users#create

.resource(name, options)

默认绑定 show, new, edit, create, update, destroy 六个 actions。 options 同 resources。

举个:chestnut:：

app.resource('users')

GET    /users.:format?        users#show
GET    /users/new.:format?    users#new
GET    /users/edit.:format?   users#edit
POST   /users.:format?        users#create
PUT    /users.:format?        users#update
DELETE /users.:format?        users#destroy

.member(routes) / .collection(routes)

这两个方法用于创建非 RESTful 的路由，只能在 resources 或 resource 的回调中使用：

app.resources('users', { only: [] }, function() {
  this.member({
    get: 'profile, avatar'
  })
})

GET  /users/:id/profile.:format?   users#profile
GET  /users/:id/avatar.:format?    users#avatar

app.resources('users', { only: [] }, function() {
  this.collection({
    get: ['profile', 'avatar']
  })
})

GET  /users/profile.:format?   users#profile
GET  /users/avatar.:format?    users#avatar

回调君还能协助实现嵌套路由，上:chestnut:：

app.resources('users', { only: ['show'] }, function() {
  this.resources('tweets', function() {
    this.resource('comments', { only: ['show'] })
    this.member({ post: 'balabala' })
  })
})

GET    /users/:id.:format?                                  users#show

GET    /users/:user_id/tweets.:format?                      tweets#index
GET    /users/:user_id/tweets/:id.:format?                  tweets#show
GET    /users/:user_id/tweets/new.:format?                  tweets#new
GET    /users/:user_id/tweets/:id/edit.:format?             tweets#edit
POST   /users/:user_id/tweets.:format?                      tweets#create
PUT    /users/:user_id/tweets/:id.:format?                  tweets#update
DELETE /users/:user_id/tweets/:id.:format?                  tweets#destroy
POST   /users/:user_id/tweets/:id/balabala.:format?         tweets#balabala

GET    /users/:user_id/tweets/:tweet_id/comments.:format?   comments#show

.match(path, namespace/controller#action)

使某个 controller 下的 action 与指定的路径匹配，同时兼容 get, post, put, delete 四个 HTTP verbs。

app.match('/login', 'sessions#new')

GET|POST|PUT|DELETE  /login.:format?   sessions#new

.namespace(path, callback)

app.namespace('admin', function() {
  // load `./controllers/admin/users_controller.js`
  this.resources('users', { except: ['index', 'destroy'] })
})

GET  /admin/users/:id.:format?        admin/users#show
GET  /admin/users/new.:format?        admin/users#new
GET  /admin/users/:id/edit.:format?   admin/users#edit
POST /admin/users.:format?            admin/users#create
PUT  /admin/users/:id.:format?        admin/users#update

before_filter

在 controller 文件中加上如下代码即可。星号 * 匹配所有 actions，且优先级最高。

exports.before_filter = {
  '*': auth,
  create: admin,
  destroy: [admin, master]
}

function auth(req, res, next) {
  // ...
  next()
}
function admin(req, res, next) {
  // ...
  next()
}
function master(req, res, next) {
  // ...
  next()
}