.2-淺析express源碼之applicaiton模塊(1)

来源:https://www.cnblogs.com/QH-Jimmy/archive/2018/04/13/8822242.html
-Advertisement-
Play Games

上一節講了express的入口文件，當執行主函數，會調用app.init方法，這個方法就來源於application模塊。 這個模塊有很多方法，目前僅僅過一下初始化方法： 這裡初始化了三個對象，作用在註釋有簡單介紹，實際用法在後面再做介紹。 隨後執行了預設配置方法，先不看那個，在這之前過一個工具方法 ...


　　上一節講了express的入口文件，當執行主函數，會調用app.init方法，這個方法就來源於application模塊。

　　這個模塊有很多方法，目前僅僅過一下初始化方法：

app.init = function init() {
    // 在render時緩存對應的view
    this.cache = {};
    // 保存對應ext的解析引擎
    this.engines = {};
    // 本地配置
    this.settings = {};

    this.defaultConfiguration();
};

　　這裡初始化了三個對象，作用在註釋有簡單介紹，實際用法在後面再做介紹。

 

　　隨後執行了預設配置方法，先不看那個，在這之前過一個工具方法。

app.set

app.set = function set(setting, val) {
    // 如果只傳一個參數相當於get
    if (arguments.length === 1) return this.settings[setting];
    // 列印日誌
    debug('set "%s" to %o', setting, val);
    // set value
    this.settings[setting] = val;
    // 特殊鍵的設置會觸發一些方法
    switch (setting) {
        case 'etag':
        this.set('etag fn', compileETag(val));
        break;
        case 'query parser':
        this.set('query parser fn', compileQueryParser(val));
        break;
        case 'trust proxy':
        this.set('trust proxy fn', compileTrust(val));

        // trust proxy inherit back-compat
        Object.defineProperty(this.settings, trustProxyDefaultSymbol, {
            configurable: true,
            value: false
        });
        break;
    }
    return this;
};

　　這裡的set方法對應官網API的app.set(name, value)，雖然官網實例用的是app.set設置值，用app.get取值，但是從源碼來看set傳一個參數就相當於app.get。

　　列印日誌就暫時不管了，引入如下：

var debug = require('debug')('express:application');

　　這個生成了一個日誌印表機，後面的參數為對應的命名空間，會映射到process的一個環境變數上。

　　而字元串中的%s、%o對應後面的參數，並會被format為指定格式的字元串，這裡參考下C的prinf格式化輸出吧，講起來沒完了，先擱著。

　　當set的值為etag、query parser、trust proxy fn之一時，會觸發一些編譯函數並設置對應的fn值，對應的編譯函數單獨講。

 

defaultConfiguration

　　接下來看預設屬性的設置(稍微調整了下代碼結構)：

app.defaultConfiguration = function defaultConfiguration() {
    // 獲取環境變數
    var env = process.env.NODE_ENV || 'development';

    // 相當於this.set(setting, true);
    this.enable('x-powered-by');
    this.set('etag', 'weak');
    this.set('env', env);
    this.set('query parser', 'extended');
    this.set('subdomain offset', 2);
    this.set('trust proxy', false);
    this.set('view', View);
    this.set('views', resolve('views'));
    this.set('jsonp callback name', 'callback');

    this.locals = Object.create(null);
    this.mountpath = '/';
    this.locals.settings = this.settings;

    // 相容處理
    // var trustProxyDefaultSymbol = '@@symbol:trust_proxy_default';
    Object.defineProperty(this.settings, trustProxyDefaultSymbol, {
        configurable: true,
        value: true
    });

    debug('booting in %s mode', env);
    // 監聽mount方法
    this.on('mount', function onmount(parent) {
        // ...
    });

    // 生產模式打開view cache屬性
    if (env === 'production') {
        this.enable('view cache');
    }

    // 4.x移除app.router方法
    Object.defineProperty(this, 'router', {
        get: function() {
        throw new Error('\'app.router\' is deprecated!\nPlease see the 3.x to 4.x migration guide for details on how to update your app.');
        }
    });
};

　　可以看到僅僅是一些屬性預設值的設置，並沒有做其餘的操作，非常的簡單。

 

app.use

　　其中有一個特別的點，就是每一個app在初始化都會預設監聽一個mount事件，而這個事件會在何時觸發呢？答案是use中。

　　先把官網的案例貼出來看一眼：

var admin = express();
admin.on('mount', function (parent) {
  console.log('Admin Mounted');
  console.log(parent); // refers to the parent app
});
admin.get('/', function (req, res) {
  res.send('Admin Homepage');
});
app.use('/admin', admin);

　　當調用app.use時，會觸發admin上的mount事件並列印一些字元串，接下來看看該方法。

