gen_serverの概要：Erlybank

背景

Open Telecom Platform / Open Telecommunication Platform（OTP / OTP）の概要



これは、Erlang / OTPに適用されるすべての概念を説明する一連の記事の最初の記事です。 将来これらすべての記事を見つけることができるように、特別なタグでマークされています： Otp紹介 （ ここでHabrタグへのリンクを作成しました ）。 OTPの概要で約束したように、Erlybankの人々の偽の銀行口座を提供するサーバーを作成します（そう、私は愚かな名前が好きです）。



シナリオ： ErlyBankは活動を開始します。マネージャーは、重要な顧客ベースの銀行口座を管理するためのスケーラブルなシステムを作成することにより、適切に立ち上がる必要があります。 アーランの力について聞いて、彼らは私たちを雇ってやってくれた！ しかし、私たちが何のために良いのかを見るために、彼らはまず、アカウントを作成および削除し、入金を行い、お金を引き出すことができるシンプルなサーバーを見たいと思っています。 顧客が望んでいるのはプロトタイプであり、生産に投入できるものではありません。



目的： gen_serverを使用して簡単なサーバーとクライアントを作成します。 これは単なるプロトタイプであるため、アカウントはメモリに保存され、名前で識別されます。 アカウントを作成するために他の情報は必要ありません。 そしてもちろん、入出金操作の確認を行います。



注： Erlang構文の最初の知識はすでにあると思います。 そうでない場合は、 初心者向けのリソースの短い要約を読んで、Erlangを学習できるリソースを見つけることをお勧めします。



準備ができたら、「続きを読む」をクリックして始めましょう！ （まだ記事全体を読んでいない場合:)）

gen_serverには何がありますか？

gen_serverは、クライアントサーバーアーキテクチャを実装するためのインターフェイスモジュールです。 このOTPモジュールを使用すると、「無料」で多くの特典が得られますが、これについては後で説明します。 また、シリーズの後半では、スーパーバイザーとエラーメッセージについて説明します。 そして、このモジュールはほとんど変わりません。



gen_serverはインターフェースであるため、いくつかのメソッドを実装するか、関数（コールバック）を返す必要があります。

• init / 1-サーバーの初期化。
• handle_call / 3-呼び出し要求を処理します。 呼び出し要求を送信したクライアントは、応答を受信するまでブロックされます。
• handle_cast / 2-キャスト要求を処理します。 キャスト要求は、非同期であることを除いて、呼び出し要求と同じです。 クライアントはキャストリクエスト中も引き続き動作します。
• handle_info / 2-一種の「すべてをキャッチ」メソッド。 サーバーがメッセージを受信し、これが呼び出しでもキャストでもない場合、ここに来ます。 このようなメッセージの例は、サーバーが別のプロセスに接続（リンク）されている場合のEXITプロセスメッセージです。
• terminate / 2-サーバーが停止すると呼び出されます。 ここで、出発前に必要な操作を行うことができます。
• code_change / 3-サーバーがリアルタイムで更新されるときに呼び出されます。 このメソッドにスタブを配置する必要があります。 この方法については、今後の記事で詳しく説明します。

サーバースケルトン

私は常に一般的なスケルトンで書き始めます。 こちらで見れます 。



注：スペースを乱雑にしないために、ここにファイルの内容を貼り付けません。できるだけ早くすべてをリンクしようとします。 ここに重要なコードスニペットを投稿します。



ご覧のとおり、モジュールはeb_serverと呼ばれます 。 上記で示したすべてのコールバックメソッドを実装し、別のstart_link/0



追加します。これはサーバーの起動に使用されます。 このコードの一部を下に挿入しました：

  start_link（）->
   gen_server：start_link（{local ,? SERVER} ,? MODULE、[]、[]）。 

これはgen_serverモジュールのstart_link / 4メソッドを呼び出します。このメソッドはサーバーを起動し、 SERVER



マクロで定義されたatomを使用してプロセスを登録します。デフォルトはモジュールの名前です。 残りの引数はgen_serverモジュールです。この場合はそれ自体であり、その他の引数はオプションの最後にあります。 引数を空のままにして（必要ありません）、オプションを指定しません。 この方法の詳細については、 gen_serverのマニュアルページを参照してください。

Erlybankサーバーの初期化

