コミュニティ 学ぶ ツールライブラリ レジャー
検索
日本語
ホームページ > バックエンド開発 > PHPチュートリアル > PHP PSR-3 ログインターフェイス仕様

PHP PSR-3 ログインターフェイス仕様

WBOY
リリース： 2016-07-23 08:54:41
オリジナル
985 人が閲覧しました
ログインターフェース仕様

この記事は、ログ ライブラリの一般的なインターフェイス仕様を定式化します。

この仕様の主な目的は、ログ ライブラリが PsrLogLoggerInterface オブジェクトを受け取ることによって、シンプルかつ汎用的な方法でログ情報を記録できるようにすることです。

必要に応じて、フレームワークと CMS コンテンツ管理システムはこのインターフェースを拡張できますが、
この仕様に従う必要があります。これにより、サードパーティのクラス ライブラリ ファイルを使用する場合でもログ インターフェースを正常に接続できるようになります。 キーワード「しなければならない」（「MUST」）、「してはならない/してはならない」（「MUST NOT」）、「必要」（「必須」）、
「するつもり」（「SHALL」）、「しない」（ 「してはならない」)、「すべきである」(「すべきである」)、「すべきではない」(「すべきではない」)、

「推奨する」(「推奨」)、「できる」(「してもよい」)、および「オプション」(" OPTIONAL") については、[RFC 2119][] で詳細に説明されています。


この記事の実装者は、LoggerInterface インターフェイスを実装するクラス ライブラリまたはフレームワークを指します。つまり、LoggerInterface のユーザーです。

仕様

1.1 基本仕様 LoggerInterface インターフェースは 8 つの外部メソッドを定義しており、[RFC 5424][] で定義されている 8 つのレベルのログ (デバッグ、情報、通知、警告、エラー、クリティカル、アラート、緊急) を記録するために使用されます。

9 番目のメソッド - log、その最初のパラメータはレコードのレベルです。このメソッドは、事前定義されたレベル定数をパラメータとして使用して呼び出すことができ、上記の 8 つのメソッドを直接呼び出すのと同じ効果が得られます。受信レベル定数パラメーターが事前定義されていない場合は、PsrLogInvalidArgumentException タイプの例外をスローする必要があります。ユーザーは、不確実な状況下でサポートされていないレベル定数を使用してこのメ​​ソッドを呼び出すべきではありません
。

1.2 レコード情報

上記の各メソッドは、文字列型または __toString() メソッドを使用したオブジェクトをレコード情報パラメーターとして受け入れるため、実装者はそれを文字列として扱うことができます。それ以外の場合は、実装者が自分で文字列に変換する必要があります

。 レコード情報パラメーター はプレースホルダーを運ぶことができ、実装者 はコンテキストに従って他のパラメータを対応する値に置き換えることができます 。

ここで、プレースホルダーは

コンテキスト配列内のキー名と一致している必要があります。 プレースホルダー名

は、

左中括弧 { と右括弧 } で囲む必要があります。ただし、中括弧と名前の間にスペースを入れてはなりません。 プレースホルダーの名前 は、A ～ Z、a ～ z、0 ～ 9、アンダースコア _、および英語のピリオドのみで構成する必要があり、他の文字は将来のプレースホルダー仕様のために予約されています。

実装者は、

プレースホルダーにさまざまなエスケープおよび変換戦略を適用することで、最終的なログを生成できます。 また、ユーザーはコンテキストを知らずに事前にプレースホルダーをエスケープするべきではありません 。

以下はプレースホルダーの使用例です:

/**

* レコード情報のプレースホルダーをコンテキスト情報に置き換えます*/function interpolate($message, array $context = array())

{

// 中括弧で囲まれた置換配列を構築しますキー名の $replace = array(); foreach ($context as $key => $val) {
$replace['{' . $key '}'] = $val; }

/ /レコード情報内のプレースホルダーを置き換えて、最後に変更されたレコード情報を返します。

