詳解SpringBoot優(yōu)雅編碼之Lombok加持
本文介紹了SpringBoot優(yōu)雅編碼之Lombok加持，分享給大家，具體如下：
概述
Lombok 通過(guò)提供簡(jiǎn)單的語(yǔ)法注解形式來(lái)幫助簡(jiǎn)化消除一些必須有但顯得很臃腫的 java 代碼。典型的是對(duì)于 POJO對(duì)象的簡(jiǎn)化（如自動(dòng)幫我們生成Setter和Getter等），有了Lombok的加持，開(kāi)發(fā)人員可以免去很多重復(fù)且臃腫的操作，極大地提高java代碼的信噪比，因此我們必須嘗試并應(yīng)用起來(lái)！
IntelliJ IDEA上配置
方法一：直接在IDEA界面中配置
首先進(jìn)入Plugins界面：
然后搜索并安裝Lombok插件：
最后不要忘了開(kāi)啟Annotation Processors的Enable選項(xiàng)：
上述安裝完成以后需要重啟IDEA生效！
方法二：手動(dòng)下載Lombok插件安裝
有時(shí)由于網(wǎng)絡(luò)原因，上面方法一這種方式安裝失敗，因此只能手動(dòng)下載安裝
下載lombok插件：
https://github.com/mplushnikov/lombok-intellij-plugin/releases
Plugins -> Install plugin from disk... 選擇下載的zip包安裝
重啟idea即可
IDE中設(shè)置完成以后需要在pom.xml中添加如下所示的lombok依賴(lài)才能使用
<dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.16.16</version> </dependency>
Lombok主要注解
@Getter and @Setter/ 自動(dòng)為屬性提供 Set和Get 方法@ToString/ 該注解的作用是為類(lèi)自動(dòng)生成toString()方法@EqualsAndHashCode/ 為對(duì)象字段自動(dòng)生成hashCode和equals實(shí)現(xiàn)@AllArgsConstructor, @RequiredArgsConstructor and @NoArgsConstructor/ 顧名思義，為類(lèi)自動(dòng)生成對(duì)應(yīng)參數(shù)的constructor@Log, @Log4j, @Log4j2, @Slf4j, @XSlf4j, @CommonsLog, @JBossLog/ 自動(dòng)為類(lèi)添加對(duì)應(yīng)的log支持@Data/ 自動(dòng)為所有字段添加@ToString, @EqualsAndHashCode, @Getter，為非final字段添加@Setter,和@RequiredArgsConstructor，本質(zhì)上相當(dāng)于幾個(gè)注解的綜合效果@NonNull/ 自動(dòng)幫助我們避免空指針。作用在方法參數(shù)上的注解，用于自動(dòng)生成空值參數(shù)檢查@Cleanup/ 自動(dòng)幫我們調(diào)用close()方法。作用在局部變量上，在作用域結(jié)束時(shí)會(huì)自動(dòng)調(diào)用close方法釋放資源
下文就Lombok中用的最為頻繁的@Data和@Log注解進(jìn)行代碼實(shí)戰(zhàn)！
@Data注解使用
官網(wǎng)關(guān)于@Data注解的解釋如下：
All together now: A shortcut for @ToString, @EqualsAndHashCode, @Getter on all fields, @Setter on all non-final fields, and @RequiredArgsConstructor!
不難理解，其可以看成是多個(gè)Lombok注解的集成，因此使用很方便！
先來(lái)創(chuàng)建一個(gè)POJO實(shí)體UserLombok，普通的寫(xiě)法如下：
public class UserLombok {
private final String name;
private int age;
private double score;
private String[] tags;
public UserLombok(String name) {
this.name = name;
}
public String getName() {
return this.name;
}
void setAge(int age) {
this.age = age;
}
public int getAge() {
return this.age;
}
public void setScore(double score) {
this.score = score;
}
public double getScore() {
return this.score;
}
public String[] getTags() {
return this.tags;
}
public void setTags(String[] tags) {
this.tags = tags;
}
@Override public String toString() {
return "DataExample(" + this.getName() + ", " + this.getAge() + ", " + this.getScore() + ", " + Arrays.deepToString(this.getTags()) + “)”;
}
protected boolean canEqual(Object other) {
return other instanceof DataExample;
}
@Override public boolean equals(Object o) {
if (o == this) return true;
if (!(o instanceof DataExample)) return false;
DataExample other = (DataExample) o;
if (!other.canEqual((Object)this)) return false;
if (this.getName() == null ? other.getName() != null : !this.getName().equals(other.getName())) return false;
if (this.getAge() != other.getAge()) return false;
if (Double.compare(this.getScore(), other.getScore()) != 0) return false;
if (!Arrays.deepEquals(this.getTags(), other.getTags())) return false;
return true;
}
@Override public int hashCode() {
final int PRIME = 59;
int result = 1;
final long temp1 = Double.doubleToLongBits(this.getScore());
result = (result*PRIME) + (this.getName() == null ? 43 : this.getName().hashCode());
result = (result*PRIME) + this.getAge();
result = (result*PRIME) + (int)(temp1 ^ (temp1 >>> 32));
result = (result*PRIME) + Arrays.deepHashCode(this.getTags());
return result;
}
}
Lombok加持后，寫(xiě)法可簡(jiǎn)化為：
@Data
public class UserLombok {
private final String name;
private int age;
private double score;
private String[] tags;
}
在IDEA中使用時(shí)，Lombok的注解會(huì)自動(dòng)補(bǔ)全，如下圖所示：
我們來(lái)寫(xiě)POJO的測(cè)試代碼
public static void main( String[] args ) {
UserLombok userLombok = new UserLombok("hansonwang99”);
userLombok.setAge(18);
String[] array = new String[]{"apple","juice”};
userLombok.setTags( array );
userLombok.setScore( 99.0 );
System.out.println(userLombok);
}
由下圖我們可以看到IDEA依然可以自動(dòng)為我們補(bǔ)全由Lombok自動(dòng)生成的代碼：
結(jié)果打印
由于Lombok為我們自動(dòng)生成了toString方法，因此對(duì)象的打印結(jié)果如下：
UserLombok(name=hansonwang99, age=18, score=99.0, tags=[apple, juice])
@Log注解實(shí)戰(zhàn)
在我的文章 Spring Boot日志框架實(shí)踐 一文中，我們使用Log4j2來(lái)作為日志對(duì)象，其寫(xiě)法如下：
@RestController
@RequestMapping("/testlogging”)
public class LoggingTestController {
private final Logger logger = LogManager.getLogger(this.getClass());
@GetMapping("/hello”)
public String hello() {
for(int i=0;i<10_0000;i++){
logger.info("info execute index method”);
logger.warn("warn execute index method”);
logger.error("error execute index method”);
}
return "My First SpringBoot Application”;
}
}
若改用Lombok后，寫(xiě)法變得更加簡(jiǎn)潔，我們只需要引入對(duì)應(yīng)的@Log注解即可完成log對(duì)象的生成：
@RestController
@RequestMapping("/testloggingwithlombok”)
@Log4j2
public class LoggingTestControllerLombok {
@GetMapping("/hello”)
public String hello() {
for(int i=0;i<10_0000;i++){
log.info("info execute index method”);
log.warn("warn execute index method”);
log.error("error execute index method”);
}
return "My First SpringBoot Application”;
}
}
怎么樣，是不是一切都是那么地優(yōu)雅！
以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。
相關(guān)文章
Java實(shí)現(xiàn)文件分片上傳接口的示例代碼
這篇文章主要為大家詳細(xì)介紹了如何利用Java語(yǔ)言實(shí)現(xiàn)文件分片上傳的功能，文中的示例代碼講解詳細(xì)，感興趣的小伙伴可以跟隨小編一起了解一下2022-07-07
下面小編就為大家?guī)?lái)一篇J2EE基礎(chǔ)之EJB全面了解。小編覺(jué)得挺不錯(cuò)的，現(xiàn)在就分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2016-07-07
springboot接收J(rèn)SON實(shí)現(xiàn)示例解析
Java畢業(yè)設(shè)計(jì)實(shí)戰(zhàn)之在線(xiàn)網(wǎng)盤(pán)系統(tǒng)的實(shí)現(xiàn)
SpringBoot開(kāi)發(fā)中的數(shù)據(jù)源詳解
解決java.sql.SQLException:索引中丟失 IN或OUT 參數(shù)::x問(wèn)題