web-dev-qa-db-ja.com

ProGuard for Android and GSON

Androidプロジェクト用にProGuardを設定しています。私のプロジェクトでもGSONを使用しています。

GSONおよびAndroidとの互換性のためにProGuard構成を調査し、google-gsonが提供するこの例を見つけました https://code.google.com/p/google-gson /source/browse/trunk/examples/Android-proguard-example/proguard.cfg 。

以下にコピーされたProGuardの構成：

##---------------Begin: proguard configuration common for all Android apps ----------
-optimizationpasses 5
-dontusemixedcaseclassnames
-dontskipnonpubliclibraryclasses
-dontskipnonpubliclibraryclassmembers
-dontpreverify
-verbose
-dump class_files.txt
-printseeds seeds.txt
-printusage unused.txt
-printmapping mapping.txt
-optimizations !code/simplification/arithmetic,!field/*,!class/merging/*

-allowaccessmodification
-keepattributes *Annotation*
-renamesourcefileattribute SourceFile
-keepattributes SourceFile,LineNumberTable
-repackageclasses ''

-keep public class * extends Android.app.Activity
-keep public class * extends Android.app.Application
-keep public class * extends Android.app.Service
-keep public class * extends Android.content.BroadcastReceiver
-keep public class * extends Android.content.ContentProvider
-keep public class * extends Android.app.backup.BackupAgentHelper
-keep public class * extends Android.preference.Preference
-keep public class com.Android.vending.licensing.ILicensingService
-dontnote com.Android.vending.licensing.ILicensingService

# Explicitly preserve all serialization members. The Serializable interface
# is only a marker interface, so it wouldn't save them.
-keepclassmembers class * implements Java.io.Serializable {
    static final long serialVersionUID;
    private static final Java.io.ObjectStreamField[] serialPersistentFields;
    private void writeObject(Java.io.ObjectOutputStream);
    private void readObject(Java.io.ObjectInputStream);
    Java.lang.Object writeReplace();
    Java.lang.Object readResolve();
}

# Preserve all native method names and the names of their classes.
-keepclasseswithmembernames class * {
    native <methods>;
}

-keepclasseswithmembernames class * {
    public <init>(Android.content.Context, Android.util.AttributeSet);
}

-keepclasseswithmembernames class * {
    public <init>(Android.content.Context, Android.util.AttributeSet, int);
}

# Preserve static fields of inner classes of R classes that might be accessed
# through introspection.
-keepclassmembers class **.R$* {
  public static <fields>;
}

# Preserve the special static methods that are required in all enumeration classes.
-keepclassmembers enum * {
    public static **[] values();
    public static ** valueOf(Java.lang.String);
}

-keep public class * {
    public protected *;
}

-keep class * implements Android.os.Parcelable {
  public static final Android.os.Parcelable$Creator *;
}
##---------------End: proguard configuration common for all Android apps ----------

##---------------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.** { *; }

##---------------End: proguard configuration for Gson  ----------

質問：

  1. このファイルは2011年以降更新されていないようですが、使用することをお勧めしますか？それ以降、Android/GSONがかなり変わったので、私は尋ねます。そのため、上記のどれが不必要か間違っているかわかりません。

  2. これが推奨されない場合、AndroidのGSON用に新しく推奨されるProGuard構成はありますか？

javaandroidconfigurationgsonproguard
30
AtariPete

そこにあるこれらの設定のほとんどは、デフォルトでAndroid SDKにすでに含まれています。

そのため、GSON専用のセクションに残して、それらのほとんどを削除できます。

Android SDK Tools 22.6.3およびそれに付属するProGuardのバージョンを使用してEclipseで開発しています。

GSON 2.2.4で使用しているものを次に示します（ 例のとおり ）：

##---------------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

# 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 mypersonalclass.data.model.** { *; }

注釈に関する行が必要ないことを除いて、あなたの持っているものとまったく同じに見えます。

自分で追加したクラスをコメントアウトしたことがわかります。独自のクラスをシリアライズ/デシリアライズする場合、mypersonalclass.data.modelへの参照の代わりにここでそれらを宣言する必要があります。 GSONがシリアル化に使用するフィールド名またはクラス名をProGuardで難読化しないようにするため、これは非常に重要です。

私はいつもそのようなタイプのコメントをそこに残しているので、次のライブラリまたはアプリを構成する方法を知っています。

68
Richard Le Mesurier

-keepを使用することは悪い習慣であり、絶対に実行しないでください。-keepを使用することはほとんどありません。 ProGuardルールが必要な場合は、通常、より具体的なバリアントの1つが必要です。

-keepclassmembers-これにより、クラスのメンバーのみが縮小および難読化から保護されます。

-keepnames-クラスとメンバーの縮小を許可しますが、難読化は許可しません。つまり、未使用のコードは削除されます。ただし、保持されるコードは元の名前を保持します。

-keepclassmembernames-未使用のクラスは削除され、残りのクラスの名前は変更され、それらのクラスの未使用のメンバーは削除されますが、残りのメンバーは元の名前のままです。

詳細についてはこちらをお読みください

PS-これは私がGsonのためにしたことです

-keepclassmembernames class rscom.pojo.** { <fields>; }
1
Kaustubh Bhagwat

私の場合、上記を追加しましたが、アプリレベルのgradleでcompile 'org.immutables:gson:2.4.6'からprovided 'org.immutables:gson:2.4.6'。もっと賢明な人が理由を説明できるかもしれませんが、これで私の問題は解決しました。

0
GotaloveCode