proguard-annotations

Easy to use inline @Keep annotation to keep class.

And easy to install.

Usage

@Keep
@KeepClassMembers
public class KeepMe {
    String keepMe;
}

Installation

build.gradle:

dependencies {
    compile "com.infstory:proguard-annotations:1.0.2"
}

Annotations

How annotations do? proguard-annotations/annotations.pro

Test

$ /gradelw clean assembleRelease
$ cd proguard-annotations-app/build/outputs/apk
$ unzip proguard-annotations-app-release-unsigned.apk
$ dex2jar classes.dex
$ unzip classes_dex2jar.jar
$ tree proguard
proguard
├── annotation
│   ├── BuildConfig.class
│   ├── KeepApplication.class
│   ├── Keep.class
│   ├── KeepClassMemberNames.class
│   ├── KeepClassMembers.class
│   ├── KeepGettersSetters.class
│   ├── KeepImplementations.class
│   ├── KeepName.class
│   ├── KeepPublicClassMemberNames.class
│   ├── KeepPublicClassMembers.class
│   ├── KeepPublicGettersSetters.class
│   ├── KeepPublicImplementations.class
│   ├── KeepPublicProtectedClassMemberNames.class
│   └── KeepPublicProtectedClassMembers.class
└── app
    ├── KeepMe.class
    └── KeepMeWithoutMembers.class

$ jd-gui classes_dex2jar.jar # Optional

$ tree proguard-annotations-app/src/main/java
proguard-annotations-app/src/main/java
└── proguard
    └── app
        ├── DontKeepMe.java
        ├── KeepMe.java
        └── KeepMeWithoutMembers.java

TODO

Test Cases

FAQ

For which classes I have to use it ? Only classes i made for my items ? Or also activities and services and so on?

It used to apply on reflection target. If you have not use relection, you just enable minify feature with default proguard config by the following build.gradle, and do nothing with proguard config:

android {
    buildTypes {
        release {
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android.txt')
        }
    }
}

When to use @Keep and when to use @KeepClassMembers ?

@Keep used to apply on runtime annotation for relection, it will keep class name and avoid be removed for optimization. @KeepClassMembers used to keep whole class with class members for POJO reflection. It's used to keep targets for Gson and Jackson JSON reflection libraries.

I don't need to write anything in my proguard rule file ? For my application or libraries or jars ?

Yes, do nothing if nothing special. Just enable minify.

[License] (LICENSE)

The MIT License (MIT)

Copyright (c) 2014 Andrew Chen

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

yongjhih/proguard-annotations

yongjhih

Reviews

Repository Details