【lombok】@ToString - 不再需要自己覆写toString，让lombok帮你生成

ゝ一纸荒年。 2022-03-24 20:38 293阅读 0赞

<table> 
 <tbody> 
  <tr> 
   <td><font>@ToString</font></td> 
  </tr> 
 </tbody> 
</table>

任何类定义都可以用`@ToString`注释，让lombok生成toString（）方法的实现。默认情况下，它会按顺序打印您的类名称以及每个字段，并以逗号分隔。通过将includeFieldNames参数设置为true，您可以为toString（）方法的输出添加一些清晰度（但也有一些长度闲置）。

默认情况下，将打印所有非静态字段。如果要跳过某些字段，可以使用`@ ToString.Exclude`注释这些字段。或者，您可以使用`@ToString（onlyExplicitlyIncluded = true）`准确指定要使用的字段，然后使用`@ ToString.Include`标记要包含的每个字段。

通过将`callSuper`设置为true，可以将toString的父类实现的输出包含到输出中。请注意，java.lang.Object中toString（）的默认实现几乎没有意义，因此除非您扩展另一个类，否则您可能不会这样做。

可以在toString中包含方法调用的输出。只能包含不带参数的实例（非静态）方法。为此，请使用@ ToString.Include标记该方法。

可以使用`@ ToString.Include（name =“some other name”）`更改用于标识成员的名称，并且可以通过`@ ToString.Include（rank = -1）`更改成员的打印顺序。未被标记添加rank标记的成员的rank默认= 0，更高等级的成员被首先打印，并且相同等级的成员以它们在源文件中出现的相同顺序被打印。

<table> 
 <tbody> 
  <tr> 
   <td><font>代码实例</font></td> 
  </tr> 
 </tbody> 
</table>

package com.amos;
    
    import lombok.ToString;
    
    
    /** * @author amos */
    @ToString
    public class ToStringExample { 
    
        /** * 静态field不会被生成到toString方法内 */
        private static final int STATIC_VAR = 10;
        private String name;
        private Shape shape = new Square(5, 10);
        private String[] tags = new String[]{ "1", "2", "3"};
        /** * 标记 @ToString.Exclude * toString方法不包含此字段 */
        @ToString.Exclude
        private int id;
    
    
        /** * callSuper -> toString方法体内会带上超类的toString方法 * includeFieldNames -> 是否包含字段名，false不包含 true包含 默认是true */
        @ToString(callSuper = true, includeFieldNames = false)
        public static class Square extends Shape { 
    
            private final int width, height;
    
            public Square(int width, int height) { 
                this.width = width;
                this.height = height;
            }
        }
    
        public static class Shape { 
    
            @Override
            public String toString() { 
                return "Shape[" + this.hashCode() + "]";
            }
    
        }
    
        public static void main(String[] args) { 
    
            System.out.println(new Shape());
            System.out.println(new Square(1,2));
            System.out.println(new ToStringExample());
    
        }
    }

执行main方法后，打印内容如下:

> Shape\[1929600551\]  
> ToStringExample.Square(super=Shape\[1053782781\], 1, 2)  
> ToStringExample(name=null, shape=ToStringExample.Square(super=Shape\[1211888640\], 5, 10), tags=\[1, 2, 3\])

先想明白为何会如此打印，再看下边编译后生成的class文件，加深印象。

编译后的class文件如下所示:

package com.amos;
    
    import java.util.Arrays;
    
    public class ToStringExample { 
        private static final int STATIC_VAR = 10;
        private String name;
        private ToStringExample.Shape shape = new ToStringExample.Square(5, 10);
        private String[] tags = new String[]{ "1", "2", "3"};
        private int id;
    
        public ToStringExample() { 
        }
    
        public static void main(String[] args) { 
            System.out.println(new ToStringExample.Shape());
            System.out.println(new ToStringExample.Square(1, 2));
            System.out.println(new ToStringExample());
        }
    
        public String toString() { 
            return "ToStringExample(name=" + this.name + ", shape=" + this.shape + ", tags=" + Arrays.deepToString(this.tags) + ")";
        }
    
        public static class Shape { 
            public Shape() { 
            }
    
            public String toString() { 
                return "Shape[" + this.hashCode() + "]";
            }
        }
    
        public static class Square extends ToStringExample.Shape { 
            private final int width;
            private final int height;
    
            public Square(int width, int height) { 
                this.width = width;
                this.height = height;
            }
    
            public String toString() { 
                return "ToStringExample.Square(super=" + super.toString() + ", " + this.width + ", " + this.height + ")";
            }
        }
    }

