PSGI / PlackでのWebアプリケーション開発の概要

著者： ドミトリー・シャマトリン。
サイクルのオリジナル記事の著者の許可を得て、Habréにサイクルを公開します。
pragmaticperl.comマガジンWebサイトのオリジナル記事

PSGI / Plackは、Perl Webアプリケーションを記述するための最新の方法です。 ほとんどすべてのフレームワークは、このテクノロジーを何らかの方法でサポートまたは使用します。 この記事では、すばやくナビゲートして先に進むのに役立つ簡単な紹介を提供します。


私たちは、Web開発の分野におけるテクノロジーとアプローチが急速に変化している時代に生きています。 最初にCGIがあり、次に十分ではなかったときにFastCGIが現れました。 FastCGIはCGIの主な問題を解決しました。 CGIでは、呼び出しごとにサーバープログラムを再起動する必要があり、STDINとSTDOUTを使用してデータが交換されました。 FastCGIでは、サーバーとの通信はTCP / IPまたはUnixドメインソケットを介して行われます。 これでPSGIができました。

これは何ですか

PSGIは、開発者の宮川達彦が言うように、「WebフレームワークとWebサーバーのためのパール大麦の接着剤」です。 最も近い親Theは、WSGI（Python）とRack（Ruby）です。 アイデアはこれです。 開発者はアプリケーションをできるだけ多くのエンジンに適応させるために非常に多くの時間を費やすことが多く、PSGIはさまざまなサーバーを操作するための単一のインターフェイスを提供し、これにより作業が大幅に簡素化されます。

特徴

もちろん、この記事の形式では、すべてのニュアンスを完全に説明することはできないため、以降は重要な点のみを説明します。

• $ envは、クライアントとサーバー間で情報を交換するために使用されます（ハッシュへのリンクです）。
• PSGIアプリケーション-$ envをパラメーターとして使用するPerl関数へのリンク。
• この関数は、3つの要素で構成される配列へのリンクを返します：HTTPステータス、[HTTPヘッダー]、[レスポンスボディ];
• 関数は別の関数へのリンクを返す場合がありますが、これについては他の詳細な記事で説明します。
• アプリケーションのスタートアップコードを含むファイルの拡張子は.psgiでなければなりません。

この段階では、コードの直接処理を開始するために必要なことはこれだけです。

PSGIアプリケーション

以下は、最も単純なPSGIアプリケーションのコードです。

