express框架路由配置及controller自動載入

向藍天招手發表於2016-06-02

express框架在node官方推薦的一個框架,關於如何入門的文章,已經很多了,我就不在累贅了,本文的核心是如何修改檔案使得更接近一個MVC的框架

express原生是通過require的方式實現了模組的載入,而且是在程式啟動時一次性全部載入(因此我的按需載入的方案擱淺了),如果在配置路由的時候都載入一次,然後全部寫在app.js檔案中,我的天吶,對於一個大型專案來說極難維護,因此必須將其分割。下面我們就來幹這麼一件事。

上圖是我的檔案目錄:

  1.   controller  資料夾是控制器
  2.      model 資料夾是資料模型
  3.      config.js 是配置檔案
  4.      app.js  預設主檔案
  5.      route.js 路由配置檔案(我刪除了原來的route檔案,將其中的檔案移到了controller中)

 先來看看我的app.js吧

var express = require('express');
var path = require('path');
var favicon = require('serve-favicon');
var logger = require('morgan');
var cookieParser = require('cookie-parser');
var bodyParser = require('body-parser');

var route = require("./route");

var app = express();

// view engine setup
app.set('views', path.join(__dirname, 'views'));
app.set('view engine', 'ejs');

// uncomment after placing your favicon in /public
//app.use(favicon(path.join(__dirname, 'public', 'favicon.ico')));
app.use(logger('dev'));
app.use(bodyParser.json());
app.use(bodyParser.urlencoded({ extended: false }));
app.use(cookieParser());
app.use(express.static(path.join(__dirname, 'public')));

route(app);

// catch 404 and forward to error handler
app.use(function(req, res, next) {
  var err = new Error('Not Found');
  err.status = 404;
  next(err);
});

// error handlers

// development error handler
// will print stacktrace
if (app.get('env') === 'development') {
  app.use(function(err, req, res, next) {
    res.status(err.status || 500);
    res.render('error', {
      message: err.message,
      error: err
    });
  });
}

// production error handler
// no stacktraces leaked to user
app.use(function(err, req, res, next) {
  res.status(err.status || 500);
  res.render('error', {
    message: err.message,
    error: {}
  });
});


module.exports = app;

上面程式碼中第8行和24行是我修改的地方,不再使用預設的路由方式。

再來看看route.js檔案

"use strict";
const path = require("path");
const url = require("url");
const config = require("./config");

/**
 * reqUrl is the current request url
 * this function will help load the controller acconding to the url
 * **/
function getCtrl(reqUrl){
    var ctrlName = url.parse(reqUrl).pathname;
    return require(path.join(config.root,config.ctrlPath,ctrlName));
}

module.exports = function(app){
    //pakage the app.use
    var depatch = function(url){
        app.use(url,getCtrl(url));
    };

    depatch("/");
    depatch("/users");
    depatch("/admin/");

};

  通過對express預設的app.use()的簡單封裝,即可根據路由自動完成controller的載入。當然,簡單需要付出代價,那就是必須保證controller的位置和url必須對應起來。這樣做也比一行行require容易多了,不是嗎?

  再來簡單瞧一眼config.js是怎麼寫的

"use strict";

var config = {
    root: __dirname,
    ctrlPath: "controller"
};

module.exports = config;

  當然根據專案可以繼續擴充套件config了。

相關文章