先看Shape类，调用System.out.printXX方法时，默认会调用该对象的toString方法，所以Shape的toString打印结果比较好理解。

再看Square的toString方法，因为Square类是ToStringExample类的静态内部类，所以再该类名前会有ToStringExample类名标识。因为添加了`callSuper = true`，所以再toString方法内，会加上超类的toString方法（查看class文件）。再看`includeFieldNames = false`，toString默认会带上字段名的，标识会false后，不会带字段名`width`和`height`.

最后看ToStringExample的toString方法，因为STATIC\_VAR是静态字段，所以不会置于toString方法体内，又因为id被添加上 @ToString.Exclude注解，所以该字段也不会置于toString方法体内。

本章完！

发表评论取消回复

表情：

评论列表（有 0 条评论，293人围观）

还没有评论，来说两句吧...

相关阅读

相关 Java基础——Object类中equals()与toString()的覆写

Java基础——Object类中equals()与toString()的覆写本篇文章只介绍equals()与toString()的覆写，其他方法(例如hashCo

我不是女神ヾ/ 2023年10月11日 10:21/ 0 赞/ 99 阅读

相关如何让Java编译器帮你写代码

导读本文结合京东监控埋点场景，对解决样板代码的技术选型方案进行分析，给出最终解决方案后，结合理论和实践进一步展开。通过关注文中的技术分析过程和技术场景，读者可收获一种样板代

落日映苍穹つ/ 2023年10月03日 23:55/ 0 赞/ 131 阅读

相关如何让Java编译器帮你写代码

导读本文结合京东监控埋点场景，对解决样板代码的技术选型方案进行分析，给出最终解决方案后，结合理论和实践进一步展开。通过关注文中的技术分析过程和技术场景，读者可收获一种样板代

亦凉/ 2023年09月23日 23:24/ 0 赞/ 155 阅读

相关如何让Java编译器帮你写代码

导读本文结合京东监控埋点场景，对解决样板代码的技术选型方案进行分析，给出最终解决方案后，结合理论和实践进一步展开。通过关注文中的技术分析过程和技术场景，读者可收获一种样板代

系统管理员/ 2023年09月23日 23:13/ 0 赞/ 234 阅读

相关 Java 对象多态equals toString 方法覆写

package com.msc.example; class TestA{ private String name; priv

Myth丶恋晨/ 2023年01月06日 14:55/ 0 赞/ 249 阅读

相关 Lombok的@Data重写的toString特性慎重

@Data注解中有默认toString方法的重写。并且Lombok的toString方法在展示数据时默认调用的是Getr方法，如果有逻辑需要在Get取值时进行计算，并且此值

﹏ヽ暗。殇╰゛Y/ 2022年10月15日 08:57/ 0 赞/ 420 阅读

相关 eclipse 配置lombok，注解生成getter，setter，equals，hashCode，toString

lombok 可以再编译过程中生成getter，setter，equals，hashCode，toString，构造函数等方法简称 lombok简介 [https

矫情吗；*/ 2022年04月06日 12:24/ 0 赞/ 309 阅读

相关【lombok】@NonNull - 不再忧虑NullPointerException

> @NonNull 说到NullPointerException，可能会是所有java搬砖工的噩梦吧？现在有了@NonNull , 让我们不在忧虑NPE!!! 您

红太狼/ 2022年03月25日 05:13/ 0 赞/ 246 阅读

相关【lombok】@ToString - 不再需要自己覆写toString，让lombok帮你生成

<table> <tbody> <tr> <td><font>@ToString</font></td> </tr> </tbody> </tab

ゝ一纸荒年。/ 2022年03月24日 20:38/ 0 赞/ 294 阅读

相关使用Lombok自动生成set get toString方法超省事！！！

我们在写自己的javabean的时候写多少的属性就要有多少个get set 方法，即便有快捷方式我们在页面上也是显示的很乱。此时我们可以引入 Lombok

墨蓝/ 2022年01月11日 03:17/ 0 赞/ 542 阅读