Moshi KotlinJsonAdapterFactory 在启用缩小后无法解析 Json

Question

我开发了一个 Android 应用程序，使用 Moshi 作为其依赖项之一。

今天我想为这个项目启用 minify。所以我在 build.gradle.

中设置了 minifyEnabled true

之后，我发现服务器的所有响应都变成了空

首先，我使用Retrofit2 来调用API。 Response.body() 中的 JSON 正文不为空并且具有正确的值。

响应正文如下（简体）：

{"status":"success","data":{"user": "I am a user"}}

我正在使用下面的代码将其转换为我自己的对象：

val someResponse = Moshi.Builder().add(KotlinJsonAdapterFactory()).build().adapter(SomeResponse::class.java).fromJson(theJsonString)

而 SomeResponse 的代码：

class SomeResponse {
    @Json(name="status")
    var status: String? = null

    @Json(name="data")
    var data: User? = null
}

然后我直接用Log.i("Moshi", "${someResponse.status}"看值，结果是null.

我已经包含了 Moshi Github 的 README 部分中指定的混淆器规则，即 this one and this one。

为什么以及如何解决这个问题？

供参考，下面是我的完整 proguard-rules.pro:

# Add project specific ProGuard rules here.
# You can control the set of applied configuration files using the
# proguardFiles setting in build.gradle.
#
# For more details, see
#   http://developer.android.com/guide/developing/tools/proguard.html

# If your project uses WebView with JS, uncomment the following
# and specify the fully qualified class name to the JavaScript interface
# class:
-keepclassmembers class fqcn.of.javascript.interface.for.webview {
   public *;
}

# Uncomment this to preserve the line number information for
# debugging stack traces.
-keepattributes SourceFile,LineNumberTable, *Annotation*

# If you keep the line number information, uncomment this to
# hide the original source file name.
#-renamesourcefileattribute SourceFile


#Crashlytics: https://docs.fabric.io/android/crashlytics/dex-and-proguard.html
-keepattributes *Annotation*
-keep public class * extends java.lang.Exception


#
-dontwarn kotlin.**
-dontwarn kotlin.reflect.jvm.internal.**
-keep class kotlin.reflect.jvm.internal.** { *; }
-keep class kotlin.Metadata { *; }
-keepclassmembers public class com.example.app.** {
    public synthetic <methods>;
}
-keepclassmembers class kotlin.Metadata {
    public <methods>;
}
-keepclassmembers class **$WhenMappings {
    <fields>;
}
-keep class kotlin.reflect.jvm.internal.impl.builtins.BuiltInsLoaderImpl

#All models
-keep class com.example.app.models.**

#######Retrofit#######
#https://github.com/square/retrofit/blob/master/retrofit/src/main/resources/META-INF/proguard/retrofit2.pro
# Retrofit does reflection on generic parameters. InnerClasses is required to use Signature and
# EnclosingMethod is required to use InnerClasses.
-keepattributes Signature, InnerClasses, EnclosingMethod

# Retrofit does reflection on method and parameter annotations.
-keepattributes RuntimeVisibleAnnotations, RuntimeVisibleParameterAnnotations

# Retain service method parameters when optimizing.
-keepclassmembers,allowshrinking,allowobfuscation interface * {
    @retrofit2.http.* <methods>;
}

# Ignore annotation used for build tooling.
-dontwarn org.codehaus.mojo.animal_sniffer.IgnoreJRERequirement

# Ignore JSR 305 annotations for embedding nullability information.
-dontwarn javax.annotation.**

# Guarded by a NoClassDefFoundError try/catch and only used when on the classpath.
-dontwarn kotlin.Unit

# Top-level functions that can only be used by Kotlin.
-dontwarn retrofit2.KotlinExtensions

# With R8 full mode, it sees no subtypes of Retrofit interfaces since they are created with a Proxy
# and replaces all potential values with null. Explicitly keeping the interfaces prevents this.
-if interface * { @retrofit2.http.* <methods>; }
-keep,allowobfuscation interface <1>



#######OkHttp3######
#https://github.com/square/okhttp/blob/master/okhttp/src/main/resources/META-INF/proguard/okhttp3.pro
# JSR 305 annotations are for embedding nullability information.
-dontwarn javax.annotation.**

# A resource is loaded with a relative path so the package of this class must be preserved.
-keepnames class okhttp3.internal.publicsuffix.PublicSuffixDatabase

# Animal Sniffer compileOnly dependency to ensure APIs are compatible with older versions of Java.
-dontwarn org.codehaus.mojo.animal_sniffer.*

# OkHttp platform used only on JVM and when Conscrypt dependency is available.
-dontwarn okhttp3.internal.platform.ConscryptPlatform




######Okio######
#https://github.com/square/okio/blob/master/okio/src/jvmMain/resources/META-INF/proguard/okio.pro
# Animal Sniffer compileOnly dependency to ensure APIs are compatible with older versions of Java.
-dontwarn org.codehaus.mojo.animal_sniffer.*





####Moshi####
#https://github.com/square/moshi/blob/master/moshi/src/main/resources/META-INF/proguard/moshi.pro
#https://github.com/square/moshi/blob/master/kotlin/reflect/src/main/resources/META-INF/proguard/moshi-kotlin.pro
# JSR 305 annotations are for embedding nullability information.
-dontwarn javax.annotation.**

-keepclasseswithmembers class * {
    @com.squareup.moshi.* <methods>;
}

-keep @com.squareup.moshi.JsonQualifier interface *

# Enum field names are used by the integrated EnumJsonAdapter.
# Annotate enums with @JsonClass(generateAdapter = false) to use them with Moshi.
-keepclassmembers @com.squareup.moshi.JsonClass class * extends java.lang.Enum {
    <fields>;
}

# The name of @JsonClass types is used to look up the generated adapter.
-keepnames @com.squareup.moshi.JsonClass class *

# Retain generated JsonAdapters if annotated type is retained.
-if @com.squareup.moshi.JsonClass class *
-keep class <1>JsonAdapter {
    <init>(...);
    <fields>;
}
-if @com.squareup.moshi.JsonClass class **$*
-keep class <1>_<2>JsonAdapter {
    <init>(...);
    <fields>;
}
-if @com.squareup.moshi.JsonClass class **$*$*
-keep class <1>_<2>_<3>JsonAdapter {
    <init>(...);
    <fields>;
}
-if @com.squareup.moshi.JsonClass class **$*$*$*
-keep class <1>_<2>_<3>_<4>JsonAdapter {
    <init>(...);
    <fields>;
}
-if @com.squareup.moshi.JsonClass class **$*$*$*$*
-keep class <1>_<2>_<3>_<4>_<5>JsonAdapter {
    <init>(...);
    <fields>;
}
-if @com.squareup.moshi.JsonClass class **$*$*$*$*$*
-keep class <1>_<2>_<3>_<4>_<5>_<6>JsonAdapter {
    <init>(...);
    <fields>;
}
-keep class kotlin.reflect.jvm.internal.impl.builtins.BuiltInsLoaderImpl

-keepclassmembers class kotlin.Metadata {
    public <methods>;
}






####Mp4 Marser####
-keep class com.coremedia.iso.** {*;}
-keep class com.googlecode.mp4parser.** {*;}
-keep class com.mp4parser.** {*;}

-dontwarn com.coremedia.**
-dontwarn com.googlecode.mp4parser.**



####Picasso#####
#https://github.com/square/picasso/blob/master/picasso/consumer-proguard-rules.txt
# Platform calls Class.forName on types which do not exist on Android to determine platform.
-dontnote okhttp3.internal.Platform
# java.nio.file.* usage which cannot be used at runtime. Animal sniffer annotation.
-dontwarn okio.Okio
# JDK 7-only method which is @hide on Android. Animal sniffer annotation.
-dontwarn okio.DeflaterSink



#Ignore all other 3rd party libraries for now as we don't really care about the size but more about code obfuscation.
-keep class de.hdodenhof.**
-keep class io.github.luizgrp.sectionedrecyclerviewadapter.**
-keep class q.rorbin.badgeview.**
-keep class com.theartofdev.edmodo.**
-keep class me.relex
-keep class com.tbruyelle.rxpermissions2.**
-keep class com.github.pwittchen.reactivenetwork.**
-keep class com.minimize.android.rxrecycleradapter.**
-keep class at.blogc.android.**
-keep class com.yarolegovich.**
-keep class cn.trinea.android.view.autoscrollviewpager.**
-keep class com.apkfuns.logutils.**

Answer 1

我认为这里的解决方案很简单：添加一个@Keep - 注释到你的模型（一些响应），marshalling-names 不应该再被混淆了。 :-)

