【插件】 lombok 引入和使用

╰半夏微凉° 2023-02-12 13:29 19阅读 0赞

# 一、 lombok 的作用 #

在编写实体 bean 中经常会有大量的 Getter/Setter 以及 toString等方法，造成许多无用的代码，影响开发的体验。且随着需求修改我们需要改动 bean 时，又需要把这些方法删掉重新生成，浪费了时间。

lombok 则帮我们解决了这个问题，它能够在编译源码的过程中，自动帮助开发者生成 Getter/Setter 以及 toString 等方法的代码，使开发者无需再写 Getter/Setter 以及 toString等方法。

# 二、引入和使用 #

## 2.1 引入 lombok ##

<dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.12</version>
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-log4j12</artifactId>
        <version>1.7.25</version>
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.25</version>
    </dependency>

**引入 log4j配置文件： log4j.properties**

log4j.rootLogger=info, stdout, R
    
    log4j.appender.stdout=org.apache.log4j.ConsoleAppender
    log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
    
    log4j.appender.stdout.layout.ConversionPattern=%5p - %m%n
    
    log4j.appender.R=org.apache.log4j.RollingFileAppender
    log4j.appender.R.File=firestorm.log
    
    log4j.appender.R.MaxFileSize=100KB
    log4j.appender.R.MaxBackupIndex=1
    
    log4j.appender.R.layout=org.apache.log4j.PatternLayout
    log4j.appender.R.layout.ConversionPattern=%p %t %c - %m%n
    
    log4j.logger.com.codefutures=INFO

### 2.2 基本使用 ###

在类中使用 @Data 表明这个 bean 需要 lombok 对他进行补全。

import lombok.Data;
    
    /**
     * 封装文件上传信息
     */
    @Data
    public class FastDFSFile {
    
        // 文件名
        private String name;
        // 文件内容
        private byte[] content;
        // 文件扩展名
        private String md5;
        // 文件创建作者
        private String author;
    
        public FastDFSFile(String name, byte[] content, String md5, String author) {
            this.name = name;
            this.content = content;
            this.md5 = md5;
            this.author = author;
        }
    }

## 2.3 其他使用 ##

主要是基于标注来进行信息的封装和使用：

<table> 
 <tbody> 
  <tr> 
   <td style="width:106px;"><strong>类型</strong></td> 
   <td style="width:394px;"><strong>注解名</strong></td> 
   <td style="width:380px;"><strong>作用</strong></td> 
  </tr> 
  <tr> 
   <td colspan="1" style="width:106px;">类注解</td> 
   <td style="width:394px;">@Data</td> 
   <td style="width:380px;">&nbsp;@Getter/@Setter, @ToString, @EqualAndHashCode等的组合</td> 
  </tr> 
  <tr> 
   <td style="width:394px;">@Getter</td> 
   <td style="width:380px;">自动生成Getter方法</td> 
  </tr> 
  <tr> 
   <td style="width:394px;">@Setter</td> 
   <td style="width:380px;">自动生成Setter方法</td> 
  </tr> 
  <tr> 
   <td style="width:394px;">@ToString</td> 
   <td style="width:380px;">覆盖tostring方法</td> 
  </tr> 
  <tr> 
   <td style="width:394px;">@EqualsAndHashCode</td> 
   <td style="width:380px;">覆盖equal和hashCode方法</td> 
  </tr> 
  <tr> 
   <td style="width:394px;">@NoArgsConstructor</td> 
   <td style="width:380px;">生成一个无参构造方法</td> 
  </tr> 
  <tr> 
   <td style="width:394px;">@AllArgsConstructor</td> 
   <td style="width:380px;">生成一个包含全部参数的构造方法</td> 
  </tr> 
  <tr> 
   <td style="width:394px;">&nbsp;&nbsp;@Slf4j</td> 
   <td style="width:380px;">默认使用slf4j的日志对象</td> 
  </tr> 
  <tr> 
   <td colspan="3" style="width:106px;">&nbsp;</td> 
  </tr> 
  <tr> 
   <td style="width:106px;">属性注解</td> 
   <td style="width:394px;">@NonNull</td> 
   <td style="width:380px;">标识对象是否为空，为空则抛出异常</td> 
  </tr> 
 </tbody> 
</table>