lombok安装和使用

最新推荐文章于 2024-09-11 14:35:24 发布

阳光的亮亮

最新推荐文章于 2024-09-11 14:35:24 发布

阅读量1.2k

点赞数

分类专栏： java

本文链接：https://blog.csdn.net/weixin_39352976/article/details/80757218

版权

java 专栏收录该内容

96 篇文章 2 订阅

订阅专栏

1，eclipse安装lombok插件参考：https://blog.csdn.net/dorothy1224/article/details/79280591/

2，IDEA安装lombok插件参考：https://blog.csdn.net/zhglance/article/details/54931430

3，添加lombok的maven的pom.xml依赖：

<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.16.10</version>
</dependency>

4，lombok的使用

1）重写实体类的get，set，toString方法

@Setter
@Getter
@ToString
@EqualsAndHashCode
public class Student {
private String name;
private int age;
private String male;
private String studentNo;
}

注意：@ToString(doNotUseGetters = true)通过向ToString注解添加doNotUseGetters 属性可以使得重写toString方法时，直接使用属性和属性值拼接

2）日志使用

@Slf4j
public class UserController {
public sayHello(){
log.info("输出日志：{}",“日志信息”);
}
}

3）Lombok提供注解方式来提高代码的简洁性,常用注解有:

@Data ：注解在类上；包含了@ToString，@EqualsAndHashCode，@Getter / @Setter和@RequiredArgsConstructor的功能，提供类所有属性的 getter 和 setter 方法，此外还提供了equals、canEqual、hashCode、toString 方法
@Setter @Getter：注解在属性上；为属性提供 getter setter 方法
@NonNull：注解在属性上；标识属性是不能为空，为空则抛出异常。
@Synchronized : 加在方法上相当于在方法中添加同步块。
@ToString：注解在类上；生成toString()方法，默认情况下，它会按顺序（以逗号分隔）打印你的类名称以及每个字段。可以这样设置不包含哪些字段@ToString(exclude = "id") / @ToString(exclude = {"id","name"})
@EqualsAndHashCode：注解在类上；生成hashCode()和equals()方法，默认情况下，它将使用所有非静态，非transient字段。但可以通过在可选的exclude参数中来排除更多字段。或者，通过在parameter参数中命名它们来准确指定希望使用哪些字段。
@Cleanup ：修饰流对象，就不用手动的关闭流对象了
@SneakyThrows ：用在方法上，如果不想try-catch异常，只想抛出异常用@SneakyThrows注解
@Slf4j : 注解在类上；根据用户实际使用的日志框架生成log日志对象。
@NoArgsConstructor：注解在类上；为类提供一个无参的构造方法。当类中有final字段没有被初始化时，编译器会报错，此时可用@NoArgsConstructor(force = true)，然后就会为没有初始化的final字段设置默认值 0 / false / null。对于具有约束的字段（例如@NonNull字段），不会生成检查或分配，因此请注意，正确初始化这些字段之前，这些约束无效。
@AllArgsConstructor：注解在类上；为类提供一个全参的构造方法
默认生成的方法是public的，如果要修改方法修饰符可以设置AccessLevel的值，例如：@Getter(access = AccessLevel.PROTECTED)
@RequiredArgsConstructor：注解在类上；会生成构造方法（可能带参数也可能不带参数），如果带参数，这参数只能是以final修饰的未经初始化的字段，或者是以@NonNull注解的未经初始化的字段@RequiredArgsConstructor(staticName = "of")会生成一个of()的静态方法，并把构造方法设置为私有的。
@Log4j ：注解在类上；为类提供一个属性名为log 的 log4j 日志对象

下面分别介绍每个方法的作用以及对应的源代码 @Data
该注解相当于同时加上以下注解@Setter @Getter,@ToString,@EqualsAndHashCode，作用于类中使用:

/**
 * author: renpl
 * blog: www.andyqian.com
 */
@Data
public class Person {
    private String name;
    private String address;
    private String city;
    private String state;
    private String zip;
    private Date brithday;
}

效果如下:

@Getter@Setter
作用于属性上,自动生成get,set方法.

/**
 * author:renpl
 * blog: www.andyqian.com
 */
public class Person {
    @Getter@Setter
    private String name;
}

等价源码:

public String getName() {
        return name;
    }

public void setName(String name) {
        this.name = name;
}

@NonNull
该注解快速判断是否为空,如果为空,则抛出java.lang.NullPointerException
使用方法:

/**
 * author: renpl
 * blog: www.andyqian.com
 */
public class Person {

    private String name;
    
    @Setter@Getter@NonNull
    private List<Person> member;
}

源码:

@NonNull
private List<Person> members;

public Family(@NonNull final List<Person> members) {
    if (members == null) throw new java.lang.NullPointerException("members");
    this.members = members;
}
    
@NonNull
public List<Person> getMembers() {
    return members;
}

public void setMembers(@NonNull final List<Person> members) {
    if (members == null) throw new java.lang.NullPointerException("members");
    this.members = members;
}

@Synchronized
该注解自动添加到同步机制,有趣的是,生成的代码并不是直接锁方法,而是锁代码块，作用范围是方法上
使用方法:

private DateFormat format = new SimpleDateFormat("MM-dd-YYYY");

@Synchronized
public String synchronizedFormat(Date date) {
    return format.format(date);
}

生成等价源码:

private final java.lang.Object $lock = new java.lang.Object[0];
private DateFormat format = new SimpleDateFormat("MM-dd-YYYY");

public String synchronizedFormat(Date date) {
    synchronized ($lock) {
        return format.format(date);
    }
}

@ToString
该方法大家应该非常熟悉，但需要注意的是:@ToString有多个属性可以进一步设置:

callSuper 是否输出父类的toString方法,默认为false
includeFieldNames 是否包含字段名称,默认为true
exclude 排除生成tostring的字段

使用方法:

/**
 * author: renpl
 * blog: www.andyqian.com
 */
@ToString(callSuper = true,exclude ={"name"})
public class Person {
    private String name;
    private String address;
    
}

等价源码:

public String toString() {
 return "Person{" +
                "address='" + address + '\'' +
    '}';
}

@Cleanup
注释可用于确保已分配的资源被释放,如IO的连接关闭。
使用方法:

public void testCleanUp() {
    try {
        @Cleanup ByteArrayOutputStream baos = new ByteArrayOutputStream();
        baos.write(new byte[] {'Y','e','s'});
        System.out.println(baos.toString());
    } catch (IOException e) {
        e.printStackTrace();
    }
}

等价源码:

public void testCleanUp() {
    try {
        ByteArrayOutputStream baos = new ByteArrayOutputStream();
        try {
            baos.write(new byte[]{'Y', 'e', 's'});
            System.out.println(baos.toString());
        } finally {
            baos.close();
        }
    } catch (IOException e) {
        e.printStackTrace();
    }
}