Lombok使用

绝地灬酷狼 2022-03-18 02:07 257阅读 0赞

### 前言 ###

`Lombok` 是一种 `Java™` 实用工具，可用来帮助开发人员消除 Java 的冗长，尤其是对于简单的 Java 对象（POJO）。它通过注解实现这一目的。

在 pom.xml 文件中添加相关依赖：

<lombok.version>1.16.20</lombok.version>
    
    
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>${lombok.version}</version>
                <scope>provided</scope>
            </dependency>

### 安装插件 ###

由于 `Lombok` 采取的注解形式的，在编译后，自动生成相应的方法，为了不让 ide 疯了，需要下载插件了支持它。   
以 idea 为例：查找插件 `lombok plugin` 安装即可。

简单实例

@Getter
    @Setter
    @ToString
    public class SysUserEntity implements Serializable

### 注解 ###

@Getter

@Setter

@ToString

*@EqualsAndHashCode*

构造函数

@AllArgsConstructor

会生成一个包含所有变量，同时如果变量使用了NotNull annotation ， 会进行是否为空的校验，   
全部参数的构造函数的自动生成，该注解的作用域也是只有在实体类上，参数的顺序与属性定义的顺序一致。

@NoArgsConstructor

无参构造函数

@RequiredArgsConstructor

会生成一个包含常量（final），和标识了@NotNull的变量 的构造方法。

怎么使用

它们都有三个参数可以设置   
1. `String staticName() default "";`

如果设置了它，将原来的构造方法的访问修饰符将会变成 **私有**的，而外添加一个**静态构造方法**，参数相同，名字是**设置的字符串的名字**，访问修饰符为**公有**的。

`1.AnyAnnotation[] onConstructor() default {};`   
在构造方法上添加**注解**。使用方法`@RequiredArgsConstructor(onConstructor=@__({@AnnotationsGoHere}))}`

例如我们在 Spring 项目中需要注入多个值，写很多个 `@Autowired` 很麻烦，就可以使用这种方式：

@Service
    @RequiredArgsConstructor(onConstructor = @__(@Autowired))
    public class UserServiceImpl implements IUserService {
       private final IUserRepository userRepository;
       private final IOrderRepository orderRepository;

2. `AccessLevel access() default lombok.AccessLevel.PUBLIC;`

构造函数访问修饰符；

`3.@NoArgsConstructor`无参构造函数中还有个注解 `boolean force() default false;`

作者的注释是 *If \{@code true\}, initializes all final fields to 0 / null / false. Otherwise, a compile time error occurs.*

设置为 `true` 的时候，初始化所有的参数为默认值，否则编译错误。

@Data

我自己尝试了下，我们使用 `@Data` 注解就可以有下面几个注解的功能： `@ToString`、`@Getter`、`@Setter`、`@EqualsAndHashCode`、`@NoArgsConstructor` 。

@Builder

bulder 模式构建对象。

@NonNull

public NonNullExample(@NonNull Person person) {
        this.name = person.getName();
     }
    转换后就是：
    public NonNullExample(@NonNull Person person) {
        if (person == null) {
          throw new NullPointerException("person");
        }
        this.name = person.getName();
     }

### 默认值问题 ###

@Data
    @Builder
    public class Demo {
    
        @Tolerate
        public Demo(){
    
        }
    
        private int type = 2;
    
        private String url;
    }

通过builder模式，如果不设置type，还指望它能够设置2，恐怕要令你失望了。

解决办法

@Builder.Default
    private int type = 2;

[原文地址][Link 1]

[Link 1]: https://www.cnblogs.com/qnight/p/8997493.html