JavaBean的实用工具Lombok(省去get、set等方法)
转:https://blog.csdn.net/ghsau/article/details/52334762
背景
我们在开发过程中,通常都会定义大量的JavaBean,然后通过IDE去生成其属性的构造器、getter、setter、equals、hashcode、toString方法,当要对某个属性进行改变时,比如命名、类型等,都需要重新去生成上面提到的这些方法,那Java中有没有一种方式能够避免这种重复的劳动呢?答案是有,我们来看一下下面这张图,右面是一个简单的JavaBean,只定义了两个属性,在类上加上了@Data
,从左面的结构图上可以看到,已经自动生成了上面提到的方法。
Lombok简介
Lombok是一个可以通过简单的注解形式来帮助我们简化消除一些必须有但显得很臃肿的Java代码的工具,通过使用对应的注解,可以在编译源码的时候生成对应的方法。官方地址:https://projectlombok.org/,github地址:https://github.com/rzwitserloot/lombok。
Lombok使用
环境
# | # |
---|---|
Maven, Ivy or Gradle | Lombok is in maven central. More… |
Javac | Just put lombok.jar on the classpath. |
NetBeans | Just put lombok.jar on the classpath and enable annotation processing. More… |
Eclipse and variants | Run lombok.jar as a java app (i.e. doubleclick it, usually) to install. Also add lombok.jar to your project. Supported variants: Springsource Tool Suite, JBoss Developer Studio |
IDEA IntelliJ | A plugin developed by Michael Plushnikov adds support for most features. |
Javadoc | First delombok your code then run javadoc on the result. More… |
Android | The proper way to use lombok with android is somewhat complicated but possible. More… |
GWT | Lombok works with GWT. More… |
Play! Framework | Use Aaron Freeman’s lombok play plugin. |
ecj | Lombok works on ecj and ecj-based tools. More… |
https://projectlombok.org/download.html
注解介绍
下面只是介绍了几个常用的注解,更多的请参见https://projectlombok.org/features/index.html。
@Getter / @Setter
可以作用在类上和属性上,放在类上,会对所有的非静态(non-static)属性生成Getter/Setter方法,放在属性上,会对该属性生成Getter/Setter方法。并可以指定Getter/Setter方法的访问级别。
@EqualsAndHashCode
默认情况下,会使用所有非瞬态(non-transient)和非静态(non-static)字段来生成equals和hascode方法,也可以指定具体使用哪些属性。
@ToString
生成toString方法,默认情况下,会输出类名、所有属性,属性会按照顺序输出,以逗号分割。
@NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor
无参构造器、部分参数构造器、全参构造器,当我们需要重载多个构造器的时候,Lombok就无能为力了。
@Data
@ToString, @EqualsAndHashCode, 所有属性的@Getter, 所有non-final属性的@Setter和@RequiredArgsConstructor的组合,通常情况下,我们使用这个注解就足够了。
Lombok原理
了解了简单的使用之后,现在应该比较好奇它是如何实现的。整个使用的过程中,只需要使用注解而已,不需要做其它额外的工作,那玄妙之处应该是在注解的解析上。JDK5引入了注解的同时,也提供了两种解析方式。
运行时解析
运行时能够解析的注解,必须将@Retention设置为RUNTIME,这样可以通过反射拿到该注解。java.lang.reflect反射包中提供了一个接口AnnotatedElement,该接口定义了获取注解信息的几个方法,Class、Constructor、Field、Method、Package等都实现了该接口,大部分开发者应该都很熟悉这种解析方式。
boolean isAnnotationPresent(Class<? extends Annotation> annotationClass);
<T extends Annotation> T getAnnotation(Class<T> annotationClass);
Annotation[] getAnnotations();
Annotation[] getDeclaredAnnotations();
- 1
- 2
- 3
- 4
编译时解析
编译时解析有两种机制,网上很多文章都把它俩搞混了,分别简单描述一下。
Annotation Processing Tool
apt自JDK5产生,JDK7已标记为过期,不推荐使用,JDK8中已彻底删除,自JDK6开始,可以使用Pluggable Annotation Processing API来替换它,apt被替换主要有2点原因:
- api都在com.sun.mirror非标准包下
- 没有集成到javac中,需要额外运行
apt的更多介绍可以参见这里。
Pluggable Annotation Processing API
JSR 269,自JDK6加入,作为apt的替代方案,它解决了apt的两个问题,javac在执行的时候会调用实现了该API的程序,这样我们就可以对编译器做一些增强,这时javac执行的过程如下:
Lombok就是使用这种方式实现的,有兴趣的话可以去看看其Lombok源码,对应注解的实现都在HandleXXX中,比如@Getter注解的实现是HandleGetter.handle()。还有一些其它类库使用这种方式实现,比如Google Auto、Dagger等等。
Lombok问题
- 无法支持多种参数构造器的重载
- 奇淫巧技,使用会有争议
引用
http://notatube.blogspot.fr/2010/11/project-lombok-trick-explained.html
http://www.lteconsulting.fr/annotation-processing
http://hannesdorfmann.com/annotation-processing/annotationprocessing101
http://docs.oracle.com/javase/7/docs/technotes/guides/apt/GettingStarted.html
本文来自:高爽|Coder,原文地址:http://blog.csdn.net/ghsau/article/details/52334762,转载请注明。
转载于:https://www.cnblogs.com/soul-wonder/p/9051362.html
JavaBean的实用工具Lombok(省去get、set等方法)相关推荐
- 消除冗长Java代码的工具——Lombok详解
消除冗长Java代码的工具--Lombok详解 文章目录 消除冗长Java代码的工具--Lombok详解 什么是Lombok Lombok的作用 Lombok常用注解 Lombok安装 什么是Lomb ...
- Java 效率工具 Lombok 使用教程
来源:微信公众号 → JavaGuide → 2019/06/17 → https://mp.weixin.qq.com/s?__biz=Mzg2OTA0Njk0OA==&mid=224748 ...
- 如何使用 ASP.NET 实用工具加密凭据和会话状态连接字符串
文章编号 : 329290 最后修改 : 2006年4月10日 修订 : 8.0 重要说明:本文包含有关如何修改注册表的信息.修改注册表之前,一定要先进行备份,并且一定要知道在发生问题时如何还原注册表 ...
- windows installer清理实用工具
今天编译了一个程序,一个Windows Service卸载命令写错了,导致这个程序不能正常卸载. 只好手动卸载这个Windows Service,之后再卸载程序,依然不能卸载.最后只好使用MSICUU ...
- Unix实用工具教程:《sed与awk》修订第三版清晰版
为什么80%的码农都做不了架构师?>>> Unix实用工具教程:<sed与awk>修订第三版清晰版 本书介绍了一组名字奇特的Unix实用工具sed和awk,这组实用 ...
- ServiceModel 元数据实用工具 (Svcutil.exe)
ServiceModel 元数据实用工具用于依据元数据文档生成服务模型代码,以及依据服务模型代码生成元数据文档. 在win7系统中的路径为C:\Program Files\Microsoft SDKs ...
- Scott Hanselman's 推荐的的实用工具集合(2011版)
Scott Hanselman活跃于.NET社区,这篇文章来自于它的工具列表,地址是http://www.hanselman.com/tools .NET开发人员应该收藏的工具 LINQPad 快速理 ...
- wps右键新建里面没有word和excel_WPS竟然出过这么多实用工具?每个都免费无广告,简直相见恨晚...
没想到,总被各种吐槽的WPS,竟然还出过这么多实用工具!向你分享4款WPS出品的软件和网站,其中1款让我又爱又恨,而另外几款免费无广告,和三顿一起来看看吧!WPS图片电脑上到底有没有好用的看图软件?这 ...
- 十款让 Web 前端开发人员更轻松的实用工具
这篇文章介绍十款让 Web 前端开发人员生活更轻松的实用工具.每个 Web 开发人员都有自己的工具箱,这样工作中碰到的每个问题都有一个好的解决方案供选择. 对于每一项工作,开发人员需要特定的辅助工具, ...
- 实用工具类库java.util
本章介绍Java的实用工具类库java.util包.在这个包中,Java提供了一些实用的方法和数据结构.例如,Java提供日期(Data)类.日历(Calendar)类来产生和获取日期及时间,提供随机 ...
最新文章
- java实现七日股票问题_七日打卡--JAVA资源限制
- k3应付系统初始化应付票据_在家工作时应付无尽干扰的真实感觉
- 成长秘笈:是你教我,不是我教你
- com.android.builder.packaging.DuplicateFileException
- PAT甲级1042 Shuffling Machine:[C++题解]模拟、哈希表、洗牌机
- Java Number 类
- 开源网店系统_amazon都做不行,就不可构建外贸网店系统吗?
- poj 3233 Matrix Power Series
- mysql5.7主从复制遇到的坑
- 00004-括号匹配问题-牛客网-要考虑各种情况
- BugkuCTF-WEB题网站被黑
- cxf开发webservice服务端怎么返回固定的报文格式_Spring boot webservice怎么玩? 第277篇...
- C语言书籍推荐从入门到进阶再到封神全套(2021年整理)
- Axure 8.0/9.0 注册码 激活码 授权码 License
- CImageList-CBitmap-Usage
- 小米笔记本pro充电测试软件,一款给人心理落差较大的笔记本--小米笔记本Pro测评...
- 手动卸载金蝶旗舰版KIS软件流程
- java魔剑天使_大天使之剑大神教你打造牛逼魔剑士
- 经济学硕士毕业论文题目【282个】
- 全国大学生智能汽车大赛(二):电感采样、卡尔曼滤波、方向控制代码