Lombok的使用和常用注解使用示例

一时失言乱红尘 2022-05-22 00:42 284阅读 0赞

无意中发现了一个巨牛的人工智能教程，忍不住分享一下给大家。教程不仅是零基础，通俗易懂，而且非常风趣幽默，像看小说一样！觉得太牛了，所以分享给大家。[点这里可以跳转到教程][Link 1]。

### 为何要使用Lombok ###

> 我们在开发过程中，通常都会定义大量的JavaBean，然后通过IDE去生成其属性的构造器、getter、setter、equals、hashcode、toString方法，当要增加属性或者对某个属性进行改变时，比如命名、类型等，都需要重新去生成上面提到的这些方法。这样重复的劳动没有任何意义，Lombok里面的注解可以轻松解决这些问题。

### Lombok简介 ###

> Lombok是一个可以通过简单的注解形式来帮助我们简化消除一些必须有但显得很臃肿的Java代码的工具，通过使用对应的注解，可以在编译源码的时候生成对应的方法。官方地址：[https://projectlombok.org/][https_projectlombok.org]，github地址：[https://github.com/rzwitserloot/lombok][https_github.com_rzwitserloot_lombok]。

### Lombok问题 ###

> 无法支持多种参数构造器的重载

### Lombok使用 ###

1.添加maven依赖

<dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.16.6</version>
    </dependency>

2.idea中需要添加插件才能支持Lombok（**IntelliJ Lombok plugin**）；

3.Lombok的使用，介绍了几个常用的注解

> **@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的组合，通常情况下，基本上使用这些注解就足够了。  
> 更多的请参见：[https://projectlombok.org/features/index.html][https_projectlombok.org_features_index.html]。

附录：

## Lombok注解 ##

*  @Data：注解在类上，将类提供的所有属性都添加get、set方法，并添加、equals、canEquals、hashCode、toString方法
 *  @Setter：注解在类上，为所有属性添加set方法、注解在属性上为该属性提供set方法
 *  @Getter：注解在类上，为所有的属性添加get方法、注解在属性上为该属性提供get方法
 *  @NotNull：在参数中使用时，如果调用时传了null值，就会抛出空指针异常
 *  @Synchronized 用于方法，可以锁定指定的对象，如果不指定，则默认创建一个对象锁定
 *  @Log作用于类，创建一个log属性
 *  @Builder：使用builder模式创建对象
 *  @NoArgsConstructor：创建一个无参构造函数
 *  @AllArgsConstructor：创建一个全参构造函数
 *  @ToStirng：创建一个toString方法
 *  @Accessors(chain = true)使用链式设置属性，set方法返回的是this对象。
 *  （链式设置属性举例：
 *  ![20180611193211200][]
 *  @RequiredArgsConstructor：创建对象
 *  @UtilityClass:工具类
 *  @ExtensionMethod:设置父类
 *  @FieldDefaults：设置属性的使用范围，如private、public等，也可以设置属性是否被final修饰。
 *  @Cleanup: 关闭流、连接点。
 *  @EqualsAndHashCode：重写equals和hashcode方法。
 *  @toString：创建toString方法。

## 一些使用的例子 ##

### 普通的bean： ###

public class User { private String id; private String name; private Integer age; public String getId() { return id; } public void setId(String id) { this.id = id; } public String getName() { return name; } public void setName(String name) { this.name = name; } public Integer getAge() { return age; } public void setAge(Integer age) { this.age = age; } }

### 使用 lambok时 ###

使用lombok，代码可以变得非常的简洁，看着也舒服。

@Setter @Getter public class User { private String id; private String name; private Integer age; } public static void main(String[] args) { User user = new User(); user.setId("1"); user.setName("name"); user.setAge(1); }

## @Accessors(chain = true)：使用链式创建: ##

@Setter @Getter @Accessors(chain = true) public class User { private String id; private String name; private Integer age; } public static void main(String[] args) { //使用@Accessors(chain = true) User userChain = new User(); userChain.setId("1").setName("chain").setAge(1); }

## @Builder：使用builder模式创建对象 ##

@Setter @Getter @Builder public class User { private String id; private String name; private Integer age; } public static void main(String[] args) { User user = User.builder().id("1").name("builder").age(1).build(); System.out.println(user.getId()); }

## @UtilityClass：工具类注解 ##

@UtilityClass public class Utility { public String getName() { return "name"; } } public static void main(String[] args) { // Utility utility = new Utility(); 构造函数为私有的, System.out.println(Utility.getName()); }

转自：https://www.jianshu.com/p/ed3d5e868825 与 https://www.jianshu.com/p/2ea9ff98f7d6的整合

[Link 1]: https://www.cbedai.net/qq33404395
[https_projectlombok.org]: https://link.jianshu.com?t=https://projectlombok.org/
[https_github.com_rzwitserloot_lombok]: https://link.jianshu.com?t=https://github.com/rzwitserloot/lombok
[https_projectlombok.org_features_index.html]: https://link.jianshu.com?t=https://projectlombok.org/features/index.html
[20180611193211200]: /images/20220522/6b11b50739fd4e2b9f57596810c0b582.png