如何使用 Gson @SerializedName 注释在 Kotlin 中反序列化嵌套的 Json API 响应
How to deserialize nested Json API response in Kotlin using Gson @SerializedName annotations
我正在将项目迁移到新的 API，因此必须更新反序列化和数据 类。使用旧的 API 和数据 类 一切正常，但使用更新的版本我得到 以下错误
java.lang.ClassNotFoundException: Didn't find class "fooapp.component.ui.cafeteria.model.CafeteriaData" on path: DexPathList[[zip file "/data/app/~~Wji9DkrkAr7qFGIIJ3Aglg==/fooapp-dbYvbr8le25I8FGioIrW6w==/base.apk"],nativeLibraryDirectories=[/data/app/~~Wji9DkrkAr7qFGIIJ3Aglg==/fooapp-dbYvbr8le25I8FGioIrW6w==/lib/x86_64, /system/lib64, /system_ext/lib64]]
尝试访问嵌套字段时，例如：
response.cafeterias[0]
请注意 response.cafeterias 已正确解析且可访问。 所以看起来 解析适用于嵌套级别 1，但是以某种方式在进入下一个级别时出现故障。
我知道映射中缺少 prices 字段，现在不需要。明天我会检查将它添加到序列化层次结构中是否可以解决问题。
到目前为止我尝试了什么
- 正在使缓存失效并重新启动
- 正在清理并重建项目
- 取小样本JSON直接解析，而不是让GSON在后台解析
- 涉及数据类中字段的val和var
样本JSON
{"canteens": [
{
"version": "2.1",
"canteen_id": "best-canteen",
"weeks": [
{
"number": 48,
"year": 2021,
"days": [
{
"date": "2021-11-29",
"dishes": [
{
"name": "Tasty food 1",
"prices": {
"students": {
"base_price": 0,
"price_per_unit": 0.33,
"unit": "100g"
},
"staff": {
"base_price": 0,
"price_per_unit": 0.55,
"unit": "100g"
},
"guests": {
"base_price": 0,
"price_per_unit": 0.66,
"unit": "100g"
}
},
"ingredients": [
"Gl",
"GlW",
"Kn"
],
"dish_type": "Daily 4"
}]
}]
}]
}]
}
Proguard 规则
proguard-gson.pro
## GSON 2.2.4 specific rules ##
# 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*
-keepattributes EnclosingMethod
# Gson specific classes
-keep class sun.misc.Unsafe { *; }
-keep class com.google.gson.stream.** { *; }
proguard-square-okhttp.pro
# OkHttp
-keepattributes Signature
-keepattributes *Annotation*
-keep class com.squareup.okhttp.** { *; }
-keep interface com.squareup.okhttp.** { *; }
-dontwarn com.squareup.okhttp.**
proguard-square-okhttp3.pro
# OkHttp
-keepattributes Signature
-keepattributes *Annotation*
-keep class okhttp3.** { *; }
-keep interface okhttp3.** { *; }
-dontwarn okhttp3.**
proguard-square-retrofit.pro
# Retrofit 1.X
-keep class com.squareup.okhttp.** { *; }
-keep class retrofit.** { *; }
-keep interface com.squareup.okhttp.** { *; }
-dontwarn com.squareup.okhttp.**
-dontwarn okio.**
-dontwarn retrofit.**
-dontwarn rx.**
-keepclasseswithmembers class * {
@retrofit.http.* <methods>;
}
# If in your rest service interface you use methods with Callback argument.
-keepattributes Exceptions
# If your rest service methods throw custom exceptions, because you've defined an ErrorHandler.
-keepattributes Signature
# Also you must note that if you are using GSON for conversion from JSON to POJO representation, you must ignore those POJO classes from being obfuscated.
# Here include the POJO's that have you have created for mapping JSON response to POJO for example.
proguard-square-retrofit2.pro
# Retrofit 2.X
## https://square.github.io/retrofit/ ##
-dontwarn retrofit2.**
-keep class retrofit2.** { *; }
-keepattributes Signature
-keepattributes Exceptions
-keepclasseswithmembers class * {
@retrofit2.http.* <methods>;
}
proguard-guava.pro
# Configuration for Guava 18.0
#
# disagrees with instructions provided by Guava project: https://code.google.com/p/guava-libraries/wiki/UsingProGuardWithGuava
-keep class com.google.common.io.Resources {
public static <methods>;
}
-keep class com.google.common.collect.Lists {
public static ** reverse(**);
}
-keep class com.google.common.base.Charsets {
public static <fields>;
}
-keep class com.google.common.base.Joiner {
public static com.google.common.base.Joiner on(java.lang.String);
public ** join(...);
}
-keep class com.google.common.collect.MapMakerInternalMap$ReferenceEntry
-keep class com.google.common.cache.LocalCache$ReferenceEntry
#
-dontwarn javax.annotation.**
-dontwarn javax.inject.**
-dontwarn sun.misc.Unsafe
# Guava 19.0
-dontwarn java.lang.ClassValue
-dontwarn com.google.j2objc.annotations.Weak
-dontwarn org.codehaus.mojo.animal_sniffer.IgnoreJRERequirement
# Guava 20.0
-dontwarn com.google.**
# Guava 23.5
-dontwarn afu.org.checkerframework.**
-dontwarn org.checkerframework.**
proguard-项目-rules.pro
# Add project specific ProGuard rules here.
#
# For more details, see
# http://developer.android.com/guide/developing/tools/proguard.html
-dontobfuscate
-keep class fooapp.models.**{*;}
proguard-简单-xml.pro
# Simple-Xml Proguard Config
# NOTE: You should also include the Android Proguard config found with the build tools:
# $ANDROID_HOME/tools/proguard/proguard-android.txt
# Keep public classes and methods.
-dontwarn com.bea.xml.stream.**
-dontwarn org.simpleframework.xml.stream.**
-keep class org.simpleframework.xml.**{ *; }
-keepclassmembers,allowobfuscation class * {
@org.simpleframework.xml.* <fields>;
@org.simpleframework.xml.* <init>(...);
}
proguard-sqlite.pro
-keep class org.sqlite.** { *; }
-keep class org.sqlite.database.** { *; }
proguard-square-okio.pro
# Okio
-keep class sun.misc.Unsafe { *; }
-dontwarn java.nio.file.*
-dontwarn org.codehaus.mojo.animal_sniffer.IgnoreJRERequirement
-dontwarn okio.**
proguard-tikxml.pro
-keep class com.tickaroo.tikxml.** { *; }
-keep class **$$TypeAdapter { *; }
-keepclasseswithmembernames class * {
@com.tickaroo.tikxml.* <fields>;
}
-keepclasseswithmembernames class * {
@com.tickaroo.tikxml.* <methods>;
}
数据类
自助餐厅响应
data class CafeteriaResponse(
@SerializedName("canteens")
var cafeterias: List<CafeteriaData>,
)
自助餐厅数据
data class CafeteriaData(
@SerializedName("version")
var version: String? = null,
@SerializedName("canteen_id")
var cafeteriaSlug: String? = null,
@SerializedName("weeks")
var menusByWeeks: List<WeeklyMenu>
)
每周菜单
data class WeeklyMenu(
@SerializedName("number")
var weekOfYear: Short = -1,
@SerializedName("year")
var year: Short = -1,
@SerializedName("days")
var dishesForWeek: List<DailyMenu>
)
每日菜单
data class DailyMenu(
@SerializedName("date")
var date: DateTime? = null,
@SerializedName("dishes")
var dishesForDay: List<Dish>
)
菜肴
data class Dish(
@SerializedName("name")
var name: String? = null,
@SerializedName("ingredients")
var ingredients: List<String>,
@SerializedName("dish_type")
var type: String? = null
)
所有这些数据类都在同一个包里。
问题
proguard-square-retrofit.pro 需要更新，包括新的 POJO 用于API数据反序列化。
解决方案
我将所有 POJO 添加到下面的 proguard 规则集。我将它们全部放在一个单独的包中以获得更精细的混淆粒度并避免保留不必要的 类.
已更新 proguard-square-retrofit.pro
# Retrofit 1.X
-keep class com.squareup.okhttp.** { *; }
-keep class retrofit.** { *; }
-keep interface com.squareup.okhttp.** { *; }
-dontwarn com.squareup.okhttp.**
-dontwarn okio.**
-dontwarn retrofit.**
-dontwarn rx.**
-keepclasseswithmembers class * {
@retrofit.http.* <methods>;
}
# If in your rest service interface you use methods with Callback argument.
-keepattributes Exceptions
# If your rest service methods throw custom exceptions, because you've defined an ErrorHandler.
-keepattributes Signature
# Also you must note that if you are using GSON for conversion from JSON to POJO representation, you must ignore those POJO classes from being obfuscated.
# Here include the POJO's that have you have created for mapping JSON response to POJO for example.
-keep class fooapp.component.ui.cafeteria.model.deserialization.*
我正在将项目迁移到新的 API，因此必须更新反序列化和数据 类。使用旧的 API 和数据 类 一切正常，但使用更新的版本我得到 以下错误
java.lang.ClassNotFoundException: Didn't find class "fooapp.component.ui.cafeteria.model.CafeteriaData" on path: DexPathList[[zip file "/data/app/~~Wji9DkrkAr7qFGIIJ3Aglg==/fooapp-dbYvbr8le25I8FGioIrW6w==/base.apk"],nativeLibraryDirectories=[/data/app/~~Wji9DkrkAr7qFGIIJ3Aglg==/fooapp-dbYvbr8le25I8FGioIrW6w==/lib/x86_64, /system/lib64, /system_ext/lib64]]
尝试访问嵌套字段时，例如：
response.cafeterias[0]
请注意 response.cafeterias 已正确解析且可访问。 所以看起来 解析适用于嵌套级别 1，但是以某种方式在进入下一个级别时出现故障。
我知道映射中缺少 prices 字段，现在不需要。明天我会检查将它添加到序列化层次结构中是否可以解决问题。
到目前为止我尝试了什么
- 正在使缓存失效并重新启动
- 正在清理并重建项目
- 取小样本JSON直接解析，而不是让GSON在后台解析
- 涉及数据类中字段的val和var
样本JSON
{"canteens": [
{
"version": "2.1",
"canteen_id": "best-canteen",
"weeks": [
{
"number": 48,
"year": 2021,
"days": [
{
"date": "2021-11-29",
"dishes": [
{
"name": "Tasty food 1",
"prices": {
"students": {
"base_price": 0,
"price_per_unit": 0.33,
"unit": "100g"
},
"staff": {
"base_price": 0,
"price_per_unit": 0.55,
"unit": "100g"
},
"guests": {
"base_price": 0,
"price_per_unit": 0.66,
"unit": "100g"
}
},
"ingredients": [
"Gl",
"GlW",
"Kn"
],
"dish_type": "Daily 4"
}]
}]
}]
}]
}
Proguard 规则
proguard-gson.pro
## GSON 2.2.4 specific rules ##
# 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*
-keepattributes EnclosingMethod
# Gson specific classes
-keep class sun.misc.Unsafe { *; }
-keep class com.google.gson.stream.** { *; }
proguard-square-okhttp.pro
# OkHttp
-keepattributes Signature
-keepattributes *Annotation*
-keep class com.squareup.okhttp.** { *; }
-keep interface com.squareup.okhttp.** { *; }
-dontwarn com.squareup.okhttp.**
proguard-square-okhttp3.pro
# OkHttp
-keepattributes Signature
-keepattributes *Annotation*
-keep class okhttp3.** { *; }
-keep interface okhttp3.** { *; }
-dontwarn okhttp3.**
proguard-square-retrofit.pro
# Retrofit 1.X
-keep class com.squareup.okhttp.** { *; }
-keep class retrofit.** { *; }
-keep interface com.squareup.okhttp.** { *; }
-dontwarn com.squareup.okhttp.**
-dontwarn okio.**
-dontwarn retrofit.**
-dontwarn rx.**
-keepclasseswithmembers class * {
@retrofit.http.* <methods>;
}
# If in your rest service interface you use methods with Callback argument.
-keepattributes Exceptions
# If your rest service methods throw custom exceptions, because you've defined an ErrorHandler.
-keepattributes Signature
# Also you must note that if you are using GSON for conversion from JSON to POJO representation, you must ignore those POJO classes from being obfuscated.
# Here include the POJO's that have you have created for mapping JSON response to POJO for example.
proguard-square-retrofit2.pro
# Retrofit 2.X
## https://square.github.io/retrofit/ ##
-dontwarn retrofit2.**
-keep class retrofit2.** { *; }
-keepattributes Signature
-keepattributes Exceptions
-keepclasseswithmembers class * {
@retrofit2.http.* <methods>;
}
proguard-guava.pro
# Configuration for Guava 18.0
#
# disagrees with instructions provided by Guava project: https://code.google.com/p/guava-libraries/wiki/UsingProGuardWithGuava
-keep class com.google.common.io.Resources {
public static <methods>;
}
-keep class com.google.common.collect.Lists {
public static ** reverse(**);
}
-keep class com.google.common.base.Charsets {
public static <fields>;
}
-keep class com.google.common.base.Joiner {
public static com.google.common.base.Joiner on(java.lang.String);
public ** join(...);
}
-keep class com.google.common.collect.MapMakerInternalMap$ReferenceEntry
-keep class com.google.common.cache.LocalCache$ReferenceEntry
#
-dontwarn javax.annotation.**
-dontwarn javax.inject.**
-dontwarn sun.misc.Unsafe
# Guava 19.0
-dontwarn java.lang.ClassValue
-dontwarn com.google.j2objc.annotations.Weak
-dontwarn org.codehaus.mojo.animal_sniffer.IgnoreJRERequirement
# Guava 20.0
-dontwarn com.google.**
# Guava 23.5
-dontwarn afu.org.checkerframework.**
-dontwarn org.checkerframework.**
proguard-项目-rules.pro
# Add project specific ProGuard rules here.
#
# For more details, see
# http://developer.android.com/guide/developing/tools/proguard.html
-dontobfuscate
-keep class fooapp.models.**{*;}
proguard-简单-xml.pro
# Simple-Xml Proguard Config
# NOTE: You should also include the Android Proguard config found with the build tools:
# $ANDROID_HOME/tools/proguard/proguard-android.txt
# Keep public classes and methods.
-dontwarn com.bea.xml.stream.**
-dontwarn org.simpleframework.xml.stream.**
-keep class org.simpleframework.xml.**{ *; }
-keepclassmembers,allowobfuscation class * {
@org.simpleframework.xml.* <fields>;
@org.simpleframework.xml.* <init>(...);
}
proguard-sqlite.pro
-keep class org.sqlite.** { *; }
-keep class org.sqlite.database.** { *; }
proguard-square-okio.pro
# Okio
-keep class sun.misc.Unsafe { *; }
-dontwarn java.nio.file.*
-dontwarn org.codehaus.mojo.animal_sniffer.IgnoreJRERequirement
-dontwarn okio.**
proguard-tikxml.pro
-keep class com.tickaroo.tikxml.** { *; }
-keep class **$$TypeAdapter { *; }
-keepclasseswithmembernames class * {
@com.tickaroo.tikxml.* <fields>;
}
-keepclasseswithmembernames class * {
@com.tickaroo.tikxml.* <methods>;
}
数据类
自助餐厅响应
data class CafeteriaResponse(
@SerializedName("canteens")
var cafeterias: List<CafeteriaData>,
)
自助餐厅数据
data class CafeteriaData(
@SerializedName("version")
var version: String? = null,
@SerializedName("canteen_id")
var cafeteriaSlug: String? = null,
@SerializedName("weeks")
var menusByWeeks: List<WeeklyMenu>
)
每周菜单
data class WeeklyMenu(
@SerializedName("number")
var weekOfYear: Short = -1,
@SerializedName("year")
var year: Short = -1,
@SerializedName("days")
var dishesForWeek: List<DailyMenu>
)
每日菜单
data class DailyMenu(
@SerializedName("date")
var date: DateTime? = null,
@SerializedName("dishes")
var dishesForDay: List<Dish>
)
菜肴
data class Dish(
@SerializedName("name")
var name: String? = null,
@SerializedName("ingredients")
var ingredients: List<String>,
@SerializedName("dish_type")
var type: String? = null
)
所有这些数据类都在同一个包里。
问题
proguard-square-retrofit.pro 需要更新，包括新的 POJO 用于API数据反序列化。
解决方案
我将所有 POJO 添加到下面的 proguard 规则集。我将它们全部放在一个单独的包中以获得更精细的混淆粒度并避免保留不必要的 类.
已更新 proguard-square-retrofit.pro
# Retrofit 1.X
-keep class com.squareup.okhttp.** { *; }
-keep class retrofit.** { *; }
-keep interface com.squareup.okhttp.** { *; }
-dontwarn com.squareup.okhttp.**
-dontwarn okio.**
-dontwarn retrofit.**
-dontwarn rx.**
-keepclasseswithmembers class * {
@retrofit.http.* <methods>;
}
# If in your rest service interface you use methods with Callback argument.
-keepattributes Exceptions
# If your rest service methods throw custom exceptions, because you've defined an ErrorHandler.
-keepattributes Signature
# Also you must note that if you are using GSON for conversion from JSON to POJO representation, you must ignore those POJO classes from being obfuscated.
# Here include the POJO's that have you have created for mapping JSON response to POJO for example.
-keep class fooapp.component.ui.cafeteria.model.deserialization.*