Proguard obfuscating Annotations

Question

I need to keep all model classes to be unobfuscated, so I added this line in proguard rules to keep all model classes:

-keep class my_package_name.model.** { *; }

All model classes are getting kept by this command but still, it is obfuscating the annotations inside the Model classes. I tried adding the following line:

-keepattributes *Annotation*
-keepattributes EnclosingMethod

But still, results are same. My model classes contain these two annotations:

@SerializedName("message")
@Expose
private String message;

How can I keep the two annotations unobfuscated?

It looks like you are using gson, so I would have a look to the recommended gson proguard configuration https://github.com/google/gson/blob/master/examples/android-proguard-example/proguard.cfg — dmarin, Feb 07 '18 at 10:34

Alexander Deych · Answer 1 · 2018-02-10T11:25:41.560

Try this:

-keepattributes *Annotation*
-keepattributes Signature
-dontnote sun.misc.**

-keep class * implements com.google.gson.TypeAdapterFactory
-keep class * implements com.google.gson.JsonSerializer
-keep class * implements com.google.gson.JsonDeserializer

Actually, there is a proguard config in official repo on github https://github.com/google/gson/blob/master/examples/android-proguard-example/proguard.cfg

score 7 · Accepted Answer · answered Feb 08 '18 at 08:03

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.

Trying adding

-keepattributes Signature
-keepattributes EnclosingMethod
-keepattributes InnerClasses
-keepattributes Annotation

For using GSON @Expose annotation

-keepattributes *Annotation*

For Gson specific classes

-keep class sun.misc.Unsafe { *; }

Prevent proguard from stripping interface information from TypeAdapterFactory,JsonSerializer, JsonDeserializer instances (so they can be used in @JsonAdapter)

-keep class * implements com.google.gson.TypeAdapterFactory
-keep class * implements com.google.gson.JsonSerializer
-keep class * implements com.google.gson.JsonDeserializer

score 3 · Answer 3 · answered Feb 03 '18 at 08:21

3

-keep @package.annotationclassname public class *

answered Feb 03 '18 at 08:21

Robert K.

1,043
1
8
20

I already tried this,but not working.It is still obfuscating the annotations – Jinesh Francis Feb 03 '18 at 11:12
Can you please write your rule here? Maybe there is a mistake. – Robert K. Feb 03 '18 at 11:46
1

-keep @com.google.gson.annotations.SerializedName public class * – Jinesh Francis Feb 04 '18 at 06:28

score 3 · Answer 4 · answered Feb 09 '18 at 17:30

3

The rule

-keep class com.google.gson.annotations.*

will keep all annotations in the package com.google.gson.annotations including the SerializedName and Expose ones that you have used.

answered Feb 09 '18 at 17:30

T. Neidhart

6,060
2
15
38

score 1 · Answer 5 · answered Feb 04 '18 at 12:22

Add to your proguard : It's preventing specific classes to be obfuscated.

Mandatory : -dontshrink. : https://www.guardsquare.com/en/proguard/manual/usage
Not mandatory : try to use -dontoptimize.

I don't really understand the issue, are you referring to a field or inner class ? If you have an inner class inside a class, you need to specify its inner fields. For example, if this is the class :

public class Parent {

protected Child child;

protected class Child {
    private String name;
    private int age;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}

}

In the proguard, you need to specify Child class :

-keep class com.package.name.Parent$Child {*; }

score 1 · Answer 6 · edited Jul 06 '20 at 09:47

1

You may Need To Create an annotation called DontObfuscate in your project for more check this Managing obfuscation with annotations

edited Jul 06 '20 at 09:47

Anh Tuan

1,728
1
13
25

answered Feb 08 '18 at 17:18

EL TEGANI MOHAMED HAMAD GABIR

1,868
2
16
34

Proguard obfuscating Annotations

6 Answers6

Linked