Annotation Type ToString

@Target(TYPE) @Retention(SOURCE) public @interface ToString
为所有对象继承的 toString 方法生成一个实现，该实现包括打印相关字段的值。

完整的文档可以在 project lombok 的 @ToString 功能页面 找到。

  • 嵌套类概要

    嵌套类
    修饰符和类型
    类
    描述
    static @interface 
    ToString.Exclude
    如果存在，则在生成的 toString 中不包含此字段。
    static @interface 
    ToString.Include
    配置此成员在 toString 中如何呈现的行为；如果在方法上，则在输出中包含该方法的返回值。

  • 可选元素概要

    可选元素
    修饰符和类型
    可选元素
    描述
    boolean
    callSuper
    在输出中包含超类 toString 实现的结果。
    boolean
    doNotUseGetters
    通常，如果 getters 可用，则会调用它们。
    String[]
    exclude
    此处列出的任何字段都不会在生成的 toString 实现中打印。
    boolean
    includeFieldNames
    打印时包含每个字段的名称。
    String[]
    of
    如果存在，则显式列出要打印的字段。
    boolean
    onlyExplicitlyIncluded
    仅包含显式标记为 @ToString.Include 的字段和方法。

  • 元素详情

    • includeFieldNames

      boolean includeFieldNames
      打印时包含每个字段的名称。默认值：true
      返回值
      是否在生成的 toString() 产生的字符串中包含字段名称。
      默认值
      true

    • exclude

      String[] exclude
      此处列出的任何字段都不会在生成的 toString 实现中打印。与 of() 互斥。

      即将被标记为 @Deprecated；请改用 @ToString.Exclude 注解。

      返回值
      要排除的字段列表。
      默认值
      {}

    • of

      String[] of
      如果存在，则显式列出要打印的字段。通常，会打印所有非静态字段。

      与 exclude() 互斥。

      即将被标记为 @Deprecated；请将 @ToString.Include 注解与 @ToString(onlyExplicitlyIncluded = true) 一起使用。

      返回值
      要使用的字段列表（默认值：全部）。
      默认值
      {}

    • callSuper

      boolean callSuper
      在输出中包含超类 toString 实现的结果。默认值：false
      返回值
      是否调用超类的 toString 实现作为生成的 toString 算法的一部分。
      默认值
      false

    • doNotUseGetters

      boolean doNotUseGetters
      通常，如果 getters 可用，则会调用它们。 要禁止这样做并让生成的代码直接使用字段，请将其设置为 true。 默认值：false
      返回值
      如果 true，则始终使用直接字段访问而不是调用 getter 方法。
      默认值
      false

    • onlyExplicitlyIncluded

      boolean onlyExplicitlyIncluded
      仅包含显式标记为 @ToString.Include 的字段和方法。 通常，默认情况下包含所有（非静态）字段。
      返回值
      如果 true，则不自动包含非静态字段（默认值：false）。
      默认值
      false