My project implements a TypeAdapter
in Gson
during serialization/deserialization for preserving object's polymorphism state. Anyhow, the project works fine during development tests, but when it is released with proguard obfuscation and tested, it just crashes.
03-21 10:06:53.632: E/AndroidRuntime(12441): FATAL EXCEPTION: main
03-21 10:06:53.632: E/AndroidRuntime(12441): java.lang.AssertionError
03-21 10:06:53.632: E/AndroidRuntime(12441): at com.google.gson.internal.bind.TypeAdapters$EnumTypeAdapter.<init>(SourceFile:724)
03-21 10:06:53.632: E/AndroidRuntime(12441): at com.google.gson.internal.bind.TypeAdapters$26.create(SourceFile:753)
03-21 10:06:53.632: E/AndroidRuntime(12441): at com.google.gson.Gson.getAdapter(SourceFile:353)
03-21 10:06:53.632: E/AndroidRuntime(12441): at com.google.gson.internal.bind.ReflectiveTypeAdapterFactory$1.<init>(SourceFile:82)
03-21 10:06:53.632: E/AndroidRuntime(12441): at com.google.gson.internal.bind.ReflectiveTypeAdapterFactory.createBoundField(SourceFile:81)
03-21 10:06:53.632: E/AndroidRuntime(12441): at com.google.gson.internal.bind.ReflectiveTypeAdapterFactory.getBoundFields(SourceFile:118)
03-21 10:06:53.632: E/AndroidRuntime(12441): at com.google.gson.internal.bind.ReflectiveTypeAdapterFactory.create(SourceFile:72)
03-21 10:06:53.632: E/AndroidRuntime(12441): at com.google.gson.Gson.getAdapter(SourceFile:353)
03-21 10:06:53.632: E/AndroidRuntime(12441): at com.google.gson.Gson.toJson(SourceFile:578)
03-21 10:06:53.632: E/AndroidRuntime(12441): at com.google.gson.Gson.toJsonTree(SourceFile:479)
03-21 10:06:53.632: E/AndroidRuntime(12441): at com.google.gson.Gson.toJsonTree(SourceFile:458)
03-21 10:06:53.632: E/AndroidRuntime(12441): at com.google.gson.Gson$3.serialize(SourceFile:137)
My Gson specific proguard configuration is:
##---------------Begin: proguard configuration for Gson ----------
# Gson uses generic type information stored in a class file when working with fields. Proguard
# removes such information by default, so configure it to keep all of it.
-keepattributes Signature
# For using GSON @Expose annotation
-keepattributes *Annotation*
# Gson specific classes
-keep class sun.misc.Unsafe { *; }
#-keep class com.google.gson.stream.** { *; }
# Application classes that will be serialized/deserialized over Gson
-keep class com.google.gson.examples.android.model.** { *; }
#This is extra - added by me to exclude gson obfuscation
-keep class com.google.gson.** { *; }
##---------------End: proguard configuration for Gson ----------
The TypeAdapter I'm using is:
public final class GsonWorkshiftAdapter implements JsonSerializer<IWorkshift>, JsonDeserializer<IWorkshift> {
private static final String CLASSNAME = "CLASSNAME";
private static final String INSTANCE = "INSTANCE";
@Override
public JsonElement serialize(IWorkshift src, Type typeOfSrc, JsonSerializationContext context) {
String className = src.getClass().getCanonicalName();
JsonElement elem = context.serialize(src);
JsonObject retValue = new JsonObject();
retValue.addProperty(CLASSNAME, className);
retValue.add(INSTANCE, elem);
return retValue;
}
@Override
public IWorkshift deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context) throws JsonParseException {
JsonObject jsonObject = json.getAsJsonObject();
JsonPrimitive prim = (JsonPrimitive) jsonObject.get(CLASSNAME);
String className = prim.getAsString();
Class<?> klass = null;
try { klass = Class.forName(className); }
catch (ClassNotFoundException e) { throw new JsonParseException(e.getMessage()); }
return context.deserialize(jsonObject.get(INSTANCE), klass);
}
}
I did a lot of search on this error specific to Gson, but couldn't find any helpful answer. However I found another question with the similar issue.
Any help from developer's community would be appreciated.
It seems like we must request that enumerations' members are kept. Adding this to the proguard config file worked for me:
-keepclassmembers enum * { *; }
Or, if you want to be more specific,
-keepclassmembers enum com.your.package.** { *; }
GSON throws this AssertionError when it fails to deserialize enumeration constants from JSON data, performing introspection on the fields of the enum class. Unfortunately, it swallows the details of the underlying NoSuchFieldException.
You should make sure that you preserve the names of the enum fields (and of fields in general) that are serialized. By default, ProGuard may rename or even remove them. For instance, with some wildcards:
-keepclassmembers class com.example.domain.** {
<fields>;
}
It is already suggested that you need to configure Proguard in a way that it keeps every enum related to serialized objects intact. I don't really like the fact that I have to explicitly list all my enums, this solution is hard to maintain. A slightly better solution I came up with is the following.
Use an empty interface to indicate that a class or enum takes part in Gson serialization:
public interface GsonSerializable { }
public class MyClass implements GsonSerializable {
public enum MyEnum implements GsonSerializable {
enumvalue1, enumvalue2
}
public MyEnum mydata1;
}
Use a Proguard config that keeps both the interface and all classes/enums that implement it:
# keep GsonSerializable interface, it would be thrown away by proguard since it is empty
-keep class com.example.GsonSerializable
# member fields of serialized classes, including enums that implement this interface
-keepclassmembers class * implements com.example.GsonSerializable {
<fields>;
}
# also keep names of these classes. not required, but just in case.
-keepnames class * implements com.example.GsonSerializable
That's it, as long as your classes and enums use the interface, you should be OK. You could also enforce the presence of this interface in your serialization/deserialization methods, so you don't forget it when adding a new class later:
public String serializeWithGson(GsonSerializable object) { ... }
Also in your configuration the line with 'com.google.gson.examples.android.model.** { *; }' refers to some Google related example code, so I don't think it is necessary.
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With