情報アイランド

「情報を制する者は世界を制す」をモットーに様々な情報を提供することを目指すブログです。現在はプログラミング関連情報が多めですが、投資関連情報も取り扱っていきたいです。

expressモジュールによるHTTPサーバ(19)Linkヘッダフィールド

この記事は「expressモジュールによるHTTPサーバ」という連載記事の19つ目の記事です。

その他の記事に関しては下を参照してください。

また、HTTP自体について知りたい方は下を参照してください。

この記事ではexpressモジュールを使ってHTTPリクエストに対してLinkヘッダフィールドを含むHTTPレスポンスを返すHTTPサーバを作成する方法について説明します。

HTTPレスポンスのLinkヘッダフィールドの値に1個以上の型付きリンクのリストを指定するにはres.links関数を使用します。

var express = require('express');

var app = express();
app.use(function (req, res, next) {
    res.links({
        xxx: 'aaa', 
        yyy: 'bbb'
    });
    next();
});

第1引数に1個以上の型付きリンクのリストをオブジェクトとして指定します。

ただし、このオブジェクトのプロパティ名は型付きリンクの型とし、プロパティの値は型付きリンクのターゲットIRIとします。

サンプルコード1

クライアントからリクエストを受け取ったらURLに応じて様々なテキストデータを返すHTTPサーバを作成し、起動します。

Enterキーが押されたらサーバを停止し、プログラムを終了します。

express-server-links.js

var express = require('express');
var http = require('http');

var app = express();
app.set('env', 'development');
app.set('x-powered-by', false);
app.set('case sensitive routing', true);
app.set('strict routing', true);
app.use(function (req, res, next) {
    res.status(200);
    res.type('text/plain; charset=utf-8');
    next();
});
app.get('/page1', function (req, res, next) {
    res.links({
        next: '/page2'
    });
    res.send('this is page1.\r\n');
});
app.get('/page2', function (req, res, next) {
    res.links({
        prev: '/page1', 
        next: '/page3'
    });
    res.send('this is page2.\r\n');
});
app.get('/page3', function (req, res, next) {
    res.links({
        prev: '/page2'
    });
    res.send('this is page3.\r\n');
});
app.get('*', function (req, res, next) {
    res.status(404);
    res.send(http.STATUS_CODES[404] + '\r\n');
});
app.post('*', function (req, res, next) {
    res.send('request method is post.\r\n');
});
app.all('*', function (req, res, next) {
    res.status(501);
    res.send(http.STATUS_CODES[501] + '\r\n');
});
var server = app.listen(3000, function () {
    console.log('http server is running...press enter key to exit.');

    process.stdin.on('data', function (data) {
        if (data.indexOf('\n') !== -1) {
            server.close(function () {
                console.log('http server closed.');
                process.exit(0);
            });
        }
    });
});
server.on('error', function (err) {
    console.error(err);
    process.exit(1);
});

使用パッケージ

  • express
    npm install expressでインストールします。

実行結果

実行結果の確認のためにcURLを使用しています。

コードを実行するとHTTPサーバが起動します。

C:\work\node>node express-server-links.js
http server is running...press enter key to exit.

cURLを使ってサーバに対して様々なURLのHTTPリクエストを行います。

C:\work\node>curl -v http://localhost:3000/page1
*   Trying ::1...
* Connected to localhost (::1) port 3000 (#0)
> GET /page1 HTTP/1.1
> Host: localhost:3000
> User-Agent: curl/7.46.0
> Accept: */*
>
< HTTP/1.1 200 OK
< Content-Type: text/plain; charset=utf-8
< Link: </page2>; rel="next"
< Content-Length: 16
< ETag: W/"10-omaO8wLwMKqststSYJ52Og"
< Date: Mon, 13 Mar 2017 15:51:12 GMT
< Connection: keep-alive
<
this is page1.
* Connection #0 to host localhost left intact
C:\work\node>curl -v http://localhost:3000/page2
*   Trying ::1...
* Connected to localhost (::1) port 3000 (#0)
> GET /page2 HTTP/1.1
> Host: localhost:3000
> User-Agent: curl/7.46.0
> Accept: */*
>
< HTTP/1.1 200 OK
< Content-Type: text/plain; charset=utf-8
< Link: </page1>; rel="prev", </page3>; rel="next"
< Content-Length: 16
< ETag: W/"10-3OPPvd7gOIHsxVrV4lbHcg"
< Date: Mon, 13 Mar 2017 15:51:50 GMT
< Connection: keep-alive
<
this is page2.
* Connection #0 to host localhost left intact
C:\work\node>curl -v http://localhost:3000/page3
*   Trying ::1...
* Connected to localhost (::1) port 3000 (#0)
> GET /page3 HTTP/1.1
> Host: localhost:3000
> User-Agent: curl/7.46.0
> Accept: */*
>
< HTTP/1.1 200 OK
< Content-Type: text/plain; charset=utf-8
< Link: </page2>; rel="prev"
< Content-Length: 16
< ETag: W/"10-lEsiLEq0Cm14CN+6YsPdyg"
< Date: Mon, 13 Mar 2017 15:51:56 GMT
< Connection: keep-alive
<
this is page3.
* Connection #0 to host localhost left intact

サーバから正しくレスポンスが返っていることが分かります。

Enterキーを押すとサーバが停止し、プログラムが終了します。

関連

pizyumi
プログラミング歴19年のベテランプログラマー。業務システム全般何でも作れます。現在はWeb系の技術を勉強中。
スポンサーリンク

-express, Node.js