使用 Lombok 简洁优雅的优化你的实体类JavaBean代码-Java的奇淫巧技

我一直坚持认为,作为程序员偷懒是优秀的品质,只有让人类更懒才能提升效率,让重复和简单的工作交给机器吧,今天给大家介绍的一款第三方库就是能帮你提升效率和偷懒的工具:Lombok,本次主要介绍的是利用 Lombok 来优化你的实体类代码,重复而又简单的 getter/setter/toString/equals 代码就交给程序来完成吧。

Lombok是一个第三方Java库,在项目开发中我们经常需要定义实体类大量的JavaBean,然后使用IDE的快捷键去构建getter/setter/toString/equals等方法,代码看着非常多,最重要的是遇到改名需要的时候,要批量替换,还可能替换出错,实在是痛苦不堪,Lombok可以帮我们在编译时完成复杂又低级的代码。官方地址:https://projectlombok.org/,github地址:https://github.com/rzwitserloot/lombok


首先要在项目中引入Jar包,我使用Maven管理依赖,所以这里给出Maven的pom.xml代码:

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


然后安装插件,因为要让IDE开发环境识别我们偷懒的写法不报错,就得安装lombok插件,我使用的是 idea,就以idea为例:在 File > Settings > Plugins,然后搜索”Lombok Plugin“,点击 Install plugin 安装插件,重新启动 idea 即可。

/31ca9e940cf949d29a3981593d0d2bc4.png

由于我已经转到SpringBoot下开发,能使用注解就使用注解,那加上Lombok的加持,就会产生这样的实体类:

@Data
public class Link {
    private String href;
    private String text;
    private String target;
}

通过代码可以看到,没有 getter/setter/toString等代码,只有一个@Data注解,这个Data注解就是在lombok.Data,这个@Data又包含:@ToString、@Getter、@Setter、@EqualsAndHashCode、@NoArgsConstructor,这就热闹了,都是啥意思呢?先不多说,我们看看编译以后的 Link.class 文件里都是什么内容:

package com.neilren.neilren4j.entity;

public class Link {
    private String href;
    private String text;
    private String target;

    public Link() {
    }

    public String getHref() {
        return this.href;
    }

    public String getText() {
        return this.text;
    }

    public String getTarget() {
        return this.target;
    }

    public void setHref(String href) {
        this.href = href;
    }

    public void setText(String text) {
        this.text = text;
    }

    public void setTarget(String target) {
        this.target = target;
    }

    public boolean equals(Object o) {
        if (o == this) {
            return true;
        } else if (!(o instanceof Link)) {
            return false;
        } else {
            Link other = (Link)o;
            if (!other.canEqual(this)) {
                return false;
            } else {
                label47: {
                    Object this$href = this.getHref();
                    Object other$href = other.getHref();
                    if (this$href == null) {
                        if (other$href == null) {
                            break label47;
                        }
                    } else if (this$href.equals(other$href)) {
                        break label47;
                    }

                    return false;
                }

                Object this$text = this.getText();
                Object other$text = other.getText();
                if (this$text == null) {
                    if (other$text != null) {
                        return false;
                    }
                } else if (!this$text.equals(other$text)) {
                    return false;
                }

                Object this$target = this.getTarget();
                Object other$target = other.getTarget();
                if (this$target == null) {
                    if (other$target != null) {
                        return false;
                    }
                } else if (!this$target.equals(other$target)) {
                    return false;
                }

                return true;
            }
        }
    }

    protected boolean canEqual(Object other) {
        return other instanceof Link;
    }

    public int hashCode() {
        int PRIME = true;
        int result = 1;
        Object $href = this.getHref();
        int result = result * 59 + ($href == null ? 43 : $href.hashCode());
        Object $text = this.getText();
        result = result * 59 + ($text == null ? 43 : $text.hashCode());
        Object $target = this.getTarget();
        result = result * 59 + ($target == null ? 43 : $target.hashCode());
        return result;
    }

    public String toString() {
        return "Link(href=" + this.getHref() + ", text=" + this.getText() + ", target=" + this.getTarget() + ")";
    }
}

现在就看明白了吧,@Data包含:@ToString、@Getter、@Setter、@EqualsAndHashCode、@NoArgsConstructor。@ToString会为我们添加toString()方法,@Getter、@Setter会为我们添加 get()、set()方法,@EqualsAndHashCode会给我们添加equals(Object o)、hashCode()方法,@NoArgsConstructor会给我们添加一个无参数的构造函数,在这里就是添加了Link()方法,怎么样是不是很爽?

再介绍一些好用的注解:

@NonNull:在方法或构造函数上加@NonNull注释,会为我们增加一个Null空值检查语句,遇到空值会抛出一个NullPointerException异常

@Cleanup:在使用类似InputStream、OutputStream资源的时候能为我们自动的释放资源,也就是会为我们增加 资源close()方法

还有很多注释,就不介绍了,这些常用的就基本够用了,接下来再介绍一个输出日志的注解@Slf4j,当我们引入Lombok的时候,@Slf4j也可以被使用了,用法是在类名上面增加@Slf4j的注解,然后在类里面使用log.info()或者log.error()方法输出和记录日志:

@Slf4j
@Service
public class IpInfoService extends BaseService {
    public AlicmapiIP getIpInfo(String ip) {
        try {
        } catch (Exception e) {
            log.error(e.getMessage(), e);
        }
        return null;
    }
}

通过配置文件可以配置日志输出位置和分级别输出。

最后说一下Lombok,一直有一些争议,应不应该使用,可以根据实际场景进行使用。