本篇文章為大家展示了express中如何使用morgan默認日志組件,內(nèi)容簡明扼要并且容易理解,絕對能使你眼前一亮,通過這篇文章的詳細介紹希望你能有所收獲。
成都創(chuàng)新互聯(lián)堅持“要么做到,要么別承諾”的工作理念,服務(wù)領(lǐng)域包括:網(wǎng)站設(shè)計制作、網(wǎng)站設(shè)計、企業(yè)官網(wǎng)、英文網(wǎng)站、手機端網(wǎng)站、網(wǎng)站推廣等服務(wù),滿足客戶于互聯(lián)網(wǎng)時代的灤平網(wǎng)站設(shè)計、移動媒體設(shè)計的需求,幫助企業(yè)找到有效的互聯(lián)網(wǎng)解決方案。努力成為您成熟可靠的網(wǎng)絡(luò)建設(shè)合作伙伴!
首先,初始化項目。
npm install express morgan
然后,在basic.js中添加如下代碼。
var express = require('express'); var app = express(); var morgan = require('morgan'); app.use(morgan('short')); app.use(function(req, res, next){ res.send('ok'); }); app.listen(3000);
node basic.js
運行程序,并在瀏覽器里訪問 http://127.0.0.1:3000 ,打印日志如下
? 2016.12.11-advanced-morgan git:(master) ? node basic.js
::ffff:127.0.0.1 - GET / HTTP/1.1 304 - - 3.019 ms
::ffff:127.0.0.1 - GET /favicon.ico HTTP/1.1 200 2 - 0.984 ms
morgan支持stream配置項,可以通過它來實現(xiàn)將日志落地的效果,代碼如下:
var express = require('express'); var app = express(); var morgan = require('morgan'); var fs = require('fs'); var path = require('path'); var accessLogStream = fs.createWriteStream(path.join(__dirname, 'access.log'), {flags: 'a'}); app.use(morgan('short', {stream: accessLogStream})); app.use(function(req, res, next){ res.send('ok'); }); app.listen(3000);
核心API
morgan的API非常少,使用頻率最高的就是morgan(),作用是返回一個express日志中間件。
morgan(format, options)
參數(shù)說明如下:
format:可選,morgan與定義了幾種日志格式,每種格式都有對應(yīng)的名稱,比如combined、short等,默認是default。不同格式的差別可參考這里。下文會講解下,如果自定義日志格式。
options:可選,配置項,包含stream(常用)、skip、immediate。
stream:日志的輸出流配置,默認是process.stdout。
skip:是否跳過日志記錄,使用方式可以參考這里。
immediate:布爾值,默認是false。當為true時,一收到請求,就記錄日志;如果為false,則在請求返回后,再記錄日志。
自定義日志格式
首先搞清楚morgan中的兩個概念:format 跟 token。非常簡單:
format:日志格式,本質(zhì)是代表日志格式的字符串,比如 :method :url :status :res[content-length] - :response-time ms。
token:format的組成部分,比如上面的:method、:url即使所謂的token。
搞清楚format、token的區(qū)別后,就可以看下morgan中,關(guān)于自定義日志格式的關(guān)鍵API。
morgan.format(name, format); // 自定義日志格式 morgan.token(name, fn); // 自定義token
非常簡單,首先通過morgan.format()定義名為joke的日志格式,然后通過morgan('joke')調(diào)用即可。
var express = require('express'); var app = express(); var morgan = require('morgan'); morgan.format('joke', '[joke] :method :url :status'); app.use(morgan('joke')); app.use(function(req, res, next){ res.send('ok'); }); app.listen(3000);
我們來看下運行結(jié)果
? 2016.12.11-advanced-morgan git:(master) ? node morgan.format.js
[joke] GET / 304
[joke] GET /favicon.ico 200
代碼如下,通過morgan.token()自定義token,然后將自定義的token,加入自定義的format中即可。
var express = require('express'); var app = express(); var morgan = require('morgan'); // 自定義token morgan.token('from', function(req, res){ return req.query.from || '-'; }); // 自定義format,其中包含自定義的token morgan.format('joke', '[joke] :method :url :status :from'); // 使用自定義的format app.use(morgan('joke')); app.use(function(req, res, next){ res.send('ok'); }); app.listen(3000);
運行程序,并在瀏覽器里先后訪問 http://127.0.0.1:3000/hello?from=app 和 http://127.0.0.1:3000/hello?from=pc
? 2016.12.11-advanced-morgan git:(master) ? node morgan.token.js
[joke] GET /hello?from=app 200 app
[joke] GET /favicon.ico 304 -
[joke] GET /hello?from=pc 200 pc
[joke] GET /favicon.ico 304 -
日志切割
一個線上應(yīng)用,如果所有的日志都落地到同一個本地文件,時間久了,文件會變得非常大,既影響性能,又不便于查看。這時候,就需要用到日志分割了。
借助file-stream-rotator插件,可以輕松完成日志分割的工作。除了file-stream-rotator相關(guān)的配置代碼,其余跟之前的例子差不多,這里不贅述。
var FileStreamRotator = require('file-stream-rotator') var express = require('express') var fs = require('fs') var morgan = require('morgan') var path = require('path') var app = express() var logDirectory = path.join(__dirname, 'log') // ensure log directory exists fs.existsSync(logDirectory) || fs.mkdirSync(logDirectory) // create a rotating write stream var accessLogStream = FileStreamRotator.getStream({ date_format: 'YYYYMMDD', filename: path.join(logDirectory, 'access-%DATE%.log'), frequency: 'daily', verbose: false }) // setup the logger app.use(morgan('combined', {stream: accessLogStream})) app.get('/', function (req, res) { res.send('hello, world!') })
日志寫入數(shù)據(jù)庫
有的時候,我們會有這樣的需求,將訪問日志寫入數(shù)據(jù)庫。這種需求常見于需要實時查詢統(tǒng)計的日志系統(tǒng)。
在morgan里該如何實現(xiàn)呢?從文檔上,并沒有看到適合的擴展接口。于是查閱了下morgan的源碼,發(fā)現(xiàn)實現(xiàn)起來非常簡單。
回顧下之前日志寫入本地文件的例子,最關(guān)鍵的兩行代碼如下。通過stream指定日志的輸出流。
var accessLogStream = fs.createWriteStream(path.join(__dirname, 'access.log'), {flags: 'a'}); app.use(morgan('short', {stream: accessLogStream}));
在morgan內(nèi)部,大致實現(xiàn)是這樣的(簡化后)。
// opt為配置文件 var stream = opts.stream || process.stdout; var logString = createLogString(); // 偽代碼,根據(jù)format、token的定義,生成日志 stream.write(logString);
于是,可以用比較取巧的方式來實現(xiàn)目的:聲明一個帶write方法的對象,并作為stream配置傳入。
var express = require('express'); var app = express(); var morgan = require('morgan'); // 帶write方法的對象 var dbStream = { write: function(line){ saveToDatabase(line); // 偽代碼,保存到數(shù)據(jù)庫 } }; // 將 dbStream 作為 stream 配置項的值 app.use(morgan('short', {stream: dbStream})); app.use(function(req, res, next){ res.send('ok'); }); app.listen(3000);
深入剖析
morgan的代碼非常簡潔,從設(shè)計上來說,morgan的生命周期包含:
token定義 --> 日志格式定義 -> 日志格式預(yù)編譯 --> 請求達到/返回 --> 寫日志
其中,token定義、日志格式定義前面已經(jīng)講到,這里就只講下 日志格式預(yù)編譯 的細節(jié)。
跟模板引擎預(yù)編譯一樣,日志格式預(yù)編譯,也是為了提升性能。源碼如下,最關(guān)鍵的代碼就是compile(fmt)。
function getFormatFunction (name) { // lookup format var fmt = morgan[name] || name || morgan.default // return compiled format return typeof fmt !== 'function' ? compile(fmt) : fmt }
compile()方法的實現(xiàn)細節(jié)這里不贅述,著重看下compile(fmt)返回的內(nèi)容:
var morgan = require('morgan'); var format = morgan['tiny']; var fn = morgan.compile(format); console.log(fn.toString());
運行上面程序,輸出內(nèi)容如下,其中tokens其實就是morgan。
function anonymous(tokens, req, res /**/) { return "" + (tokens["method"](req, res, undefined) || "-") + " " + (tokens["url"](req, res, undefined) || "-") + " " + (tokens["status"](req, res, undefined) || "-") + " " + (tokens["res"](req, res, "content-length") || "-") + " - " + (tokens["response-time"](req, res, undefined) || "-") + " ms"; }
看下morgan.token()的定義,就很清晰了
function token (name, fn) { morgan[name] = fn return this }
上述內(nèi)容就是express中如何使用morgan默認日志組件,你們學到知識或技能了嗎?如果還想學到更多技能或者豐富自己的知識儲備,歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道。
網(wǎng)站題目:express中如何使用morgan默認日志組件
分享網(wǎng)址:http://aaarwkj.com/article8/iggiop.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供營銷型網(wǎng)站建設(shè)、外貿(mào)建站、自適應(yīng)網(wǎng)站、網(wǎng)站設(shè)計、關(guān)鍵詞優(yōu)化、虛擬主機
聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請盡快告知,我們將會在第一時間刪除。文章觀點不代表本網(wǎng)站立場,如需處理請聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時需注明來源: 創(chuàng)新互聯(lián)