Lombok的安装和使用

Lombok使用

介绍

在项目中使用Lombok可以减少很多重复代码的书写。比如说getter/setter/toString等方法的编写。

主要是他可以动态的生成get，set等等方法，在企业中是非常实用的，修改属性时，不用在去修改get，set方法，tostring方法等

IDEA中的安装

打开IDEA的Setting –> 选择Plugins选项 –> 选择Browse repositories –> 搜索lombok –> 点击安装 –> 安装完成重启IDEA –> 安装成功

 

引入依赖

在项目中添加Lombok依赖jar，在pom文件中添加如下部分。(不清楚版本可以在Maven仓库中搜索)

<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.16.18</version>
    <scope>provided</scope>
</dependency>

案例

@NoArgsConstructor
@Data    //包含了get，set，toString 等等方法
@AllArgsConstructor
@Accessors()
public class Student {
    private  @Getter  int id;  //只生成get方法
    private  @Getter @Setter String name;
    
    //也可以覆盖Data已经写了的方法
    @Override
    public String toString() {
        return "Student{" +
                "id=" + id +
                ", name='" + name + '\'' +
                '}';
    }
}

Lombok的注解

• @Setter
• @Getter
• @Data
• @Log(这是一个泛型注解，具体有很多种形式)
• @AllArgsConstructor
• @NoArgsConstructor
• @EqualsAndHashCode
• @NonNull
• @Cleanup
• @ToString
• @RequiredArgsConstructor
• @Value
• @SneakyThrows
• @Synchronized

注解详情

@Getter和@Setter

该注解使用在类或者属性上，该注解可以使用在类上也可以使用在属性上。生成的getter遵循布尔属性的约定。例如：boolean类型的sex,getter方法为isSex而不是getSex

在使用该注解时，会默认生成一个无参构造。和对应的getterhe setter方法 

该注解也可以使用在单个属性上，会默认生成一个无参构造： 

@EqualsAndHashCode

该注解使用在类上，该注解在类级别注释会同时生成equals和hashCode。 
注意继承关系的时候该注解的使用。详细介绍参照官方介绍 

存在继承关系需要设置callSuper参数为true。

@Data

该注解使用在类上，该注解是最常用的注解，它结合了@ToString，@EqualsAndHashCode， @Getter和@Setter。本质上使用@Data注解，类默认@ToString和@EqualsAndHashCode以及每个字段都有@Setter和@getter。该注解也会生成一个公共构造函数，可以将任何@NonNull和final字段作为参数。

虽然@Data注解非常有用，但是它没有与其他注解相同的控制粒度。@Data提供了一个可以生成静态工厂的单一参数，将staticConstructor参数设置为所需要的名称，Lombok自动生成的构造函数设置为私有，并提供公开的给定名称的静态工厂方法。 

@AllArgsConstructor

该注解使用在类上，该注解提供一个全参数的构造方法，默认不提供无参构造。 

@NoArgsConstructor

该注解使用在类上，该注解提供一个无参构造 

@RequiredArgsConstructor

该注解使用在类上，使用类中所有带有 @NonNull 注解的或者带有 final 修饰的成员变量生成对应的构造方法。