[TOC]

Java代碼混淆工具ProGuard

由于Java 代碼的 class類很容易被反編譯，為了保證知識產(chǎn)權(quán)有時候需要將代碼進行混淆。而ProGuard就提供了混淆Java代碼的方法。

簡介

描述

ProGuard是Java字節(jié)碼最受歡迎的優(yōu)化程序。它能夠讓Java代碼變小90%變快20%。ProGuard通過混淆類名、屬性、方法來提供對代碼的保護，一次對抗反編譯工程。

作用的環(huán)境

• 桌面應用
• 嵌入式應用
• 手機應用

功能

當你安裝好一個windows桌面版的ProGuard之后，面板上會提示你設置壓縮（Shrink）、優(yōu)化（Optimize） 、混淆（Obfuscate）、預檢（Preverify）。

• 壓縮：會檢測遞歸地確定哪些class被使用。所有起的類和方法將會被刪除
• 優(yōu)化：將非入口的方法、類設置為私有、靜態(tài)或者不可更改的，沒有使用的變量刪除一些方法會被橫線劃掉。
• 混淆：將那些不是入口點的類、方法重命名。在整個過程中保證入口點確保他們始終能夠被原有的名字訪問到。
• 預檢：對處理后的代碼進行預檢，確保加載的class文件是可執(zhí)行的

工作原理

注：圖片來源于官網(wǎng)

image

下載

https://sourceforge.net/projects/proguard/

下載解壓后，有多種方式可以運行，以windows下為例

• 可以運行proguardgui.bat文件運行桌面應用

• 在lib下找到proguard.jar，通過執(zhí)行 java -jar proguard.jar @ input

# 注：這個方法未嘗試成功，報如下錯誤
Error: Can't read [C:\Program Files (x86)\Java\jdk1.8.0_172\jre\jmods\java.base.jmod(;;;;;;!**.jar;!module-info.class)] (No such file or directory: C:\Program Files (x86)\Java\jdk1.8.0_172\jre\jmods\java.base.jmod)

• 在lib下找到proguardgui.jar，通過執(zhí)行java -jar proguardgui.jar進入到桌面應用

使用時注意事項

<font color="red">注：下面是碰見的問題</font>

版本問題

一定要使用6.0以上的ProGuard 版本，因為不同的ProGuard版本支持不同的Java版本，目前Proguard6.0 支持 Java9。我再調(diào)試過程中遇見的問題是

# log4j部分的lib庫使用了Java9,一直報錯如下。
Can't read [D:\proguardConfig\lib\log4j-api-2.10.0.jar] (Can't process class [META-INF/versions/9/org/apache/logging/log4j/util/ProcessIdUtil.class] (Unsupported class version number [53.0] (maximum 52.0, Java 1.8)))

JDK位數(shù)問題

盡量使用64位的JDK，否則可能會出現(xiàn)棧溢出的錯誤

Exception in thread "main" java.lang.OutOfMemoryError: Java heap space

Java的字節(jié)碼驗證問題

重新混淆后的class類，在使用tomcat啟動項目的時候會報，原因是不符合字節(jié)碼不符合規(guī)范

# java7 在JAVA_OPTS中加入
-XX:-UseSplitVerifier
# java8 中上面的選項被移除了使用如下參數(shù)
-noverify
# --------------------------
# 增加之后會跳過字節(jié)碼的驗證，當然程序還能夠正常運行的，不需要擔心

關(guān)于使用類似于Hibernate的對象關(guān)系映射框架

model類一定不能混淆，包括類名、屬性、以及get set方法。使用如下配置可以做到

-keep class test.model.*  {*;}
#  class test.model.* 保存model包下的所有類名
#  {*;} 保存每個類下的所有屬性與方法
#  可以不用保留住類名，要保留的最重要的東西是類中定義的mapping
# 關(guān)于配置下面還會有介紹

在Maven項目中 使用ProGuard

注：項目使用的是Maven打包的所以最終使用這個當例子，桌面版的也很簡單，就是簡單通過可視化界面自動生成了配置文件。

引入Proguard 插件

• pom.xml

