document/init-class.html at main · socket-manager/document · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
<!DOCTYPE html>
<html lang="ja">
    <head>
        <meta charset="utf-8" />
        <meta name="viewport" content="width=device-width, initial-scale=1" />

        <title>初期化クラスの実装 | SOCKET-MANAGER Framework For PHP</title>
        <meta name="description" content="SOCKET-MANAGERフレームワークにおける初期化クラスの実装方法を解説。ログライター、シリアライザー、コマンドディスパッチャーなど、サーバー起動時に必要な機能の実装例を詳しく紹介。" />
        <meta content="PHP,ソケット通信,サーバー開発,framework,IPC,ソケットマネージャー" name="keywords">
        <link rel="canonical" href="https://socket-manager.github.io/document/init-class.html" />

        <script async src="https://www.googletagmanager.com/gtag/js?id=G-LF9W695NNW"></script>
        <script>
          window.dataLayer = window.dataLayer || [];
          function gtag(){dataLayer.push(arguments);}
          gtag('js', new Date());

          gtag('config', 'G-LF9W695NNW');
        </script>
        <link rel="icon" href="https://socket-manager.github.io/document/favicon.ico" type="image/x-icon" />
        <link type="text/css" rel="stylesheet" href="./css/common.css" media="all" />
        <script src="./js/jquery-3.7.1.min.js"></script>
        <script type="text/javascript" src="./js/common.js"></script>
        <script type="application/ld+json">
        {
            "@context": "https://schema.org",
            "@type": "TechArticle",
            "headline": "SOCKET-MANAGER Framework - 初期化クラスの実装ガイド",
            "description": "SOCKET-MANAGERフレームワークにおける初期化クラスの実装方法を解説。ログライター、シリアライザー、コマンドディスパッチャーなど、サーバー起動時に必要な機能の実装例を詳しく紹介。",
            "articleSection": ["Technical Documentation", "Server Development", "PHP Programming"],
            "keywords": "PHP, ソケット通信, 初期化クラス, 非同期処理, ソケットマネージャー",
            "author": {
                "@type": "Person",
                "name": "SOCKET-MANAGER開発チーム"
            },
            "publisher": {
                "@type": "Organization",
                "name": "SOCKET-MANAGER",
                "logo": {
                    "@type": "ImageObject",
                    "url": "https://socket-manager.github.io/document/logo.png",
                    "width": 355,
                    "height": 50
                }
            },
            "mainEntityOfPage": {
                "@type": "WebPage",
                "@id": "https://socket-manager.github.io/document/init-class.html"
            },
            "url": "https://socket-manager.github.io/document/init-class.html",
            "breadcrumb": {
                "@type": "BreadcrumbList",
                "itemListElement": [{
                    "@type": "ListItem",
                    "position": 1,
                    "name": "Framework Top",
                    "item": "https://socket-manager.github.io/document/"
                },{
                    "@type": "ListItem",
                    "position": 2,
                    "name": "初期化クラスの実装",
                    "item": "https://socket-manager.github.io/document/init-class.html"
                }]
            },
            "isPartOf": {
                "@type": "WebSite",
                "name": "フレームワークのご紹介",
                "url": "https://socket-manager.github.io/document/"
            }
        }
        </script>
    </head>
    <body>
        <div class="layout">
            <div class="menu" role="navigation" aria-label="ページメニュー">
                <h2 class="menu-title">SOCKET-MANAGER</h2>
                <h4 class="menu-reference menu-page-title-bottom"><a href="./reference/" target="_blank">&gt;&gt; Reference</a></h4>
                <h2 class="menu-label">MAIN-MENU</h2>
                <div class="menu-text">

                    <h3 class="menu-page-title-link"><a href="./">▶フレームワークのご紹介</a></h3>

                    <h3 class="menu-page-title-link"><a href="./event-handler.html">▶イベントハンドラについて</a></h3>

                </div>
                <h3 class="menu-label-sub">IMPLEMENT</h3>
                <div class="menu-text">

                    <h3 class="menu-page-title">▼初期化クラス</h3>

                    <ul>
                        <li><a href="./init-class.html#begin">はじめに</a></li>
                    </ul>
                    <ul>
                        <li><a href="./init-class.html#log">➤ログライター</a></li>
                    </ul>
                    <ul>
                        <li><a href="./init-class.html#serializer">➤シリアライザー</a></li>
                    </ul>
                    <ul>
                        <li><a href="./init-class.html#unserializer">➤アンシリアライザー</a></li>
                    </ul>
                    <ul>
                        <li><a href="./init-class.html#dispatcher">➤コマンドディスパッチャー</a></li>
                    </ul>
                    <ul>
                        <li><a href="./init-class.html#emergency">➤緊急切断コールバック</a></li>
                    </ul>
                    <ul>
                        <li><a href="./init-class.html#parameter">➤UNITパラメータインスタンス</a></li>
                    </ul>
                    <ul>
                        <li><a href="./init-class.html#last">おわりに</a></li>
                    </ul>

                    <h3 class="menu-page-title-link"><a href="./unit-parameter.html">▶UNITパラメータクラス</a></h3>

                    <h3 class="menu-page-title-link"><a href="./protocol-unit.html">▶プロトコルUNITクラス</a></h3>

                    <h3 class="menu-page-title-link"><a href="./command-unit.html">▶コマンドUNITクラス</a></h3>

                    <h3 class="menu-page-title-link"><a href="./main.html">▶メイン処理クラス</a></h3>

                    <h3 class="menu-page-title-link"><a href="./setting.html">▶設定ファイル</a></h3>

                    <h3 class="menu-page-title-link"><a href="./message.html">▶メッセージファイル</a></h3>

                </div>
                <div class="menu-line"></div>
                <div class="menu-text">

                    <h3 class="menu-page-title-link-for-runtime-manager"><a href="./runtime-manager/" target="_blank">&gt;&gt; ランタイムライブラリ</a></h3>

                    <h3 class="menu-page-title-link-for-runtime-manager"><a href="./simple-socket/" target="_blank">&gt;&gt; シンプルソケット機能</a></h3>

                </div>
                <h3 class="menu-label-sub">ADVANCED</h3>
                <div class="menu-text">

                    <h3 class="menu-page-title-link"><a href="./architecture.html">▶アーキテクチャ</a></h3>

                    <h3 class="menu-page-title-link"><a href="./event.html">▶イベント駆動アーキテクチャ</a></h3>

                    <h3 class="menu-page-title-link"><a href="./ipc.html">▶IPC（プロセス間通信）</a></h3>

                    <h3 class="menu-page-title-link"><a href="./multi-server.html">▶マルチサーバーの構成</a></h3>

                    <h3 class="menu-page-title-link"><a href="./tcp-and-udp.html">▶TCP/UDP通信について</a></h3>

                    <h3 class="menu-page-title-link"><a href="./laravel.html">▶Laravelと連携する</a></h3>

                    <h3 class="menu-page-title-link"><a href="./system-setting.html">▶システム設定ファイル</a></h3>

                    <h3 class="menu-page-title-link"><a href="./custom-command.html">▶カスタムコマンド作成機能</a></h3>

                </div>
                <h3 class="menu-label-sub">OTHER-PROJECT</h3>
                <div class="menu-text">

                    <h3 class="menu-page-title-link"><a href="./new-project.html">▶新規開発環境</a></h3>

                    <h3 class="menu-page-title-link"><a href="./websocket.html">▶Websocketサーバー開発環境</a></h3>

                    <h3 class="menu-page-title-link"><a href="./dev-ops.html">▶フレームワークのDevOps環境</a></h3>

                </div>
                <div class="menu-line"></div>
                <div class="menu-text">

                    <h3 class="menu-page-title-link-for-minecraft"><a href="./minecraft-contents/" target="_blank">&gt;&gt; マインクラフト専用環境</a></h3>

                    <h3 class="menu-page-title-link-for-launcher"><a href="./launcher/" target="_blank">&gt;&gt; GUI & CLI ランチャー</a></h3>

                    <h3 class="menu-page-title-link-for-rest-api"><a href="./rest-api/" target="_blank">&gt;&gt; REST-APIサーバー開発環境</a></h3>

                </div>
                <h2 class="menu-label">EXTRA-MENU</h2>
                <div class="menu-text">

                    <h3 class="menu-page-title-link"><a href="./extra-demo.html">▶デモサーバーの種類</a></h3>

                    <h3 class="menu-page-title-link"><a href="./extra-demo-command.html">▶デモのコマンド仕様</a></h3>

                    <h3 class="menu-page-title-link"><a href="./extra-demo-setting.html">▶デモの設定ファイル</a></h3>

                    <h3 class="menu-page-title-link"><a href="./extra-minecraft.html">▶マインクラフトの通信仕様</a></h3>

                    <h3 class="menu-page-title-link"><a href="./extra-close-frame.html">▶切断フレームの検証</a></h3>

                </div>
                <h2 class="menu-label">PHP-TECHNIQUE</h2>
                <div class="menu-text">

                    <h3 class="menu-page-title-link"><a href="./php-pass-by-reference.html">▶参照渡し</a></h3>

                    <h3 class="menu-page-title-link"><a href="./php-phpdoc.html">▶PHPDocのフォーマット</a></h3>

                </div>
                <div class="menu-dummy-for-framework"></div>
            </div>
            <div class="main" role="main">

                <h1>【初期化クラスの実装】</h1>

                <a id="begin"></a>
                <h2 class="subtitle">はじめに</h2>
                <div class="text-block">
                    初期化クラスは、サーバー起動時に必要なデータ（UNITパラメータインスタンス）や処理（ログライター、シリアライザー／アンシリアライザー、コマンドディスパッチャー、緊急停止コールバック）を読み込むための実装を行うところで、専用のコマンドを使ってスキャフォールディングできます。<br /><br />

                    初期化クラスを生成するコマンドは以下の通り。<br />

                    <pre color-change="command" aria-label="コマンド実行（InitForTestというクラス名を指定する場合）">
