Lombok 快速入門

• Lombok其實(shí)就是取名自龍目島（Pulau Lombok），龍目島是印度尼西亞西努沙登加拉(Nusa Tenggara Barat)省島嶼，西隔龍目海峽面對(duì)巴厘島，東隔阿拉斯(Alas)海峽面松巴哇(Sumbawa)島，北瀕爪哇海，南臨印度洋。

• 在編程上，Lombok是一個(gè)可以通過簡單的注解形式來幫助我們簡化消除一些必須有但顯得很臃腫的Java代碼的工具，通過使用對(duì)應(yīng)的注解，可以在編譯源碼的時(shí)候生成對(duì)應(yīng)的方法。簡而言之，一句話就是：通過簡單的注解來精簡代碼達(dá)到消除冗長代碼的目的。

• Lombok官網(wǎng)：https://projectlombok.org/

• github地址：https://github.com/rzwitserloot/lombok

• 提高編碼效率

• 使代碼更簡潔

• 消除冗長代碼

• 避免修改字段名字時(shí)忘記修改方法名

public class Mountain{
    private String name;
    private double longitude;
    private String country;
}

@Data
public class Mountain{
    private String name;
    private double longitude;
    private String country;
}

• Lombok 實(shí)現(xiàn)了 JSR 269 Pluggable Annotation Processing API 規(guī)范，也就是可插拔注釋處理

• javac 從 JDK6 開始支持 “JSR 269 API” 規(guī)范

• 只要程序?qū)崿F(xiàn)了該API，就能在javac運(yùn)行的時(shí)候得到調(diào)用

• 而Lombok實(shí)現(xiàn)了 “JSR 269 API” 規(guī)范 ，在編譯時(shí)，javac編譯源碼的具體流程如下：

<dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <version>1.16.18</version>
  </dependency>

java -jar lombok.jar

以上只列出了部分常用注解，更多注解的使用方式，請(qǐng)參考 官網(wǎng)關(guān)于注解的文檔

• Java Decompiler

• JD 官網(wǎng)地址

• 分為以下幾類

• JD-GUI，獨(dú)立的圖形化軟件

• JD-Eclipse，可以集成到Eclipse插件

• JD-Intellij，可以集成到IDEA插件

• 在類需要序列化、反序列化時(shí)或者需要詳細(xì)控制字段時(shí)，應(yīng)該謹(jǐn)慎考慮是否要使用Lombok，因?yàn)樵谶@種情況下容易出問題。例如：Jackson、Json 序列化

• 使用Lombok雖然能夠省去手動(dòng)創(chuàng)建setter和getter方法等繁瑣事情，但是卻降低了源代碼文件的可讀性和完整性，減低了閱讀源代碼的舒適度

• 使用@Slf4j還是@Log4j注解，需要根據(jù)實(shí)際項(xiàng)目中使用的日志框架來選擇。

• Lombok并非處處適用，我們需要選擇適合的地方使用Lombok，例如pojo是一個(gè)好地方，因?yàn)閜ojo很單純

package org.mmall.pojo;

import lombok.*;

import java.util.Date;

@Data
@NoArgsConstructor
@AllArgsConstructor
@EqualsAndHashCode(of = "id")
@ToString(exclude = "updateTime")
public class Category {
    private Integer id;

    private Integer parentId;

    private String name;

    private Boolean status;

    private Integer sortOrder;

    private Date createTime;

    private Date updateTime;

}

package org.mmall.pojo;

import java.beans.ConstructorProperties;
import java.util.Date;

public class Category {
    private Integer id;
    private Integer parentId;
    private String name;
    private Boolean status;
    private Integer sortOrder;
    private Date createTime;
    private Date updateTime;

    public Integer getId() {
        return this.id;
    }

    public Integer getParentId() {
        return this.parentId;
    }

    public String getName() {
        return this.name;
    }

    public Boolean getStatus() {
        return this.status;
    }

    public Integer getSortOrder() {
        return this.sortOrder;
    }

    public Date getCreateTime() {
        return this.createTime;
    }

