一、介绍和使用
Lombok 是一个 java 库,能以简单的注解形式来简化 java 代码,提高开发人员的开发效率。
常见使用在开发过程中需要写的 javabean,往往开发需要花时间去添加相应的 getter/setter,也许还要去写构造器、equals等方法,而且需要维护,当属性多时会出现大量的 getter/setter 方法,这些显得很冗长也没有太多技术含量,一旦修改属性,就容易出现忘记修改对应方法的失误,而这些都可以通过 Lombok 的注解去完成,而且!Lombok 的功能还不仅仅是这些。
1、pom.xml
<dependency> groupId>org.projectlombok</artifactId>lombokversion>1.18.2scope>provided> >
2、插件安装
推荐安装 IDEA lombok plugin 插件,非必须,但是开发过程中看着一堆红色报错,还是略不爽呀~
二、注解说明
这里罗列一些常用的 Lombok 注解:
@EqualsAndHashCode:生成 equal() 和 hashCode() 方法。
@NoArgsConstructor:生成一个无参构造器。
@AllArgsConstructor:生成一个全参构造器。
@NonNull:为字段参数生成非空检查,避免 NullPointerException;
@requiredArgsConstructor:为所有必填字段生成一个构造器。
@Cleanup:用在局部变量上,作为资源使用完成后的释放。比如 FileInputStream 这类的文件流,会在使用完成后调用 close() 方法。
@SneakyThrows:用在方法或者构造器上,抛出需要 throw 的异常。比如 @SneakyThrows(UnsupportedEncodingException.class)。
@Synchronized:用在方法上。相当于对方法使用了 synchronized 关键字。
@Data:神器,相当于同时使用了 @Getter、@Setter、@requiredArgsConstructor、@ToString、@EqualsAndHashCode。
@Slf4j:用在类上,相当于写了 private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExample.class);
完整的注解文档说明:https://projectlombok.org/features/all
@Data @NoArgsConstructor @AllArgsConstructor
@Slf4j public class UserVO { private Long id; @NonNull String name; String password; void copyFile(String in,String out) throws IOException { @Cleanup FileInputStream inStream = new FileInputStream(in); @Cleanup FileOutputStream outStream = FileOutputStream(out); byte[] b = new byte[65536]; while (true) { int r = inStream.read(b); if (r == -1) break; outStream.write(b,0,r); } } @SneakyThrows(UnsupportedEncodingException.class) public String utf8ToString(byte[] bytes) { return new String(bytes,"UTF-8"); } }