要素のデフォルト名を設定する注釈。
イベント・クラスの場合、名前は、Java言語で指定されている有効なクラス名(たとえば、"com.example.Transaction"
)である必要があります。 イベント・フィールドまたはイベント設定の場合、名前は有効な識別子(たとえば、"message"
)である必要があります。 詳細は、Java言語仕様の3.8および3.9の項を参照してください。
指定した名前が無効な場合、注釈は無視されます。
安定した使いやすいイベント名の形式は次のとおりです:
[org|com|net].[organization|product].EventName
@Name
注釈のないイベントは、その名前を完全修飾クラス名から取得します。これは実験に適していますが、本番では回避する必要があります。
- この名前は、イベントを使用または構成する設定ファイルおよびコードが壊れないように安定している必要があります。
- この名前には、
"jfr"
,"internal"
,"events"
や"Event"
などの冗長な情報や不要な情報を含めないでください。 - 名前は短くする必要がありますが、他の組織または製品と競合するように短くしないでください。
- この名前はわかりやすく、イベントを構成するユーザーにとって覚えやすい名前にする必要があります。 これは特に、イベントが、第三者の使用するフレームワークやライブラリの一部である場合に当てはまります。 通常は、ライブラリまたは製品のすべてのイベントを同じネームスペースに入れるだけで十分です。 たとえば、OpenJDKのすべてのイベントは
"jdk"
ネームスペースにあり、"hotspot"
、"gc"
または"compiler"
のサブ・ネーム・スペースはありません。 これにより、ユーザーの不必要な認識的負荷を回避できます。 かわりに、@Category
注釈を使用してイベントをカテゴリに分類できます。 カテゴリの名前は、依存性を損なうことなく自由に変更できます
- 導入されたバージョン:
- 9
-
必須要素のサマリー
-
要素の詳細
-
value
String value名前を返します。- 戻り値:
- 名前
-