Module jdk.jfr
Package jdk.jfr

Annotation Interface Name


@Target({TYPE,FIELD,METHOD}) @Retention(RUNTIME) public @interface Name
设置元素的默认名称的注解。

对于事件类,名称必须是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
  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    返回名称。
  • Element Details

    • value

      String value
      返回名称。
      返回:
      名称