Lombok在idea中的使用教程

目录

• 一、什么是lombok
• 二、如何使用 
• 1.导入lombok的maven包
• 2.在idea中添加对lombok的支持
• 3.设置lombok在编译阶段生效
•  三、lombok中常用的注解
• 1.@ToString
•  2.@EqualsAndHashCode
• 3.@NonNull
•  4.@NoArgsConstructor、@RequiredArgsConstructor、@AllArgsConstructor
• 5.@Date
• 6. @Builder

一、什么是lombok

        Lombok是一个可以通过简单的注解形式，来帮助我们简化消除一些必须有但显得很臃肿（如果getter、setter方法）的Java代码的工具，通过使用对应的注解，可以在编译源码的时候生成对应的方法

二、如何使用 

1.导入lombok的maven包

    
 
          org.projectlombok
          lombok
          1.18.20
 
    

2.在idea中添加对lombok的支持

idea中File——Settings——Pulgins——上方选择Marketplace搜索Lombok点击Install安装

3.设置lombok在编译阶段生效

 三、lombok中常用的注解

1.@ToString

作用在类上，覆盖默认的的toString()方法。可以通过of属性设置显示什么字段，通过exclude属性排除某些字段

//toString方法显示username、age属性，排除password属性
@ToString(of={"username","age"},exclude={"password"})
public class User{
    private String username;
    private String password;
    private int age;   
}

 2.@EqualsAndHashCode

作用在类上，覆盖默认的equals、hashCode方法

3.@NonNull

作用在成员变量和参数中，标识不能为空，否则抛出空指针异常 

//属性password、参数username不能为空，否则抛出空指针异常
public class User{
    private String username;
@NonNull private String password;
    private int age;  
    public String sleep (@NonNull String username){
        System.out.println(username+"在睡觉")
    }
}

 4.@NoArgsConstructor、@RequiredArgsConstructor、@AllArgsConstructor

@NoArgsConstructor——作用在类上，生成一个无参构造方法

@RequiredArgsConstructor——作用在类上，这个注解可以生成带参或者不带参的构造方法。若带参数，只能是类中所有带有@NonNull注解的和以final修饰的未经初始化的字段

@AllArgsConstructor——作用在类上，生成一个包含变量的构造方法
   如果变量使用了@NotNull会校验是否为空

5.@Date

作用在类上自动生成所有字段的toString、EqualsAndHashCode、Getter方法，为非final字段生成Setter、RequiredArgsConstructor方法  

6. @Builder

作用在类上，为作用的类生成相对略微复杂的构建器API，可以通过下方形式调用代码实例化对象

Student.builder()
               .sno( "001" )
               .sname( "admin" )
               .sage( 18 )
               .sphone( "110" )
               .build();

@Builder内部帮我们做了什么？

创建一个名为ThisClassBuilder的内部静态类，并具有和实体类形同的属性（称为构建器）。在构建器中：对于目标类中的所有的属性和未初始化的final字段，都会在构建器中创建对应属性。在构建器中：创建一个无参的default构造函数。在构建器中：对于实体类中的每个参数，都会对应创建类似于setter的方法，只不过方法名与该参数名相同。 并且返回值是构建器本身（便于链式调用），如上例所示。在构建器中：一个build()方法，调用此方法，就会根据设置的值进行创建实体对象。在构建器中：同时也会生成一个toString()方法。在实体类中：会创建一个builder()方法，它的目的是用来创建构建器。

到此这篇关于Lombok在idea中的使用的文章就介绍到这了,更多相关Lombok在idea使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！