Lombok快速入门
文章目录
- 一、Lombok介绍:
- 1.1 Lombok优点:
- 1.2 lombok 依赖引入
- 1.3 lombok 插件安装
- 二、常用注解
- 2.1 @Getter and @Setter
- 2.2 @ToString
- 2.3 @EqualsAndHashCode
- 2.4 @NoArgsConstructor
- 2.5 @AllArgsConstructor
- 2.6 @Slf4j
- 2.7 @Builder、
- 2.8 @Data
- 2.9
- 2.10
一、Lombok介绍:
通过简单的注解来精简代码达到消除冗长代码的目的。
1.1 Lombok优点:
- 提高编码效率
- 使代码更简洁
- 消除冗长代码
- 避免修改字段名字时忘记修改方法名
注:IDE上必须要支持Lombok,否则IDE会报错。
举个栗子:
public class User {private final String username;private String password;private Integer age;
}
要使用这个对象,必须还要写一些getter和setter方法,可能还要写一个构造器、equals方法、或者hash方法。这些方法很冗长而且没有技术含量,我们叫它样板式代码。
lombok的主要作用是通过一些注解,消除样板式代码,像这样:
@Data
public class User {private final String username;private String password;private Integer age;
}
@Data是一个组合注解源码:
* @see Getter* @see Setter* @see RequiredArgsConstructor* @see ToString* @see EqualsAndHashCode* @see lombok.Value
1.2 lombok 依赖引入
使用 meavn 的朋友在 pom.xml 文件中添加依赖即可
<dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>1.18.8</version><scope>provided</scope></dependency>
1.3 lombok 插件安装
二、常用注解
2.1 @Getter and @Setter
你可以用@Getter / @Setter注释任何字段(当然也可以注释到类上的),让lombok自动生成默认的getter / setter方法,生成的getter遵循布尔属性的约定。
默认生成的方法是public的,如果要修改方法修饰符可以设置AccessLevel的值,例如:@Getter(access = AccessLevel.PROTECTED)
- 字段上的注解示例:
- 类上注解栗子:
2.2 @ToString
2.3 @EqualsAndHashCode
2.4 @NoArgsConstructor
无参构造
2.5 @AllArgsConstructor
有参构造
2.6 @Slf4j
日志记录
2.7 @Builder、
对象构建
2.8 @Data
@RequiredArgsConstructor