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"})