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

@ToString

任何类定义都可以用@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，更高等级的成员被首先打印，并且相同等级的成员以它们在源文件中出现的相同顺序被打印。

代码实例

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方法体内。

本章完！