Lombok的@Accessors使用說明

更新時間：2025年03月25日 09:51:56 作者：付聰1210

這篇文章主要介紹了Lombok的@Accessors使用說明,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

1. 基本功能

@Accessors 允許開發(fā)者通過配置參數，控制生成的 getter 和 setter 方法的命名規(guī)則和行為。它支持以下參數：

參數	作用
chain	是否啟用鏈式調用（Fluent API），默認為 false。
fluent	是否生成簡潔的 getter/setter 方法名（無 get/set 前綴），默認為 false。
prefix	指定字段名前綴，生成的 getter/setter 方法會忽略這些前綴。

2. 使用示例

2.1 默認行為

import lombok.Getter;
import lombok.Setter;
import lombok.experimental.Accessors;

@Getter
@Setter
@Accessors
public class User {
    
    private String name;
    
    private Integer age;
    
}

生成的代碼：

public class User {
    
    private String name;
    
    private Integer age;

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

    public Integer getAge() { 
        return age;
    }
    
    public void setAge(Integer age) { 
        this.age = age; 
    }
    
}

2.2 啟用鏈式調用（chain = true）

@Getter
@Setter
@Accessors(chain = true)
public class User {
    
    private String name;
    
    private Integer age;
    
}

生成的代碼：

public class User {
    
    private String name;
    
    private Integer age;

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

    public Integer getAge() { 
        return age;
    }
    
    public User setAge(Integer age) { 
        this.age = age; return this; 
    }
    
}

使用示例：

User user = new User().setName("Alice").setAge(25);

2.3 啟用簡潔方法名（fluent = true）

@Getter
@Setter
@Accessors(fluent = true)
public class User {
    
    private String name;
    
    private Integer age;
    
}

生成的代碼：

public class User {
    
    private String name;
    
    private Integer age;

    public String name() { 
        return name; 
    }
    
    public User name(String name) {
        this.name = name; return this;
    }

    public Integer age() { 
        return age; 
    }
    
    public User age(Integer age) { 
        this.age = age; return this; 
    }
    
}

使用示例：

User user = new User().name("Alice").age(25);

2.4 忽略字段前綴（prefix）

@Getter
@Setter
@Accessors(prefix = "m_")
public class User {
    
    private String m_name;
    
    private Integer m_age;
    
}

生成的代碼：

public class User {
    
    private String m_name;
    
    private Integer m_age;

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

    public Integer getAge() {
        return m_age; 
    }
    
    public void setAge(Integer age) {
        this.m_age = age; 
    }
    
}

使用示例：

User user = new User();
user.setName("Alice");
user.setAge(25);

3. 組合使用

可以將多個參數組合使用，例如：

@Getter
@Setter
@Accessors(chain = true, fluent = true, prefix = "m_")
public class User {
    
    private String m_name;
    
    private Integer m_age;
    
}

生成的代碼：

public class User {
    
    private String m_name;
    
    private Integer m_age;

    public String name() {
        return m_name; 
    }
    
    public User name(String name) { 
        this.m_name = name; return this; 
    }

    public Integer age() {
        return m_age; 
    }
    
    public User age(Integer age) { 
        this.m_age = age; return this; 
    }
    
}

4. 注意事項

與 @Data 的兼容性
@Data 已經包含了 @Getter 和 @Setter，因此可以直接與 @Accessors 一起使用。
IDE 支持
確保 IDE 安裝了 Lombok 插件，否則可能無法識別生成的代碼。
代碼可讀性
雖然 @Accessors 可以簡化代碼，但過度使用可能導致代碼可讀性下降，需權衡使用。

5. 總結

@Accessors 是 Lombok 中一個強大的注解，通過配置 chain、fluent 和 prefix 參數，可以靈活定制 getter 和 setter 方法的行為。它特別適合需要 鏈式調用 或 簡潔方法名 的場景，能夠顯著減少樣板代碼，提升開發(fā)效率。

以上為個人經驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

您可能感興趣的文章: