Proguard使用教程

一、概念 

    ProGuard是一款免費的Java類文件壓縮器、優化器和混淆器。它能發現並刪除無用類、字段（field）、方法和屬性值（attribute）。它也能優化字節碼並刪除無用的指令。最后，它使用簡單無意義的名字來重命名你的類名、字段名和方法名。經過以上操作的jar文件會變得更小，並很難進行逆向工程。這里提到了ProGuard的主要功能是壓縮、優化和混淆，下面我就先介紹一下這些概念，然后再介紹ProGuard的基本使用方法。 

1、 什么是壓縮： 
   Java源代碼（.java文件）通常被編譯為字節碼（.class文件）。而完整的程序或程序庫通常被壓縮和發布成Java文檔（.jar文件）。字節碼比Java源文件更簡潔，但是它仍然包含大量的無用代碼，尤其它是一個程序庫的時候。ProGuard的壓縮程序操作能分析字節碼，並刪除無用的類、字段和方法。程序只保留功能上的等價，包括異常堆棧描述所需要的信息。 

2、什么是混淆： 
    通常情況下，編譯后的字節碼仍然包含了大量的調試信息：源文件名，行號，字段名，方法名，參數名，變量名等等。這些信息使得它很容易被反編譯和通過逆向工程獲得完整的程序。有時，這是令人厭惡的。例如像ProGuard這樣的混淆器就能刪除這些調試信息，並用無意義的字符序列來替換所有名字，使得它很難進行逆向工程，它進一步免費的精簡代碼。除了異常堆棧信息所需要的類名，方法名和行號外，程序只會保留功能上的等價。通過以上的了解，你應該明白為什么需要混淆了。 

3、 ProGuard支持那些種類的優化： 
除了在壓縮操作刪除的無用類，字段和方法外，ProGuard也能在字節碼級提供性能優化，內部方法有： 

• 常量表達式求值
• 刪除不必要的字段存取
• 刪除不必要的方法調用
• 刪除不必要的分支
• 刪除不必要的比較和instanceof驗證
• 刪除未使用的代碼
• 刪除只寫字段
• 刪除未使用的方法參數
• 像push/pop簡化一樣的各種各樣的peephole優化
• 在可能的情況下為類添加static和final修飾符
• 在可能的情況下為方法添加private, static和final修飾符
• 在可能的情況下使get/set方法成為內聯的
• 當接口只有一個實現類的時候，就取代它
• 選擇性的刪除日志代碼

實際的優化效果是依賴於你的代碼和執行代碼的虛擬機的。簡單的虛擬機比有復雜JIT編譯器的高級虛擬機更有效。無論如何，你的字節碼會變得更小。 
仍有一些明顯需要優化的技術不被支持： 

• 使非final的常量字段成為內聯
• 像get/set方法一樣使其他方法成為內聯
• 將常量表達式移到循環之外
• Optimizations that require escape analysis

    ProGuard是一個命令行工具，並提供了圖形化用戶界面，它也可以結合Ant或J2ME Wireless Toolkit使用。通過ProGuard得到的更精簡的jar文件意味着只需要更小的存儲空間；網絡傳輸更省時；裝載速度更快和占用更小的內存空間。另外，ProGuard非常快速和高效，它僅僅只花費幾秒鍾和幾兆的內存在處理程序。它處理的順序是先壓縮，然后優化，最后才進行混淆。The results section presents actual figures for a number of applications.與其他Java混淆器相比，ProGuard的主要優勢可能是它的基於模版文件的簡單配置。一些直觀的命令行選項或一個簡單的配置文件已經足夠了。例如，下面的配置選項保護了jar文件里的所有applets： 
-keep public class * extends java.applet.Applet 
用戶指南里說明了所有可用的選項，並以大量的例子為你演示這些功能強大的配置選項。 

   上面談到了ProGuard的很多好處，現在我們就來看看如何在程序中使用ProGuard吧，之前也提到了ProGuard可以用命令行、圖形界面、Ant等來執行和處理程序，同時也提到了配置文件，下面我們一起來看如何使用： 
用命令行執行ProGuard的命令如下： 
java –jar proguard.jar options…… 
具體的選項可以參考ProGuard的用戶指南，你也可以把這些屬性寫在配置文件里；運行時，我們只需要指定這個配置文件就行了，例如： 
java –jar proguard.jar @config.pro 
而配置文件的格式也是要按照ProGuard提供的格式來寫的，這個可以參考ProGuard例子里的配置文件來配置適合你的應用系統的ProGuard配置文件。ProGuard提供了圖形界面的配置和運行程序，你可以在界面上配置你想要的參數，然后運行即可。前面提到的要手動寫的配置文件也可以用圖形界面來配置和生成。 
如果你要在Ant里運行ProGuard，只需要添加一一個如下的target即可： 

<target name="proguard" depends="init"> 
       <taskdef resource="proguard/ant/task.properties" classpath="${lib.dir}/proguard/proguard.jar" /> 
       <proguard configuration="${src.dir}/config.pro" /> 
</target> 

