使用lombok简化开发

Posted 2022-02-08 今夜月色很美

1、在项目中使用lombok

1.1、为什么要使用lombok

永远不需要再编写 getter、setter 或 equals 方法，使用一个注释，您的类就有一个功能齐全的构建器、自动帮您创建日志记录变量等。

1.2、引入maven依赖

		<dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
            <scope>provided</scope>
        </dependency>

1.3、idea配置插件支持

安装插件支持lombok，据说idea 2020版本已经内置lombok支持。

2、Lombok实现原理

自从Java 6起，javac就支持“JSR 269 Pluggable Annotation Processing API”规范，只要程序实现了该API，就能在javac运行的时候得到调用。

Lombok就是一个实现了"JSR 269 API"的程序。在使用javac的过程中，它产生作用的具体流程如下：

1. javac对源代码进行分析，生成一棵抽象语法树(AST)

2. javac编译过程中调用实现了JSR 269的Lombok程序

3. 此时Lombok就对第一步骤得到的AST进行处理，找到Lombok注解所在类对应的语法树 (AST)，然后修改该语法树(AST)，增加Lombok注解定义的相应树节点

4. javac使用修改后的抽象语法树(AST)生成字节码文件

原理介绍参考：https://www.jianshu.com/p/2543c71a8e45

3、常用注解

3.1、@Log

作用于类上，生成日志变量。针对不同的日志实现产品，有不同的注解：

//@CommonsLog
private static final org.apache.commons.logging.Log log = org.apache.commons.logging.LogFactory.getLog(LogExample.class);
//@JBossLog
private static final org.jboss.logging.Logger log = org.jboss.logging.Logger.getLogger(LogExample.class);
//@Log
private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(LogExample.class.getName());
//@Log4j
private static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(LogExample.class);
//@Log4j2
private static final org.apache.logging.log4j.Logger log = org.apache.logging.log4j.LogManager.getLogger(LogExample.class);
//@Slf4j
private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExample.class);
//@XSlf4j
private static final org.slf4j.ext.XLogger log = org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class);

3.2、@Data

作用于类上，是以下注解的集合：@ToString @EqualsAndHashCode @Getter @Setter @RequiredArgsConstructor

提供toString、getter、setter、equals等方法

3.3、@AllArgsConstructor

提供一个全参数的构造方法

3.4、@NoArgsConstructor

提供一个无参构造

3.5、@Cleanup

自动关闭资源，针对实现了java.io.Closeable接口的对象有效，如：典型的IO流对象

4、样例代码

@Data注解

import lombok.Data;

@Data
public class UserDto 
    private Long id;
    private String name;
    private String gender;
    private Integer age;

    private Pet pet;

编译后:

public class UserDto 
    private Long id;
    private String name;
    private String gender;
    private Integer age;
    private Pet pet;

    public UserDto() 
    

    public Long getId() 
        return this.id;
    

    public void setId(Long id) 
        this.id = id;
    

   .....

    public String toString() 
        return "UserDto(id=" + this.getId() + ", name=" + this.getName() + ", gender=" + this.getGender() + ", age=" + this.getAge() + ", pet=" + this.getPet() + ")";
    

@Slf4j

@RestController
@Slf4j
public class UserController 

    @PostMapping("/user/save")
    public UserDto save(UserDto userDto)
        log.info("测试@Slf4j注解打印日志，保存用户:", userDto.toString());
        return userDto;
    

编译后:

@RestController
public class UserController 
    private static final Logger log = LoggerFactory.getLogger(UserController.class);

    .....

@Cleanup

	@Test
    void contextLoads() throws Exception 
        @Cleanup BufferedReader reader = new BufferedReader(new FileReader(new File("C:\\\\file\\\\11.txt")));
        String tempStr;
        while ((tempStr = reader.readLine()) != null) 
            System.out.println(tempStr);
        
    

编译后:

	@Test
    void contextLoads() throws Exception 
        BufferedReader reader = new BufferedReader(new FileReader(new File("C:\\\\file\\\\11.txt")));

        String tempStr;
        try 
            while((tempStr = reader.readLine()) != null) 
                System.out.println(tempStr);
            
         finally 
            if (Collections.singletonList(reader).get(0) != null) 
                reader.close();
            
        
    

源码地址:

https://gitee.com/HaiShangShengMingYue/lombok-demo