【IDEA】lombok注解形式简化代码

lombok简介

Project Lombok是一个java库，可以自动插入编辑器并构建工具，节省了时间不用去编写getter/setter或equals方法，使用注解一步到位，让代码整体更简洁。

lombok的优点

1. 提高编码效率；
2. 使代码更简洁；
3. 消除冗长代码；
4. 避免修改字段名字时忘记修改方法名；

对比

普遍的实体类方法【实例：用户类】

import com.fasterxml.jackson.annotation.JsonFormat;

import java.util.Date;
public class CdUser {

  private Integer userid;
  private String usercode;
  private String userpassword;
  private String username;
  private String email;
  private String phone;
  @JsonFormat(pattern = "yyyy-MM-dd", timezone="GMT+8")
  private Date registertime;

  public Integer getUserid() {
    return userid;
  }

  public void setUserid(Integer userid) {
    this.userid = userid;
  }

  public String getUsercode() {
    return usercode;
  }

  public void setUsercode(String usercode) {
    this.usercode = usercode;
  }

  public String getUserpassword() {
    return userpassword;
  }

  public void setUserpassword(String userpassword) {
    this.userpassword = userpassword;
  }

  public String getUsername() {
    return username;
  }

  public void setUsername(String username) {
    this.username = username;
  }

  public String getEmail() {
    return email;
  }

  public void setEmail(String email) {
    this.email = email;
  }

  public String getPhone() {
    return phone;
  }

  public void setPhone(String phone) {
    this.phone = phone;
  }
  
  public Date getRegistertime() {
    return registertime;
  }

  public void setRegistertime(Date registertime) {
    this.registertime = registertime;
  }

lombok方法【实例：用户类】

import com.fasterxml.jackson.annotation.JsonFormat;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.util.Date;

@Data               //整合@ToString、@EqualsAndHashCode、@Getter、@Setter、@RequiredArgsConstrutor
@NoArgsConstructor  //无参函数
@AllArgsConstructor //有参函数
public class CdUser {

  private Integer userid;
  private String usercode;
  private String userpassword;
  private String username;
  private String email;
  private String phone;
  @JsonFormat(pattern = "yyyy-MM-dd", timezone="GMT+8")
  private Date registertime;

lombok配置

1.安装lombok

点击右上角的File–>点击Setting –> 选择Plugins选项 –> 选择Browse repositories –> 搜索lombok –> 点击安装 –> 安装完成重启IDEA

2.添加maven依赖【version版本关注中央仓库更新】

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.4</version>
    <scope>provided</scope>
</dependency>

Lombok常用注解和功能

@Setter		//set封装
@Getter		//get封装
@Data		//整合多种封装，注解在类上，相当于同时使用了@ToString、@EqualsAndHashCode、@Getter、@Setter和@RequiredArgsConstrutor
@Log		//根据不同的注解生成不同类型的log对象，有六种可选实现类
				1.@CommonsLog Creates log = org.apache.commons.logging.LogFactory.getLog(LogExample.class);
				2.@Log Creates log = java.util.logging.Logger.getLogger(LogExample.class.getName());
				3.@Log4j Creates log = org.apache.log4j.Logger.getLogger(LogExample.class);
				4.@Log4j2 Creates log = org.apache.logging.log4j.LogManager.getLogger(LogExample.class);
				5.@Slf4j Creates log = org.slf4j.LoggerFactory.getLogger(LogExample.class);
				6.@XSlf4j Creates log = org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class);
@AllArgsConstructor		//有参函数
@NoArgsConstructor		//无参函数
@EqualsAndHashCode		//自动生成equals方法和hashCode方法
@NonNull	//是否为空的校验，如果为空，则抛出NPE（NullPointerException）
@Cleanup	//自动管理资源，用在局部变量之前，在当前变量范围内即将执行完毕退出之前会自动清理资源，自动生成try-finally这样的代码来关闭流。
			//在本地变量上使用该注解，任何后续代码都将封装在try/finally中，确保当前作用于中的资源被释放。默认@Cleanup清理的方法为close，可以使用value指定不同的方法名称。 
@ToString	//用在类上，可以自动覆写toString方法，当然还可以加其他参数
@Value			//相当于为属性添加final声明，只提供getter方法，而不提供setter方法
@SneakyThrows	//自动抛受检异常，而无需显式在方法上使用throws语句
@Synchronized	//使用在类或者实例方法上,将方法声明为同步的，并自动加锁。

官网：https://www.projectlombok.org/