提高代码优雅-Lombok代替Getter/Setter方法

旧城等待， 2022-06-08 11:18 205阅读 0赞

## 前言 ##

大家经常在编写实体类Model的时候，需要生成Getter/Setter方法，如果一个Model类很多字段的时候，Model类的代码将会很多，造成很难看，不优雅

## Lombok快速入门 ##

为了提高代码优雅，引入了Lombok(lombok.\*包)

lombok 的官方网址：[http://projectlombok.org/][http_projectlombok.org]

让IDE支持lombok，如果不安装插件，IDE是无法解析Lombok的注解

*  IDEA   
    File –> Settings –> Plugins –> Browse reposiories –> 输入lombok   
    ![这里写图片描述][SouthEast]
 *  Eclipse/MyEclipse

手动安装 lombok

1. 将 lombok.jar 复制到 myeclipse.ini / eclipse.ini 所在的文件夹目录下
    2. 打开 eclipse.ini / myeclipse.ini，在最后面插入以下两行并保存：
            -Xbootclasspath/a:lombok.jar
            -javaagent:lombok.jar
    3.重启 eclipse / myeclipse
     
      
       1
       2
       3
       4
       5

*  如果是Maven项目，在Maven项目中引入：

<dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.16.16</version>
        <scope>provided</scope>
    </dependency>
     
      
       1
       2
       3
       4
       5
       6

*  如果是普通的WEB项目，直接拷贝Jar到工程下面的lib目录

没编写@Data注解之前，属性也是直接灰色，这个时候在new完对象以后，是无法调用getter/setter方法的。

![这里写图片描述][SouthEast 1]

加上注解完毕以后

![这里写图片描述][SouthEast 2]

![这里写图片描述][SouthEast 3]

可以看到是可以有属性的getter/setter方法，跟我们直接编写或者生成getter/setter方法是一致的

## Lombok详细解析 ##

Lombok 注解在线帮助文档：[http://projectlombok.org/features/index][http_projectlombok.org_features_index]

@Data：注解在类上；提供类所有属性的 getting 和 setting 方法，此外还提供了equals、canEqual、hashCode、toString 方法
    
    @Setter：注解在属性上；为属性提供 setting 方法
    
    @Getter：注解在属性上；为属性提供 getting 方法
    
    @Log4j2 ：注解在类上；为类提供一个 属性名为log 的 log4j 日志对象，和@Log4j注解类似
    
    @NoArgsConstructor：注解在类上；为类提供一个无参的构造方法
    
    @AllArgsConstructor：注解在类上；为类提供一个全参的构造方法
    
    @EqualsAndHashCode:默认情况下，会使用所有非瞬态(non-transient)和非静态(non-static)字段来生成equals和hascode方法，也可以指定具体使用哪些属性。
    
    @toString:生成toString方法，默认情况下，会输出类名、所有属性，属性会按照顺序输出，以逗号分割。
    
    @NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor
    无参构造器、部分参数构造器、全参构造器，当我们需要重载多个构造器的时候，只能自己手写了
    
    @NonNull：注解在属性上，如果注解了，就必须不能为Null
    
    @val:注解在属性上，如果注解了，就是设置为final类型，可查看源码的注释知道
    
     
      
       1
       2
       3
       4
       5
       6
       7
       8
       9
       10
       11
       12
       13
       14
       15
       16
       17
       18
       19
       20
       21
       22
       23

例子：

如果我需要静态构造器，查看源码发现有个@Data有个staticConstructor
    代码如下：
    
    /** * Created by Nick on 2017/6/10. */
    @Data(staticConstructor = "getInstance")
    public class LombokTestModel { 
    
        private Integer id;
    
        private String name;
    
        private String desc;
    
    }
    
    使用中如下：
    LombokTestModel lombokTestModel = LombokTestModel.getInstance();
    lombokTestModel.setName("Nick");
    System.out.println(lombokTestModel.getName());
     
      
       1
       2
       3
       4
       5
       6
       7
       8
       9
       10
       11
       12
       13
       14
       15
       16
       17
       18
       19
       20
       21

![这里写图片描述][SouthEast 4]

![这里写图片描述][SouthEast 5]

上面例子，假如对id注解了@NonNull，那么可以发现LombokTestModel lombokTestModel = LombokTestModel.getInstance();报错了，必须要对id赋值

如下代码：

LombokTestModel lombokTestModel = LombokTestModel.getInstance(1);
     
      
       1

下面是@val的Demo   
![这里写图片描述][SouthEast 6]

![这里写图片描述][SouthEast 7]

[http_projectlombok.org]: http://projectlombok.org/
[SouthEast]: /images/20220608/ce941e95c36a496391b2b7fdd74181b9.png
[SouthEast 1]: /images/20220608/33aceb81797b454184af12f79a9b0e66.png
[SouthEast 2]: /images/20220608/efb8062b6a434a2e90a81e2d2c092443.png
[SouthEast 3]: /images/20220608/86cec8b3419f4ab298bffa7b1fa129ba.png
[http_projectlombok.org_features_index]: http://projectlombok.org/features/index
[SouthEast 4]: /images/20220608/37a73ed9a10c4714864476807bea9e3b.png
[SouthEast 5]: /images/20220608/9d9971c15e96413daf7280cc07c34ab2.png
[SouthEast 6]: /images/20220608/31ad9c9324b142e19875ed3687879af9.png
[SouthEast 7]: /images/20220608/b7c209ff27374250a9f0f4c27a069752.png