使用ProGuard混淆Maven项目代码

基于idea开发的springboot maven项目,如果需要对java编译后的源码进行代码混淆,可以使用当下比较主流的ProGuard解决方案。ProGuard的版本选用和jdk的版本有很大关系。对于JDK1.8,至少需要选用ProGuard版本在6.0以上的。如下,采用最新的6.1.0beta2版本。

一:引入proguard-maven-plugin插件

<!-- 编译时使用ProGuard插件进行代码混淆 -->

<plugin>

    <groupId>com.github.wvengen</groupId>

    <artifactId>proguard-maven-plugin</artifactId>

    <version>2.0.14</version>

    <executions>

        <execution>

            <!-- 混淆时刻,这里是打包的时候混淆-->

            <phase>package</phase>

            <goals>

                <!-- 使用插件的什么功能,当然是混淆-->

                <goal>proguard</goal>

            </goals>

        </execution>

    </executions>

    <configuration>

        <proguardVersion>6.1.0beta2</proguardVersion>

        <obfuscate>true</obfuscate>

        <!-- 是否将生成的PG文件安装部署-->

        <attach>true</attach>

        <!-- 是否混淆-->

        <obfuscate>true</obfuscate>

        <!-- 指定生成文件分类 -->

        <attachArtifactClassifier>pg</attachArtifactClassifier>

        <options>

            <!-- JDK目标版本1.8-->

            <option>-target 1.8</option>

            <!-- 不做收缩(删除注释、未被引用代码)-->

            <!--<option>-dontshrink</option>-->

            <!-- 不做优化(变更代码实现逻辑)-->

            <!--<option>-dontoptimize</option>-->

            <!-- 不路过非公用类文件及成员-->

            <option>-dontskipnonpubliclibraryclasses</option>

            <option>-dontskipnonpubliclibraryclassmembers</option>

            <!-- 优化时允许访问并修改有修饰符的类和类的成员 -->

            <option>-allowaccessmodification</option>

            <!-- 确定统一的混淆类的成员名称来增加混淆,防止冲突-->

            <option>-useuniqueclassmembernames</option>

            <!-- 不混淆所有包名,Spring配置中有大量固定写法的包名-->

            <option>-keeppackagenames</option>

            <!-- 不混淆所有特殊的类-->

            <option>-keepattributes

                Exceptions,InnerClasses,Signature,Deprecated,SourceFile,LineNumberTable,LocalVariable*Table,*Annotation*,Synthetic,EnclosingMethod

            </option>

            <!-- 不混淆所有的set/get方法,毕竟项目中使用的部分第三方框架(例如Shiro/MyBatis)会用到大量的set/get映射-->

            <option>-keepclassmembers public class * {void set*(***);*** get*();}</option>

            <!--<option>-keepclassmembers class * { public protected *; }</option>-->

            <option>-keep class com.adnetera.adio.aop.*</option>

            <option>-keepclassmembers class com.adnetera.adio.aop.* { public protected *; }</option>

            <option>-keep class com.adnetera.adio.content.**</option>

            <option>-keepclassmembers class com.adnetera.adio.content.** { public protected *; }</option>

            <option>-keep class com.adnetera.adio.exception.**</option>

            <option>-keepclassmembers class com.adnetera.adio.exception.** { public protected *; }</option>

            <option>-keep class com.adnetera.adio.job.**</option>

            <option>-keepclassmembers class com.adnetera.adio.job.** { *; }</option>

            <option>-keep class com.adnetera.adio.module.**</option>

            <option>-keepclassmembers class com.adnetera.adio.module.** { *; }</option>

            <option>-keep class com.adnetera.adio.privilege.**</option>

            <option>-keepclassmembers class com.adnetera.adio.privilege.** { public protected *; }</option>

            <option>-keep class com.adnetera.adio.AdioUtilApplication</option>

            <option>-keepclassmembers class com.adnetera.adio.AdioUtilApplication{ *;}</option>

            <!--不显示警告信息,如果显示则会出现Error无法完成混淆!-->

            <option>-dontwarn **</option>

        </options>

        <!-- 添加依赖,这里你可以按你的需要修改,这里测试只需要一个JRE的Runtime包就行了 -->

        <libs>

            <lib>${java.home}/lib/rt.jar</lib>

            <lib>${java.home}/lib/jce.jar</lib>

            <lib>${java.home}/lib/ext/sunjce_provider.jar</lib>

        </libs>

        <!-- 加载文件的过滤器,就是你的工程目录了-->

        <inFilter>com/adnetera/adio/**</inFilter>

        <!-- 输出目录-->

        <outputDirectory>${project.build.directory}</outputDirectory>

        <!--<injar>classes</injar>-->

        <injar>${project.build.finalName}.jar</injar>

        <outjar>${project.build.finalName}-pg.jar</outjar>

    </configuration>

    <dependencies>

        <!-- 使用6.0.2版本来混淆 -->

        <dependency>

            <groupId>net.sf.proguard</groupId>

            <artifactId>proguard-base</artifactId>

            <version>6.1.0beta2</version>

            <scope>runtime</scope>

        </dependency>

    </dependencies>

</plugin>

在指定混淆/不混淆的控制选项中,需要注意以下准则:

(1)不混淆包名:

-keeppackagenames

(2)不混淆所有特殊的类,具体如:              Exceptions,InnerClasses,Signature,Deprecated,SourceFile,LineNumberTable,LocalVariable*Table,*Annotation*,Synthetic,EnclosingMethod

(3)不混淆setter和getter方法

项目中使用的部分第三方框架(例如MyBatis)会用到大量的set/get映射

<option>-keepclassmembers public class * {void set*(***);*** get*();}</option>

(4)不混淆入口函数所在类

如SpringBoot的Application启动类、Controller类、定时任务Job类、拦截器监听器;

建议基于项目代码层级逐层进行配置;

在没有使用keep指定不混淆的路径下的类的时候,会把所在路径下的类清除掉;

在没有使用keepclassmembers指定不混淆的类的时候,类中的未被引用的成员变量/方法会被清除掉。

(5)不显示警告信息

如果显示则会出现Error无法完成混淆!

<option>-dontwarn **</option>


二:更换Bean命名策略

由于proguard混淆貌似不能指定混淆的类名在basePackages下面类名混淆后唯一,不同包名经常有a.class,b.class,c.class之类重复的类名,因此spring容器初始化bean的时候会报错。不过,我们可以通过改变spring的bean的命名策略来解决这个问题,把包名带上,就唯一了

public static class CustomGenerator implements BeanNameGenerator {

    @Override

    public String generateBeanName(BeanDefinition definition, BeanDefinitionRegistry registry) {

        return definition.getBeanClassName();

    }

}

public static void main(String[] args) {

    new SpringApplicationBuilder(AdioUtilApplication.class)

            .beanNameGenerator(new CustomGenerator())

            .run(args);

}

由于采用ProGuard进行代码混淆需要在Application应用入口类启动应用时修改命名策略为根据类型(包含包名进行命名),而无法识别根据名称命名的bean属性,所以在这里需要将根据beanName获取bean对象的方式改为根据beanType获取。

例如:

// apiAuthAccountService = (ApiAuthAccountService) ApplicationContextContainer.getBean("apiAuthAccountService");

apiAuthAccountService = (ApiAuthAccountService) ApplicationContextContainer.getBean(ApiAuthAccountService.class);

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容