03. 《Lombok 实战 —— @toString & @EqualsAndHashCode》

最新推荐文章于 2025-04-28 11:57:46 发布

「已注销」

最新推荐文章于 2025-04-28 11:57:46 发布

阅读量1.7k

点赞数 2

分类专栏： Lombok 文章标签： java lombok @toString @EqualsAndHashCode

本文链接：https://blog.youkuaiyun.com/weixin_41540822/article/details/86606467

版权

本文详细介绍了Lombok库中的@toString和@EqualsAndHashCode两个注解的使用，从入门到深度研究，包括全局配置。@toString用于自动生成toString方法，@EqualsAndHashCode则用于简化equals和hashCode方法的实现。文章通过源码分析和示例代码展示了如何进行个性化配置，如排除字段、显示字段名、排序等。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

文章目录

- 《Lombok 实战 —— @toString & @EqualsAndHashCode》

《Lombok 实战 —— @toString & @EqualsAndHashCode》

1. @toString

No need to start a debugger to see your fields: Just let lombok generate a toString for you!

1.1 入门使用`@toString`

任何类定义都可以用@ToString注释，让lombok生成toString()方法的实现。默认情况下，它会按顺序打印类名和每个字段，并以逗号分隔，如下所示：

@Getter
@Setter
@ToString
public class User {
   
    private String username;
    private String password;
    private boolean isAdult;
}

// 编译后：
public class User {
   
    private String username;
    private String password;
    private boolean isAdult;
	// 其他省略
    public String toString() {
   
        return "User(username=" + this.getUsername() + 
        ", password=" + this.getPassword() + 
        ", isAdult=" + this.isAdult() + ")";
    }
}

在编译后地结果中可以看到，lombok默认使用的是getter方法进行设值，如this.getUsername()，但是我们实际并不需要通过getter的方式进行设置，lombok也知道我们有这样的需求，为我们提供了注解配置项，下面我们就来继续看看如何进行更个性化的配置@toString。

1.2 深度研究`@toString`

深度研究一个东西，肯定少不了源码的分析，当然@toString的代码并不难，放一百个心，如下所示：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.SOURCE)
public @interface ToString {
   
	// 输出是否带字段名称
	boolean includeFieldNames() default true;
	// 排除字段，以 String[] 格式设置
	String[] exclude() default {
   };
	// 指定输出哪些字段，不过将来会被标注@deprecated，使用 @ToString.Include 替代
	String[] of() default {
   };
	// 是否调用父类的 toString() 方法
	boolean callSuper() default false;
	// 不使用 getter 方法获取字段值
	boolean doNotUseGetters() default false;
	// 是否只输出被 @ToString.Include 备注的属性，默认情况输出所有非静态字段
	boolean onlyExplicitlyIncluded() default false;
	
	// 标注不被输出的字段
	@Target(ElementType.FIELD)
	@Retention(RetentionPolicy.SOURCE)
	public @interface Exclude {
   }
	
	// 标注被输出的字段 @ToString.Include
	@Target({
   ElementType.FIELD, ElementType.METHOD})
	@Retention(RetentionPolicy.SOURCE)