node静态文件服务器端实现与扩展

以前刚开始学node的时候写过几个小项目练手,但都是一开始就用到了express框架,这段时间重学node基础,想到如何用node实现一个类似于express的框架,于是就想从静态文件服务器开始实现一部分功能,实现了基本的文件服务器后我还继续扩展了路由逻辑处理的功能,用于简易服务器后台的实现与搭建

注:本篇主要是记述性质文章,用于自我总结
github地址:https://github.com/kindboy/node-file-server
博客地址:我的博客

一、创建服务器

利用http模块的createServer创建一个服务器,就是这么简单, 如下为app.js启动文件的配置

const config = require('./config');
const router = require('./router/router');
const handle = require('./handle');

const http = require('http');

var httpServer = http.createServer(onRequest);
httpServer.listen(config.port || 8888);
httpServer.on('error', (err) => {
    console.log(err);
});

function onRequest(request, response) {
    console.log('request received');

    router(request, response, handle);
}

.config为配置文件,用于导出配置信息,便于配置信息的统一修改,定义了服务器的端口位置,和支持的MINE类型(可自行扩展)

module.exports = {
    port: 8888,
    ip: '127.0.0.1',
    mine: {
        html: 'text/html',
        js: 'text/javascript',
        css: 'text/css',
        gif: 'image/gif',
        jpg: 'image/jpeg',
        png: 'image/png',
        ico: 'image/icon',
        txt: 'text/plain',
        json: 'application/json',
        xml: 'text/xml',
        pdf: 'application/pdf',
        default: 'application/octet-stream'
    }
};

二、路由的实现

路由模块主要用于解析请求URL中的路径,并对不同的路径实施不用的处理逻辑。

用到的模块:url 解析请求URL返回Object对象
path 处理路径

首先,我们先要实现一个根据path获取MINE类型的方法

var getFileMine = (pathname) => {
    let extname = path.extname(pathname).substr(1);
    let mineType = config.mine;
    if (mineType.hasOwnProperty(extname)) {
        return mineType[extname];
    } else {
        return false;
    }
};

核心处理逻辑就是,首先检查请求URL的文件MINE类型,如果是我们配置文件config.js 中定义的类型之一,则调用routerHandle模块(稍后会讲)的文件读取功能去读取并返回对应的请求文件;若URL没有MINE类型的后缀名,则默认为调用路由处理方法,根据handle.js中配置的handle对象的方法处理;若在handle对象中没有对应的路由处理方法,则返回404 Not Found.

完整的实现代码为:

const url = require('url');
const path = require('path');

const routerHandle = require('./routerHandle');
const config = require('../config');

module.exports = (function() {

    /*
    * 获取请求文件MINE类型
    * @param pathname <String> 文件路径
    * @return <String> | false 文件MINE类型或false
    *
    */
    var getFileMine = (pathname) => {
        let extname = path.extname(pathname).substr(1);
        let mineType = config.mine;
        if (mineType.hasOwnProperty(extname)) {
            return mineType[extname];
        } else {
            return false;
        }
    };

    return function(request, response, handle) {
        let pathname = url.parse(request.url).pathname;
        let mine = getFileMine(pathname);

        pathname = decodeURI(pathname);
        if(mine) {
            routerHandle.static(request, response, pathname, mine);
        } else if (typeof handle[pathname] === 'function') {
            handle[pathname](request, response);
        } else {
            response.writeHead(404, {'Content-Type': 'text/plain'});
            response.write('404 Not Found');
            response.end();
        }
    };
})();

三、路由handle的实现

最后就是对于不同的路由调用不用等handle来处理了,这里我在routerHandle.js中定义了一个static方法专门用来处理静态文件的读取返回操作

exports.static = (request, response, pathname, mine) => {
    pathname = path.join('./static', path.normalize(pathname.replace(/\.\./g, '')));

    let promise = new Promise((resolve, reject) => {
        fs.exists(pathname, (exists) => {
            if(!exists) {
                reject();
            } else {
                resolve();
            }
        });
    });
    
    promise.then(() => {
        response.writeHead(200, {'Content-Type': mine});
        let readStream = fs.createReadStream(pathname);
        readStream.on('error', (err) => {
            serverException(response); //自定义方法,处理500错误
        });
        readStream.pipe(response);
    }).catch(() => {
        notFoundException(response); //自定义方法,处理404错误
    });
    
};

然后,为了提高兼容性,我对于 '/' 路径的请求做了一个重定向处理,默认访问 ./static 文件夹下的index.html文件

exports.start = (request, response) => {
    let redirect = 'http://' + request.headers.host + '/index.html';
    response.writeHead(301, { 'location': redirect});
    response.end();
};  

至此,一个基本的静态文件服务器就已经实现了。

对于,自定义路由,在handle.js文件中require自己新建的路由文件(建议放在router文件夹下),并通过handle对象注册自定义路由文件中自定义的功能(如:handle['/test'] = myRouter.myTest;)

const routerHandle = require('./router/routerHandle');
const myRouter = require('./router/myRouter');
// 1. 添加自定义模块 

let handle = {};
handle['/'] = routerHandle.start;
// 2. 为自定义模块定义路由
handle['/test'] = myRouter.myTest;

module.exports = handle;

以上代码,我新建了一个myRouter.js文件用于放置自定义的路由方法,并通过handle对象扩展这一路由文件下的myTest方法,如果要添加其他方法,可以效仿。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,402评论 6 499
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,377评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,483评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,165评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,176评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,146评论 1 297
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,032评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,896评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,311评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,536评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,696评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,413评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,008评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,659评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,815评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,698评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,592评论 2 353

推荐阅读更多精彩内容