gen_fsmの概要：Erlybank ATM

背景
Open Telecom Platform / Open Telecommunication Platform（OTP / OTP）の概要
gen_serverの概要：Erlybank

これは、OTPシリーズの概要の2番目の記事です。 gen_serverについて説明し 、これを読む前に銀行システムの基礎を築く最初の記事を読むことをお勧めします。 すばやく把握すれば、 完成したバージョンのサーバーを確認して先に進むことができます。

シナリオ： ErlyBankサーバーを顧客に提供しましたが、顧客は非常に満足していました。 しかし、21世紀は庭にあり、安全で使いやすいATMも求めているため、サーバーを拡張し、ATM用のソフトウェアを作成するよう依頼されました。 ユーザーアカウントは4桁のPINコードで保護する必要があります。 ATMでは、以前に作成したアカウントを使用してログインし、アカウントから入金または引き出しを行うことができます。 美しいインターフェイスを作成する必要はありません;他の人がそれをやっています。

目標：最初に、アカウントのPINコードのサポートとPINコードによる認証を追加して、サーバーを拡張します。 次に、gen_fsmを使用してATMバックエンドを作成します。 データ検証はサーバー側で実行されます。

gen_fsmとは何ですか？

gen_fsmは別のErlang / OTPインターフェイスモジュールです。 有限状態マシンを実装するために使用されます。

この記事では「状態」の概念が2つのことを意味するために使用されるため、事前に謝罪します。

• state gen_fsm-状態マシンの状態、その操作の現在の「モード」。 gen_serverからの状態（データ）とは関係ありません。
• ステータス（データ） -サーバーステータスデータは、gen_serverについての以前の記事から学んだことです。

もちろん少しcですが、上記の条件のコンテキストでのみ参照するようにします。

gen_fsmはある状態で動作を開始します。 gen_fsmへの呼び出し/キャスト呼び出しは、特別なコールバックメソッドで処理されます。このメソッドは、gen_fsmの現在の状態（ステートマシン）の名前と呼ばれます。 実行されたアクションに基づいて、モジュールは状態を変更できます（[現在の状態、着信文字]->新しい状態、約）。 ステートマシンの教科書の例は、閉じたドアです。 最初は、ドアは「閉じた」状態です。 開くには4桁のコードを入力する必要があります。 1桁を入力すると、ドアはそれを保存しますが、1桁では不十分なので、「閉じた」状態で待機し続けます。 4桁を入力した後、それらが正しい場合、ドアはしばらくその状態を「開く」に変更します。 数値が正しくない場合、「クローズ」状態のままになり、メモリがクリアされます。 おそらく、gen_fsmを使用してステートマシンを実装する方法について、すでにいくつかの推測をお持ちかもしれません。

gen_serverの場合と同様に、gen_fsmで実装する必要があるコールバックメソッドのリストを示します。 gen_serverに関連することがたくさんあります。

• init / 1-ステートマシンサーバーを初期化します。 gen_serverとほぼ同じです。
• StateName / 2 -StateNameは州の名前に置き換えられます。 このメソッドは、ステートマシンがこの状態にあり、メッセージを受信したときに呼び出されます。 その結果、特定のアクションが実行されます。 これは非同期コールバックメソッドです。
• handle_event / 3 -StateName / 2と同じ。ただし、このメソッドは、マシンの現在の状態に関係なく、クライアントがgen_fsm：send_all_state_eventを呼び出したときに起動します。 繰り返しますが、非同期です。
• StateName / 3 -StateName / 2の同期バージョン。 クライアントはサーバーの応答を待ちます。
• handle_sync_event / 4 -handle_eventの同期バージョン/ 3。
• handle_info / 3 -gen_server handle_infoと同等です。 このメソッドは、gen_fsmの非標準の手段によって送信されたすべてのメッセージを受信します。 これは、タイムアウトメッセージ、プロセス終了メッセージ、または「！」を使用してサーバープロセスに送信されるその他のメッセージです。
• terminate / 3-サーバーのシャットダウン時に呼び出され、サーバー内の占有リソースを解放できます。
• code_change / 4-サーバーがリアルタイムで更新されるときに呼び出されます。 現在は使用していませんが、今後の記事で使用する予定です。

gen_fsmスケルトン

gen_serverと同様に、一般的なスケルトンを使用してステートマシンを作成し始めます。 gen_fsmのスケルトンはこちらにあります 。

特別なものはありません。 start_linkは、gen_server用に作成したものに似ています。 :)スケルトンをeb_atm.erlとして保存します。 これで、開始する準備ができました！

アカウント認証メカニズムを作成するためのeb_server拡張。

これは私があなたに任せる別のタスクです。 必要な変更：

1. これで、アカウントを作成するときに、暗号化せずにアカウントと共に保存されるPINコードを要求する必要があります。
2. 名前とPIN引数を使用してauthorize / 2メソッドを追加します。 戻り値はokまたは{error, Reason}なければなりません。

