使用Proguard完全删除未使用的字段引用(例如日志记录)

Question

我正试图从我的应用程序中删除日志记录。这里有一个非常简单的孤立，但完整的示例：

Java文件(默认包，都在同一个文件中，位于src/source.java中(

class Logger {
    public void log() {
        new Exception().printStackTrace();
    }
}
class LoggerFactory {
    public static Logger createLogger() {
        return new Logger();
    }
}
class Normal {
    private static final Logger LOG = LoggerFactory.createLogger();
    public static void main(String... args) {
        System.out.println("Normal main");
        LOG.log();
    }
}

Proguard配置(config.pro(

-injars src/test.jar
-outjars opt/test.jar
-libraryjars  <java.home>/lib/rt.jar
-dontobfuscate
-optimizationpasses 3
# keep entry points
-keep class ** { public static void main(java.lang.String[]); }
# usual approach to removing logging
-assumenosideeffects class Logger { void log(); }
# attempted solution for my problem:
-assumenosideeffects class LoggerFactory { Logger createLogger(); }
-assumenosideeffects class Normal { Logger LOG; }

生成脚本

set PATH=%JAVA7_HOME%bin;.proguard5.2.1bin;P:toolsdecompilejad-1.5.8g-win
cd src
javac -source 1.7 -target 1.7 *.java
jar cfM test.jar *.class
java -cp test.jar Normal
cd ..
call proguard @config.pro -verbose
java -cp test.jar Normal
cd opt
jar xf test.jar
jad -dead -noconv -nocast -noclass -v -a -o -s java *.class

输出(简化(

$java -cp src/test.jar Normal
Normal main
java.lang.Exception
        at Logger.log(source.java:3)
        at Normal.main(source.java:15)
$proguard @config.pro -verbose
ProGuard, version 4.7
... last optimizing pass prints 0 changes
$java -cp opt/test.jar Normal
Normal main

问题

正如您在上面看到的，输出是预期的，log()调用没有输出。然而，当我仔细查看生成的.jar文件时，Logger和LoggerFactory都存在，并且它们甚至被使用：

class Normal {
    public static transient void main(String args[]) {
        System.out.println("Normal main");
        //    0    0:getstatic       #8   <Field PrintStream System.out>
        //    1    3:ldc1            #1   <String "Normal main">
        //    2    5:invokevirtual   #10  <Method void PrintStream.println(String)>
        Logger _tmp = LOG;
        //    3    8:getstatic       #7   <Field Logger LOG>
        //    4   11:pop             
        //    5   12:return          
    }
    private static final Logger LOG = LoggerFactory.createLogger();
    static {
        //    0    0:invokestatic    #9   <Method Logger LoggerFactory.createLogger()>
        //    1    3:putstatic       #7   <Field Logger LOG>
        //*   2    6:return          
    }
}

如果我看对了，根本原因是这两条指令：

        //    3    8:getstatic       #7   <Field Logger LOG>
        //    4   11:pop

如果我可以去掉这些，那么优化会注意到未使用的LOG字段，并希望完全去掉初始化器。由于没有使用这些记录器类，它们将被收缩。

我缺少什么？这是不可能的，还是我只是使用了错误的选项。如果是，我需要什么选择才能实现

Answer 1

您被ProGuard的保留选项的细微差别所欺骗！

你正在寻找的规则应该是：

# keep entry points
-keepclasseswithmembers class ** {
    public static void main(java.lang.String[]);
}
# usual approach to removing logging
-assumenosideeffects class Logger { void log(); }
# careful with this one, it's potentially very dangerous
# but in this case it seems necessary (perfect solution probably only with Dexguard)
-assumenosideeffects class Logger { <init>(); }

你必须小心这个规则：

-keep class ** {
    public static void main(java.lang.String[]);
}

它实际上保留了所有类(即使它们是空的(。除此之外，它保留了他们的主要方法(如果有的话(。我用一个规则替换了它，该规则只保留一个具有main(String[])方法的类(它也保留了该方法(。

正确使用-assumenosideeffects有点复杂。实际上有必要省略Logger的构造函数，而不是LoggerFactory.createLogger()。这可能是由于应用优化的顺序，createLogger()方法似乎被优化掉了，取而代之的是将保留的new Logger()。

当你不确定你的选择有什么问题时，最好使用

-whyareyoukeeping class_specification

选项。它会试图向你指出是什么保持了课堂。

编辑：我忘了提到我使用了ProGuard的5.2.1版本。

Answer 2

您使用的是ProGuard的过时版本。尝试使用5.2.1版本(此处可用(，您应该会得到预期的结果。