你只需要制定lib.dir和src.dir屬性就行了，同樣的，這里也用了proguard配置文件，跟上面提到的是一樣的。建議大家把ProGuardGUI當成一個生成配置文件的向導來使用，這樣我們只需要修改配置文件而不用重新寫一個配置文件。 

 

二、用法

   （1）、從網上download proguard工具，proguard工具主要包含是幾個jar文件和一些example，下載地址http://proguard.sourceforge.net/ 
   （2）、將里面的幾個jar文件添加到類路徑下面。當然，也可以不添加，但是下面在做混淆的時候，必須指定classpath，使在做混淆的過程中，能否訪問該類 
   （3）、編寫一個配置文件，主要是混淆器的一些參數。比如，下面是一個例子 

-injars       platform.jar 
-outjars      platform_out.jar 
-libraryjars  <java.home>/lib/rt.jar 
-libraryjars ibatis-common-2.jar 
-libraryjars ibatis-dao-2.jar 
-libraryjars ibatis-sqlmap-2.jar 
-libraryjars junit-3.8.1.jar 
-libraryjars d:/j2ee.jar 
-libraryjars struts.jar 
-libraryjars commons-lang.jar 
-libraryjars D:/0working/coreproject/byislib/jasperreports-0.6.1.jar 
-libraryjars  commons-beanutils.jar 

-printmapping proguard.map 
-overloadaggressively 
-defaultpackage '' 
-allowaccessmodification 
-dontoptimize 
-keep public class * 
{ 
public protected *; 
} 
-keep public class org.** 
-keep public class it.** 

各個參數的含義參考proguard文檔，該文檔非常詳細，上手很容易 
OK，到此就完成了代碼混淆，打開產生的jar包可以看到，多了好多a、b、c之類的類文件。說明混淆結果已經成功。將原jar刪除、運行產生的混淆jar包，一切正常！ 

常見問題：使用過程中個人遇到了幾個問題，開始也是找了很久才解決 
  a. 內存溢出異常： 主要是proguard在做混淆的時候，吃了很多內存，因此，在運行混淆器的時候，可以增加內存，比如 java -mx512m ..... 
  b.棧溢出異常： 主要是proguard在做混淆的時候，會對一些代碼進行優化，若遇到一些相對復雜的方法時，可能會拋出此異常。對付的辦法是增加配置參數-dontoptimize，如上面的配置例子所示 

圖形界面程序:

解壓后，得到的lib包里有三個jar包文件，其中一個proguardgui.jar，是圖形界面程序。 
　　運行方法：在同樣的目錄中，建一個批處理文件（bat文件），內容就一句：java -jar proguardgui.jar，保存文件，雙擊鼠標運行這個文件，圖形界面就出現了。 
　　在圖形界面中，只需簡單的設置，就可以完成混淆的任務。 

　　1.在"Input/Output"頁簽中，設置好要混淆的jar包，設置好混淆結果包的名字，指定好編譯這個包需要的jar包，注意，jar包不要同名包含接口jar包及接口的實現jar包，Proguard會個定義重復的錯。 
　　2.在"Shriking"頁簽中，選擇一個Keep的類型，如果是WEB工程，就選Library，應用程序就選Application，等。 
　　3."Obfuscation"、"Optimization"頁簽中都選默認就可以了。有特殊要求，可以仔細研究一下文檔。如果混淆結果使用程序功能不太正常，可以把Optimize選項關閉。反正我們最關心的是混淆，優化不優化無所謂。 
　　4."Information"頁簽中，有個Ignore warnings about possibly erronous input，如果混淆的時候，因為警告無法繼續，可以把這個選項勾上。其它的選默認就可以了。 
　　5."Process"頁簽中，點"Process!"按鈕進行混淆。也可以點"Save configuration..."按鈕，保存配置文件。

 

以下面的Test.java文件為例：

import java.util.*;
import java.io.*;

public class Test {
    public static void main(String[] args) throws Exception { 
        BufferedReader stdin = new BufferedReader(new InputStreamReader(System.in));
           String s = stdin.readLine();        
        if(s.length()%2==0)
            System.out.println(showMsg1()); 
        else
            System.out.println(showMsg2());
        Flight a = new Flight();
        a.setName(s);
        System.out.println(a.output());
        Bomber b = new Bomber();
        b.setName(s);
        System.out.println(b.output());
        s = stdin.readLine();
        StringTokenizer st = new StringTokenizer(s);
        int n = Integer.parseInt(st.nextToken()); 
        System.out.println(compute(n));
    }
    
    public static String showMsg1() { 
        return "You are my sun1"; 
    }
    
    public static String showMsg2() { 
        return "You are my sun2"; 
    }
    
    public static int compute(int n) { 
        if(n>1)
            return n*compute(n-1); 
        else
            return 1;
    }
    
    public static class Flight{
        public Flight(){
        }
        
        public String output(){
            return this.name;
        }
        
        public void setName(String name){
            this.name="Flight:"+name;
        }
        
        private String name;
    }
    
    public static class Bomber{
        public Bomber(){
        }
        