    public Date getUpdateTime() {
        return this.updateTime;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public void setParentId(Integer parentId) {
        this.parentId = parentId;
    }

    public void setName(String name) {
        this.name = name;
    }

    public void setStatus(Boolean status) {
        this.status = status;
    }

    public void setSortOrder(Integer sortOrder) {
        this.sortOrder = sortOrder;
    }

    public void setCreateTime(Date createTime) {
        this.createTime = createTime;
    }

    public void setUpdateTime(Date updateTime) {
        this.updateTime = updateTime;
    }

    public Category() {
    }

    @ConstructorProperties({"id", "parentId", "name", "status", "sortOrder", "createTime", "updateTime"})
    public Category(Integer id, Integer parentId, String name, Boolean status, Integer sortOrder, Date createTime, Date updateTime) {
        this.id = id;
        this.parentId = parentId;
        this.name = name;
        this.status = status;
        this.sortOrder = sortOrder;
        this.createTime = createTime;
        this.updateTime = updateTime;
    }

    public boolean equals(Object o) {
        if (o == this) {
            return true;
        } else if (!(o instanceof Category)) {
            return false;
        } else {
            Category other = (Category)o;
            if (!other.canEqual(this)) {
                return false;
            } else {
                Object this$id = this.getId();
                Object other$id = other.getId();
                if (this$id == null) {
                    if (other$id != null) {
                        return false;
                    }
                } else if (!this$id.equals(other$id)) {
                    return false;
                }

                return true;
            }
        }
    }

    protected boolean canEqual(Object other) {
        return other instanceof Category;
    }

    public int hashCode() {
        int PRIME = true;
        int result = 1;
        Object $id = this.getId();
        int result = result * 59 + ($id == null ? 43 : $id.hashCode());
        return result;
    }

    public String toString() {
        return "Category(id=" + this.getId() + ", parentId=" + this.getParentId() + ", name=" + this.getName() + ", status=" + this.getStatus() + ", sortOrder=" + this.getSortOrder() + ", createTime=" + this.getCreateTime() + ")";
    }
}

package org.mmall.pojo;

import lombok.Getter;
import lombok.NonNull;
import lombok.RequiredArgsConstructor;
import lombok.Setter;

@Getter
@Setter
@RequiredArgsConstructor(staticName = "getInstance")
public class Test {
    private String name;

    @NonNull
    private int age;
}

package org.mmall.pojo;

import java.beans.ConstructorProperties;
import lombok.NonNull;

public class Test {
    private String name;
    @NonNull
    private int age;

    public String getName() {
        return this.name;
    }

    @NonNull
    public int getAge() {
        return this.age;
    }

    public void setName(String name) {
        this.name = name;
    }

    public void setAge(@NonNull int age) {
        this.age = age;
    }

    @ConstructorProperties({"age"})
    private Test(@NonNull int age) {
        this.age = age;
    }

    public static Test getInstance(@NonNull int age) {
        return new Test(age);
    }
}

...
@Service("iCategoryService")
@Slf4j
public class CategoryServiceImpl implements ICategoryService {

    public ServerResponse<List<Category>> getChildrenParallelCategory(Integer categoryId) {
        List<Category> categoryList = categoryMapper.selectCategoryChildrenByParentId(categoryId);
        if (CollectionUtils.isEmpty(categoryList)) {
            log.info("未找到當(dāng)前分類的子分類");
        }
        return ServerResponse.createBySuccess(categoryList);
    }
}

...
@Service("iCategoryService")
public class CategoryServiceImpl implements ICategoryService {

    private static final Logger log = LoggerFactory.getLogger(CategoryServiceImpl.class);

    public ServerResponse<List<Category>> getChildrenParallelCategory(Integer categoryId) {
        List<Category> categoryList = this.categoryMapper.selectCategoryChildrenByParentId(categoryId);
        if (CollectionUtils.isEmpty(categoryList)) {
            log.info("未找到當(dāng)前分類的子分類");
        }
        return ServerResponse.createBySuccess(categoryList);
    } 
}