また、入金/出金操作ごとにPINコードを要求することは素晴らしいことですが、時間を節約するために、また銀行が偽物であるため（私の心が壊れています：（ha！）、これは行いません）。

正直なところ、これはそれほど簡単ではありませんが、Erlangを自分で学べば、十分に賢くなければなりません;）だからあなたはそれができると思います！ 続行する前に変更をテストするか、少なくとも以下の回答と比較してください。

変更後、eb_server.erlは次のようになります 。 サーバーに送信するメッセージは異なる場合があることに注意してください。これは正常な動作です。 誰もが異なる考え方を持っています。 APIが同じデータを正しく出力することが非常に重要です。 （重要なことは、APIが同じデータを正しく出力することです）

ATM設計戦略

ATMステートマシンの作業計画を伝えるために、「コードなし」の短い休止をとりたいと思います。 以下の図に従って実行します。



3つの青いブロックは、異なるサーバー状態を表します。 矢印は、ある状態から別の状態に移行するために必要なアクションを示しています。

gen_fsmの初期化

ATMを起動するには、gen_serverと同じstart_linkメソッドを使用します。 ただし、初期化は少し異なります。

  init（[]）->
   {OK、無許可、誰も}。 

gen_fsmのinit / 1メソッドは{ok, StateName, StateData}を返す必要があります。 StateNameはサーバーの初期状態、StateDataはサーバーの初期状態（データ）です。 このケースでは、無許可の状態で開始し、データはnobody設定されます。 状態（データ）は作業しているアカウントの名前になるため、最初は何もありません。 Erlangにはnull / nil / nothingのデータ型がありません。代わりに、例えば誰もいないので、通常は話すアトムが使用されます。

アカウント認証

次に、ATMの認証APIを実装する必要があります。 まず、API定義：

 承認（名前、PIN）->
   gen_fsm：sync_send_event（？SERVER、{authorize、Name、PIN}）。 

sync_send_eventメソッドは、gen_serverモジュールの呼び出しメソッドと同等です。 サーバーの現在の状態（最初の引数）にメッセージ（2番目の引数）を送信します。 したがって、このメッセージのハンドラーを作成する必要があります。

 未承認（{authorize、Name、Pin}、_From、State）->
  ケースeb_server：の承認（名前、ピン）
     OK->
       {返信、OK、承認済み、名前};
     {エラー、理由}->
       {返信、{エラー、理由}、不正、状態}
  終わり;
不正（_Event、_From、State）->
  返信= {エラー、無効なメッセージ}、
   {返信、返信、未承認、州}。 

この関数は、サーバーが無許可の状態にあるときにメッセージを受信する必要があるため、無許可と呼ばれます。 タップ{authorize, Name, Pin}を処理し、eb_serverサーバーによってエクスポートされたAPIメソッドを使用してユーザーを認証するために、サンプルと比較します。

ユーザー名とPINが正しい場合、クライアントにokを送信okます。 応答形式： {reply, Response, NewStateName, NewStateData} 形式に従って、状態を許可に変更し、アカウント名を状態（データ）に保存します。

アカウント情報が間違っていた場合、エラーおよびエラーの原因を応答として送信します。状態と条件（データ）は変更されません。

最後に、別のキャッチオール関数を実装します。 常にこれを行う必要がありますが、 ここでは特に重要です 。なぜなら、状態は他の状態に宛てられたメッセージを受信できるからです。 例：何らかの理由で、誰かが未放送の状態で預金しようとするとどうなりますか？ エラーメッセージを送り返すには、キャッチオールメソッドが必要です。

入金

承認状態に入るとすぐに、ユーザーは自分の銀行口座から入金または引き出しを行います。 サーバーへの非同期呼び出しを使用してデポジットを実装します。 繰り返しますが、これはあまり安全ではありません。入金が成功したかどうかはまったくチェックしませんが、銀行は偽物なので、忘れてしまいます。 ;）

したがって、最初はAPIです！

 %% ------------------------------------------------ --------------------
 %%関数：deposit（Amount）-> ok
 %%説明：現在承認されている特定の金額を入金します
 %%アカウント。
 %% ------------------------------------------------ --------------------
デポジット（金額）->
   gen_fsm：send_event（？SERVER、{deposit、Amount}）。

簡単です。今回は、sync_send_eventの代わりにsend_event/2メソッドを使用しsend_event/2 。 サーバーに非同期呼び出しを送信します。 そして今、ハンドラー...

承認済み（{deposit、Amount}、State）->
   eb_server：deposit（州、金額）、
   {next_state、thank_you、State、5000};
承認済み（_Event、State）->
   {next_state、authorized、State}。