　　在看源碼時，需要對方法有一個清晰的認識，官網介紹如下：

app.use([path,] function [, function...])

　　其中path為指定的路徑，可以不傳，預設為/，後面的中間件函數至少要傳一個，所有對指定路徑的請求都會觸發對應的中間件，看起來就像tapable的apply。

　　整理後的use方法源碼如下：

app.use = function use(fn) {
    // 參數的偏移
    // 如果傳了path就是1
    var offset = 0;
    // 預設path
    var path = '/';

    // 參數修正
    if (typeof fn !== 'function') {
        var arg = fn;
        // 當path為數組時
        while (Array.isArray(arg) && arg.length !== 0) {
            arg = arg[0];
        }
        // 直接判斷數組中第一個元素是否不為函數
        if (typeof arg !== 'function') {
            offset = 1;
            path = fn;
        }
    }
    // 扁平化參數數組 獲取所有的中間件
    // 處理形如app.use(path,[middlewarefn1,middlewarefn2],subApp)的參數組合
    var fns = flatten(slice.call(arguments, offset));

    if (fns.length === 0) {
        throw new TypeError('app.use() requires a middleware function')
    }

    // 懶載入路由
    // 該方法只有第一次調用是有效的 單例模式
    this.lazyrouter();
    var router = this._router;

    fns.forEach(function(fn) {
        // quack quack 哈哈
        // 當該中間件不是express應用時直接調用router.use
        if (!fn || !fn.handle || !fn.set) {
            return router.use(path, fn);
        }
        // 設置子應用的mountpath、parent
        debug('.use app under %s', path);
        fn.mountpath = path;
        fn.parent = this;

        // 這個涉及router模塊 暫時不深入
        router.use(path, function mounted_app(req, res, next) {
            var orig = req.app;
            fn.handle(req, res, function(err) {
                setPrototypeOf(req, orig.request)
                setPrototypeOf(res, orig.response)
                next(err);
            });
        });

        // 觸發mount事件
        fn.emit('mount', this);
    }, this);

    return this;
};

　　由於path參數是可選的，而後面所有的function會被扁平化為一個一維數組，所以大體上可以根據中間件是否包含express應用而分為兩種情況處理。

　　當不包含express應用時，處理就十分簡單，在初始化一個router對象後，依次對所有的中間件調用router.use(path,fn)。

　　當包含express應用時，處理就不太一樣了，自定義一個中間件函數並調用了app.handle方法，而這個handle最終會指向router.handle，所以就不深入講解了。

 

　　下麵講一些鹹魚方法。

app.engine

app.engine = function engine(ext, fn) {
    // 這個應該叫模板解析函數？
    if (typeof fn !== 'function') {
        throw new Error('callback function required');
    }
    // 獲取指定文件的擴展名
    var extension = ext[0] !== '.' ?
        '.' + ext :
        ext;
    // 將尾碼與對應解析方式保存到engines對象上
    this.engines[extension] = fn;

    return this;
};

 

app.METHOD

　　這裡特地請求方法，諸如get、post等等。

methods.forEach(function(method) {
    app[method] = function(path) {
        // app.get傳一個參數時指向獲取本地參數的app.set方法
        if (method === 'get' && arguments.length === 1) {
            // app.get(setting)
            return this.set(path);
        }
        this.lazyrouter();
        var route = this._router.route(path);
        // 調用route.METHOD(path,callback)
        route[method].apply(route, slice.call(arguments, 1));
        return this;
    };
});

　　這裡最後仍然把請求的具體實現指向了route模塊的方法。

　　可以稍微看一下這個methods的種類：

module.exports = getCurrentNodeMethods() || getBasicNodeMethods();

function getCurrentNodeMethods() {
    // http.METHODS => 返回解析器支持的 HTTP 方法的列表
    return http.METHODS && http.METHODS.map(function lowerCaseMethod(method) {
        return method.toLowerCase();
    });
}

// 預設的請求方式集合
function getBasicNodeMethods() {
    return [
        'get', 'post', 'put', 'head', 'delete', 'options', 'trace', 'copy', 'lock', 'mkcol', 'move',
        'purge', 'propfind', 'proppatch', 'unlock', 'report', 'mkactivity', 'checkout', 'merge',
        'm-search', 'notify', 'subscribe', 'unsubscribe', 'patch', 'search', 'connect'
    ];
}

　　這裡會優先獲取node的內置模塊http的METHODS屬性，如果獲取不到就用本地定義的數據。

　　嘗試在本地列印了一下http.METHODS屬性，果然不一樣：

