使gson使用枚举字符串值而不是常量名称
有没有办法告诉gson使用字符串值本身,而不是它的Java常量名称? 理想情况下,在gson配置中是全局的,因此它将对所有枚举执行此操作。
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
public class Main {
public static class Dress {
public Color color;
}
public static enum Color {
RED("red"),
BLUE("blue");
private final String type;
Color(final String type) { this.type = type; }
public String toString() { return type; }
}
public static void main(String[] args) throws InterruptedException {
Dress dress = new Dress();
dress.color = Color.RED;
GsonBuilder builder = new GsonBuilder();
builder.setPrettyPrinting();
Gson gson = builder.create();
System.out.println(gson.toJson(dress));
// ==> { "color": "RED" }
}
}
它打印{ "color": "RED" }
而不是{ "color": "red" }
。
解决方案
创建自定义序列化程序,如下所示:
public class EnumSerializer<T extends Enum<T>>
implements JsonSerializer<T> {
@Override
public JsonElement serialize(T src, Type typeOfSrc,
JsonSerializationContext context) {
return new JsonPrimitive(src.toString());
}
}
按如下方式注册:
builder.registerTypeAdapter(Color.class, new EnumSerializer<>());
// there is a reason for generics: that way you can easily register it to
// other Enum types also, for example:
// builder.registerTypeAdapter(SomeEnum.class, new EnumSerializer<>());
如果需要将其应用于多个或所有Enum,并且不希望将其分别注册到每个Enum,则可以使用TypeAdapterFactory(稍微复杂一点)。首先,您需要TypeAdapter:
public class EnumTypeAdapter<T extends Enum<T>> extends TypeAdapter<T> {
@Override
public void write(JsonWriter out, T value) throws IOException {
out.jsonValue(value.toString());
}
@Override
public T read(JsonReader in) throws IOException {
return null;
}
}
然后工厂:
public static class EnumTypeAdapterFactory implements TypeAdapterFactory {
@Override
// Actually it might be easier to just make EnumTypeAdapter non-generic
// but on the other hand it might be better if used in some other contexts
// and in some other ways. Thus these suppressions
@SuppressWarnings({"rawtypes", "unchecked"})
public <T> TypeAdapter<T> create(Gson gson, TypeToken<T> type) {
// This if applies to all Enums. Change if not wanted.
if(Enum.class.isAssignableFrom(type.getRawType())) {
return new EnumTypeAdapter();
} else {
return null;
}
}
}
并注册:
builder.registerTypeAdapterFactory(new EnumTypeAdapterFactory());
相关文章