Express.jsライクな簡単なWebアプリケーションフレームワークを作った話

リポジトリはここ(GitHub)です。ライセンスはApache License 2.0です。
これを使って何か起きても責任は負いません。

Express.jsはNode.jsで動作するWebアプリケーションフレームワークで、MEANスタックのEです。JavaScriptで簡単に書けて便利なフレームワークです。
これっぽいものをC++で実装したのがこれです。

使い方はできるだけ本家に近づけましたが、足りない機能がかなりたくさんあります。(1ヘッダだから許して...)
とりあえず、C++でRESTful APIを作りたいという人(いるのかわからないですが)におすすめです!

使い方

test.cppを見ていただければ分かると思いますが、とりあえず書いておきます。
  1. express::Expressのインスタンスを作成します。
  2. get, post, put, del関数を使ってハンドラを登録します。
  3. listen関数を呼んで実行を開始します。
パスの書き方は/abcみたいにパスにパラメータがないものと/abc/:idみたいにパスにパラメータがあるものが書けます。
:idの部分がパスパラメータになります。パスパラメータの値はreq.params("id")のような形で取得できます。
#include "express.hpp"
#include <iostream>

int main() {
    express::Express app;
    app.get("/", [](const express::Request &req, express::Response &res) {
        std::cout << "ok /" << std::endl;
        res.end("ok");
    });

    app.get("/parameters/:id/others/:other",
            [](const express::Request &req, express::Response &res) {
                std::cout << "ok /parameters/" << req.params("id") << "/others/"
                          << req.params("other") << std::endl;
                res.end("ok");
            });

    app.post("/post", [](const express::Request &req, express::Response &res) {
        std::cout << "ok /port " << req.body() << std::endl;
        res.end("ok post");
    });

    app.listen();
    return 0;
}

技術的説明

  • 全ての機能がC++11でコンパイルできるレベルになっています
  • Linuxでしか動きません(epollがある環境ならLinuxじゃなくても動くかも)
  • GET, POST, PUT, DELETEのみに対応
  • 標準C++ライブラリ以外に依存がありません
  • ヘッダひとつだけで動きます
  • HTTP/1.1しか動きません
  • 絶対にconnection: closeします
  • コメント空行込みで600行!!
処理の流れは次のとおりです。
  1. ソケット作成
  2. bind
  3. listen
  4. epollでaccept待ち
  5. accept
  6. HTTPヘッダを読み込み(\r\n\r\nまでを読み込み)
  7. ヘッダをパース
  8. メソッドがPOST, PUTの場合はContent-Lengthを読んでbodyを読み込み
  9. マッチするハンドラを検索
  10. ハンドラにreq, resを渡す
  11. 4に戻る

ハンドラの登録

ハンドラの登録にはメソッド、パス、ハンドラ本体の関数が必要です。
登録前にパスを正規表現の形に変換します。先に正規表現に直しておくことで、リクエストを受けるときに、いちいち文字列操作をしなくて済むようにしています。

パスの変換はExpress::_pathToRegex関数で行っています。

ヘッダのパース

ヘッダそのもののパースはdetail::RequestHeader::Parse関数で行っています。
やっていることは超絶単純で、ほとんど文字列の分割しかしていません。

まず、ヘッダ文字列を\r\nで分割します。
一行目をスペースで分割しメソッド名、パスを取ります。(HTTPのバージョンは見てません)
二行目以降は:で分割しキーとバリューに分けます。
こんだけです。

ヘッダのキーは見つけやすいよう全て小文字に変換されています。
キーからバリューを取るときも小文字に変換されて検索されるので大文字小文字は使う側からも関係ありません。

残念なところ

非同期じゃない

リクエストごとにスレッドで処理していて非同期じゃないのはともかく、1スレッドで非同期じゃないのはだいぶ致命的ですね。
できたら非同期にします。

絶対にConnection: close

構造を単純にするため、リクエストを処理したら即closeされます。
リソースの確保・破棄を繰り返すので、まあ良くないですよね。
まだ、そこまで致命的ではないのですぐには対応しないと思います。

Linuxしか使えない

これは、残念なんだろうかとは思いますが、おそらくLinuxしか動かないです。
Windowsは確実に動かないですが、FreeBSDとかでも動かないはずです。
まあ、当分困らんだろうということでだいぶ放置されると思います。

JSONが使えない

JSONパーサーを入れる余裕(コード量と心の余裕)がないので、ここはpicojsonとかの外部JSONパーサーがある場合のみ使えるようにするかもしれないです。
JSONがあればAPIが作りやすいので、これは入れたいとは思っています。