Answer 2

尝试将其添加到您的 proguard-rules.pro 文件中。希望这会有所帮助。

# Moshi
-keepclassmembers class ** {
  @com.squareup.moshi.FromJson *;
  @com.squareup.moshi.ToJson *;
}

Answer 3

-keepclasseswithmembers class * {
    @com.squareup.moshi.* <methods>;
}
-keep @com.squareup.moshi.JsonQualifier interface *
-dontwarn org.jetbrains.annotations.**
-keep class kotlin.Metadata { *; }
-keepclassmembers class kotlin.Metadata {
    public <methods>;
}

-keepclassmembers class * {
    @com.squareup.moshi.FromJson <methods>;
    @com.squareup.moshi.ToJson <methods>;
}

-keepnames @kotlin.Metadata class (Change with Yourpackagename) com.myapp.packagename.model.**
-keep class (Change with Yourpackagename) com.myapp.packagnename.model.** { *; }
-keepclassmembers class (Change with Yourpackagename) com.myapp.packagename.model.** { *; }

将 com.myapp.packagnename 更改为您的包名

或

将 moshi-kotlin 替换为 kotshi，它可以在没有特殊规则的情况下与 Proguard 一起正常运行，在最终的 apk 中减少了数百 KB。

Answer 4

@JeganBabu

的评论中提到了唯一对我有用的解决方案

即将 @Json(name="field_name") 更改为 @field:Json(name="field_name").

可能是因为如果未添加 field:，则注释不会应用于转换后的 Java 代码。很奇怪。

供您参考：

Answer 5

您还可以使用 Moshi "codegen" 注释处理器。

添加依赖：

kapt "com.squareup.moshi:moshi-kotlin-codegen:1.9.2"

然后用 @JsonClass:

注释你的模型

@JsonClass(generateAdapter = true)
data class MyModel(...)

您还需要注释模型使用的任何枚举类，但它们不需要适配器：

@JsonClass(generateAdapter = false)
enum class MyEnumClass { ... }

前面提到的来自 here and here 的 Moshi Proguard 规则也是必需的。

Moshi KotlinJsonAdapterFactory 在启用缩小后无法解析 Json

Moshi KotlinJsonAdapterFactory cannot parse Json after enabled minify

android

kotlin

minify

moshi