开发环境中实现Lombok消除Java冗余

最新推荐文章于 2022-07-20 11:08:05 发布

tdshzd01

最新推荐文章于 2022-07-20 11:08:05 发布

阅读量208

点赞数

文章标签： java eclipse getter setter accessor equals

Lombok是一种JavaArchive(JAR)文件，可用来消除Java代码的冗长。通过在开发环境中实现Lombok，开发人员可以节省构建诸如hashCode()和equals()这样的方法以及以往用来分类各种accessor和mutator的大量时间。

我们看这样一个例子，一个标准的Javabean。一个典型的Javabean一般具有几个属性。每个属性具有一个accessor和mutator（getter和setter）。通常还会有一个toString()方法、一个equals()方法和一个hashCode()方法。初看上去，其中可预见的冗余就已经非常多了。如果每个属性都具有一个getter和setter，并且通常如此，那么又何必详细说明呢？

让我们来看看Lombok。为了消除代码行，Lombok使用注释来标识类和Java代码块。在前述的那个Javabean示例中，所有的getter、setter以及其他三个方法都是在编译时被暗示并包括进来的。

而且更好的是如果您使用的是Eclipse或IBM®WebSphere®StudioApplicationDeveloper（如果还没用的话，建议最好使用），您就可以将Lombok集成到Java项目并即刻获得开发时结果。换言之，Eclipse编译器可以立即识别所暗指的getters/setters，而其他Java代码则可引用这些方法。

最直接的好处当然是代码行的减少，这真的很棒。并且，如果有一个特定的getter或setter需要特别的注意，那么您就不必为了找到这个特定的getter或setter而遍历数十行代码。代码也会更为简洁并且冗余也少了。

Lombok还让您得以简化代码的其他部分—不仅仅是Javabean。比如，还可以减少try/catch/finally块内以及同步方法内的冗余代码。现在，我们来看看在您自己的开发环境中如何能实现上述目的。

安装Lombok

要进行安装，本文假设您使用的是Eclipse或WebSphereStudioApplicationDeveloper。如果不是，您仍可使用Lombok；但是不能享用开发时的种种益处。不过，您仍然可以享用编译时的益处。首先，打开您的浏览器并将URL指向http://projectlombok.org/。

在撰写本文之时，用这个URL打开的页面的右上角会出现一个很大的单词。这个单词是“Download”。单击该单词并开始下载lombok.jar。此文件无需解压缩，而从其他站点下载的文件中，99%都需要解压缩。

下载此文件后，需要执行这个JAR文件。在您的操作系统中打开一个提示符，进入到安装了lombok.jar的那个目录，并键入java-jarlombok.jar。以上假设在您的路径内已经有JavaRuntimeEnvironment(JRE)。如果没有，需要添加它。如果要了解如何添加，可以参考针对您的具体操作系统的相关文档。如果您使用的是Microsoft®Windows®，那么还可以双击这个lombok.jar图标。同样地，您必须能够从您的图形用户界面（GUI）执行JAR。

不管采取何种方式，应该最终都能看到一个Lombok安装屏幕。该屏幕会提问Eclipse或WebSphereStudioApplicationDeveloper可执行文件位于何处。它的默认位置有可能是正确的。但有时可能需要更改这个默认位置。单击Install/Update，Lombok会被迅速并入Eclipse开发环境。如果已经运行了Eclipse，那么就需要关闭它并重启。

使用Lombok

现在，就可以在Eclipse或WebSphereStudioApplicationDeveloper内开始使用Lombok了。请参考清单1内的代码。

 
 清单1.Javabean的一个良好开端  
publicclassLure{  
 privateStringname;  
 privateintsize;  
 privateStringcolor;  
 privateStringstyle;  
}

以上是一个简单的Javabean的典型开始。从这里，可以为每个属性添加getters和setters。然后再添加一个equals()方法、一个toString()方法和一个hashCode()方法。有了Lombok，您无需自己完成上述操作。相反，您只需添加一个注释：@Data。没错，就这么简单。清单2中包括了@Data。

 
 清单2.Javabean的一个更好的开端  
importlombok.Data  
public@DataclassLure{  
 privateStringname;  
 privateintsize;  
 privateStringcolor;  
 privateStringstyle;  
}

不过请记住，只有当lombok.jar位于您的构建路径且lombok.Data被导入到这个Java类时，上述代码才会奏效。如果在Eclipse或WebSphereStudioApplicationDeveloper内查看这个类的概要（通常位于屏幕上这个类的右侧），就能看到这些方法会被自动添加到这个Lure类。

若不能立即看到这个概要，可以单击Eclipse内的Window菜单，然后选择ShowView。从所出现的弹出菜单中，选择Outline，它应该出现在屏幕的右侧。强制显示类的概要的热键组合是Alt+Shift+Q，然后是O。

如果您编写了另一个类来实例化Lure，您将能立刻拥有对Lure所暗指的方法（比如getName()或setSize()）的访问。您还能拥有对equals()、hashCode()和toString()的访问。很棒，对吧？

如果您使用的不是Eclipse或WebSphereStudioApplicationDeveloper，那么所暗指的这些方法添加只有在实际编译这些代码时才能被认可。所以虽然在没有Eclipse或WebSphereStudioApplicationDeveloper时仍可以使用Lombok，但Lombok最初的设计目的就是与Eclipse或WebSphereStudioApplicationDeveloper相集成。

在生成getter/setter方法时，Lombok遵从传统的标准。所有这些方法名都以get或set开头并且属性名都是大写的。当然，如果属性是一个Boolean，情况例外。在这种情况下，getter以is开始，而非get。这是Javabean的一种标准实践。

现在，假设有一个Javabean对您的一个getter具有特殊要求。在清单2的例子中，getStyle()可能返回颜色和大小的组合。在这种情况下，可以按自己的意愿编写getStyle()方法的代码。Lombok检查您的代码并且不会基于这个属性创建其自己的getStyle版本。又假设，您有一个getter方法不想公开。为此，Lombok让您可以输入一个附加参数。清单3给出了一个定制的修饰符（modifier）。

 
 清单3.一个定制的修饰符  
privateStringname;  
@Getter(AccessLevel.PROTECTED)privateintsize;  
privateStringcolor;  
privateStringstyle;

在本例中，getSize()方法将不会被公开。它具有一个受保护的修饰符，所以它只对派生子类可用并且在Lure类本身的内部。您可能并不总是想接受Lombok为您提供的其他默认值。比如，toString()方法会列出类名以及所有的属性名和值，中间以逗号分割。这个列表出现在类名的旁边。比如，假设在记录这个Lure类时，您并不关心颜色。为了更改toString()的默认设置，需要使用ToString注释。