使用 Proguard 编译会给出 SimException: “局部变量类型不匹配”

Question

当我在启用 Proguard 的情况下编译 Android 应用程序时，出现以下错误：

-dex:
 [echo] Converting compiled files and external libraries into /home/ka/dev/workspace/ImPress/build/classes.dex...
[apply] 
[apply] UNEXPECTED TOP-LEVEL EXCEPTION:
[apply] com.android.dx.cf.code.SimException: local variable type mismatch: attempt to set or access a value of type java.io.File using a local variable of type java.lang.Object[]. This is symptomatic of .class transformation tools that ignore local variable information.
[apply]     at com.android.dx.cf.code.BaseMachine.throwLocalMismatch(BaseMachine.java:550)
[apply]     at com.android.dx.cf.code.BaseMachine.getLocalTarget(BaseMachine.java:405)
[apply]     at com.android.dx.cf.code.BaseMachine.storeResults(BaseMachine.java:532)
[apply]     at com.android.dx.cf.code.ValueAwareMachine.run(ValueAwareMachine.java:197)
[apply]     at com.android.dx.cf.code.RopperMachine.run(RopperMachine.java:291)
[apply]     at com.android.dx.cf.code.Simulator$SimVisitor.visitLocal(Simulator.java:608)
[apply]     at com.android.dx.cf.code.BytecodeArray.parseInstruction(BytecodeArray.java:526)
[apply]     at com.android.dx.cf.code.Simulator.simulate(Simulator.java:99)
[apply]     at com.android.dx.cf.code.Ropper.processBlock(Ropper.java:684)
[apply]     at com.android.dx.cf.code.Ropper.doit(Ropper.java:639)
[apply]     at com.android.dx.cf.code.Ropper.convert(Ropper.java:252)
[apply]     at com.android.dx.dex.cf.CfTranslator.processMethods(CfTranslator.java:252)
[apply]     at com.android.dx.dex.cf.CfTranslator.translate0(CfTranslator.java:131)
[apply]     at com.android.dx.dex.cf.CfTranslator.translate(CfTranslator.java:85)
[apply]     at com.android.dx.command.dexer.Main.processClass(Main.java:369)
[apply]     at com.android.dx.command.dexer.Main.processFileBytes(Main.java:346)
[apply]     at com.android.dx.command.dexer.Main.access$400(Main.java:59)
[apply]     at com.android.dx.command.dexer.Main$1.processFileBytes(Main.java:294)
[apply]     at com.android.dx.cf.direct.ClassPathOpener.processArchive(ClassPathOpener.java:244)
[apply]     at com.android.dx.cf.direct.ClassPathOpener.processOne(ClassPathOpener.java:130)
[apply]     at com.android.dx.cf.direct.ClassPathOpener.process(ClassPathOpener.java:108)
[apply]     at com.android.dx.command.dexer.Main.processOne(Main.java:313)
[apply]     at com.android.dx.command.dexer.Main.processAllFiles(Main.java:233)
[apply]     at com.android.dx.command.dexer.Main.run(Main.java:185)
[apply]     at com.android.dx.command.dexer.Main.main(Main.java:166)
[apply]     at com.android.dx.command.Main.main(Main.java:90)
[apply] ...at bytecode offset 00000006
[apply] locals[0000]: Lcom/officemax/impress/ui/library/task/DocumentBrowserTask;
[apply] locals[0001]: [Ljava/lang/Object;
[apply] locals[0002]: <invalid>
[apply] ...while working on block 0006
[apply] ...while working on method doTaskJob:([Ljava/lang/Object;)Lcom/kaciula/utils/ui/BasicTaskResponse;
[apply] ...while processing doTaskJob ([Ljava/lang/Object;)Lcom/kaciula/utils/ui/BasicTaskResponse;
[apply] ...while processing com/officemax/impress/ui/library/task/DocumentBrowserTask.class
[apply] 
[apply] 1 error; aborting

如何解决此问题？

Answer 1

这是 ProGuard 中的一个错误。它的优化步骤有时不会完全正确地更新类文件内的可选“LocalVariableTable”和“LocalVariableTypeTable”调试属性。 Dalvik VM 显式检查调试属性，如果不一致则拒绝类文件。

您应该检查最新版本的 ProGuard 是否修复了该问题。否则，您应该从类文件中删除局部变量名称和类型。您可以要求 java 编译器不要生成它们（例如“javac -g:none”）。您还可以要求 ProGuard 不要保留它们（不要指定“-keepattributes LocalVariableTable,LocalVariableTypeTable”）。

Answer 2

实际的 Proguard 部分完成，但 dex 无法再转换生成的字节码。 Dex 认为 LocalVariableTable 不正确。埃里克·拉福图恩（Eric Lafortune）是解释原因的更好来源（请参阅他的回答）。

如果您不仅不进行混淆，而且跳过优化步骤（-dontoptimize），那么问题就会消失。但你想用它来缩小尺寸。解决此问题的另一种方法是删除 javac 和 dex 中的调试标志。唯一的问题是，你也不会有正确的堆栈跟踪。您将获得没有源文件信息或行号的堆栈跟踪行，例如：

net.lp.collectionista.domain.items.book.BookItem.getCoverImageForFormField(Unkno‌​wn Source)

您可以通过在 ant 的 javac 标记中添加 debug="false" 来实现此目的main-rules.xml（您可能需要先将该部分复制到 build.xml）。这将设置一个标志javac -g:none。您还必须配置 dex，这在提供的 ant 模板中很难做到。我复制了 dex-helper 宏，确保它正在被使用，并在 dex 调用周围添加了一个条件标记：

        <echo>Converting compiled files and external libraries into ${intermediate.dex.file}...</echo>
        <if condition="debug">
            <then>
                <apply executable="${dx}" failonerror="true" parallel="true">
                    <arg value="--dex" />
                    <arg value="--output=${intermediate.dex.file}" />
                    <extra-parameters />
                    <arg line="${verbose.option}" />
                    <arg path="${out.dex.input.absolute.dir}" />
                    <path refid="out.dex.jar.input.ref" />
                    <external-libs />
                </apply>
            </then>
            <else>
                <apply executable="${dx}" failonerror="true" parallel="true">
                    <arg value="--dex" />
                    <arg value="--output=${intermediate.dex.file}" />
                    <arg value="--no-locals" /><!-- otherwise dex fails on the proguard bytecode -->
                    <extra-parameters />
                    <arg line="${verbose.option}" />
                    <arg path="${out.dex.input.absolute.dir}" />
                    <path refid="out.dex.jar.input.ref" />
                    <external-libs />
                </apply>
            </else>
        </if>

由 --no-locals 执行此操作。

为了减少堆栈跟踪信息的丢失，您可以分别使用行号信息以及类和方法名称信息：

-keepattributes SourceFile, LineNumberTable
-keep,allowshrinking,allowoptimization class * { <methods>; }

这样您可以进行部分混淆，并且仍然具有等效的良好堆栈跟踪。不过，我仍然建议您在发布时创建并保留映射文件。

最重要的是，您不应该指定 -keepattributes LocalVariableTable,LocalVariableTypeTable 以及同样的 -keepparameternames （如果您进行混淆，这本身也可能会给您带来麻烦） 。请注意，第二个隐含第一个，尽管从其名称中可能无法清楚地看出它影响属性。

就个人而言，考虑到 Proguard 的其他问题，我选择进行混淆，但减少堆栈跟踪信息的丢失。我还没有尝试过@plowman 的建议。

有关更多详细信息，您可以在此处找到我的版本控制项目文件：

• proguard.cfg

• build.xml

Answer 3

我刚刚在 Windows 的 Android Studio 上重新出现了这个问题，禁用 Instant Run 使一切再次正常运行。

Answer 4

在将 -dontobfuscate 标志添加到我的 proguard.cfg 文件后，我遇到了同样的问题。

最终的解决方案是我需要将其添加到我的优化中：

!code/allocation/variable

这使我的完整优化字符串如下所示：

-optimizations !field/removal/writeonly,!field/marking/private,!class/merging/*,!code/allocation/variable