今後

とりあえず残念なところとバグの修正をすると思います。
気が向いたら更新するみたいな感じになると思うので、「こいつ全然更新しねーじゃん」みたいになると思いますが、PRを出してもらえれば気づいたときに確認するので気が向いたらよろしくです。

コメント

コメントを投稿

このブログの人気の投稿

初めの挨拶

このブログではプログラミング関係の解説や備忘録、こんなの作ったよみたいなことを上げていこうかと考えています。 以後よろしくお願いします。
続きを読む

C++11の機能 (型推論, 範囲for)

C++11は2011年に策定された規格でだいぶ経つ仕様ですが、今でも頑張ってこのバージョンしか無理みたいな環境があります。 組み込みとかCentOSとか そういう環境を使っている人向けに便利だなーと思う機能をいくつか紹介していきたいと思います。 型推論 型推論は一般に右辺の値から左辺の新しい変数の決定したり、逆に左辺の型から右辺の型の一部を補完したりという、要するに型をいちいち書かなくても良くする機能です。 前者の型推論を持つ言語としてはC#, Dart, Kotlin, Java(10以上)などがあります。 後者の型推論を持つ言語としてはJavaがあり、ダイアモンド演算子と呼ばれています。こんな機能にどんな意味があるんだとか言われていましたがないよりはあったほうが圧倒的に便利です。 C++は前者のパターンの型推論です。 C++の型推論は次のように書きます auto number = 1; この機能はC++としては珍しく破壊的変更が行われた機能です。 どういうことかというとautoは自動変数(ローカル変数)という意味の記憶域クラス指定子でした。 ですが、これってあんまり使われて無くねということになりautoは自動なので自動的に型が決定することになぞらえたのか型推論を表す予約語になりました。 上記の例はintに推論されます。 intだとあんまり便利さを感じません(autoのほうが長いですし)が次のような型ではめちゃくちゃ便利だと思います。 std::unordered_map<std::string, std::vector<std::string>>::const_iterator itr = ...; auto itr = ...; この例はunordered_mapという型のイテレータですが随分長ったらしい型がautoの4文字になっています。 こんな感じでコード量を小さくできるのが魅力です。 範囲for (Range-based for loop) 範囲forはいわゆるforeachに当たるループです。 C++20からRangesライブラリが入りますがそれの先触れのような機能で、イテレータで範囲が表せるコンテナの走査ができます。 std::vector<std::strin
続きを読む

C++11の機能 (関数のdefault・delete宣言, overrideとfinal指定子, 移譲コンストラクタ, 継承コンストラクタ)

C++11の機能を紹介するシリーズ第四弾です。 今回は関数のdefault・delete宣言、overrideとfinal指定子、移譲コンストラクタと継承コンストラクタを紹介していきます。 関数のdefault・delete宣言 コンストラクタや代入演算子などにはユーザーが指定しなくても、必要に応じてコンパイラがそれらを自動的に作ってくれます。 ですが、「デフォルトで作ってほしくないんだよ」とか「コピーはしてほしくない」とか「この関数は呼べないようにしたい」という需要に答えるとなると、privateな部分に宣言だけ書いておくなど、あんまり綺麗でないやり方をするしかありませんでした。 そういうときに使うことができるのがdelete宣言です。delete宣言された関数は暗黙的に実体化されること無く、delete宣言された関数を必要とするコードが存在した場合コンパイルエラーになります。 対して、default宣言は、コンパイラが自動的に生成してくれるコードを明示的に生成させる宣言です。コピーやムーブで特殊な処理を行わない場合などはいちいち書くのは面倒で間違いの元になります。こういったときに使えます。また、virtualやinlineなどの指定子をつけた上でdefault宣言することもできるので、「仮想関数にするけど処理自体はコンパイラのデフォルトの動作で構わない」みたいな場合にも使えます。 struct Klass { Klass() = default; // デフォルトのコンストラクタはコンパイラのデフォルトで生成 Klass(const Klass&) = delete; // コピーコンストラクタは削除 Klass(Klass&&) = default; virtual ~Klass() = default; // 仮想関数としてデストラクタをデフォルト生成 }; overrideとfinal指定子 overrideはあのオーバーライドです。この指定子をつけることでこの関数はオーバーライドしているということを明示することができます。override指定子を付けているにもかからわずオーバーライドできていない場合はコンパイルエラーになります。なので、間違ってオーバー
続きを読む