サーバーは、gen_server：start_linkメソッドで開始します。このメソッドは、サーバーのinitメソッドを呼び出します。 その中で、サーバーの状態（データ）を初期化する必要があります。 状態（データ）は、アトム、値のリスト、関数など、何でもかまいません！ この状態（データ）は、各コールバックメソッドでサーバーに送信されます。 私たちの場合、すべてのアカウントとその残高値のリストを保持したいと思います。 さらに、名前でアカウントを検索したいと思います。 このために、キーと値のペアをメモリに保存するdictモジュールを使用します。



オブジェクト指向の心への注意： OOPから来た場合、インスタンス変数のサーバー状態を取得できます。 各コールバックメソッドでは、これらの変数を使用できますが、変更することもできます。



したがって、initメソッドの最終形式は次のとおりです。

  init（_Args）->
   {ok、dict：new（）}。 

本当に簡単です！ したがって、Erlybankサーバーの場合、initが返す期待値の1つは{ok, State}



です。 状態（データ）としてokと空の連想配列を返すだけです。 また、引数をinit（まだ空の配列、start_linkから覚えています）に渡さないため、引数の前に「_」を付けてこれを示します。

電話するかキャストしますか？ ここに質問があります

サーバーのほとんどを開発する前に、callメソッドとcastメソッドの違いをもう一度簡単に確認します。



呼び出しは、クライアントをブロックするメソッドです。 これは、クライアントがサーバーにメッセージを送信するとき、続行する前に応答を待つことを意味します。 たとえば、特定の口座の残高を要求するなど、答えが必要な場合に呼び出しを使用します。



キャストは、 非ブロッキングまたは非同期メソッドです。 これは、クライアントがサーバーにメッセージを送信するとき、サーバーが応答するのを待たずに、さらに機能し続けることを意味します。 Erlangは、プロセスに送信されるすべてのメッセージが宛先に到達することを保証するようになりました。したがって、サーバー応答が明らかに必要ない場合は、キャストを使用する必要があります。 つまり、メッセージが到着したことを確認するためだけに電話をかける必要はありません。Erlangにおまかせください。

銀行口座を作成する

最初のスタート:) Erlybankには新しいアカウントを作成する方法が必要です。 すぐに自分自身を確認してください：銀行口座を作成する必要がある場合、 キャストまたは電話を使用しますか？ 高品質だと思う...どのような価値が返されるべきか？ 電話を選択した場合-あなたは正しいですが、そうでない場合は大丈夫です。 アカウントに依存するだけでなく、アカウントが正常に作成されたことを確認する必要があります。 私たちのケースでは、現在エラーをチェックしていないので、キャストで実行します。



最初に、モジュールの外部から呼び出してアカウントを作成するAPIメソッドを作成します。

  %% ------------------------------------------------ --------------------
 %%関数：create_account（名前）-> ok
 %%説明：名前がNameの人の銀行口座を作成します
 %% ------------------------------------------------ --------------------
 create_account（名前）->
   gen_server：cast（？SERVER、{create、Name}）。 

start_linkで?SERVER



として登録したサーバーにキャスト要求を送信します。 要求は、テーパー{create, Name}



です。 キャストを使用すると、「ok」がすぐに返されます。これは、関数によっても返されます。



次に、このキャストを処理するサーバーのコールバックメソッドを記述する必要があります。

  handle_cast（{作成、名前}、状態）->
   {noreply、dict：store（Name、0、State）};
 handle_cast（_Msg、State）->
   {noreply、州}。 

ご覧のとおり、handle_castの別の定義を追加して、別のリクエストを処理しました。 次に、現在のアカウントの残高を表示する値0の配列に保存します。 handle_castは{noreply, State}



返します{noreply, State}



はサーバーの新しい状態（データ）です。 そのため、今回はアカウントが追加された新しい配列を返します。



また、最後に「キャッチオール」機能を追加したことに注意してください。 これはここだけでなく、一般的なすべての機能言語でも実行する必要があります。 このメソッドは、メッセージを静かに飲み込むためにのみ使用できます:)、または必要な場合は例外をスローする必要があります。 私たちの場合、私はそれを静かに処理します。



ここにある時点でのeb_server.erlファイルの内容。

現金預金

クライアントのErlybankに、入金用のAPIと基本的な小切手を追加することを約束しました。 したがって、口座にお金を入金する前にサーバーが口座の存在を確認する必要があるように、預金APIメソッドを作成する必要があります。 そしてもう一度、自分自身をチェックしてください： cast call



？ 答えは簡単です。電話です。 お金が届いたことを確認し、ユーザーに通知する必要があります。



前と同様に、最初にAPIメソッドを記述します。

  %% ------------------------------------------------ --------------------
 %%関数：deposit（名前、金額）-> {ok、Balance} |  {エラー、理由}
 %%説明：Name'sアカウントへの入金額。 を返します
成功した場合は%% balance、そうでない場合はエラーと理由を返します。
 %% ------------------------------------------------ --------------------
デポジット（名前、金額）->
   gen_server：呼び出し（？SERVER、{deposit、Name、Amount}）。

目立ったものは何もありません。サーバーにメッセージを送信するだけです。 上記はキャストとほぼ同じなので、おなじみのはずです。 ただし、サーバー側には違いが現れます。

  handle_call（{deposit、Name、Amount}、_From、State）->
  ケース辞書：（名前、州）の検索
     {OK、値}->
       NewBalance =値+金額、
      応答= {ok、NewBalance}、
       NewState = dict：store（Name、NewBalance、State）、
       {返信、応答、NewState};
    エラー->
       {返信、{エラー、account_does_not_exist}、州}
  終わり;
 handle_call（_Request、_From、State）->
  返信= OK、
   {返信、返信、州}。

わあ！ たくさんの新しくてわかりにくい！ メソッド定義は、使用していない新しいFrom



引数を除いて、handle_castのように見えます。 これは呼び出しプロセスのpid識別子なので、必要に応じて追加のメッセージを送信できます。



アカウントの存在を確認することをアーリーバンクに約束しました。これはコードの最初の行で行います。 入金しようとしているユーザーに相当する状態（データ）の配列から値を見つけようとしています。 dictモジュールのfindメソッドは、 {ok, Value}



、またはerror



の2つの値のいずれかを返しerror



。



口座が存在する場合、価値は現在の口座残高と等しくなります-預金額を追加します。 次に、新しい口座残高を配列に保存し、変数に割り当てます。 また、サーバーの応答を変数に保存します。これは、deposit APIのコメントのように見えます：すべては{ok, Balance}



です。 次に、 {reply, Reply, State}



返すと、サーバーは返信を送り返し、新しい状態（データ）を保存します。



一方、アカウントが存在しない場合は、状態（データ）をまったく変更しませんが、それに応じてエラー{error, account_does_not_exist}



account {error, account_does_not_exist}



を送信します。これは、deposit APIコメントの仕様に従います。



繰り返しますが、ここにeb_server.erlの更新バージョンがあります。

アカウントの削除と引き出し

ここで、アカウントを削除してアカウントからお金を引き出すための演習として、読者にAPIを書いてもらいます。 これを行うために必要なすべての知識があります。 dictモジュールに関するヘルプが必要な場合は、 dict APIリファレンスを参照してください 。 口座からお金を引き出すときは、口座に引き出しに必要な金額が存在するかどうかを確認してください。 負の値を処理する必要はありません。



完了したら、または完了していない場合（そうではありません！）、 ここで答えを見つけることができます。

結びのメモ

この記事では、gen_serverの基本と、クライアントとサーバー間の通信を作成する方法を示しました。 メッセージのタイムアウトやサーバーのシャットダウンなど、gen_serverのすべての機能については説明しませんでしたが、このインターフェイスの強固な部分について説明しました。



コールバックメソッド、戻り値、およびその他のより高度なgen_serverについて詳しく知りたい場合は、gen_serverのドキュメントを参照してください 。 本当に全部読んでください。



また、私はcode_change / 3メソッドには触れなかったことを知っています。これは何らかの理由で人々にとって最もおいしい方法です。 心配する必要はありません。作業中のシステム（ホットスワップコード）のアップグレードに関する記事（シリーズの終わり近く）のスケッチが既にあります。この方法は主な役割の1つです。



次の記事は数日中にあります。 gen_fsm専用になります。 したがって、この記事があなたの脳をくすぐったなら、「マニュアルに飛び込む自由を感じて」:)、自分で行動してください。 たぶん、ErlyBankストーリーの続きを推測できるでしょう。これはgen_fsmで行います;;）