> php worker craft:init InitForTest

[success] 初期化クラスの生成に成功しました (InitForTest)
                    </pre><br />

                    コマンドを実行する事で<code>app/InitClass</code>の場所に<code>InitForTest</code>というクラス名で<code>IInitSocketManager</code>インターフェイスをimplementsした初期化クラスが生成されます。<br /><br />

                    以降では生成されたクラス内で実装が必要なインターフェイスメソッドの内訳を見ていきます。<br />
                </div><br />

                <a id="log"></a>
                <h2 class="subtitle">➤ログライター</h2>
                <div class="text-block">
                    error_logの標準関数やLoggerなどの有名なライブラリを使ってログを出力する事ができます。<br />
                    イベントハンドラ（UNIT）内ではパラメータ経由で使いますので<code>$param->logWriter('debug', ['メッセージ受信' => $message])</code>のように記述します。<br />

                    <pre aria-label="シグネチャ">
【メソッド】getLogWriter(): Closure|string|null

【パラメータ】なし

【戻り値】
    Closure|string|null
    - ログ出力を行う場合: Closure
        パラメータ:
            $p_level - string - 必須 - ログレベル
                現状では以下のレベルが定義されています。
                debug
                info
                notice
                warning
                error
            $p_param - array  - 必須 - 出力内容
                連想配列の形式で以下のように指定します。
                ['メッセージ受信' => $message]
        戻り値: void
    - ログ出力を行う場合: string
        ヘルパー関数などの関数名
    - ログ出力を行わない場合: null
                    </pre><br />

                    <pre color-change="php" aria-label="チャットログ保存の実装例（Closureタイプ）">
