Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

ProGuard: keep implementations for interface annotated with @Keep

I would like to annotate some interfaces in my application with a custom @Keep annotation and configure ProGuard so as to

  • not obfuscate the annotated interface and its methods,
  • not obfuscate implementations for those interface methods in implementing classes.

I tried something like

# Kept interfaces and all their methods
-keep interface @com.foo.bar.annotation.Keep * {
    <methods>;
}

# Classes implementing kept interfaces
-keep class * implements @com.foo.bar.annotation.Keep *

but obviously the syntax is invalid. I tried other things, but the ProGuard documentation and its examples are not really clear about the exact syntax and what is possible under which circumstances.

like image 415
kriegaex Avatar asked Mar 18 '14 08:03

kriegaex


1 Answers

Sorry for answering my own question, but I just happened to bump into the solution when playing around. Actually it is much simpler than I thought:

# Annotated interfaces (including methods which are also kept in implementing classes)
-keep @com.foo.bar.annotation.Keep interface * {
    *;
}

Obviously it was wrong to specify <methods> on an interface keep clause, maybe because ProGuard only filters for actual method implementations, not mere method declarations as can be found in interface declarations.

The above syntax seems to keep the full interface (class name, method names) plus all implementing method names, which is logical if I think about it, because if I do implement an interface I cannot change (obfuscate) the method names anyway.

like image 145
kriegaex Avatar answered Nov 09 '22 04:11

kriegaex