Lombok注解详解-优快云博客

本文链接：https://blog.youkuaiyun.com/luyafeng121/article/details/84853085

介绍

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

安装方法

在官网下载https://projectlombok.org/会下载一个lombok.jar的jar包，双击jar包会出现如下图：

此时环境中就已经集成了该插件。

如果是maven还可以使用下面的方式来进行

<dependencies>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>0.9.2</version>
    </dependency>
</dependencies>
<repositories>
    <repository>
        <id>projectlombok.org</id>
        <url>http://projectlombok.org/mavenrepo</url>
    </repository>
</repositories>

Lombok注解

log：

注解在类上。

@CommonsLog
Creates
private static final org.apache.commons.logging.Log log=org.commons.logging.LogFactory.getLog(LogExample.class);

@Flogger
Creates
private static final com.google.common.flogger.FluentLogger log=com.google.common.flogger.FluentLogger.forEnclosingClass();

@JBossLog
Creates
private static final org.jboss.logging.Logger log=org.jboss.logging.Logger.getLogger(LogExample.class);

@Log
Creates
private static final java.util.logging.Logger log=java.util.logging.Logger.getLogger(LogExample.class.getName);

@Log4j
Creates
private static final org.apache.log4j.Logger log=org.apache.log4j.Logger.getLogger(LogExample.class);

@Log4j2
Creates
private static final org.apache.logging.log4j.Logger log=org.apache.logging.log4j.LogManager.getLogger(LogExample.class);

@Slf4j
Creates
private static final org.slf4j.Logger log=org.slf4j.LoggerFactory.getLogger(LogExample.class);

@XSlf4j
Creates
private static final org.slf4j.ext.XLogger log=org.slf4j.ext.XLoggerFactory.getXlogger(LogExample.class);

举例子

With Lombok:

import lombok.extern.java.log;
import lombok.extern.slf4j.Slf4j;

@Log
public class LogExample{
    public static void main(String... args){
        log.severs("Something's wrong here");
    }
}
@Slf4j
public class LogExampleOther{
    public static void main(String... args){
        log.error("Something else is wrong here")
    }
}

@CommonsLog(topic="CounterLog")
public class LogExampleCategory{
    public static void main(String ... args){
        log.error("Calling the 'CounterLog' with a message");
    }
}

Vanilla Java

public class LogExample{
    private static final java.util.logging.Logger log=java.util.logging.Logger.getLogger(LogExample.class.getName());
    public static void main(String...args){
        log.severe("Something's wrong here")
    }
}

public class LogExampleOther{
    private static final org.slf4j.Logger log=org.slf4j.LoggerFactory.getLogger(logExampleOther.class);
    public static void main(String...args){
        log.error("Something else is wrong here")
    }
}

public class LogExampleCategory{
    private static final org.apache.commons.logging.Log log=apache.commons.logging.LogFactory.getLog("counterLog");
    public static void main(String...args){
    log.error("Calling the 'CounterLog' with a message")
    }
}

@Getter和@Setter

改注解使用在类或者属性上。生成的getter遵循布尔属性的约定。例如：loolean类型的设想，getter方法为isSex而不是getSex

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

举例：

//使用lombok注解
import lombok.Getter;
import lombok.Setter;
import java util.Data;
@Getter
@Setter
public class Person{
    private String firstName;
    private String address;
    private Data dateOfBirth;
    private boolean sex;
}

import java.util.Date;
public class Person{
    private String firstName;
    private String address;
    private Date dateOfBirth;
    private boolean sex;
    
    public Person(){
    }
    public String getFirstName(){return this.firstName;}
    public String getAddress(){return this.address;}
    public String getDateOfBirth(){return this.dateOfBirth;}
    public boolean isSex(){return this.sex;}
    public void setFirstName(String firstName){this.firstName=firstName;}
    public void setAddress(String address){this.address=address;}
    public void setDateOfBirth(Date dateOfBirth){this.dateOfBirth=dateOfBirth;}
    public void setSex(boolean sex){this.sex=sex;}
}

@NonNull

该注解使用在属性上，该注解用于属性的非空检查，当放在setter方法的字段上，将生成一个空检查，如果为空，则抛出NullPointerException。该注解会默认生成一个无参的构造函数。

@ToString

该注解使用在类上，该注解默认生成字段以名称-值得形式输出。
1、如果需要可以通过注释参数includeFieldNames来控制输出中是否包含的属性名称。

2、可以通过exclude参数中包含字段名称，可以从生成的方法中排出特定字段。

3、可以通过callSuper参数控制父类的输出。

例子：

import lombok.ToString;
import java.util.Date;
@ToString
public class Person{
    private String firstName;
    private String address;
    private Date dateOfBirth;
    private boolean sex;
}
//在类的上方是用了@ToString注解，会默认生成toString()方法

注意：在使用callSuper,父类也要有toString方法，不然打印的是对象内存地址

@EqualsAndHashCode

该注解使用在类上，该注解在类级别注释会同时生成equals和hashCode。

注意继承关系的时候该注解的使用。

当存在继承关系时候，需要设置callSuper参数我true.

@Data

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

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

//使用lombok的@Data注解
import lombok.Data;
import java.util.Date;
@Data(staticConstructor="PersonFactory")
public class Person{
    private String firstName;
    private String address;
    private Date dateOfBirth;
    private boolean sex;
}

//未使用该注解时
public class Person{
    private String firstName;
    private String address;
    private Date dateOfBirth;
    priavate boolean sex;
    private Person(){}
    
    public static Person PersonFactory(){
        return new Person();
    }
   /*
    getter和setter方法
   */
}

@AllArgsConstructor

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

@NoArgsConstructor

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

@RequiredArgsConstructor

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

@Value

该注解用在类上，会生成含有参数的构造方法，get方法，此外还提供了equals、hashCode、toString方法。

注意：没有setter

@Cleanup

该注解使用在属性前，该注解是用来保证分配的资源被释放。在本地变量上使用该注解，任何后续代码都将封装在try/finally中，确保当前作用于中的资源被释放。默认@Cleanup清理的方法为close，可以使用vlaue指定不同的方法名。

@Synchronized

该注解使用在类或者实例方法上，Synchronized在一个方法上，使用关键字可能会导致结果和想要的结果不同，因为多线程情况下会出现异常情况。Synchrnoized关键字将在this实例方法情况下锁定当前对象，或者将发方法的对象上多锁定。这可能会导致死锁现象。一般情况下建议锁定一个专门用于次目的的独立所，而不是允许公共对象进行锁定。该注解也是为了达到爱目的。