使用Gson序列化时如何排除枚举类？已尝试@Exclude无效

嘿，我之前也碰到过类似的坑！你说用@Exclude没生效，大概率是踩了注解包或者Gson配置的小问题，下面给你一步步捋清楚：

首先，确认你用对了Gson的@Exclude注解 #

一定要导入Gson官方的注解包，很多框架都有同名的@Exclude，别搞混了：

import com.google.gson.annotations.Exclude;

排除单个枚举类型字段的正确姿势 #

如果是Java类里有个枚举类型的成员要排除，直接在**这个字段上标记@Exclude**就行，别把注解加在枚举类本身或者枚举的成员上：

public class User {
    private String username;
    private int age;

    // 这个枚举字段会被Gson跳过序列化
    @Exclude
    private UserRole userRole; // UserRole是你的自定义枚举类

    // getter/setter 省略...
}

为什么你的@Exclude没生效？检查这两点： #

• Gson实例的配置冲突：
  如果你是用GsonBuilder创建的实例，并且开启了excludeFieldsWithoutExposeAnnotation()，那只有标记了@Expose的字段才会被序列化。这种情况下，@Exclude依然会生效，但你需要给其他需要序列化的字段加上@Expose，或者去掉这个配置。

  举个例子，这种配置下的注意事项：

  // 此配置下，仅带@Expose的字段会被序列化，@Exclude标记的字段始终被跳过
  Gson gson = new GsonBuilder()
      .excludeFieldsWithoutExposeAnnotation()
      .create();
  

• 注解加错了位置：
  你提到在枚举类或单个枚举成员上加了注解——如果目标是排除Java对象中的枚举字段，注解必须加在包含枚举的Java类的字段上，而不是枚举类本身哦！

全局排除某个枚举类的序列化（所有场景下都不转） #

如果是想让某个枚举类在任何地方被用到时，都不被Gson序列化，可以用TypeAdapter做全局配置：

Gson gson = new GsonBuilder()
    .registerTypeAdapter(UserRole.class, new TypeAdapter<UserRole>() {
        @Override
        public void write(JsonWriter out, UserRole value) throws IOException {
            // 不写入任何内容，或者写入null值
            out.nullValue();
        }

        @Override
        public UserRole read(JsonReader in) throws IOException {
            // 反序列化时跳过该值，按需返回null或抛出异常
            in.skipValue();
            return null;
        }
    })
    .create();

这样不管哪个Java类里用到UserRole枚举，都会被Gson跳过序列化啦。

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