Springboot+proguard+maven 混淆

最近在弄项目混淆的，proguard是最为广为使用的工具之一，可是用他的客户端来混淆springboot项目的时候最后总得不到可执行的jar。后来发现了proguard-maven-plugin这个插件，所有proguard的指令都可以在pom中实现，正好在github上也找到了参考项目，这里给大家分享下。

直接看pom：

<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>

            <!-- 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插件替换成上面的代码即可，注意将上面包路径改为自己的。

<option>-keep class !com.slm.proguard.example.spring.boot.controller.ExampleController { *; }</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>

这块代码可以作为一个研究部分，如果有好多共同的类不需要混淆，如实体类（试过经过序列化了），可以通过添加如下代码来保留：

<option>-keep class * implements java.io.Serializable </option>

@org.springframework.这块可以自己继续添加要保留的注解。

<libs>
    <!-- Include main JAVA library required.-->
    <lib>${java.home}/lib/rt.jar</lib>
    <lib>${java.home}/lib/jce.jar</lib>
</libs>

一般这里添加第一个就够了，而且用proguard的时候也是默认给出第一个，如果有必要再添加第二个或其它依赖的jar。

<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的问题。

在使用客户端的时候经常会出现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。