企业开发中Lombok是这样用

Lombok

学习目标

• 什么是Lombok ？
• Lombok的原理 ？
• Lombok常用注解 ？
• Lombok安装 ？

1、Lombok 简介

Lombok是一款Java开发插件，可以通过它定义的注解来精简冗长和繁琐的代码，主要针对简单的Java模型对象

官网： https://projectlombok.org/

Project Lombok is a java library that automatically plugs into your editor and build tools, spicing up your java.Never write another getter or equals method again, with one annotation your class has a fully featured builder, Automate your logging variables, and much more.

简单翻译一下： Lombok项目是一个Java库， 它可以自动插入编辑器并构建工具 ，从而 简化Java开发 。
我们不在需要编写一个个的getter，setter或equals方法 ， 通过添加注解的方式，同时可以自动化日志变量。

简而言之：Lombok能以简单的注解形式来简化java代码，提高开发人员的开发效率。

• 博客及源码GitHub链接 ： https://github.com/JourWon/test-lombok

lombok在开发中确实简化了一些操作，但是也有他的不便之处，团队中每个人都要在编译器中安装lombok插件否则就会报错。所以项目开始就规定好团队是否使用lombok。

2、Lombok原理

3、使用Lombok

安装插件

使用Lombok还需要插件的配合，我使用开发工具为idea，这里只讲解idea中安装lombok插件，使用eclipse和 的小伙伴和自行google安装方法。

打开IDEA，在File -> Settings -> Plugins中搜索 lombok ,点击安装然后重启IEDA即可

• 为什么要安装插件

  Lombok是一款通过注解在Java编译期生成代码的工具，通过使用其内置的一些注解如@Getter, @Setter等，可以在编译期间生成getter，setter，构造器，builder等代码 ，他是在编译期间，如果我们不安装插件的话，开发期间无法使用生成的方法。 使用Lombok还需要插件的配合。

使用Lombok

所需工具和版本

• 使用Lombok需要的开发环境Java+Maven+IDEA

• lombok 1.18.10

• 引入lombok依赖

<dependency>
	<groupId>org.projectlombokgroupId>
	<artifactId>lombokartifactId>
	<version>1.18.10version>
	<scope>providedscope>
dependency>

• 使用lombok中的注解标注实体类即可

4、Lombok注解

Lombok使用过程中主要靠注解起作用，官方文档中有很多注解，这里只讲解常用的注解。

1. @Date

• 该注解使用在类上，该注解会提供getter、setter、equals、 canEqual、hashCode、toString方法。

@Data
public class User {
    private Integer id;
    private String name;
    private String age;
    private String birthdy;
}

2. @Getter 和 @Setter

• @Getter ： 生成对应的getter方法， 生成的getter遵循布尔属性的约定。 例如：boolean类型的sex,getter方法为 isSex 而不是 getSex
• @Setter ： 生成对应的setter方法
• 这两个注解一般情况下搭配使用

3. @ToString

• 作用在类上，生成ToString()方法

4. @AllArgsConstructor 和 @NoArgsConstructor

• 作用在类上
• 一般情况也是搭配使用
• 用来提供有参和无参方法

@AllArgsConstructor
@NoArgsConstructor
public class User {
    private Integer id;
    private String name;
    private String age;
    private String birthdy;

}

5. @Accessors

• 用在类上。用来给set方法开启链式调用chain属性：用来指定SET方法链式调用true开启，false关闭

@Data
@Accessors(chain = true)
public class User {
    private Integer id;
    private String name;
    private String age;
    private String birthdy;

}    
public static void main(String[] args) {
    User user = new User();
    user.setId(1).setName("songzuer").setAge("12").setBirthdy("2001-01-01");
}

6. @Slf4j

• 用在类上
• 作用：快速定义一个日志变量
• 原理：在对应的类上加入这个注解相当于在这个类中声明了一个日志对象

private Logger logger = LoggerFactory.getLogger(this.getClass());

注解的常用整理

注解名称	含义	是 否 默 认 生 成 无 参 构 造 方 法
@Setter	生成对应的setter方法	是
@Getter	生成对应的getter方法， 生成的getter遵循布尔属性的约定。 例如：boolean类型的sex,getter方法为 isSex 而不是 getSex	是
@Data	该注解会提供getter、setter、equals、 canEqual、hashCode、toString方法。	否
@Log	这是一个泛型注解，具体有很多种形式 。（具体请参考Log官 方介绍）
@AllArgsConstructor	该注解提供一个全参数的构造方法	否
@NoArgsConstructor	该注解提供一个无参构造	— –
@EqualsAndHashCode	该注解在类级别注释会同时生成 equals 和 hashCode 。 注意 继承关系的时候该注解的使用。详细介绍参照官方介绍
@NonNull	该注解使用在属性上，该注解用于属的非空检查，当放在 setter方法的字段上，将生成一个空检查，如果为空，则抛出 NullPointerException 。	是
@Cleanup	该注解使用在属性前，该注解是用来保证分配的资源被释放。 在本地变量上使用该注解，任何后续代码都将封装在try/finally 中，确保当前作用于中的资源被释放。默认 @Cleanup 清理的 方法为 close ，可以使用value指定不同的方法名称。	否
@ToString	该注解使用在类上，该注解默认生成任何非讲台字段以名称-值 的形式输出。 1、如果需要可以通过注释参数 includeFieldNames 来控制输出中是否包含的属性名称。 2、可以通过 exclude 参数中包含字段名称，可以从生成的方 法中排除特定字段。 3、可以通过 callSuper 参数控制父类 的输出。	否
@RequiredArgsConstructor	该注解使用在类上，使用类中所有带有 @NonNull 注解的或者 带有 final 修饰的成员变量生成对应的构造方法	否

@Value	这个注解用在 类 上，会生成含所有参数的构造方法，get 方 法，此外还提供了equals、hashCode、toString 方法。 注 意：没有****setter	否
@SneakyThrows	该注解使用在方法上，这个注解用在 方法 上，可以将方法中 的代码用 try-catch 语句包裹起来，捕获异常并在 catch 中用 Lombok.sneakyThrow(e) 把异常抛出，可以使用 @SneakyThrows(Exception.class) 的形式指定抛出哪种异 常。该注解需要谨慎使用。详情参看官方介绍	否
@Synchronized	该注解使用在类或者实例方法上，Synchronized在一个方法 上，使用关键字可能会导致结果和想要的结果不同，因为多线 程情况下会出现异常情况。Synchronized	否

5、总结

其实Lombok就着吗点东西，把这些东西学会了，在实际开发中绝对没有任何为题，希望对大家有收获。