ProGuard混淆Java项目的核心代码

开发需求

众所周知，class文件可以进行反编译从而泄露核心代码，为了保护知识产权，需要对代码进行混淆再进行打包。现阶段采用proguard去做一个基本的混淆，使代码的可读性降低。

操作步骤 

【模块目录结构】

1.在子模块provider的src目录下增加assembly目录和package.xml，xml内容如下

<include>标签：是混淆该模块下的代码，值和provider模块pom中的<groupId>标签值一致。因为我的pom中还引入公司封装的redis模块，所以也一起配置。

<assembly xmlns="http://maven.apache.org/ASSEMBLY/2.1.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.1.0 http://maven.apache.org/xsd/assembly-2.1.0.xsd">

    <id>assembly</id>
    <formats>
        <format>jar</format>
    </formats>
    <includeBaseDirectory>false</includeBaseDirectory>
    <dependencySets>
        <dependencySet>
            <outputDirectory>/</outputDirectory>
            <useProjectArtifact>true</useProjectArtifact>
            <unpack>true</unpack>
            <scope>runtime</scope>
            <includes>
                <include>com.test.df:*</include>
                <include>com.test.platform.redis:*</include>
            </includes>
        </dependencySet>
    </dependencySets>
</assembly>

2.在子模块provider下增加一个文件配置，命名为progrard.cfg 。配置内容如下，-keep 根据实际包名自行修改

##指定java版本号
-target 1.8
##默认是开启的，这里关闭shrink，即不删除没有使用的类/成员
-dontshrink
##默认是开启的，这里关闭字节码级别的优化
-dontoptimize
##对于类成员的命名的混淆采取唯一策略
-useuniqueclassmembernames
## 混淆类名之后，对使用Class.forName('className')之类的地方进行相应替代
-adaptclassstrings
## 混淆时不生成大小写混合的类名，默认是可以大小写混合
-dontusemixedcaseclassnames
##忽略warn消息,如果提示org.apache.http.* 这个包里的类有问题，那么就加入下述代码：
## -keep class org.apache.http.** { *; }    -dontwarn org.apache.http.**
-ignorewarnings
##保留那些需要被保留的方法的参数名称
-keepparameternames
##对异常、注解信息在runtime予以保留，不然影响springboot启动
-keepattributes Exceptions,InnerClasses,Signature,Deprecated,SourceFile,LineNumberTable,*Annotation*,EnclosingMethod
##保留main方法的类及其方法名
-keepclasseswithmembers public class * { public static void main(java.lang.String[]);}
##保留枚举成员及方法
-keepclassmembers enum * { *; }
##指定那些需要被保留名字的类和类成员，前提是他们在被代码压缩的时候没有被移除。
##如：你可能希望保留那些实现了Serializable接口的类的名字
-keepnames interface **
##保留接口
-keep interface * extends * { *; }
##保留项目需要的相关类，根据项目实际情况配置
-keep class com.test.df.provider.DfBillApplication {*;}
-keep class com.test.df.api.model.** {*;}
-keep class com.test.df.common.enums.** {*;}

3.子模块provider的pom文件添加配置

 3.1 使用 <plugin> assembly把依赖打进去，注意它的id必须是assembly；

 3.2 使用 <plugin> proguard混淆代码，配置标签 <injar> 和 <outjar> 的后缀都需要带上assembly；

 3.3 使用 <plugin> repackage打包，注意这里需要排除前面第一步在package.xml中include进来的包，如果不排除的话，它会把没混淆的jar包再次加入到lib目录；

 <plugin>标签配置的顺序必须是先assembly再proguard再repackage

<properties>
        <java.version>1.8</java.version>
        <proguard.version>6.2.0</proguard.version>
        <proguard.maven.plugin.version>2.3.1</proguard.maven.plugin.version>
</properties>
<build>
        <finalName>bill-provider</finalName>
        <plugins>
            <!--assembly插件-->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-assembly-plugin</artifactId>
                <version>2.4.1</version>
                <executions>
                    <execution>
                        <id>assembly</id>
                        <phase>package</phase>
                        <goals>
                            <goal>single</goal>
                        </goals>
                        <configuration>
                            <descriptors>
                                <descriptor>src/assembly/package.xml</descriptor>
                            </descriptors>
                            <archive>
                                <manifest>
                                  <mainClass>com.test.df.provider.DfBillApplication</mainClass>
                                </manifest>
                            </archive>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
            <!--proguard插件-->
            <plugin>
                <groupId>com.github.wvengen</groupId>
                <artifactId>proguard-maven-plugin</artifactId>
                <version>${proguard.maven.plugin.version}</version>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>proguard</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <proguardInclude>./proguard.cfg</proguardInclude>
                    <proguardVersion>${proguard.version}</proguardVersion>
                    <injar>${project.build.finalName}-assembly.jar</injar>
                    <outjar>${project.build.finalName}-assembly.jar</outjar>
                    <obfuscate>true</obfuscate>
                    <injarNotExistsSkip>true</injarNotExistsSkip>
                    <libs>
                        <!--Put here your libraries if required-->
                        <lib>${java.home}/lib/rt.jar</lib>
                        <lib>${java.home}/lib/jce.jar</lib>
                    </libs>
                </configuration>
                <dependencies>
                    <dependency>
                        <groupId>net.sf.proguard</groupId>
                        <artifactId>proguard-base</artifactId>
                        <version>${proguard.version}</version>
                    </dependency>
                </dependencies>
            </plugin>
            <!--springboot插件-->
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>2.0.0.x.RELEASE</version>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                        <configuration>
                            <finalName>${artifactId}</finalName>
                            <mainClass>com.test.df.provider.DfBillApplication</mainClass>
                            <excludeGroupIds>com.test.df</excludeGroupIds>
                            <excludes>
                                <exclude>
                                    <groupId>com.test.platform.redis</groupId>
                                    <artifactId>test-platform-redis</artifactId>
                                </exclude>
                            </excludes>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
</build>

编译打包

maven打包后，会出现三个jar包和两个proguard.txt文件，测试的话启动第一个jar包。

 

你会看到jar包中classes文件的包名，类名，方法名都用abc去代替，降低了代码可读性。

运行测试

启动jar包的过程中遇到了挺多bug，列举一些典型的。

1. jar包里面只有api模块代码，没有provider模块代码

解决方法：子模块api和provider下的pom<groupId>标签值不一致，因为你前面package.xml配置了include标签值，所以pom里也要改成 <groupId>com.test.df</groupId>

2. 找不到某个模块中的类，报错：ClassNotFoundException

解决方法：看jar包里是不是缺少这个类，可能是打包方式不对，找出为什么没有打进去的原因。

3. 配置文件（xml和properties文件）的内容被覆盖了

解决方法：因为和别的模块下同名有冲突，所以内容就会被覆盖。目前是改配置文件名称，有好的方法以后会再补充。

4. 找不到bean，报错：Field A in com.test.df.a.a required a bean 'com.test.platform.redis.MsgProcess' that could not be found.

解决方法：原因是redis模块的MsgProcess类没有被springboot注入。需要在provider模块的启动类配置注解，@ComponentScan(basePackages = {"com.test.df","com.test.platform.redis"})