基於Springboot+proguard+maven 混淆

最近在弄項目混淆的,proguard是最爲廣爲使用的工具之一,但是用他的客戶端來混淆springboot項目的時候最後總得不到可執行的jar。後來發現了proguard-maven-plugin這個插件,全部proguard的指令均可以在pom中實現,正好在github上也找到了參考項目,這裏給你們分享下。java

直接看pom:git

<build>
        <finalName>${artifactId}</finalName>
        <plugins>
            <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>5.3.3</proguardVersion>
                    <injar>${project.build.finalName}.jar</injar>
                    <outjar>${project.build.finalName}.jar</outjar>
                    <obfuscate>true</obfuscate>
                    <options>
                        <option>-dontshrink</option>
                        <option>-dontoptimize</option>
                        <!-- This option will replace all strings in reflections method invocations with new class names.
                             For example, invokes Class.forName('className')-->
                        <option>-adaptclassstrings</option>
                        <!-- This option will save all original annotations and etc. Otherwise all we be removed from files.-->
                        <option>-keepattributes Exceptions,InnerClasses,Signature,Deprecated,
                            SourceFile,LineNumberTable,*Annotation*,EnclosingMethod</option>
                        <!-- This option will save all original names in interfaces (without obfuscate).-->
                        <option>-keepnames interface **</option>
                        <!-- This option will save all original methods parameters in files defined in -keep sections,
                             otherwise all parameter names will be obfuscate.-->
                        <option>-keepparameternames</option>
                        <!-- This option will save all original class files (without obfuscate) but obfuscate all in domain package.-->
                        <!--<option>-keep class !com.slm.proguard.example.spring.boot.domain.** { *; }</option>-->
                        <option>-keep class !com.slm.proguard.example.spring.boot.controller.ExampleController { *; }</option>
                        <!-- This option will save all original class files (without obfuscate) in service package-->
                        <!--<option>-keep class com.slm.proguard.example.spring.boot.service { *; }</option>-->
                        <!-- This option will save all original interfaces files (without obfuscate) in all packages.-->
                        <option>-keep interface * extends * { *; }</option>
                        <!-- This option will save all original defined annotations in all class in all packages.-->
                        <option>-keepclassmembers class * {
                                @org.springframework.beans.factory.annotation.Autowired *;
                                @org.springframework.beans.factory.annotation.Value *;
                            }
                        </option>
                    </options>
                    <libs>
                        <!-- Include main JAVA library 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>5.3.3</version>
                    </dependency>
                </dependencies>
            </plugin>github

            <!-- Maven assembly must be run after proguard obfuscation so it take already obfuscated files.-->
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                        <configuration>
                            <mainClass>com.slm.proguard.example.spring.boot.Application</mainClass>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

直接在項目中將本身打包的maven插件替換成上面的代碼便可,注意將上面包路徑改成本身的。spring

<option>-keep class !com.slm.proguard.example.spring.boot.controller.ExampleController { *; }</option>
1
這行代碼是用來指定不被混淆的包的,這裏用的是「!」操做,我實際用的時候把這裏直接改爲本身要保留的包(注意將!去掉),由於項目中通常不止一處須要混淆,這樣也更清晰些。springboot

<!-- This option will save all original interfaces files (without obfuscate) in all packages.-->
                        <option>-keep interface * extends * { *; }</option>
                        <!-- This option will save all original defined annotations in all class in all packages.-->
                        <option>-keepclassmembers class * {
                                @org.springframework.beans.factory.annotation.Autowired *;
                                @org.springframework.beans.factory.annotation.Value *;
                            }
                        </option>

這塊代碼能夠做爲一個研究部分,若是有好多共同的類不須要混淆,如實體類(試過通過序列化了),能夠經過添加以下代碼來保留:dom

<option>-keep class * implements java.io.Serializable </option>
@org.springframework.這塊能夠本身繼續添加要保留的註解。maven

<libs>
    <!-- Include main JAVA library required.-->
    <lib>${java.home}/lib/rt.jar</lib>
    <lib>${java.home}/lib/jce.jar</lib>
</libs>
通常這裏添加第一個就夠了,並且用proguard的時候也是默認給出第一個,若是有必要再添加第二個或其它依賴的jar。spring-boot

<dependencies>
    <dependency>
        <groupId>net.sf.proguard</groupId>
        <artifactId>proguard-base</artifactId>
        <version>5.3.3</version>
    </dependency>
</dependencies>
若是使用的是jdk8,最好這裏使用5.0以上的版本,我這裏選用目前最新的5.3.3。工具

另外須要注意的點, shrink這個功能通常最好別用,因此這裏添加了<option>-dontshrink</option>,我就遇到過啓動jar的時候不支持壓縮jar的問題。ui

在使用客戶端的時候常常會出現warings之類的提示,大多數處理方式都是使用-ignorewarings這個被官方指令來解決的,可是好多文章或參考資料中都有說明,這可能會帶來一些問題。(使用本文中插件的時候用不到這個東西)。

網上不少地方是把指令寫在一個外部proguard.conf來實現的,可是我用那些方法的時候一直沒有成功。問題有可能出在下面這塊代碼處:

<configuration>
     <mainClass>com.slm.proguard.example.spring.boot.Application</mainClass>
</configuration>
由於通常都沒指定這裏,在proguard.conf中加上或許能夠(具體我沒試)。

<option>-keep class !com.slm.proguard.example.spring.boot.controller.ExampleController { *; }</option>
通常的keep指令中具體到某個類的時候,是能夠用/指定的,可是在這裏我用的時候一直說未閉合的<>之類的問題,你們能夠留一下。若是在這裏實在無法用,能夠考慮在proguard.conf用來實現,而後再pom中指定引用這個配置。

要說的就這些,若是有什麼問題能夠給我留言,遇到問題找不到解決方案的滋味很差受啊~~

最後貼身github上原做者的項目鏈接proguard-spring-boot。

相關文章
相關標籤/搜索