public function getLogWriter()
{
    return function(string $p_level, array $p_param)
    {
        // ファイル名を設定
        $filename = date('Ymd');

        // 現在日付を含むログ内容を作成
        $now = date('Y-m-d H:i:s');
        $log = $now." {$p_level} ".print_r($p_param, true)."\n";

        // ログ出力（カレントパスはプロジェクトルートになる）
        error_log($log, 3, "./logs/socket-manager-log/{$filename}.log");
    };
}
                    </pre><br />

                    ※カレントパスはプロジェクトルートになるので<code>./logs/debug.log</code>のように指定します。<br />
                    ※このメソッドはフレームワークのライブラリからもコールされますので、イベントハンドラのログも含めて時系列で出力されます。<br />
                </div><br />

                <a id="serializer"></a>
                <h2 class="subtitle">➤シリアライザー</h2>
                <div class="text-block">
                    送信するデータをシリアライズするためのメソッドを実装します。<br />

                    <pre aria-label="シグネチャ">
【メソッド】getSerializer(): Closure|string|null

【パラメータ】なし

【戻り値】
    Closure|string|null
    - シリアライズを行う場合: Closure
        パラメータ:
            $p_data - mixed - 必須 - 送信データ
                イベントハンドラで設定された送信データがそのまま渡されます。
        戻り値: mixed
            シリアライズ後のデータ
    - シリアライズを行う場合: string
        ヘルパー関数などの関数名
    - シリアライズを行わない場合: null
                    </pre><br />

                    <pre color-change="php" aria-label="JSONデータへシリアライズする例（Closureタイプ）">