return strtr($message, $replace);

}
// 中括弧プレースホルダーを含むレコード情報が含まれます。
    $message = "User {username} created";
  2. // 置換情報を含むコンテキスト配列。キー名はプレースホルダー名、キー値は置換値です。
  3. $context = array('username' => 'bolivar');
  5. // "ユーザー名 bolivar が作成されました" を出力
  6. echo interpolate($message, $context);
  9. コードをコピー
  11. 1.3 コンテキスト

    各記録関数は、文字列型では表現できない情報をロードするためにコンテキスト配列パラメーターを受け入れます。 あらゆる情報をロードできるため、実装者は ロードする情報を正しく処理できることを確認する必要があり、 例外をスローしたり、PHP エラー、警告、リマインダー メッセージ (エラー、警告、注意）。 Exception オブジェクトがコンテキスト パラメータを通じて渡される場合、 キー名として「例外」を使用する必要があります。

    例外情報のログ記録は非常に一般的であるため、ログ記録クラス ライブラリの最後に実装できれば、実装者は例外情報を削除できます。

    もちろん、これを使用する場合、実装者は、キー名「例外」を持つキー値が本当に例外であるかどうかを 確認する必要があります。結局のところ、あらゆる情報を 読み込むことができます。
    1.4 ヘルパークラスとインターフェース PsrLogAbstractLogger クラスを使用すると、LoggerInterface インターフェイスを継承して log メソッドを実装するだけで簡単に実装できます。他の 8 つのメソッドはログ情報とコンテキスト情報をそれに渡すことができます。
    同様に、PsrLogLoggerTrait を使用するには、log メソッドを実装するだけです。ただし、特性の再利用可能なコード ブロックがインターフェイスを実装できる前に、LoggerInterface を実装する必要があることに注意することが重要です。 利用可能なロガーがない場合、PsrLogNullLogger インターフェイスは、ユーザーにバックアップ ログ「ブラック ホール」を提供できます。ただし、コンテキストの構築がリソースを非常に大量に消費する場合は、条件付きチェックを使用してログを記録する方が良い方法である可能性があります。 PsrLogLoggerAwareInterface インターフェイスには

    setLogger(LoggerInterface $logger) メソッドのみが含まれており、フレームワークはこれを使用して任意のログ インスタンスに自動的に接続できます。

    PsrLogLoggerAwareTrait 特性の再利用可能なコード ブロックは、どのクラスでも使用でき、同等のインターフェイスは、それが提供する $this->logger を通じて簡単に実装できます。

    PsrLogLogLevel クラスは 8 つのログ レベル定数を読み込みます。

    バッグ

    上記のインターフェイス、クラス、および関連する例外クラス、および一連の実装検出ファイルは、psr/log ファイル パッケージに含まれています。

    PsrLogLoggerInterface

    3. namespace PsrLog;
    5. /**
    6. * ログインスタンス
    7. *
    8. * ログ情報変数 - メッセージ、**必須** 文字列または __toString() メソッドを実装するオブジェクトです。
    9. *
    10. * ログ情報変数 **can** には、"{foo}" (foo を表す) 形式のプレースホルダーを含めることができます。
    11. * これは、コンテキスト配列内のキー値 "foo" に置き換えられます。
    12. *
    13. * コンテキスト配列は任意のデータを保持できます。唯一の制限は、例外オブジェクトを保持する場合、そのキー名は「例外」でなければならないことです。
    14. *
    15. * 詳細については、https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-3-logger-interface-cn.mdを参照してください
    16. */
    17. interface LoggerInterface
    18. {
    19. /**
    20. * システムが利用できません
    21. *
    22. * @param string $message
    23. * @param array $context
    24. * @return null
    25. */
    26. public functionEmergency($message, array $context = array());
    28. /**
    29. * **すぐに行動を起こす必要があります**
    30. *
    31. * たとえば、Web サイト全体がダウンしている場合、データベースが利用できない場合、またはその他の状況の場合は、ユーザーを目覚めさせるために警告テキスト メッセージが送信される必要があります。
    32. *
    33. * @param string $message
    34. * @param array $context
    35. * @return null
    36. */
    37. public functionalert($message, array $context = array());
    39. /**
    40. * 緊急
    41. *
    42. * 例: プログラム コンポーネントが利用できない、または予期しない例外が発生します。
    43. *
    44. * @param string $message
    45. * @param array $context
    46. * @return null
    47. */
    48. public functioncritical($message, array $context = array());
    50. /**
    51. * 実行時に発生したエラーは直ちに対処する必要はありませんが、検出のために記録する必要があります。
    52. *
    53. * @param string $message
    54. * @param array $context
    55. * @return null
    56. */
    57. public function error($message, array $context = array());
    59. /**
    60. * エラー以外の例外が発生しました。
    61. *
    62. * 例: 非推奨の API の使用、API の誤った使用、または予期しない不要なエラーの原因。
    63. *
    64. * @param string $message
    65. * @param array $context
    66. * @return null
    67. */
    68. public function warning ($message, array $context = array());
    70. /**
    71. *一般的に重要なイベント。
    72. *
    73. * @param string $message
    74. * @param array $context
    75. * @return null
    76. */
    77. public function Notice($message, array $context = array());
    79. /**
    80. * 重要なイベント
    81. *
    82. * 例: ユーザー ログインと SQL レコード。
    83. *
    84. * @param string $message
    85. * @param array $context
    86. * @return null
    87. */
    88. パブリック関数 info($message, array $context = array());
    90. /**
    91. * デバッグの詳細
    92. *
    93. * @param string $message
    94. * @param array $context
    95. * @return null
    96. */
    97. public function debug($message, array $context = array());
    99. /**
    100. * 任意のレベルでのロギング
    101. *
    102. * @parammixed $level
    103. * @param string $message
    104. * @param array $context
    105. * @return null
    106. */
    107. public function log($level, $message, array $context = array());
    108. }
    复制代码

    PsrLogLoggerAwareInterface

    3. namespace PsrLog;
    5. /**
    6. * ロガー対応定義インスタンス
    7. */
    8. interface LoggerAwareInterface
    9. {
    10. /**
    11. * ロギングインスタンスをセットアップします
    12. *
    13. * @param LoggerInterface $logger
    14. * @return null
    15. */
    16. public function setLogger(LoggerInterface $logger);
    17. }
    复制代

    PsrLogLogLevel

    3. namespace PsrLog;
    5. /**
    6. * ログレベル定数の定義
    7. */
    8. class LogLevel
    9. {
    10. const EMERGENCY = '緊急';
    11. const ALERT = 'alert';
    12. const CRITICAL = ' Critical';
    13. const ERROR = 'error';
    14. const WARNING = 'warning';
    15. const NOTICE = 'notice';
    16. const INFO = 'info';
    17. const DEBUG = 'debug';
    18. }
    复制代

    转自Github(PizzaLiu)

PHP、PSR


関連ラベル：
PHP PSR-3 日志接口规范
ソース：php.cn
前の記事：プログラマーのホーム - プログラマーのフォーラム [広告スポンサーシップの見積もり] - インターネット情報 プログラマーのホーム フォーラム 次の記事：ecshop が新しい php ファイルを作成する require_once エラー
このウェブサイトの声明
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。
著者別の最新記事
最新の問題
function_exists() はカスタム関数を決定できません Function test () {return true;} if (function_exists ('test')) {echo "テストは関数です";
から 2024-04-29 11:01:01
0
3
2240
Google Chromeのモバイル版を表示する方法 こんにちは、先生、Google Chrome をモバイル版に変更するにはどうすればよいですか?
から 2024-04-23 00:22:19
0
11
2380
子ウィンドウは親ウィンドウを操作しますが、出力は応答しません。 最初の 2 つの文は実行可能ですが、最後の文は実装できません。
から 2024-04-19 15:37:47
0
1
1990
親ウィンドウには出力がありません document.onclick = function(){ window.opener.document.write('私は子ウィンドウの出力です');
から 2024-04-18 23:52:34
0
1
1877
CSS マインド マッピングに関するコースウェアはどこにありますか? コースウェア
から 2024-04-16 10:10:18
0
0
1947
関連トピック
詳細>
人気のおすすめ
人気のチュートリアル
詳細>
関連するチュートリアル
人気のおすすめ
最新のコース
最新のダウンロード
詳細>
ウェブエフェクト
公式サイト
サイト素材
フロントエンドテンプレート