Lombok的@Accessors使用说明
作者：付聪1210
这篇文章主要介绍了Lombok的@Accessors使用说明,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
@Accessors 是 Lombok 库中的一个注解，用于定制生成 getter 和 setter 方法的行为。
它通常与 @Getter 和 @Setter 注解一起使用，以简化代码并增强可读性。
以下是 @Accessors 的详细介绍：
1. 基本功能
@Accessors 允许开发者通过配置参数，控制生成的 getter 和 setter 方法的命名规则和行为。它支持以下参数：
| 参数 | 作用 |
|---|---|
| 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 方法的行为。它特别适合需要 链式调用 或 简洁方法名 的场景，能够显著减少样板代码，提升开发效率。
以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。