繰り返しますが、すべてが非常に簡単です。 このメソッドは、情報を単にeb_serverモジュールのdepositメソッドにリダイレクトします。このメソッドは、チェック全体も実行します。 ただし、depositメソッドの戻り値には異常があります！ 状態がthank_youに変わるだけでなく、最後にその番号「5000」もあります。 これは単なるタイムアウトです。 5000ミリ秒（5秒）以内にメッセージが受信されない場合、 -が現在の状態に送信されます。
コトルは次のトピックに私たちを導きます...

短い「ありがとう！」条件

ATMを使用した多くの（またはすべての）人々は、短い間表示される小さな「ありがとう！」画面があることを知っています。 実際、実装ではこの画面がなくても安全に実行できます。gen_fsmにタイムアウトのある機能を表示したかっただけです。 5000ミリ秒後、またはメッセージが受信されない場合、状態を「無許可」に戻すので、ATMは次のユーザーで再び開始できます。 コードは次のとおりです。

 thank_you（タイムアウト、_State）->
   {next_state、無許可、無人};
 thank_you（_Event、_State）->
   {next_state、無許可、無人}。

注：訓練を受けた目では、両方の方法が同等であり、最初のサンプルは不要であることがわかります。 確かに、最初のサンプルを含めて、タウマウトを捕まえるようにしました。

そして、ここに現在完成したeb_atm.erlのバージョンがあります。

アカウントからお金を引き出す

繰り返しますが、お金を引き出す方法の開発は読者のための演習として残しておきます。 必要に応じてこのパズルを実装できます！ あなたが本当にお金を取ることを確認してください;）

これは、引き出しメカニズムを実装した後のeb_atm.erlの私のバージョンです 。 操作が正常に完了すると、マシンがタイムアウトでthank_you状態に移行することに注意してください。

「何もキャンセルしない」ボタン

コンピューターの最大の問題の1つは、すべてを中断する[キャンセル]ボタンがないことです。 そして、コンピューターの電源オフボタンがこのタスクに対応していることは承知していますが、Erlybank ATMのユーザーはそのような機会を奪われています。 したがって、現在の状態に関係なく、すべてのトランザクションをキャンセルするcancelメソッドを実装しましょう。

これをどのように実装しますか？ 一般に、この記事の情報に基づいて、cancelメソッドを使用してcancelメッセージを送信することをお勧めします。 次に、各状態で、それを処理し、 unauthorized状態に戻ります。

機知に富んでいますが、正しくありませんが、それはあなたのせいではありません！ サーバーの状態に関係なく、サーバーにメッセージを送信するgen_fsm:send_all_state_event/2メソッドがあることを示しませんでした（または、簡単に説明しなかったかもしれません）。 コードをクリーンに保つために使用します。

API：

 %% ------------------------------------------------ --------------------
 %%機能：キャンセル/ 0
 %%説明：状態に関係なくATMトランザクションをキャンセルします。
 %% ------------------------------------------------ --------------------
キャンセル（）->
   gen_fsm：send_all_state_event（？SERVER、キャンセル）。

このメッセージは、以下に拡張するhandle_event/3送信されます。

 handle_event（キャンセル、_StateName、_State）->
   {next_state、無許可、無人};
 handle_event（_Event、StateName、State）->
   {next_state、StateName、State}。

キャンセルメッセージを受信した場合、サーバーは状態を無許可に、連絡先（データ）を誰にも変換しません：新しいATM！

いつものように、eb_atm.erlの現在のバージョンはここで見ることができます 。

結びのメモ

この記事では、 gen_fsmを使用して、 ステートマシン上に構築された簡単なATMシステムを作成する方法を示しました 。 さまざまな状態のメッセージを処理する方法、状態を変更する方法、タイムアウトによって状態を変更する方法、およびすべてにメッセージを送信する方法を示しました。

ただし、システムにはまだいくつかの「いぼ」があり、それらを修正する機会を残しておきます。 必要に応じて、2つのタスクを用意しました。 私を信じて、あなたはそれらを実行することができます：

1. 預金操作にエラーチェックを追加します。 常に「ok」ではなく{ok, Balance} {error, Reason}および{ok, Balance}返すようにし{error, Reason} 。
2. ATMに残高チェック機能を追加します。 許可された状態でのみ使用可能であり、トランザクションを完了してはなりません。 これは、彼女が状態をthank_youに変換しないことを意味します。 これは、通常、残高を確認した人が、自分の口座に引き出したり、お金を入れたいと思うためです。

演習のこれら2つの機能は今後使用されません。使用する場合は、ここに回答を掲載しません。 それらを機能させることでテストできます！ :)

これらの記事の第2部は完了しています。 3番目の記事はほぼ準備ができており、数日中に公開されます。 彼女はgen_eventトピックについて説明します。 楽しむために、gen_eventを使用してErlybankに追加するものについて考えてみてください。 ：D

Erlang / OTPのこれらの紹介記事を、私がそれらを書くのを楽しんでいたのと同じくらい楽しんでくれたことを願っています。 ご支援と幸運をありがとうございました！