使用lombok减少编写Java样板代码

阳光穿透心脏的1/2处 2023-07-08 09:03 8阅读 0赞

### 文章目录 ###

*  使用lombok减少编写Java样板代码
 *   *  引入lombok依赖
     *  安装lombok插件
     *  用@Data注解来修饰POJO类
     *  用@Builder注解来支持流式编程
     *  用@Slf4j注解来引入logger
     *  用\`@RequiredArgsConstructor\` 来注入一个需要所有属性的构造方法
     *  用\`@SneakyThrows\` 简化方法抛出异常声明
     *  用\`@UtilityClass\` 简化工具类
     *  其它用法
     *  参考文档
     *  扩展阅读

# 使用lombok减少编写Java样板代码 #

lombok用来简化Java编程中的编写样板代码（boilerplate code）的重复工作，比如POJO类中的setters/getters方法、构造方法、toString()方法、equals()方法和hashCode()方法，比如获取日志logger的方法等。

相比使用IDE的generate code功能，使用lombok可以在修改类属性后，不需要再重新生成相应的方法代码，使得代码更为简洁。

## 引入lombok依赖 ##

在pom.xml中添加lombok依赖：

<dependency>
    	<groupId>org.projectlombok</groupId>
    	<artifactId>lombok</artifactId>
    	<version>1.18.10</version>
    	<scope>provided</scope>
    </dependency>

lombok的scope为`provided`，即lombok依赖只在编译阶段生效，不会被打入包中。  
因为lombok在编译期会将带lombok注解的Java文件编译为完整的Class文件，因此在运行时并不需要lombok依赖。

## 安装lombok插件 ##

在IDEA中安装lombok插件，使得IDEA可以支持lombok。

## 用@Data注解来修饰POJO类 ##

参考：

[https://projectlombok.org/features/Data][https_projectlombok.org_features_Data]

定义一个Person类，并使用`@Data`注解修饰该类。

package me.cookcode.lombokdemo;
    
    import lombok.Data;
    
    import java.util.Date;
    
    @Data
    public class Person { 
        private final String firstName;
        private final String lastName;
        private String address;
        private String city;
        private String state;
        private String zip;
        private final Date dateOfBirth;
        private boolean married;
        private int age;
        private float height;
    }

在IDEA中按下`ALT` \+ `7`来打开一个类的Structure（大纲视图，Outline）。

可以看到Person类中自动多了以下方法：

*  setters/getters方法，对布尔值的字段自动转换为is开头的方法
 *  构造方法
 *  equals()方法
 *  hashCode()方法
 *  toString()方法

也可以使用`@Setter`和`@Getter`对属性字段作更加精细的控制，比如控制属性字段只读、属性字段方法的访问级别。

> Spring Boot + Spring Data JPA + Lombok + 自动化生成JPA Entity和Repository，可以大大地简化Java数据库编程。

## 用@Builder注解来支持流式编程 ##

参考：  
[https://projectlombok.org/features/Builder][https_projectlombok.org_features_Builder]

@Builder和@Data配合食用，效果更佳呃，再也不用傻傻地写`return this;`了。

## 用@Slf4j注解来引入logger ##

参考：

[https://projectlombok.org/features/log][https_projectlombok.org_features_log]

使用`@Slf4j`后，可以直接使用log.info()，或log.debug()，或log.error()方法，而不用每个类中都要定义一次logger：

private final Logger log = LoggerFactory.getLogger(AccessingDataMysqlApplication.class)

示例：

package me.cookcode.accessingdatamysql;
    
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @Slf4j
    @SpringBootApplication
    public class AccessingDataMysqlApplication { 
    
        public static void main(String[] args) { 
            log.info("Start AccessingDataMysqlApplication...");
        	SpringApplication.run(AccessingDataMysqlApplication.class, args);
        }
    }

## 用`@RequiredArgsConstructor` 来注入一个需要所有属性的构造方法 ##

可用`@RequiredArgsConstructor` 来简化bean的注入。

@RestController
    @RequiredArgsConstructor
    public class HelloController { 
    
        private final HelloService helloService;
    
        @GetMapping("/hello")
        String hello(@RequestParam String name) { 
            return helloService.hello(name);
        }
    }

@Service
    public class HelloService { 
    
        String hello(String name) { 
            return "Hello, " + name;
        }
    }

## 用`@SneakyThrows` 简化方法抛出异常声明 ##

public class SneakyThrowDemo { 
    
        @SneakyThrows
        public void sneakyThrowException() { 
            throw new Exception();
        }
    
        public void throwException() throws Exception { 
            throw new Exception();
        }
    }

## 用`@UtilityClass` 简化工具类 ##

用`@UtilityClass` 可以自动：

*  定义一个私有构造方法，防止工具类被实例化
 *  将工具类定义为`final` 类，防止被继承
 *  将类的所有方法定义为`static` 方法

用`@UtilityClass` 的例子：

@UtilityClass
    public class CoolUtils { 
        public String bearerToken(String token) { 
            return "Authorization: Bearer " + token;
        }
    }

不用`@UtilityClass` 的例子：

public final class UtilityClass { 
    
        private UtilityClass() { 
        }
    
        public static String bearerToken(String token) { 
            return "Authorization: Bearer " + token;
        }
    }

## 其它用法 ##

lombok的特性列表：

[https://projectlombok.org/features][https_projectlombok.org_features]

> 需要注意的是lombok本质上提供的是一种“语法糖”，恰当使用可以简化编码工作，但是过度使用反而增加代码维护的复杂性。比如可以放心使用`@Getter`, `@Setter`, `@Slf4j`和`@Builder`，但是对其他的注解要在明白其原理后再谨慎使用。

## 参考文档 ##

*  [https://projectlombok.org/][https_projectlombok.org]
 *  [https://projectlombok.org/features/all][https_projectlombok.org_features_all]
 *  [https://objectcomputing.com/resources/publications/sett/january-2010-reducing-boilerplate-code-with-project-lombok][https_objectcomputing.com_resources_publications_sett_january-2010-reducing-boilerplate-code-with-project-lombok]
 *  [Lombok的基本使用][Lombok]
 *  [五分钟学会 Java 开发效率神器 Lombok][Java _ Lombok]

## 扩展阅读 ##

*  [Lombok makes Java cool again][]
 *  [Good and Bad usage of Lombok][]

[https_projectlombok.org_features_Data]: https://projectlombok.org/features/Data
[https_projectlombok.org_features_Builder]: https://projectlombok.org/features/Builder
[https_projectlombok.org_features_log]: https://projectlombok.org/features/log
[https_projectlombok.org_features]: https://projectlombok.org/features
[https_projectlombok.org]: https://projectlombok.org/
[https_projectlombok.org_features_all]: https://projectlombok.org/features/all
[https_objectcomputing.com_resources_publications_sett_january-2010-reducing-boilerplate-code-with-project-lombok]: https://objectcomputing.com/resources/publications/sett/january-2010-reducing-boilerplate-code-with-project-lombok
[Lombok]: https://www.jianshu.com/p/2543c71a8e45
[Java _ Lombok]: https://mp.weixin.qq.com/s?__biz=MjM5NzMyMjAwMA==&mid=2651486562&idx=1&sn=589b1ee715ebe9e9e1ca5843f05796e2&chksm=bd25151d8a529c0bc3589ed35b8bb648a992d4a56e5e12bb6c9c4ad663d798923488708cba89&mpshare=1&scene=1&srcid=&sharer_sharetime=1583754430371&sharer_shareid=3b67fb804ed3005ff9d2bd31df7d4169&key=e1c2dfa459d4b9748bb89db46eda81480f1e328c4180b3000b731e40f6c287a1570cddf4cc2f5eb62a9dd2657690c1a678615eebac05a672d36724ca3cf5ae10b77015365200c83b9d184d2057583925&ascene=1&uin=NjEzOTk4NzIx&devicetype=Windows+10&version=62080079&lang=zh_CN&exportkey=A9kWcnYHRBASniCtzc24EvM%3D&pass_ticket=4Rm0J%2B8oej%2F%2FlNNN7V5l8O2aCfO6huiBZI530TQBL4m6mB87a6RXGRZ4fcGWrCyb
[Lombok makes Java cool again]: https://bytes.grubhub.com/lombok-makes-java-cool-again-171102bdcc52
[Good and Bad usage of Lombok]: https://medium.com/geekculture/good-and-bad-usage-of-lombok-8c8f70874a93