在简单的 Java 对象(POJO)中定义很多私有属性变量,通过开放的get/set方法来访问和修改这个类的成员属性。虽然可以使用IDE自带的快捷键来生成get/set方法,但是一个类中80%都是这些get/set方法,会显得类的臃肿和不利于代码的阅读。
提供一种使用注解的方式来规避生成get/set的方法,但同时又可以使用get/set方法的一种注解
1:Lombok的注解
Lombok主要常用的注解有:@Data,@getter,@setter,@NoArgsConstructor,@AllArgsConstructor,@ToString,@EqualsAndHashCode,@Slf4j,@Log4j。我们一个一个来看:
@Data注解:在JavaBean或类JavaBean中使用,这个注解包含范围最广,它包含getter、setter、NoArgsConstructor注解,即当使用当前注解时,会自动生成包含的所有方法;
@getter注解:在JavaBean或类JavaBean中使用,使用此注解会生成对应的getter方法;
@setter注解:在JavaBean或类JavaBean中使用,使用此注解会生成对应的setter方法;
@NoArgsConstructor注解:在JavaBean或类JavaBean中使用,使用此注解会生成对应的无参构造方法;
@AllArgsConstructor注解:在JavaBean或类JavaBean中使用,使用此注解会生成对应的有参构造方法;
@ToString注解:在JavaBean或类JavaBean中使用,使用此注解会自动重写对应的toStirng方法;
@EqualsAndHashCode注解:在JavaBean或类JavaBean中使用,使用此注解会自动重写对应的equals方法和hashCode方法;
@Slf4j:在需要打印日志的类中使用,当项目中使用了slf4j打印日志框架时使用该注解,会简化日志的打印流程,只需调用info方法即可;
@Log4j:在需要打印日志的类中使用,当项目中使用了log4j打印日志框架时使用该注解,会简化日志的打印流程,只需调用info方法即可;
在使用以上注解需要处理参数时,处理方法如下(以@ToString注解为例,其他注解同@ToString注解):
@ToString(exclude="column")
意义:排除column列所对应的元素,即在生成toString方法时不包含column参数;
@ToString(exclude={"column1","column2"})
意义:排除多个column列所对应的元素,其中间用英文状态下的逗号进行分割,即在生成toString方法时不包含多个column参数;
@ToString(of="column")
意义:只生成包含column列所对应的元素的参数的toString方法,即在生成toString方法时只包含column参数;;
@ToString(of={"column1","column2"})
意义:只生成包含多个column列所对应的元素的参数的toString方法,其中间用英文状态下的逗号进行分割,即在生成toString方法时只包含多个column参数;
2:Lombok插件安装
以eclipse安装lombok为例
首先下载lombokj架包 地址:https://projectlombok.org/download
然后将lombok架包放在eclipse安装的根目录中和eclipse.ini文件在同一个文件夹
运行cmd进入dos界面,跳转到lombok的目录下,运行 java -jar lombok.jar 选择 install
打开eclipse.ini文件查看最后
新建一个maven项目 建立lombok依赖
public class MyLombok {
@Getter
@Setter
private String name;
public static void main(String[] args) {
MyLombok lombok = new MyLombok();
lombok.setName("lisi");
System.out.println(lombok.getName());
}
}
输出 lisi