如何使用Gson序列化/重新序列化枚举

dm7nw8vv  于 2023-10-18  发布在  其他
关注(0)|答案(3)|浏览(126)

我需要序列化/重新序列化一个特定的枚举:

public enum Status {
    ONLINE("online"),
    OFFLINE("offline"),
    UNKNOWN("del") {
        @Override
        public String getStatusOld() {
            return "off";
        }
    };
  
    private final String name;
    Status(String name) {
        this.name = name;
    }

    public String getStatusOld() {
        return name;
    }
    
    public String toString() {
        return name;
    }

    public static Status typeOf(String name) {
        if (!StringUtils.isEmpty(name)) {
            for (Status type : values()) {
                if (type.name.equalsIgnoreCase(name)) {
                    return type;
                }
                if (type.getStatusOld().equalsIgnoreCase(name)) {
                    return type;
                }
            }
        }
        throw new IllegalArgumentException("Unknown status type: " + name);
    }
}

我的POJO看起来像这样:

public class User {
    public String name;
    public Status status;
    ...
}

为了序列化/重新序列化我的enum Status,我创建了自定义序列化器/重新序列化器:

public class GsonStatusEnumSerializer implements JsonSerializer<Status> {
    @Override
    public JsonElement serialize(Status status, Type type, JsonSerializationContext jsonSerializationContext) {
        return new JsonPrimitive(status.toString());
    }
}
public class GsonStatusEnumDeserializer implements JsonDeserializer<Status> {
    @Override
    public Status deserialize(JsonElement jsonElement, Type type, JsonDeserializationContext jsonDeserializationContext) throws JsonParseException {
        if (jsonElement != null && jsonElement.isJsonPrimitive()) {
            final String status = jsonElement.getAsString();
            if (StringUtils.isNotBlank(status)) {
                return Status.typeOf(status);
            }
        }
        return null;
    }
}

当我尝试序列化我的User类时,Status的值为UNKNOWN,我的自定义序列化器没有被Gson用于序列化User的状态。我发现这是因为UNKNOWN的值有不同的类型。

public static void main(String[] args) {
    for (Status value : Status.values()) {
            System.out.println("class = " + value.getClass() + ", value = " + value);
        }
}

我得到的结果如下:

class = class com.test.Status, value = online
class = class com.test.Status$2, value = del
class = class com.test.Status, value = offline

我序列化User POJO的主要方法:

public static void main(String[] args) {
    Gson gson = new GsonBuilder()
                .registerTypeAdapter(Status.class, new GsonStatusEnumDeserializer())
                .registerTypeAdapter(Status.class, new GsonStatusEnumSerializer())
                .create();
    User user = new User();
    user.name = "John";
    user.status = Status.UNKNOWN;
    
    String json = gson.toJson(user);
    User user1 = gson.fromJson(json, User.class);
}

我得到一个例外:

Exception in thread "main" java.lang.IllegalArgumentException: Unknown process type: UNKNOWN
    at com.test.Status.typeOf(Status.java:97)
    at com.test.GsonStatusEnumDeserializer.deserialize(GsonStatusEnumDeserializer.java:22)
    at com.test.GsonStatusEnumDeserializer.deserialize(GsonStatusEnumDeserializer.java:16)

如何通过Gson序列化/重命名它?

v64noz0r

v64noz0r1#

我已经找到了解决方案,我必须为这个类型单独添加一个序列化程序。

public static void main(String[] args) {
    Gson gson = new GsonBuilder()
                .registerTypeAdapter(Status.class, new GsonStatusEnumDeserializer())
                .registerTypeAdapter(Status.class, new GsonStatusEnumSerializer())
                .registerTypeAdapter(Status.UNKNOWN.getClass(), new GsonStatusEnumSerializer())
                .create();
    User user = new User();
    user.name = "John";
    user.status = Status.UNKNOWN;
    
    String json = gson.toJson(user);
    User user1 = gson.fromJson(json, User.class);
}

我不喜欢这种方法,但它对我有效。

oo7oh9g9

oo7oh9g92#

com.test.Status$2com.test.Status的后代,因此只需使用registerTypeHierarchyAdapter(而不是registerTypeAdapter

registerTypeHierarchyAdapter(Status.class, new GsonStatusEnumSerializer())
gpnt7bae

gpnt7bae3#

快速修复:如果你真的需要你的代码工作,删除UNKNOWN(“del”)后面的花括号

我试着复制你的代码,但我不太明白你的一些决定背后的需要,所以如果这不适用,请提供额外的澄清。有几点:

KISS:过度工程化我认为你的很多代码是不必要的,所以让它保持愚蠢的简单。我们可以将状态简化为:

状态枚举:

public enum Status {
    ONLINE,
    OFFLINE,
    UNKNOWN
}

似乎有一些关于enum实际上在做什么的困惑。枚举只是为了方便起见,标识符“ONLINE”、“OFFLINE”和“UNKNOWN”都是Status类型。要检查这一点,我们可以做:

for (Status value : Status.values()){
    System.out.println(value.getClass().getName());
}

我们得到以下输出:

Status
Status
Status

Process finished with exit code 0

这意味着您不必将其转换为字符串,并且根本不需要自定义序列化器和反序列化器!
我知道了
我建议为变量和方法制定一个一致的命名约定。调用一个类GsonStatusEnumSerializer和另一个类GsonProcessTypeEnumDeserializer(状态与进程)可能很难跟踪,并且会让其他人觉得它们没有逻辑连接。
在Status中,有ONLINE('online')OFFLINE('offline'),但有UNKNOWN('del'),这可能是许多混乱的根源(特别是当您重写toString()方法以返回“off”时!)

封装封装是面向对象编程的核心原则,通过getter和setter访问变量可以使代码更安全。
最终输出

public static void main(String[] args) {
        Gson gson = new Gson();
        User user = new User("John", Status.UNKNOWN);

        String json = gson.toJson(user);

        System.out.println(json);

        User user1 = gson.fromJson(json, User.class);

        System.out.println(user1.getName());
        System.out.println(user1.getStatus());
    }

运行上面的命令会产生以下输出:

{"name":"John","status":"UNKNOWN"}
John
UNKNOWN

Process finished with exit code 0

祝你在所有的编码工作中好运:)

相关问题