<plugin>
                <groupId>com.github.wvengen</groupId>
                <artifactId>proguard-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals><goal>proguard</goal></goals>
                    </execution>
                </executions>
                <configuration>
                    <proguardVersion>6.1.0beta1</proguardVersion>
                    <injar>classes</injar>
                    <outjar>test.jar</outjar>
                    <obfuscate>true</obfuscate>
                    <proguardInclude>proguard.conf</proguardInclude>
                    <libs>
                        <lib>C:/Program Files (x86)/Java/jdk1.8.0_172/jre/lib/rt.jar</lib>
                        <lib>C:/Program Files (x86)/Java/jdk1.8.0_172/jre/lib/jce.jar</lib>
                    </libs>
                </configuration>
                <dependencies>
                    <dependency>
                        <groupId>net.sf.proguard</groupId>
                        <artifactId>proguard-base</artifactId>
                        <version>6.1.0beta1</version>
                    </dependency>
                </dependencies>
            </plugin>

注：

1. <font color="red">一定要使用6.0以上的版本，否則不支持Java9</font>

2. <font color="red">我測試的時候使用的springboot項目，需要將proguard 插件的位置放在Spring Boot 插件的前面否則會失敗。該問題是我記錄的問題，寫本文的時候又嘗試了一下，前后都沒有問題。僅供有問題的人參考一下。</font>

• 參數(shù)說明

injar:輸入文件，可以是[jar][war][folder][aar][ear][zip][apk],我injar是target下的class目錄
outjar:導出文件，以上的都可以是導出一個jar
proguardInclude:配置文件位置,配置文件中的配置都可以在pom.xml中用標簽的方式寫，太亂不建議
libs:使用到的java類庫。rt.jar是必須的，我看網(wǎng)上都是dt.jar。官網(wǎng)目前介紹的是rt.jar

<font color="red">注：這里聲明一個問題。我在使用 war to war 的過程中一直報棧溢出的錯誤，我在本地更換64位的jdk之后不會報這個錯誤，但是一直在執(zhí)行很長時間沒有停止，不知道原因。</font>

• 配置文件proguard.conf

-target 1.8 ##指定java版本號
-dontshrink ##默認是開啟的，這里關(guān)閉shrink，即不刪除沒有使用的類/成員
-dontoptimize ##默認是開啟的，這里關(guān)閉字節(jié)碼級別的優(yōu)化
-useuniqueclassmembernames ##對于類成員的命名的混淆采取唯一策略
-adaptclassstrings ## 混淆類名之后，對使用Class.forName('className')之類的地方進行相應替代
-dontusemixedcaseclassnames ## 混淆時不生成大小寫混合的類名，默認是可以大小寫混合
-dontpreverify
-ignorewarnings
-dontskipnonpubliclibraryclasses ## 不加這個會報錯Error: Can't find common super class of [java/lang/StringBuffer] and [org/eclipse/swt/internal/win32/TCHAR]
-keep class com.cisco.bgp.model.*  {*;}

<font color="red">注：幾點注意，關(guān)閉壓縮、關(guān)閉優(yōu)化、關(guān)閉預檢，否則會出現(xiàn)問題?；煜遣簧a(chǎn)大小寫混合名稱，否則會產(chǎn)生歧義。關(guān)閉warning 否則不讓通過。</font>

• 配置文件的詳細介紹

官網(wǎng)地址 https://www.guardsquare.com/en/products/proguard/manual/usage#iooptions

• 運行mvn命令

mvn package
#以上是我遇到的一些問題，如果還有問題可以再運行mvn package +X 看看具體的信息進行修改

• 顯示結(jié)果

 [proguard] Preparing output jar [C:\Workflow\BGP\target\test.jar]
 [proguard]   Copying resources from program directory [C:\Workflow\BGP\target\classes] (filtered)
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  14.467 s
[INFO] Finished at: 2019-03-12T10:11:01+08:00
[INFO] ------------------------------------------------------------------------

• 輸出文件

如果沒有指定injar outjar他會在target目錄下生成如下四個文件

gs-rest-service-0.1.0_proguard_base.jar
gs-rest-service-0.1.0.jar.original
proguard_map.txt # 存放混淆前后類、方法的對應關(guān)系
proguard_seed.txt # 存放保持不變的類

如果指定injar outjar他會在指定目錄下生成如下三個文件

test.jar # 指定的輸出文件
proguard_map.txt # 存放混淆前后類、方法的對應關(guān)系
proguard_seed.txt # 存放保持不變的類

• 導入war包

由于war to war的過程中一直有問題，我只能講jar包的里面的類導入到war包中

1. 用解壓工作打開混淆后的jar，將混淆后的class類文件夾提取出來
2. 用解壓工具打開war包，將war包原有的類文件刪除
3. 將提取出的混淆后的class文件夾拖入到war包中
4. 放到tomcat web路徑，測試成功

附一張桌面版的截圖

image