美文网首页
什么是 Java 编程中的 @Lombok 注解

什么是 Java 编程中的 @Lombok 注解

作者: _扫地僧_ | 来源:发表于2024-08-01 19:20 被阅读0次

    在 Java 编程中，@Lombok 注解是一种减少冗余代码的利器，深受开发者喜爱，不仅提升了代码的可读性，还提高了开发效率。"Project Lombok" 是一款用于 Java 的库，通过注解的方式帮助开发者自动生成 getter/setter、equals、hashCode、toString、构造方法等代码，从而避免样板代码的存在。

    @Lombok 注解概览

    在详细介绍具体注解前，先说一下 Lombok 的基本概念和作用。Lombok 是一个 Java 库，通过使用简单的注解就可以在编译时自动生成大量样板代码，例如 getter 和 setter 方法、构造函数、toString() 方法等。这不仅提高了开发效率，也让代码变得更加简洁和易于维护。

    主要的注解包括：@Getter、@Setter、@ToString、@EqualsAndHashCode、@NoArgsConstructor、@AllArgsConstructor、@Builder、@Data 等等。每个注解都有特定的用途，帮助开发者减少编写重复代码的负担。接下来，我们用真实的代码示例来详细介绍这些注解的使用场景及作用。

    @Getter 和 @Setter 注解

    @Getter 和 @Setter 注解分别用于自动生成 getter 和 setter 方法，几乎是 Lombok 中最常用的注解。这些方法在进行对象属性访问和修改时是必需的，但手工编写它们会显得冗长乏味。

    示例

    import lombok.Getter;
import lombok.Setter;

public class Person {
    @Getter @Setter
    private String name;
    
    @Getter @Setter
    private int age;
    
    public static void main(String[] args) {
        Person person = new Person();
        person.setName("John");
        person.setAge(25);
        
        System.out.println("Name: " + person.getName());
        System.out.println("Age: " + person.getAge());
    }
}

    通过 @Getter 和 @Setter 注解，Person 类不再需要手写 getName、setName、getAge 和 setAge 方法，编译器会自动生成这些方法，大大简化了代码。

    @ToString 注解

    每当需要打印对象信息时，toString() 方法会被调用。手工编写 toString() 方法不仅冗长，还容易出错。@ToString 注解解决了这个问题。

    示例

    import lombok.ToString;

@ToString
public class Person {
    private String name;
    private int age;
}

// 测试代码
public class Main {
    public static void main(String[] args) {
        Person person = new Person();
        person.setName("John");
        person.setAge(25);
        
        System.out.println(person);
    }
}

    上述代码中，@ToString 注解自动生成了 toString() 方法，使得 Person 对象在被打印时展示其属性信息。

    @EqualsAndHashCode 注解

    在使用集合（如 HashSet、HashMap 等）时，equals 和 hashCode 方法非常重要。手工编写这些方法容易出错且繁琐，@EqualsAndHashCode 注解则能自动生成这些方法。

    示例

    import lombok.EqualsAndHashCode;

@EqualsAndHashCode
public class Person {
    private String name;
    private int age;
}

// 测试代码
public class Main {
    public static void main(String[] args) {
        Person person1 = new Person();
        person1.setName("John");
        person1.setAge(25);
        
        Person person2 = new Person();
        person2.setName("John");
        person2.setAge(25);
        
        System.out.println(person1.equals(person2)); // 输出：true
    }
}

    通过 @EqualsAndHashCode 注解，Person 类自动生成了 equals 和 hashCode 方法，使得两个具有相同属性值的 Person 对象在逻辑上相等。

    @NoArgsConstructor 和 @AllArgsConstructor 注解

    @NoArgsConstructor 和 @AllArgsConstructor 注解用于生成无参构造函数和全参构造函数，方便对象的实例化。

    示例

    import lombok.NoArgsConstructor;
import lombok.AllArgsConstructor;

@NoArgsConstructor
@AllArgsConstructor
public class Person {
    private String name;
    private int age;
}

// 测试代码
public class Main {
    public static void main(String[] args) {
        Person person1 = new Person(); // 无参构造函数
        Person person2 = new Person("John", 25); // 全参构造函数
    }
}

    使用 @NoArgsConstructor 和 @AllArgsConstructor 注解，开发者无需亲自编写构造函数，大大简化了代码。

    @Builder 注解

    @Builder 注解用于生成建造者模式，适用于具有多个可选参数的对象的实例化，避免构造函数参数列表过长导致的可读性降低问题。

    示例

    import lombok.Builder;

@Builder
public class Person {
    private String name;
    private int age;
}

// 测试代码
public class Main {
    public static void main(String[] args) {
        Person person = Person.builder()
                              .name("John")
                              .age(25)
                              .build();
    }
}

    通过 @Builder 注解，Person 类提供了链式调用的方式进行属性设置，使用起来更加直观和便捷。

    @Data 注解

    @Data 注解是一个综合性注解，包含了 @ToString、@EqualsAndHashCode、@Getter/@Setter 以及 @RequiredArgsConstructor 注解的功能，非常适合简化数据传输对象（DTO）和实体类。

    示例

    import lombok.Data;

