Lombok：优雅地消除Java程序中的冗余代码

2023-11-20 10:00:31

Lombok是一款广受欢迎的Java库，它可以消除Java程序中的大量冗余代码，极大地提高开发效率。Lombok通过在编译时生成代码来实现这一目标，而无需开发者手动编写这些代码。

Lombok精选注解及其原理：

1. @Getter和@Setter

@Getter和@Setter注解可以自动生成getter和setter方法。这两个注解可以极大地简化JavaBean的编写，尤其是在JavaBean有很多属性的情况下。

public class Person {
    private String name;
    private int age;

    @Getter
    @Setter
    private String address;
}

编译后，Lombok会在Person类中自动生成name、age和address的getter和setter方法。

2. @ToString

@ToString注解可以自动生成toString方法。toString方法通常用于在控制台输出对象的字符串表示。

public class Person {
    private String name;
    private int age;

    @Getter
    @Setter
    private String address;

    @Override
    public String toString() {
        return "Person{" +
                "name='" + name + '\'' +
                ", age=" + age +
                ", address='" + address + '\'' +
                '}';
    }
}

编译后，Lombok会在Person类中自动生成toString方法，该方法会返回name、age和address的字符串表示。

3. @EqualsAndHashCode

@EqualsAndHashCode注解可以自动生成equals和hashCode方法。equals方法用于比较两个对象的相等性，hashCode方法用于计算对象的哈希值。

public class Person {
    private String name;
    private int age;

    @Getter
    @Setter
    private String address;

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;

        Person person = (Person) o;

        if (age != person.age) return false;
        if (name != null ? !name.equals(person.name) : person.name != null) return false;
        return address != null ? address.equals(person.address) : person.address == null;
    }

    @Override
    public int hashCode() {
        int result = name != null ? name.hashCode() : 0;
        result = 31 * result + age;
        result = 31 * result + (address != null ? address.hashCode() : 0);
        return result;
    }
}

编译后，Lombok会在Person类中自动生成equals和hashCode方法。这两个方法会根据name、age和address属性来判断两个Person对象的相等性。

4. @Data

@Data注解是一个组合注解，它相当于同时使用了@Getter、@Setter、@ToString、@EqualsAndHashCode这四个注解。

public class Person {
    private String name;
    private int age;

    @Getter
    @Setter
    private String address;

    @Data
    private String phone;
}

编译后，Lombok会在Person类中自动生成name、age、address和phone这四个属性的getter、setter、toString和equals/hashCode方法。

5. @Log

@Log注解可以自动生成一个日志对象。该日志对象可以通过LoggerFactory.getLogger()方法获得。

public class Person {
    private String name;
    private int age;

    @Getter
    @Setter
    private String address;

    @Data
    private String phone;

    @Log
    private Logger logger;

    public void printLog() {
        logger.info("Hello, world!");
    }
}