Lombok技术常用注解总结

 用来简化pojo类的开发，包括getter/setter/toString/equal/构造方法 等等

Lombok可以通过注解，来帮助开发人员消除Java尤其是pojo类的冗余代码

插件安装

idea版本在2020.3以上，不需要安装了，在以下要安装，在File->Setting->plugins中安装

Lombok依赖

Spring Boot项目的依赖为：

        <!--引入lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

Lombok注解@Setter 和@Getter

作用：为类中的属性提供setter和getter方法

位置：类上方或者属性上方，在属性上方则为属性生成setter和getter方法，在类上方表示给该类下的所有属性生成setter和getter方法

/**
 * 注意：
 * 1.static 修饰的属性不生成get和set
 * 2.final 修饰的属性只生成get方法
 */
@Component
//为该类下所有的属性添加setter方法
@Setter
//为该类下所有的属性添加getter方法
@Getter
public class User {
    //在id上面加入这个注解以后，id就有了set方法
    @Setter
    private int id;
    //取消username 的set方法
    @Setter(AccessLevel.NONE)
    private String username;
    //设置password 的 setter的私有权限
    @Setter(AccessLevel.PRIVATE)
    private String password;    
    
}

Lombok注解@ToString

作用：生成toSting方法，默认情况会按照顺序打印类名称以及每个字段

位置：类上方

@Component
//为该类生成toString方法
//去除password和username，只打印id
@ToString(exclude = {"password","username"})
public class User {
    private int id;
    private String username;
    private String password;

}

Lombok注解@EqualsAndHashCode

作用：生成equal方法和hashCode、canEqual方法。用于比较两个类对象是否相同。

位置：类上方

属性：exclude  of

@Component
//这个直接帮我们重写equal方法 属性的比较默认都有
//exclude 是排除一些属性 ，of 是只包含一些属性
//@EqualsAndHashCode(exclude = {"password"})
@EqualsAndHashCode(of = {"id"})   //只比较一个id
public class User {
    private int id;
    private String username;
    private String password;

}

 注意：

        对比的时候，只使用非静态属性

        默认仅使用该类定义的属性，不比较父类定义的属性

Lombok注解@NonNull

作用：用于方法的参数的前，表示调用该方法的参数不能是null；用于属性上方，表示该属性赋值的时候不能为null。

位置：方法参数前或者属性上方

@Component
public class User {
    //给id赋值的时候，值不能为null
    @NonNull
    private Integer id;
    private String username;
    private String password;
    //调用该方法的时候，time的参数不能为null
    public void sleep(@NonNull Integer time){//调用方法的时候 time参数不能为null
        System.out.println("睡觉");
    }

}

Lombok构造方法注解

构造方法@NoArgsConstructor

作用：生成无参的构造方法

位置：类上方

构造方法@RequiredArgsConstructor

作用：生成包含final和 @NonNull修饰的属性的构造方法

位置：类上方

构造方法@AllArgsConstructor

作用：生成全参的构造方法

位置：类上方

@Component
//@NoArgsConstructor //添加无参数的构造方法
//@AllArgsConstructor //添加全参的构造方法
@RequiredArgsConstructor //生成包含final和 @NonNull修饰的属性的构造方法
public class User {
    private int id;
    private String username;
    private String password;
    private final String sex;

}

Lombok注解@Data

作用：相当于同时添加@Setter,@Getter,@ToString,@EqualsAndHashCode,@RequiredArgsConstructor五个注解

位置：类上方

Lombok注解@Builder

作用：提供链式风格创建对象

位置：类上方

@Component
@Data  //五合一 setter/getter/toString/EqualsAndHashCode/RequiredArgsConstructor
@Builder //提供 链式 风格创建对象
public class User {

    private int id;
    private String username;
    private String password;
    
    public static void main(String[] args) {
        UserBuilder builder = User.builder().id(1).username("hehe").password("1234");
        System.out.println(builder);
    }

}

Lombok注解@Log

作用：在类中生成日志对象，在方法中可以直接使用

位置：类上方

@Component
@Log//打印日志
//@Log4j2   //也可以使用这个
public class User {
    private int id;
    private String username;
    private String password;
    //不使用注解，就添加一个自带的logger对象
    //private Logger log=Logger.getLogger("user");
    public void sleep(){
        log.info("调用sleep method");
        System.out.println("睡觉");
    }

}

使用@Log表示使用Java自带的日志功能，还可以使用@Log4j，@Log4j2，@Slf4j等注解，来使用不同的日志产品

Lombok注解@Cleanup

作用：自动关闭资源，例如IO流对象

位置：代码前方

Lombok注解@SneakyThrows

作用：对方法中异常进行捕捉并抛出

位置：方法上方

@Component
public class User {
    private int id;
    private String username;
    private String password;
    @SneakyThrows
    //作用：对方法中的异常进行捕捉并抛出 位置：方法上方 . 使得方法定义更简单
    public void read()  {
        //这个注解放在代码前面，资源用完了，自动关闭资源
       @Cleanup FileInputStream fis =new FileInputStream("index.html");
       //fis.close();
    }
}

嘿嘿，总结了一个简单的技术。。。