@Data
public class Person {
    private String name;
    private int age;
}

// 测试代码
public class Main {
    public static void main(String[] args) {
        Person person = new Person();
        person.setName("John");
        person.setAge(25);
        
        System.out.println(person);
        System.out.println(person.equals(new Person()));
    }
}

    通过 @Data 注解，Person 类迅速变得简单且功能全面，适用于大多数常见场景。

    Lombok 应用中的实际案例

    考虑一个实际的企业级应用场景，我们需要实现一个 Order 类，包含订单号、订单日期、商品列表和金额等属性。传统方式下，这些属性需要大量的样板代码来进行声明和访问。

    传统方式

    import java.util.List;
import java.util.Date;
import java.util.Objects;

public class Order {
    private String orderNumber;
    private Date orderDate;
    private List<String> itemList;
    private double totalAmount;
    
    public Order() {}
    
    public Order(String orderNumber, Date orderDate, List<String> itemList, double totalAmount) {
        this.orderNumber = orderNumber;
        this.orderDate = orderDate;
        this.itemList = itemList;
        this.totalAmount = totalAmount;
    }
    
    public String getOrderNumber() {
        return orderNumber;
    }
    
    public void setOrderNumber(String orderNumber) {
        this.orderNumber = orderNumber;
    }
    
    public Date getOrderDate() {
        return orderDate;
    }
    
    public void setOrderDate(Date orderDate) {
        this.orderDate = orderDate;
    }
    
    public List<String> getItemList() {
        return itemList;
    }
    
    public void setItemList(List<String> itemList) {
        this.itemList = itemList;
    }
    
    public double getTotalAmount() {
        return totalAmount;
    }
    
    public void setTotalAmount(double totalAmount) {
        this.totalAmount = totalAmount;
    }
    
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        Order order = (Order) o;
        return Double.compare(order.totalAmount, totalAmount) == 0 &&
               Objects.equals(orderNumber, order.orderNumber) &&
               Objects.equals(orderDate, order.orderDate) &&
               Objects.equals(itemList, order.itemList);
    }
    
    @Override
    public int hashCode() {
        return Objects.hash(orderNumber, orderDate, itemList, totalAmount);
    }
    
    @Override
    public String toString() {
        return "Order{" +
                "orderNumber='" + orderNumber + '\'' +
                ", orderDate=" + orderDate +
                ", itemList=" + itemList +
                ", totalAmount=" + totalAmount +
                '}';
    }
}

    上述 Order 类代码展示了传统方式的种种冗长和重复，不仅增加了工作量，也容易出错。

    使用 Lombok 的方式

    import lombok.Data;
import java.util.List;
import java.util.Date;

@Data
public class Order {
    private String orderNumber;
    private Date orderDate;
    private List<String> itemList;
    private double totalAmount;
}

// 测试代码
public class Main {
    public static void main(String[] args) {
        Order order = new Order();
        order.setOrderNumber("123456");
        order.setOrderDate(new Date());
        order.setItemList(List.of("Item1", "Item2"));
        order.setTotalAmount(100.0);
        
        System.out.println(order);
    }
}

    通过引入 @Data 注解，代码变得简洁，但功能依然完整，不仅包含 getter、setter 方法，还实现了 equals、hashCode 和 toString 方法。

    在每个编程项目中，减少冗长而重复的代码对于提升代码质量和开发效率至关重要。Lombok 凭借其强大的注解支持和简洁的使用方式，成为 Java 开发者不可或缺的工具。它在实际项目中的应用，不但优化了开发体验，也让项目维护变得更加轻松。

    因此，在下一个项目中尝试引入 Lombok，不仅能在编写代码时减少压力，还能大幅提升开发速度与代码的整洁度，真正实现“少写代码，多做事”的目标。

    相关文章

      网友评论

          本文标题：什么是 Java 编程中的 @Lombok 注解

          本文链接：https://www.haomeiwen.com/subject/qcnohjtx.html

          延伸阅读

          深度阅读

          • 您也可以注册成为美文阅读网的作者，发表您的原创作品、分享您的心情！

          栏目导航

          热点阅读

          关于我们|服务条款|联系我们|什么是 Java 编程中的 @Lombok 注解|投稿指南|网站地图|RSS订阅|排版工具|手机版

          提供经典美文摘抄,优美散文欣赏,现代诗歌精选,短篇小说,心情随笔,表白情书范文,故事会在线阅读欣赏

          Copyright © 2014-2023 Haomeiwen.com All Rights Reserved. 好美文阅读网 版权所有

          备案信息：桂公网安备 45052102000051号 · 桂ICP备13007215号-3

          本站所收录作品、热点评论等信息部分来源互联网，目的只是为了系统归纳学习和传递资讯

          所有作品版权归原创作者所有，与本站立场无关，如不慎侵犯了你的权益，请联系我们告知，我们将做删除处理！