        public String output(){
            return this.name;
        }
        
        public void setName(String name){
            this.name="Bomber:"+name;
        }
        
        private String name;
    }
}

首先jar cvf a.jar *.class打包程序，然后jad -d d:\ -r -s java d:\*.class反編譯程序，生成Test.java文件，通過對比可以發現，它和原來文件的內容基本是相同的。

// Decompiled by Jad v1.5.8g. Copyright 2001 Pavel Kouznetsov.
// Jad home page: http://www.kpdus.com/jad.html
// Decompiler options: packimports(3) 
// Source File Name:   Test.java

import java.io.*;
import java.util.StringTokenizer;

public class Test
{
    public static class Bomber
    {

        public String output()
        {
            return name;
        }

        public void setName(String s)
        {
            name = (new StringBuilder()).append("Bomber:").append(s).toString();
        }

        private String name;

        public Bomber()
        {
        }
    }

    public static class Flight
    {

        public String output()
        {
            return name;
        }

        public void setName(String s)
        {
            name = (new StringBuilder()).append("Flight:").append(s).toString();
        }

        private String name;

        public Flight()
        {
        }
    }


    public Test()
    {
    }

    public static void main(String args[])
        throws Exception
    {
        BufferedReader bufferedreader = new BufferedReader(new InputStreamReader(System.in));
        String s = bufferedreader.readLine();
        if(s.length() % 2 == 0)
            System.out.println(showMsg1());
        else
            System.out.println(showMsg2());
        Flight flight = new Flight();
        flight.setName(s);
        System.out.println(flight.output());
        Bomber bomber = new Bomber();
        bomber.setName(s);
        System.out.println(bomber.output());
        s = bufferedreader.readLine();
        StringTokenizer stringtokenizer = new StringTokenizer(s);
        int i = Integer.parseInt(stringtokenizer.nextToken());
        System.out.println(compute(i));
    }

    public static String showMsg1()
    {
        return "You are my sun1";
    }

    public static String showMsg2()
    {
        return "You are my sun2";
    }

    public static int compute(int i)
    {
        if(i > 1)
            return i * compute(i - 1);
        else
            return 1;
    }
}

進入Proguard的lib目錄，用JDK打開proguardgui.jar（java -jar proguardgui.jar），點選Input/Output標簽，選擇要混淆的JAR包（注意是JAR包），輸出JAR包，以及用到的所有類庫。
點選Obfuscation標簽，選中不需要混淆的類（要被反射的類絕對不能被混淆），一般是1，4，5，9，10，11，12這幾個選項。

a.txt的文件內容為：（混淆函數名）
Gcd
b.txt的文件內容為：（混淆類名）
A
B

點選Process標簽，Process按鈕，生產b.jar

解壓b.jar后，這時的3個class文件分別為A.class、B.class、Test.class；
重新反編譯程序jad -d d:\b\ -r -s java d:\b\*.class，生成3個java文件：A.java、B.java、Test.java，具體內容如下：

A.java

// Decompiled by Jad v1.5.8g. Copyright 2001 Pavel Kouznetsov.
// Jad home page: http://www.kpdus.com/jad.html
// Decompiler options: packimports(3) 


public final class A
{

    public A()
    {
    }

    public final String Gcd()
    {
        return Gcd;
    }

    public final void Gcd(String s)
    {
        Gcd = (new StringBuilder()).append("Bomber:").append(s).toString();
    }

    private String Gcd;
}

B.java

// Decompiled by Jad v1.5.8g. Copyright 2001 Pavel Kouznetsov.
// Jad home page: http://www.kpdus.com/jad.html
// Decompiler options: packimports(3) 


public final class B
{

    public B()
    {
    }

    public final String Gcd()
    {
        return Gcd;
    }

    public final void Gcd(String s)
    {
        Gcd = (new StringBuilder()).append("Flight:").append(s).toString();
    }

    private String Gcd;
}

Test.java

// Decompiled by Jad v1.5.8g. Copyright 2001 Pavel Kouznetsov.
// Jad home page: http://www.kpdus.com/jad.html
// Decompiler options: packimports(3) 

import java.io.*;
import java.util.StringTokenizer;

public class Test
{

    public Test()
    {
    }

    public static void main(String args[])
    {
        String s;
        if((s = (args = new BufferedReader(new InputStreamReader(System.in))).readLine()).length() % 2 == 0)
            System.out.println("You are my sun1");
        else
            System.out.println("You are my sun2");
        Object obj;
        ((B) (obj = new B())).Gcd(s);
        System.out.println(((B) (obj)).Gcd());
        ((A) (obj = new A())).Gcd(s);
        System.out.println(((A) (obj)).Gcd());
        s = args.readLine();
        args = Integer.parseInt((args = new StringTokenizer(s)).nextToken());
        System.out.println(Gcd(args));
    }

    private static int Gcd(int i)
    {
        if(i > 1)
            return i * Gcd(i - 1);
        else
            return 1;
    }
}

通過對比可以發現，它和原來文件的內容有許多出入。