在 ProGuard 优化期间删除未使用的字符串

Question

我在发布 Android 应用程序时包含 this ProGuard configuration 以去除调试日志语句：

-assumenosideeffects class android.util.Log {
    public static *** d(...);
    public static *** v(...);
}

这按预期工作 - 我可以从 ProGuard 日志和 Android 日志输出中看到，诸如 Log.d("This is a debug statement"); 之类的调用已被删除。

但是，如果我在这个阶段反编译应用程序，我仍然可以看到所有使用过的 String 字面量——即本例中的 This is a debug statement。

有没有办法同时从字节码中删除不再需要的每个 String？

Answer 1

ProGuard 可以删除简单的常量参数（字符串、整数等）。所以在这种情况下，代码和字符串常量应该完全消失：

Log.d("This is a debug statement");

但是，您可能已经观察到以下代码的问题：

Log.d("The answer is "+answer);

编译后，这个其实对应：

Log.d(new StringBuilder().append("The answer is ").append(answer).toString());

ProGuard 4.6 版可以将其简化为：

new StringBuilder().append("The answer is ").append(answer).toString();

所以日志记录消失了，但优化步骤仍然留下一些绒毛。如果没有对 StringBuilder 类有更深入的了解，要简化它是非常棘手的。就 ProGuard 而言，它可以说：

new DatabaseBuilder().setup("MyDatabase").initialize(table).close();

对于人类来说，StringBuilder 代码显然可以删除，但 DatabaseBuilder 代码可能不能。 ProGuard 需要逃逸分析和其他一些技术，这些技术还没有在这个版本中。

至于解决方案：您可以创建其他带有简单参数的调试方法，并让 ProGuard 删除这些：

MyLog.d("The answer is ", answer);

或者，您可以尝试在每个调试语句前加上 ProGuard 以后可以评估为假的条件。这个选项可能有点复杂，需要在调试标志的初始化方法上添加一些额外的 -assumenosideeffects 选项。

Answer 2

这是我们的做法 - 使用 ant 任务

<target name="base.removelogs">
    <replaceregexp byline="true">
        <regexp pattern="Log.d\s*\(\s*\)\s*;"/>
        <substitution expression="{};"/>
        <fileset dir="src/"><include name="**/*.java"/></fileset>
    </replaceregexp>
</target>

Answer 3

由于我没有足够的代表来直接评论 ant 任务的答案，因此这里对其进行了一些更正，因为事实证明它与可以执行发布构建的 Jenkins 等 CI-Server 结合使用非常有帮助：

<target name="removelogs">
    <replaceregexp byline="true">
        <regexp pattern="\s*Log\.d\s*\(.*\)\s*;"/>
        <substitution expression="{};"/>
        <fileset dir="src">
            <include name="**/*.java"/>
        </fileset>
    </replaceregexp>
</target>

'.'在 Log 之后必须转义和一个 '.'括号内的目标是任何日志记录语句，而不仅仅是像 '\s*' 那样的空格。

由于我对 RegEx 没有太多经验，我希望这将帮助处于相同情况的某些人使这个 ant 任务正常工作（例如在 Jenkins 上）。

Answer 4

如果你想支持多行日志调用，你可以改用这个正则表达式：

(android\.util\.)*Log\.@([ewidv]|wtf)\s*\([\S\s]*?\)\s*;

您应该可以在 ant replaceregexp 任务中使用它，如下所示：

<replaceregexp>
    <regexp pattern="((android\.util\.)*Log\.([ewidv]|wtf)\s*\([\S\s]*?\)\s*;)"/>
    <substitution expression="if(false){\1}"/>
    <fileset dir="src/">
        <include name="**/*.java"/>
    </fileset>
</replaceregexp>

注意：这围绕着带有if(false){ 和} 的Log 调用，因此保留了原始调用，供参考和在检查中间构建文件时保留行号，让Java 编译器在编译期间剥离调用。

如果您希望完全删除日志调用，您可以这样做：

<replaceregexp>
    <regexp pattern="(android\.util\.)*Log\.([ewidv]|wtf)\s*\([\S\s]*?\)\s*;"/>
    <substitution expression=""/>
    <fileset dir="src/">
        <include name="**/*.java"/>
    </fileset>
</replaceregexp>

您还可以将正则表达式用作<copy> 任务中的过滤器，如下所示：

<copy ...>
    <fileset ... />
    <filterchain>
        <tokenfilter if:true="${strip.log.calls}">
            <stringtokenizer delims=";" includeDelims="true"/>
            <replaceregex pattern="((android\.util\.)*Log\.([ewidv]|wtf)\s*\([\S\s]*?\)\s*;)" replace="if(false){\1}"/>
        </tokenfilter>
    </filterchain>
    <!-- other-filters-etc -->
</copy>