Java界的神器-使用Lombok来消除你的冗余代码量

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/renpingqing/article/details/51714539

简介

他是一个通过注解方式来减少你的POJO类的getter和setter等方法的一个工具,我这里演示的在Android Studio中的使用方式,当然如果你使用的是idea那么这方法也通用,如果你用的是eclipse,那么官网也有视频教程,我这里就不演示了

安装依赖

众所周知在在Android Studio中添加依赖有直接下载jar包和使用cradle的dependencies方法,我们这里直接使用dependencies方法

添加gradle依赖

在你的项目的build.grade文件中添加

provided 'org.projectlombok:lombok:1.12.6'

至于为什么是provided而不是compile,因为这个框架是在将java编译为class前处理代码了,意思是在生成的class文件中已经生成了getter和setter,所以这个依赖是我们在编译的时候使用,不需要打包到apk中

安装Lombok插件

虽然我们添加了依赖,但是Android Studio他知道怎么处理这个文件吗,肯定是不知道啦,所以我们的安装一个插件来告诉他怎么处理

Preferences > Plugins > Browse repositories

在输入框内输入combo,可看到已经搜索出来了这个插件,我们点击旁边的安装,安装完成后重启插件我们就安装完毕了,它的使用使用说明可以查看插件主页

现在插件虽然安装完了,但是Android Studio他怎么知道什么时候来使用这个插件呢,他是不是有个开关什么的,没错!你猜对了

开启项目的Annotation process

首先我们打开项目的设置,要强调的是项目的,而不是工具全局的设置,如下图

打开后按照下图勾选Enable annotation processing

到这里为止,工具和基本环境我们基本配置完了,接下来我们需要创建一个项目来测试

一些常用注解

@Getter and @Setter

可以很直观的从名字看出这个两个是分别用来生成Getter和Setter方法的

public class User{
    @Getter @Setter private boolean employed = true;
    @Setter(AccessLevel.PROTECTED) private String name;
}

相当于

public class User {
    private boolean employed = true;
    private String name;

    public User() {
    }

    public boolean isEmployed() {
        return this.employed;
    }

    public void setEmployed(boolean employed) {
        this.employed = employed;
    }

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

到这里,大家肯定要问了,你说相当就等啊,或者上面相等的代码是怎么来的呢,其他我们可以直接反编译生成的class文件查看,打开Android Studio的class目录下的User.class文件,可以看到

同样下面的实例代码你可以这样查看,当然我们也可用通过Android Studio的

从上图我们发现我们没有在源代码写一些Getter方法,但是从Structure窗口看到这些方法已经自动生成了,是不是很神奇

@NonNull

提供一个参数的非空判断

@Getter @Setter @NonNull
private List<String> members;

等同于

@NonNull
private List<String> members;

@NonNull
public List<String> getMembers() {
    return this.members;
}

public void setMembers(@NonNull List<String> members) {
    if(members == null) {
        throw new NullPointerException("members");
    } else {
        this.members = members;
    }
}

查看原文或源代码点击这里http://i.woblog.cn/2016/06/19/use-lombok/

猜你喜欢

转载自blog.csdn.net/renpingqing/article/details/51714539