Springboot - 代碼混淆

 

一、ProGuard POM文件

<plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>

            <!-- proguard混淆插件-->
            <plugin>
                <groupId>com.github.wvengen</groupId>
                <artifactId>proguard-maven-plugin</artifactId>
                <version>2.2.0</version>
                <executions>
                    <execution>
                        <!-- 打包的時候開始混淆-->
                        <phase>package</phase>
                        <goals>
                            <goal>proguard</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <injar>${project.build.finalName}.jar</injar>
                    <!--輸出的jar-->
                    <outjar>${project.build.finalName}.jar</outjar>
                    <!-- 是否混淆-->
                    <obfuscate>true</obfuscate>
                    <options>
                        <option>-target 1.8</option> <!--指定java版本號-->
                        <option>-dontshrink</option> <!--默認開啟，不做收縮（刪除注釋、未被引用代碼）-->
                        <option>-dontoptimize</option><!--默認是開啟的，這里關閉字節碼級別的優化-->
                        <option>-adaptclassstrings</option><!--混淆類名之后，對使用Class.forName('className')之類的地方進行相應替代-->
                        <option>-ignorewarnings
                        </option><!-- 忽略warn消息,如果提示org.apache.http.* 這個包里的類有問題，那么就加入下述代碼：-keep class org.apache.http.** { *; }    -dontwarn org.apache.http.**-->
                        <option>-keep class org.apache.logging.log4j.util.* { *; }</option>
                        <option>-dontwarn org.apache.logging.log4j.util.**</option>
                        <option>-keepattributes
                            Exceptions,InnerClasses,Signature,Deprecated,SourceFile,LineNumberTable,*Annotation*,EnclosingMethod
                        </option><!--對異常、注解信息在runtime予以保留，不然影響springboot啟動-->
                        <!--不混淆所有interface接口-->
                        <!--                        <option>-keepnames interface **</option>-->
                        <option>-keepclassmembers enum * { *; }</option><!--保留枚舉成員及方法-->
                        <option>-keepparameternames</option>
                        <option>-keepclasseswithmembers public class * {
                            public static void main(java.lang.String[]);}
                        </option> <!--保留main方法的類及其方法名-->
                        <!--忽略note消息，如果提示javax.annotation有問題，那麽就加入以下代碼-->
                        <option>-dontnote javax.annotation.**</option>
                        <option>-dontnote sun.applet.**</option>
                        <option>-dontnote sun.tools.jar.**</option>
                        <option>-dontnote org.apache.commons.logging.**</option>
                        <option>-dontnote javax.inject.**</option>
                        <option>-dontnote org.aopalliance.intercept.**</option>
                        <option>-dontnote org.aopalliance.aop.**</option>
                        <option>-dontnote org.apache.logging.log4j.**</option>

                        <!--  ##### 以下為需要根據項目情況修改 ##### -->
                        <!--入口程序類不能混淆，混淆會導致springboot啟動不了-->
                        <option>-keep class com.garbat.es.Application</option>
                        <option>-keep class com.garbat.es.controller.* {*;}</option>
                        <!--  ##### 以上為需要根據項目情況修改 ##### -->

                        <option>-keep interface * extends * { *; }</option>
                        <!--不混淆所有類,保存原始定義的注釋-->
                        <option>-keepclassmembers class * {
                            @org.springframework.beans.factory.annotation.Autowired *;
                            @org.springframework.beans.factory.annotation.Value *;
                            }
                        </option>
                    </options>
                    <libs>
                        <!-- 添加依賴 java8-->
                        <lib>${java.home}/lib/rt.jar</lib>
                        <lib>${java.home}/lib/jce.jar</lib>
                    </libs>
                </configuration>
                <dependencies>
                    <!-- https://mvnrepository.com/artifact/net.sf.proguard/proguard-base -->
                    <dependency>
                        <groupId>net.sf.proguard</groupId>
                        <artifactId>proguard-base</artifactId>
                        <version>6.1.1</version>
                    </dependency>
                </dependencies>
            </plugin>
            <!--Springboot repackage 打包-->
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <!-- spingboot 打包需要repackage否則不是可執行jar -->
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                        <configuration>
                            <mainClass>com.garbat.es.Application</mainClass>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

二、混淆配置要點

建議逐個java包定義混淆規則，這樣思路更清晰 ；
repository（dao）層需要保存包名和類名，因為Mybatis的xml文件中引用了dao層的接口 ；
controller層注意在使用@PathVariable、@RequestParam時需要顯式聲明參數名 ；
dao層用於映射數據庫表的類和controller層映射前台參數的類，都需要保留類成員 ；

三、更換bean命名策略

bean命名重復異常，由於proguard混淆貌似不能指定在basePackages下面類名混淆后唯一，不同包名經常有a.class，b.class,c.class之類重復的類名，因此spring容器初始化bean的時候會報錯。我們可以通過改變spring的bean的命名策略來解決這個問題，把包名帶上，就唯一了

修改spring的bean命名策略，改成按類的全限定名來命名。

@SpringBootApplication
public class MmfwEsApplication {
    public static class CustomGenerator implements BeanNameGenerator {
        @Override
        public String generateBeanName(BeanDefinition definition, BeanDefinitionRegistry registry) {
            return definition.getBeanClassName();
        }
    }

    public static void main(String[] args)
    {
        context = new SpringApplicationBuilder(MmfwEsApplication.class)
                .beanNameGenerator(new CustomGenerator())
                .run(args);
      
        System.out.println("平台啟動成功");
    }
}

　參考：https://www.jianshu.com/p/09b0637525db