如何使用SnakeYAML序列化Java Bean到YAML文件时忽略部分字段

当然有办法，下面是几种常用的实现方式，按需选择：

1. 使用SnakeYAML自带的@YamlIgnore注解 #

这是最直观的方式，直接给你不想序列化的字段加上这个注解即可，SnakeYAML在序列化时会自动跳过这些字段。

示例代码：

import org.yaml.snakeyaml.annotations.YamlIgnore;

public class User {
    private String username;
    private String email;
    
    // 这个字段会被忽略
    @YamlIgnore
    private String password;

    // 构造器、getter/setter省略
}

// 序列化代码
import org.yaml.snakeyaml.Yaml;
import java.io.FileWriter;
import java.io.IOException;

public class SerializeDemo {
    public static void main(String[] args) throws IOException {
        User user = new User("john_doe", "john@example.com", "123456");
        Yaml yaml = new Yaml();
        try (FileWriter writer = new FileWriter("user.yaml")) {
            yaml.dump(user, writer);
        }
    }
}

生成的YAML文件里不会包含password字段。

2. 使用Java的transient关键字 #

SnakeYAML默认会忽略被transient修饰的字段，这种方式不需要引入额外注解，适合不想依赖SnakeYAML特定注解的场景。

示例代码：

public class User {
    private String username;
    private String email;
    
    // 被transient修饰，序列化时忽略
    private transient String password;

    // 构造器、getter/setter省略
}

注意：transient是Java原生关键字，它同时会让该字段在Java原生序列化中也被忽略，如果你的类需要同时支持原生序列化，要谨慎使用。

3. 自定义Representer实现灵活过滤 #

如果需要动态决定忽略哪些字段，或者不想修改实体类的代码，可以自定义Representer来过滤属性。

示例代码：

import org.yaml.snakeyaml.introspector.Property;
import org.yaml.snakeyaml.introspector.PropertyUtils;
import org.yaml.snakeyaml.representer.Representer;

import java.util.List;
import java.util.stream.Collectors;

public class CustomRepresenter extends Representer {
    private final List<String> ignoredFields;

    public CustomRepresenter(List<String> ignoredFields) {
        this.ignoredFields = ignoredFields;
        this.propertyUtils = new PropertyUtils() {
            @Override
            public List<Property> getProperties(Class<?> type) {
                // 过滤掉指定字段
                return super.getProperties(type).stream()
                        .filter(p -> !ignoredFields.contains(p.getName()))
                        .collect(Collectors.toList());
            }
        };
    }
}

// 使用自定义Representer进行序列化
public class SerializeDemo {
    public static void main(String[] args) throws IOException {
        User user = new User("john_doe", "john@example.com", "123456");
        // 指定要忽略的字段
        CustomRepresenter representer = new CustomRepresenter(List.of("password"));
        Yaml yaml = new Yaml(representer);
        try (FileWriter writer = new FileWriter("user.yaml")) {
            yaml.dump(user, writer);
        }
    }
}

这种方式的优势是可以在序列化时动态指定忽略的字段，不需要修改实体类，适合多场景复用同一实体类的情况。

内容的提问来源于stack exchange，提问作者zjffdu