public function getSerializer()
{
    return function($p_data)
    {
        return json_encode($p_data);
    };
}
                    </pre><br />

                    ※シリアライザーはデータ送信時にライブラリから自動でコールされます。<br />
                    ※Websocketサーバーとして使う場合はJSON形式で使うのがいいでしょう。<br />
                    ※通信データ量を減らすためにバイナリデータを扱う事も可能です。<br />
                </div><br />

                <a id="unserializer"></a>
                <h2 class="subtitle">➤アンシリアライザー</h2>
                <div class="text-block">
                    受信データを取得する時にアンシリアライズするためのメソッドを実装します。<br />

                    <pre aria-label="シグネチャ">
【メソッド】getUnserializer(): Closure|string|null

【パラメータ】なし

【戻り値】
    Closure|string|null
    - アンシリアライズを行う場合: Closure
        パラメータ:
            $p_data - mixed - 必須 - 受信データ
                シリアライズされている受信データがそのまま渡されます。
        戻り値: mixed
            アンシリアライズ後のデータ
    - アンシリアライズを行う場合: string
        ヘルパー関数などの関数名
    - アンシリアライズを行わない場合: null
                    </pre><br />

                    <pre color-change="php" aria-label="JSONデータを連想配列へ展開する例（Closureタイプ）">
public function getUnserializer()
{
    return function($p_data)
    {
        return json_decode($p_data, true);
    };
}
                    </pre><br />

                    ※アンシリアライザーは受信データ取得時にライブラリから自動でコールされます。<br />
                    ※Websocketサーバーとして使う場合はJSON形式で使うのがいいでしょう。<br />
                    ※通信データ量を減らすためにバイナリデータを扱う事も可能です。<br />
                </div><br />

                <a id="dispatcher"></a>
                <h2 class="subtitle">➤コマンドディスパッチャー</h2>
                <div class="text-block">
                    受信データを受け取った時に呼び出され、そのデータを解析した上でサーバーコンテンツ（コマンドUNIT）上の適切なイベントハンドラを呼び出すためのルーティングの役割を果たします。<br />
                    コマンドディスパッチャーからは、ルーティングするキュー名を返す事でイベントハンドラを呼び出す事ができます。<br />

                    <pre aria-label="シグネチャ">
【メソッド】getCommandDispatcher(): Closure|string|null

【パラメータ】なし

【戻り値】
    Closure|string|null
    - コマンドディスパッチャーを使う場合: Closure
        パラメータ:
            $p_param - SocketManagerParameter - 必須 - UNITパラメータクラスのインスタンス
                各イベントハンドラで共通の引数として使用されるインスタンス。
                SocketManagerParameterクラスを継承した拡張クラスを指定する事も可能。
            $p_dat   - mixed                  - 必須 - 受信データ
                アンシリアライズ化された受信データがそのまま渡されます。
        戻り値: string
            ルーティングするキュー名
    - コマンドディスパッチャーを使う場合: string
        ヘルパー関数などの関数名
    - コマンドディスパッチャーを使わない場合: null
                    </pre><br />

                    <pre color-change="php" aria-label="受信データ内のコマンド名を使う例（Closureタイプ）">
public function getCommandDispatcher()
{
    return function(SocketManagerParameter $p_param, $p_dat): ?string
    {
        // コマンド部のキュー名と一致している必要があります
        return $p_dat['command'];
    };
}
                    </pre><br />
                </div><br />

                <a id="emergency"></a>
                <h2 class="subtitle">➤緊急切断コールバック</h2>
                <div class="text-block">
                    クライアントとの接続が維持できなくなった時に呼び出されるコールバックメソッドを実装します。<br />
                    例えば以下の場面で呼び出されます。
                    <ul>
                        <li>アライブチェック処理のタイムアウト</li>
                        <li>コマンドディスパッチャーでの例外発生</li>
                        <li>相手先による強制切断</li>
                    </ul>

                    <pre aria-label="シグネチャ">
【メソッド】getEmergencyCallback(): Closure|string|null

【パラメータ】なし

【戻り値】
    Closure|string|null
    - 緊急切断コールバックを使う場合: Closure
        パラメータ:
            $p_param - SocketManagerParameter - 必須 - UNITパラメータクラスのインスタンス
                各イベントハンドラで共通の引数として使用されるインスタンス。
                SocketManagerParameterクラスを継承した拡張クラスを指定する事も可能。
        戻り値: なし
    - 緊急切断コールバックを使う場合: string
        ヘルパー関数などの関数名
    - 緊急切断コールバックを使わない場合: null
                    </pre><br />

                    <pre color-change="php" aria-label="チャットが切断された時の例（Closureタイプ）">
public function getEmergencyCallback()
{
    return function(SocketManagerParameter $p_param)
    {
        // 送信データを作成
        $send_data = [];
        $send_data['command'] = 'close';
        $send_data['message'] = '切断されました';
        $send_data['connection_id'] = $p_param->getConnectionId(); // 接続IDを取得

        // 全員へ配信（第二パラメータがtrueの場合は自身を除く）
        $p_param->setSendStackAll($send_data, true);
    };
}
                    </pre><br />
                </div><br />

                <a id="parameter"></a>
                <h2 class="subtitle">➤UNITパラメータインスタンス</h2>
                <div class="text-block">
                    UNITとしてのイベントハンドラを実行する時に渡されるUNITパラメータクラスのインスタンスを指定します。<br />
                    基底クラスである<code>SocketManagerParameter</code>クラスのインスタンスがデフォルトで指定されていますが、このクラスを継承した拡張クラスを使用する場合はそのインスタンスを戻り値に指定する必要があります。<br />
                    ここで指定したインスタンスはそのままUNITの引数として使われますので、動的に増殖してメモリを圧迫する心配はありません。<br />

                    <pre aria-label="シグネチャ">
【メソッド】getUnitParameter(): SocketManagerParameter|null

【パラメータ】なし

【戻り値】SocketManagerParameter|null
    - UNITパラメータクラスを使う場合: SocketManagerParameter
        各イベントハンドラで共通の引数として使用されるインスタンス。
        SocketManagerParameterクラスを継承した拡張クラスを指定する事も可能。
    - UNITパラメータクラスを使わない場合: null
                    </pre><br />

                    <pre color-change="php" aria-label="基底のUNITパラメータクラスを使う例">
public function getUnitParameter(): ?SocketManagerParameter
{
    return new SocketManagerParameter();
}
                    </pre><br />

                    ※UNITパラメータクラスの詳細については<font><a href="./unit-parameter.html" target="_blank">▶UNITパラメータクラス</a></font>のページをご覧ください。<br />
                </div><br /><br />

                <a id="last"></a>
                <h2 class="subtitle">おわりに</h2>
                <div class="text-block">
                    生成されたクラスのインスタンスは、メイン処理クラス内で<code>$manager->setInitSocketManager()</code>メソッドに引き渡す事で適用されます。<br />
                    複数の初期化クラスやメイン処理クラスを用意している場合は、サーバーの実装内容によって最適なインスタンスを動的、あるいは静的に適用する事で柔軟なサーバー構築が可能になります。<br />
                </div>
            </div>
        </div>
    </body>
</html>