如何使用IntelliJ IDEA 2017.3配置Lombok及掌握核心注解？

本文共计1294个文字，预计阅读时间需要6分钟。

前言：不知道大家是否在创建一个实体类的时候，每次定义好属性后，都需要手动右键生成getter、setter和toString()等方法的代码。假设有很多实体类，工程量就会增加。为了提高效率，下面将介绍一种方法，通过编写一个通用的代码模板，可以快速生成这些方法。

具体步骤如下：

1. 创建一个名为EntityMethodGenerator.java的文件，并添加以下代码：

javapublic class EntityMethodGenerator { public static void main(String[] args) { String className=YourEntityClass; // 替换为你的实体类名 String code=generateCode(className); System.out.println(code); }

public static String generateCode(String className) { StringBuilder sb=new StringBuilder(); sb.append(public class ).append(className).append( {\n); sb.append( // 属性\n); sb.append( private String property1;\n); sb.append( private int property2;\n); sb.append( // ... 其他属性\n); sb.append(\n); sb.append( // getter 方法\n); sb.append( public String getProperty1() {\n); sb.append( return property1;\n); sb.append( }\n); sb.append(\n); sb.append( public int getProperty2() {\n); sb.append( return property2;\n); sb.append( }\n); sb.append(\n); sb.append( // ... 其他 getter 方法\n); sb.append(\n); sb.append( // setter 方法\n); sb.append( public void setProperty1(String property1) {\n); sb.append( this.property1=property1;\n); sb.append( }\n); sb.append(\n); sb.append( public void setProperty2(int property2) {\n); sb.append( this.property2=property2;\n); sb.append( }\n); sb.append(\n); sb.append( // ... 其他 setter 方法\n); sb.append(\n); sb.append( @Override\n); sb.append( public String toString() {\n); sb.append( return \).append(className).append({property1=').append(property1).append(', property2=).append(property2).append('}\;\n); sb.append( }\n); sb.append(}\n); return sb.toString(); }}

2. 在你的实体类中，将以下代码替换为你想要生成的getter、setter和toString()方法：

javapublic class YourEntityClass { // 属性 private String property1; private int property2; // ... 其他属性

// getter 方法 public String getProperty1() { return property1; }

public int getProperty2() { return property2; }

// ... 其他 getter 方法

// setter 方法 public void setProperty1(String property1) { this.property1=property1; }

public void setProperty2(int property2) { this.property2=property2; }

// ... 其他 setter 方法

@Override public String toString() { return YourEntityClass{property1='property1', property2=property2}; }}

3. 运行EntityMethodGenerator.java文件，在控制台输出你想要的实体类代码。

通过以上步骤，你可以快速生成实体类的getter、setter和toString()方法，提高开发效率。

前言

不知道大家在创建一个实体类的时候，有没有发现每次定义好属性之后，都需要手动右键Generate构建getter、setter和toString()之类的方法，假设很多实体类的话，工程量就增加了，为提高开发效率且代码优雅，特给大家推荐一下Lombok神器。

简介

Lombok项目是一个Java库，它会自动插入您的编辑器和构建工具中，从而为您的Java增光添彩。永远不需要再写另一个getter或equals方法，带有一个注释之后您的类有一个功能全面的生成器，自动化您的日志记录变量等等。

使用

使用的IDE是Intellij IDEA 2017.3版本，JDK是1.8版本，在Lombok官网可以找到在IDEA安装的教程，具体如下图：

插件安装

结合“Lombok”官网给出的教程，在IDEA具体操作如下图：

Maven依赖

在IDEA中创建一个Maven项目“lombok-test”，在pom.xml文件中依赖“Lombok”相关注解依赖包，并添加单元测试包（添加与否不影响效果，只是为了后面进行单元测试），依赖情况如下图：

常用注解

@Data：注解在类上，提供类所有属性的 getting 和 setting 方法，此外还提供了equals、canEqual、hashCode、toString 方法。
@Setter：注解在属性上，为属性提供 setting 方法。
@Setter：注解在属性上，为属性提供 getting 方法。
@ToString：在JavaBean中使用，注解会自动重写对应的toStirng方法。
@ToString(exclude={“column1”,“column2”})：排除多个column列所对应的元素。
@ToString(of={“column1”,“column2”})：只生成包含多个column列所对应的元素。
@NoArgsConstructor：注解在类上，为类提供一个无参的构造方法。
@AllArgsConstructor：注解在类上，为类提供一个全参的构造方法。
@Log4j：注解在类上，为类提供一个属性名为log 的 log4j 日志对象。
@Cleanup：可以关闭流。
@Builder： 被注解的类加个构造者模式。
@Synchronized：加个同步锁。
@SneakyThrows：等同于try/catch 捕获异常。
@NonNull：如果给参数加个这个注解 参数为null会抛出空指针异常。
@Value ：注解和@Data类似，区别在于它会把所有成员变量默认定义为private final修饰，并且不会生成set方法。

@Data注解效果

从下图可以看到@Data经过编译后的字节码文件中是已经自动生成了getter setter方法之类的。

测试

这次仅仅添加了@Data注解，其他注解大同小异，各位均可自行测试。

参考文档

官方文档： projectlombok.org/features/all
maven参考地址：mvnrepository.com/artifact/org.projectlombok/lombok

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持自由互联。