express框架路由配置及congtroller自动加载

Posted 2020-07-19

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 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了。