my $app = sub { my $env = shift; #     $env return [200, ['Content-Type' => 'text/plain'], ["hello, world\n"]]; }; 

このアプリケーションをapp.psgiファイル、またはpsgi拡張子を持つその他のファイルに保存します。 機能を調べます。 次に、コードに。 その後、再び機能について。 それはすべて一緒に収まります。 始めます。

perl app.psgiを起動すると、静かに実行されますが、アプリケーションは実行されていません。

プライマリPSGIサーバー

PSGIアプリケーションを実行するには、PSGIサーバーが必要です。 現在、いくつかのサーバーがあります。

• ツイギー
• スターマン
• フェルスム
• コロナ

PSGIサーバーについて簡単に

• Starman-事前分岐サーバー。 非常に高速に動作し、すぐに多くのことを実行できます。たとえば、UNIXドメインソケットのサポート。
• Twiggy-AnyEventに基づく非同期サーバー。
• Feersum-主観的に、このリスト全体で最速。 メイン部分はXSモジュールとして実装されます。 EVに基づく;
• Coronaは、Coroに基づく非同期サーバーです。

これらのサーバーはすべてCPANで利用できます。 将来的には、スターマンを使用し、Twiggyに変更してから、Feersumに変更します。 各タスクには独自のサーバーがあります。

アプリケーションの起動

アプリケーションは、これらのサーバーのいずれでもまったく同じように実行されます。コロナでは、わずかに変更する必要があります。 サーバーをインストールした後（この場合はStarman）、starman実行可能ファイルは/ usr / binまたは/ usr / local / binに表示されます。 起動は、次のコマンドによって実行されます。

 /usr/local/bin/starman app.psgi 

デフォルトでは、PSGIサーバーは5000ポートを使用します。 たとえば、アプリケーションを--port 8080スイッチで実行することで変更できます。 PSGIは仕様であることを思い出してください。 この場合、この仕様を使用して単純なWebアプリケーションを作成しました。 明らかに、通常の開発では、GETパラメーターの受信からCookieデータの受信まで、多くの補助機能を実装する必要があります。 これはすべて、必要な機能がなければ実現しなかったでしょう。

プラック

PlackはPSGI実装です（Perlには標準のPackモジュールがあるため、実装の名前はPlackです）。 Plackは開発者としての私たちの生活を楽にします。 $ envを操作するための膨大な数の関数が含まれています。
基本構成では、Plackはかなり多数のモジュールで構成されています。 この段階では、これらにのみ興味があります。

• プラック
• Plack ::リクエスト
• Plack ::応答
• Plack ::ビルダー
• Plack ::ミドルウェア

Plack :: RequestおよびPlack :: Responseは、Hash :: MultiValue型の異なる値を返しますが、注意する価値があります。

ハッシュ:: MultiValue

同じく宮川達彦によって作成されたこのモジュールはハッシュですが、微妙な違いがあります。 1つのキーに複数の値を保存できます。 例：$ hash-> get（ 'key'）は値を返し、キーに複数の値がある場合は最後を返します。すべての値が必要な場合は、関数$ hash-> get_all（ 'key'）を使用して、結果を返します（ 'value1'、 'value2'）になります。 Hash :: MultiValueでは、呼び出しのコンテキストも考慮されるため、注意が必要です。

Plack ::リクエスト

クライアント要求を処理するための機能を含むモジュール。 これには多くのメソッドが含まれており、CPANでいつでも見つけることができます。 さらに、この記事のフレームワークでは、次のメソッドを使用します。

• env-$ envを返します。
• method-要求メソッドを返します：GET、POST、OPTIONS、HEADなど。
• path_infoは重要なメソッドです。 現在のスクリプトへのローカルパスを返します。
• parameters-Hash :: MultiValueの形式でパラメーター（x-www-form-url-encoded、アドレスバーパラメーター）を返します。
• uploads-ハッシュ:: MultiValueの形式でもパラメーター（multipart-form-dataを使用して転送）を返します。

Plack ::応答

• status-ステータス（HTTP応答コード）を設定します。パラメーターなしで呼び出されると、以前に設定されたステータスを返します。
• headers-応答ヘッダーを設定します;
• finalize-出口点、アプリケーションの最後の機能。 仕様に従ってPSGI応答を返します。

Plack ::ビルダー

メソッドは考慮しません。これは非常に柔軟なルーターであることに注意してください。 たとえば、ローカルアドレスにハンドラー（PSGIアプリケーション）をインストールできます。

 my $app = builder { mount "/" => builder { $my_cool_app; }; }; 

結果-/への呼び出しは、対応するPSGIアプリケーションにリダイレクトされます。 この場合、$ my_cool_appです。

ルートは、たとえば次のようにネストできます。

 my $app = builder { mount "/" => builder { mount "/another" => builder { $my_another_cool_app; }; mount "/" => builder { $my_cool_app; }; }; }; 

そして、これらのルートはネストできます。 この例では、/に該当しないものはすべて/に送信されます。

Plack ::ミドルウェア

ミドルウェアアプリケーションを作成するための基本クラス。 ミドルウェアは「ミドルウェア」です。 PSGI要求または準備ができたPSGI応答を変更する必要がある場合に使用され、アプリケーションの特定の部分を起動するための特定の条件も提供します。

Plackでアプリケーションを書き換える

 use strict; use Plack; use Plack::Request; my $app = sub { my $env = shift; my $req = Plack::Request->new($env); my $res = $req->new_response(200); $res->body('Hello World!'); return $res->finalize(); }; 

これはPlackを使用した最も単純なアプリケーションです。 それはその仕事の原理を完全に示しています。

あなたが注意を払う必要があるもの。 $ appは関数へのリンクです。 非常に多くの場合、類似したものの簡単なつづりがあると、記号が忘れられます。 関数へのリンクを終了するか、$ envを渡さずにPlack :: Requestを作成した後。 注意する価値があります。

perl -c app.psgiを使用して構文を確認できます。

PSGIアプリケーションの作成に関するもう1つの重要なポイントは次のとおりです。応答本文を作成するときは、文字ではなくバイト（UTF-8など）があることを確認してください。 このエラーは非常に難しいことがわかります。 その存在は、psgi.errorのエラーで空のサーバー応答につながります。

「syswriteでのワイド文字」

私たちのアプリケーションは前のアプリケーションと同様に起動します。

• $ reqはPlack :: Request型のオブジェクトです。 $ reqにはクライアント要求データが含まれます。 関数に渡される$ envハッシュからそれらを取得します。
• $ res-Plack ::応答、これはクライアントへの応答です。 new_responseメソッドを使用した要求に基づいて構築され、応答コード（この場合は200）をパラメーターとして受け取ります。
• body-応答本文を設定します。
• finalize-応答オブジェクトをPSGI応答の配列への参照に変換します（上記のように、応答のステータス、ヘッダー、および本文で構成されます）。

はい、Hello worldは確かに悪くはありませんが、あまり機能的ではありません。 ここで、すべてのツールを使用して、最も単純なアプリケーションを作成しようとします（ただし、はるかに便利です）。

3つの機能を実装するAPIを作成します。

• 最初のものはその行を入力パラメーターとして受け取り、その行が正常に受け入れられたと言います。 連絡先のアドレス-localhost：8080 /;
• 2番目の関数は、パラメーターとして文字列を取り、たとえば、この文字列が回文（両側で同じように見える単語またはフレーズ、たとえば、「アルゼンチンが黒人を誘う」）かどうかを返します。 ローカルホストに配置されます：8080 / palindrome;
• 3番目の関数はパラメーターと同じ文字列を取り、逆さまに返します。 localhost：8080 / reverseに配置されます。

コードを記述した結果、次のことを実行できるものを取得する必要があります。

• 文字列パラメーターが渡された場合、すべてが正常であることにアクセス/応答するとき;
• パリンドロームに連絡するときは、文字列パラメーターの存在を確認し、パリンドロームかどうかを答えます。
• アクセス/リバースするとき、反転文字列を指定します。

行を逆にするには、次の構成を使用します。

 $string = scalar reverse $string; 

文字列が回文であるかどうかを判断するには、次の関数を使用します。

 sub palindrome { my $string = shift; $string = lc $string; $string =~ s/\s//gs; if ($string eq scalar reverse $string) { return 1; } else { return 0; } } 

アプリ

Plack :: Requestでは、parametersメソッドを使用してパラメーターを受け取ることができます。

 my $params = $req->parameters(); 

アプリケーションを完成させ、フォームに追加します。

 use strict; use Plack; use Plack::Request; my $app = sub { my $env = shift; my $req = Plack::Request->new($env); my $res = $req->new_response(200); my $params = $req->parameters(); my $body; if ($params->{string}) { $body = 'string exists'; } else { $body = 'empty string'; } $res->body($body); return $res->finalize(); }; 

始めます。 最初の部分の準備ができました。

アドレスlocalhost ：8080 /？String = 1に移動すると、行があることを示す回答が表示されます。 localhost ：8080 /に移動すると、エラーが返されます。

ロジックの残りの部分は同じアプリケーションに直接実装でき、現在のパスを含むpath_infoでロジックを分割できます。 参考のために、path_info解析は次のように実装できます。

 my @path = split '\/', $req->path_info(); shift @path; 

そして今、$ path [0]に必要なパスがあります。

重要：コードを変更した後、サーバーを再起動する必要があります！

Plack ::ビルダー

今、ルーターを詳しく見る価値があります。

他のPSGIアプリケーションをコンポーネントとして使用することができます。 ミドルウェアを接続する機能は非常に便利です。

ルーターを使用するように、最初のアプリケーションを作り直しましょう。

 use strict; use Plack; use Plack::Request; use Plack::Builder; my $app = sub { my $env = shift; my $req = Plack::Request->new($env); my $res = $req->new_response(200); $res->header('Content-Type' => 'text/html', charset => 'Utf-8'); my $params = $req->parameters(); my $body; if ($params->{string}) { $body = 'string exists'; } else { $body = 'empty string'; } $res->body($body); return $res->finalize(); }; my $main_app = builder { mount "/" => builder { $app; }; }; 

これで、$ main_appがメインのPSGIアプリケーションになりました。 $アプリは/で参加します。 さらに、応答にヘッダーを設定する関数が追加されました（ヘッダーメソッドを使用）。 重要な注意を払う価値があります。このアプリケーションでは、簡単にするために、すべての機能が1つのファイルに配置されています。 より複雑なアプリケーションの場合、これはもちろん推奨されません。

次に、コンポーネントを接続して、アプリケーションの形式で行を有効にします。アプリケーションは、 localhost ：8080 / reverseに配置されます。

 use strict; use Plack; use Plack::Request; use Plack::Builder; my $app = sub { my $env = shift; my $req = Plack::Request->new($env); my $res = $req->new_response(200); $res->header('Content-Type' => 'text/html', charset => 'Utf-8'); my $params = $req->parameters(); my $body; if ($params->{string}) { $body = 'string exists'; } else { $body = 'empty string'; } $res->body($body); return $res->finalize(); }; my $reverse_app = sub { my $env = shift; my $req = Plack::Request->new($env); my $res = $req->new_response(200); my $params = $req->parameters(); my $body; if ($params->{string}) { $body = scalar reverse $params->{string}; } else { $body = 'empty string'; } $res->body($body); return $res->finalize(); }; my $main_app = builder { mount "/reverse" => builder { $reverse_app }; mount "/" => builder { $app; }; }; 

検証アドレスはlocalhost ：8080 / reverse？String = test％20stringです。

2/3タスクが完了しました。 ただし、この場合、$ appと$ reverse_appは非常によく似ています。 少しリファクタリングしましょう。 別の関数を返す関数を作成しましょう（それ以外の場合、高階関数）。

これで、アプリケーションは次のようになります。

 use strict; use Plack; use Plack::Request; use Plack::Builder; sub build_app { my $param = shift; return sub { my $env = shift; my $req = Plack::Request->new($env); my $res = $req->new_response(200); $res->header('Content-Type' => 'text/html', charset => 'Utf-8'); my $params = $req->parameters(); my $body; if ($params->{string}) { if ($param eq 'reverse') { $body = scalar reverse $params->{string}; } else { $body = 'string exists'; } } else { $body = 'empty string'; } $res->body($body); return $res->finalize(); }; } my $main_app = builder { mount "/reverse" => builder { build_app('reverse') }; mount "/" => builder { build_app() }; }; 

はるかに良い。 次に、最後の3番目の関数をAPIに追加し、最終的にアプリケーションを終了します。 すべての改善の結果、フォームのアプリケーションが取得されました。

 use strict; use Plack; use Plack::Request; use Plack::Builder; sub build_app { my $param = shift; return sub { my $env = shift; my $req = Plack::Request->new($env); my $res = $req->new_response(200); $res->header('Content-Type' => 'text/html', charset => 'Utf-8'); my $params = $req->parameters(); my $body; if ($params->{string}) { if ($param eq 'reverse') { $body = scalar reverse $params->{string}; } elsif ($param eq 'palindrome') { $body = palindrome($params->{string}) ? 'Palindrome' : 'Not a palindrome'; } else { $body = 'string exists'; } } else { $body = 'empty string'; } $res->body($body); return $res->finalize(); }; } sub palindrome { my $string = shift; $string = lc $string; $string =~ s/\s//gs; if ($string eq scalar reverse $string) { return 1; } else { return 0; } } my $main_app = builder { mount "/reverse" => builder { build_app('reverse') }; mount "/palindrome" => builder { build_app('palindrome') }; mount "/" => builder { build_app() }; }; 

検証リンク：

localhost ：8080 / palindrome？string = argentina％20Manit％20negra

さらに詳細なトピックでは、ミドルウェア、セッション、Cookie、サーバーの概要、特定の小さなベンチマークの例、PSGI / Plackの機能と微妙さ、負荷のかかったPSGI、PSGIアプリケーションの展開方法の概要、PSGIフレームワーク、プロファイリングを取り上げます。 、スターマン+ Nginx、PSGIモードでのCGIスクリプトの実行、または「CGIアプリケーションはあるがPSGIが欲しい」など。