Detaillierte Einführung in die Express-Standardprotokollkomponente Morgan

Dieses Mal werde ich Ihnen eine detaillierte Einführung in die Standardprotokollkomponente Morgan geben. Was sind die Vorsichtsmaßnahmen bei der Verwendung der Standardprotokollkomponente Morgan?

Kapitelübersicht

Morgan ist die Standard-Protokollierungs-Middleware von Express und kann auch unabhängig von Express als Protokollierungskomponente von node.js verwendet werden. Dieser Artikel geht von oberflächlich bis tiefgründig und der Inhalt umfasst hauptsächlich:

1. Einführungsbeispiele für die Verwendung von Morgan

2. So speichern Sie Protokolle in lokalen Dateien

3. Anweisungen und Beispiele zur Verwendung der Kern-API

4. Erweiterte Verwendung: 1. Protokollaufteilung 2. Protokoll in Datenbank

5. Quellcode-Analyse: Morgans Protokollformat und Vorkompilierung

Beispiel für den ersten Schritt

Zuerst

Initialisierungsprojekt.

npm install express morgan

Fügen Sie dann den folgenden Code in basic.js hinzu.

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);

Führen Sie das Programm aus und greifen Sie im Browser auf http://127.0.0.1:3000 zu. Das Druckprotokoll lautet wie folgt:node basic.js

➜ 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

Protokoll in eine lokale Datei drucken

Morgan unterstützt das Stream-Konfigurationselement, mit dem das erreicht werden kann Der Code lautet wie folgt:

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);

Verwendungserklärung

Kern-API

Morgan hat nur sehr wenige APIs und Am häufigsten wird morgan() verwendet. Es gibt eine Express-Log-Middleware zurück.

morgan(format, options)

Die Parameterbeschreibung lautet wie folgt:

1. Format: Optional, Morgan hat mehrere Protokollformate definiert, jedes Format hat einen entsprechenden Namen, z. kurz usw., der Standardwert ist Standard. Die Unterschiede zwischen verschiedenen Formaten finden Sie hier. Im Folgenden wird erläutert, wie Sie das Protokollformat anpassen.

2. Optionen: Optional, Konfigurationselemente, einschließlich Stream (häufig verwendet), Überspringen und Sofort.

3. stream: Konfiguration des Protokollausgabestreams, der Standardwert ist process.stdout.

4. Überspringen: Ob die Protokollierung übersprungen werden soll, erfahren Sie hier zur Verwendung.

5. sofort: Boolescher Wert, Standard ist falsch. Bei „true“ wird das Protokoll protokolliert, sobald die Anfrage eingeht; bei „false“ wird das Protokoll protokolliert, nachdem die Anfrage zurückgegeben wurde.

Benutzerdefiniertes Protokollformat

Verstehen Sie zunächst die beiden Konzepte in Morgan: Format und Token. Ganz einfach:

1. Format: Protokollformat, das im Wesentlichen eine Zeichenfolge ist, die das Protokollformat darstellt, z. B. :method :url :status :res[content-length] - :response-time MS.

2. Token: Komponente des Formats, wie z. B. :method und :url oben sind sogenannte Token.

Nachdem Sie den Unterschied zwischen Format und Token geklärt haben, können Sie einen Blick auf die wichtigsten APIs zum Anpassen von Protokollformaten in Morgan werfen.

morgan.format(name, format); // 自定义日志格式
morgan.token(name, fn); // 自定义token

Benutzerdefiniertes Format

ist sehr einfach. Definieren Sie zunächst das Protokollformat namens joke über morgan.format() und übergeben Sie dann morgan('joke'). Rufen Sie es einfach an.

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);

Werfen wir einen Blick auf die laufenden Ergebnisse

➜ 2016.12.11-advanced-morgan git:(master) ✗ node morgan.format.js

[ joke] GET / 304
[joke] GET /favicon.ico 200

Benutzerdefiniertes Token

Der Code ist wie folgt, angepasst durch Morgan. token()-Token und fügen Sie dann das benutzerdefinierte Token zum benutzerdefinierten Format hinzu.

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);

Führen Sie das Programm aus und besuchen Sie http://127.0.0.1:3000/hello?from=app und http://127.0.0.1:3000/hello?from=pc im Browser

➜  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 -

高级使用

日志切割

一个线上应用，如果所有的日志都落地到同一个本地文件，时间久了，文件会变得非常大，既影响性能，又不便于查看。这时候，就需要用到日志分割了。

借助file-stream-rotator插件，可以轻松完成日志分割的工作。除了file-stream-rotator相关的配置代码，其余跟之前的例子差不多，这里不赘述。

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!')
})

日志写入数据库

有的时候，我们会有这样的需求，将访问日志写入数据库。这种需求常见于需要实时查询统计的日志系统。

在morgan里该如何实现呢？从文档上，并没有看到适合的扩展接口。于是查阅了下morgan的源码，发现实现起来非常简单。

回顾下之前日志写入本地文件的例子，最关键的两行代码如下。通过stream指定日志的输出流。

var accessLogStream = fs.createWriteStream(path.join(dirname, 'access.log'), {flags: 'a'});
app.use(morgan('short', {stream: accessLogStream}));

在morgan内部，大致实现是这样的（简化后）。

// opt为配置文件
var stream = opts.stream || process.stdout;
var logString = createLogString(); // 伪代码，根据format、token的定义，生成日志
stream.write(logString);

于是，可以用比较取巧的方式来实现目的：声明一个带write方法的对象，并作为stream配置传入。

var express = require('express');
var app = express();
var morgan = require('morgan');
// 带write方法的对象
var dbStream = {
 write: function(line){
 saveToDatabase(line); // 伪代码，保存到数据库
 }
};
// 将 dbStream 作为 stream 配置项的值
app.use(morgan('short', {stream: dbStream}));
app.use(function(req, res, next){
 res.send('ok');
});
app.listen(3000);

深入剖析

morgan的代码非常简洁，从设计上来说，morgan的生命周期包含：

token定义 --> 日志格式定义 -> 日志格式预编译 --> 请求达到/返回 --> 写日志

其中，token定义、日志格式定义前面已经讲到，这里就只讲下 日志格式预编译 的细节。

跟模板引擎预编译一样，日志格式预编译，也是为了提升性能。源码如下，最关键的代码就是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()方法的实现细节这里不赘述，着重看下compile(fmt)返回的内容：

var morgan = require('morgan');
var format = morgan['tiny'];
var fn = morgan.compile(format);
console.log(fn.toString());

运行上面程序，输出内容如下，其中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
}

相信看了本文案例你已经掌握了方法，更多精彩请关注php中文网其它相关文章！

推荐阅读：

mint-ui在vue中的使用方法

怎样使用JS判断当前页面是否有滚动条

Das obige ist der detaillierte Inhalt vonDetaillierte Einführung in die Express-Standardprotokollkomponente Morgan. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!