使用 yGuard 在 Gradle 中混淆 Java ~ 如何排除方法？

Question

我想使用 yGuard 混淆 Gradle 中的 Java 代码。到目前为止，我已经设法使用以下方法进行混淆：

dependencies {
    compile 'com.yworks:yguard:2.9.2'
}

task yGuardObfuscate {
    group 'yGuard'
    description 'Obfuscates existing archives.'
    dependsOn "installDist"

    doLast {
        ant.taskdef(
            name: 'yguard',
            classname: 'com.yworks.yguard.YGuardTask',
                classpath: sourceSets.main.runtimeClasspath.asPath
            )

        ant.yguard {
            inoutpairs {
                fileset(dir: "./build/install/module") {
                    include(name: "module*.jar")
                    exclude(name: "*_obf.jar")
                }
            }

            rename(logFile: "./build/install/module/rename.log") {
                property(name: "naming-scheme", value: "mix")
            }
        }
    }
}

但是，问题是 main 函数被遮盖了，我不能再使用 java -jar module_obf.jar（它与未混淆的 jar 一起工作）运行它了。

我尝试了几种方法将 main 函数从混淆中排除。

首先，我尝试按照文档 (https://yworks.github.io/yGuard/task_documentation/#controlling-obfuscation-exclusion-with-annotations) 中的说明使用 @Obfuscate 注释，如下所示：

  @com.yworks.util.annotation.Obfuscation( exclude = true, applyToMembers = false)
  public static void main(String[] args) {
    try {
      new Start();
    } catch (SQLException e) {
      LOGGER.error(e, e);
    }
  }

在我的 IDE（Eclipse 2019-14）中，此行显示为有效。但是，当尝试使用我创建的 gradle 任务对其进行编译时，出现以下错误：

...\Start.java:22: error: package com.yworks.util.annotation does not exist
  @com.yworks.util.annotation.Obfuscation( exclude = true, applyToMembers = false)
                             ^

我尝试了很多方法来让它工作，但无法找到一个可行的解决方案。

所以接下来，我尝试在 yGuardObfuscate 任务中使用 keep > 方法元素来显式保留 Start class 的 main 函数，就像这样:

task yGuardObfuscate {
    group 'yGuard'
    description 'Obfuscates existing archives.'
    dependsOn "installDist"

    doLast {
        ant.taskdef(
            name: 'yguard',
            classname: 'com.yworks.yguard.YGuardTask',
                classpath: sourceSets.main.runtimeClasspath.asPath
            )

        ant.yguard {
            inoutpairs {
                fileset(dir: "./build/install/module") {
                    include(name: "module*.jar")
                    exclude(name: "*_obf.jar")
                }
            }

            rename(logFile: "./build/install/module/rename.log") {
                property(name: "naming-scheme", value: "mix")
                keep {
                    method("class": "com.company.project.module.Start", name: "public static void main(String[] args)")
                }
            }
        }
    }
}

这导致 Gradle 构建失败并出现以下异常：

: java.lang.IllegalArgumentException: '(' expected but found void
[...]
Caused by: java.lang.IllegalArgumentException: '(' expected but found void
    at com.yworks.yguard.ObfuscatorTask.toNativeMethod(ObfuscatorTask.java:188)
    at com.yworks.yguard.ant.MethodSection.addEntries(MethodSection.java:35)
    at com.yworks.yguard.ant.ExposeSection.createEntries(ExposeSection.java:170)
    at com.yworks.yguard.ObfuscatorTask.execute(ObfuscatorTask.java:745)
    at com.yworks.yguard.YGuardTask.execute(YGuardTask.java:116)
[...]
Root cause: java.lang.IllegalArgumentException: '(' expected but found void
    at com.yworks.yguard.ObfuscatorTask.toNativeMethod(ObfuscatorTask.java:188)
    at com.yworks.yguard.ant.MethodSection.addEntries(MethodSection.java:35)
    at com.yworks.yguard.ant.ExposeSection.createEntries(ExposeSection.java:170)
    at com.yworks.yguard.ObfuscatorTask.execute(ObfuscatorTask.java:745)
    at com.yworks.yguard.YGuardTask.execute(YGuardTask.java:116)

同样，我在这里尝试了几种方法，例如不带“”编写 "class"，添加额外的 {}，但没有任何帮助。

所以这里的问题是：我做错了什么？我怎样才能防止 yGuard 混淆 main 函数？

Answer 1

我现在想出了一个让它工作的方法，尽管它感觉更像是一种变通方法而不是正确的解决方案，所以如果有人知道我在 "official" 解决方案中做错了什么，请告诉我我.

为此，我使用了注释方法，而不是使用默认注释，而是创建了一个自定义注释，它几乎是我项目中的精确副本。

注释 class 如下所示：

package com.company.project.module.annotations;

public @interface Obfuscation {
      boolean exclude() default true;

      boolean applyToMembers() default true;
}

我在开始 class 中这样使用它：

import com.company.project.module.annotations.*;

[...]

  @Obfuscation( exclude = true, applyToMembers = false)
  public static void main(String[] args) {
    [...]
  }

最后，我将这个自定义注释 class 添加到任务的 rename 元素中，如下所示：

            rename(logFile: "./build/install/module/rename.log", annotationClass: "com.company.project.module.annotations.Obfuscation") {
                property(name: "naming-scheme", value: "mix")
            }

所以整个 gradle 任务现在看起来像这样：

task yGuardObfuscate {
    group 'yGuard'
    description 'Obfuscates existing archives.'
    dependsOn "installDist"

    doLast {
        ant.taskdef(
            name: 'yguard',
            classname: 'com.yworks.yguard.YGuardTask',
                classpath: sourceSets.main.runtimeClasspath.asPath
            )

        ant.yguard {
            inoutpairs {
                fileset(dir: "./build/install/module") {
                    include(name: "module*.jar")
                    exclude(name: "*_obf.jar")
                }
            }

            rename(logFile: "./build/install/module/rename.log", annotationClass: "com.company.project.module.annotations.Obfuscation") {
                property(name: "naming-scheme", value: "mix")
            }
        }
    }
}

有了它，构建现在可以工作了，我可以使用 java -jar module_obf.jar 成功地运行我的程序。

使用 yGuard 在 Gradle 中混淆 Java ~ 如何排除方法？

Obfuscating Java in Gradle using yGuard ~ How to exclude methods?

java

obfuscation

yguard

gradle