[
    'ACL', 'BIND', 'CHECKOUT', 'CONNECT', 'COPY', 'DELETE', 'GET', 'HEAD', 'LINK', 'LOCK',
    'M-SEARCH', 'MERGE', 'MKACTIVITY', 'MKCALENDAR', 'MKCOL', 'MOVE', 'NOTIFY', 'OPTIONS',
    'PATCH', 'POST', 'PROPFIND', 'PROPPATCH', 'PURGE', 'PUT', 'REBIND', 'REPORT', 'SEARCH',
    'SUBSCRIBE', 'TRACE', 'UNBIND', 'UNLINK', 'UNLOCK', 'UNSUBSCRIBE'
]

　　全部大寫，高大上，內容也多了不少。

 

app.all

app.all = function all(path) {
    this.lazyrouter();

    var route = this._router.route(path);
    var args = slice.call(arguments, 1);
    // 遍歷所有的方法 依次調用route進行處理
    for (var i = 0; i < methods.length; i++) {
        route[methods[i]].apply(route, args);
    }

    return this;
};

　　這就很暴力了，直接遍曆數組所有方法。

 

app.listen

app.listen = function listen() {
    var server = http.createServer(this);
    return server.listen.apply(server, arguments);
};

　　從源碼可知，這個方法實際上只是對node里監聽埠方法的一種簡化。

 

小結

　　其實app的很多方法最終還是指向了其他模塊，本身最主要的作用是保存了幾個配置對象，負責在需要的時候取出對象的值。

　　另外還有一個app.render其實也比較複雜，然而涉及到了view這個特殊模塊，所以這裡暫時不講這個了。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 華為手機設置桌面圖標角標提醒的實現
    華為手機用戶占有率已經很大，有必要為華為手機支持角標提醒。 首先，要參考官網文檔。 實現 1. 申請許可權，這裡有點多，還包含了其他手機的。官方文檔的許可權是不夠的。 2. 官方代碼。需要註意包名和類名必須正確，否則無反應 自由打賞 ...
  • angularJS入門筆記
    1.debug調試工具：batarang2.ng指令 1、ng-app=" " 定義angularJS的使用範圍； main方法，入口 ng-app="myModule" 2、ng-init="變數=值;變數='值'" 初始化變數的值，有多個變數時，中間用分號隔開； 3、ng-model="變數" ...
  • 【讀書筆記】iOS-Settings Bundle
    一，打開工程 >右鍵 >Add File >iOS-->Resource-->Settings Bundle. 二，會彈出如下對話框 》Create. 三，會看到工程多了Settings.bundle.-->裡面包含en.lproj,Root.plist. 四，展開Root.plist,也可以通過點 ...
  • css選擇器的綜合使用
    代碼實現： 1 <!DOCTYPE html> 2 <html lang="en"> 3 <head> 4 <meta charset="utf-8"> 5 <title>css的綜合使用</title> 6 <style> 7 div { 8 color: #daa520; 9 } 10 .red ...
  • HTML學習筆記(二)
    一：表單 1.外部基本結構 name="表單名稱" ：為表單命名，防止提交到後臺混亂 action="提交地址" ：用於指定表單數據提交到哪個地址進行處理 method="傳送方法" ：指定將表單中的數據使用哪一種HTTP提交方法，取值為get或post target="跳轉方式"：指定目標視窗的打 ...
  • 小劉同學的第一百一十一篇博文
    終於把昨天顯示不了頭像的問題解決了。。。 這裡特別要感謝@Jeffweb的幫助，果然是logo變數出了問題……實際上是…我……我根本沒往裡面存數據。。 XiaoLiu這個用戶還是剛剛存的，昨天是logo欄位下的記錄全是空的，所以難怪昨天代碼怎麼改都渲染不了圖。 哎，看來真是要長點腦子寫代碼啊！ 頭像 ...
  • HTML的display屬性將行內元素、塊狀元素、行內塊狀元素互相轉換以及三者的區別
    1.行內元素 (1)設置寬高無效 (2)對margin僅設置左右方向有效，上下無效；padding設置上下左右都有效，即會撐大空間 (3)不會自動進行換行 2.塊狀元素 (1)能夠識別寬高 (2)margin和padding的上下左右均對其有效 (3)可以自動換行 (4)多個塊狀元素標簽寫在一起，默 ...
  • JS事件覆蓋問題和觸發問題
    昨天遇到一個面試題，主要就是事件覆蓋問題和觸發問題 （不是打廣告，無視文本內容） 總之這樣的話，會輸出三次“做自己的網站”。 為什麼不是兩次，而是輸出三次呢？ 1.首先onclick=function...是DOM0級事件處理程式，而addEventListener是DOM2級事件處理程式，這兩種屬 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類