Proguard在SpringBoot中的使用方法

在項(xiàng)目發(fā)布時(shí),有時(shí)為了保護(hù)代碼,防止他人反編譯,發(fā)布者會(huì)對(duì)代碼采取一定的保護(hù)措施。保護(hù)代碼的措施有很多種,而且安全性也不一樣。本文以SpringBoot項(xiàng)目為例,主要介紹的是在項(xiàng)目在發(fā)布時(shí)使用Proguard工具對(duì)代碼進(jìn)行混淆,增加代碼的閱讀難度。

1.在pom.xml文件中添加Proguard插件配置

<plugin>
            <groupId>com.github.wvengen</groupId>
            <artifactId>proguard-maven-plugin</artifactId>
            <version>2.0.11</version>
            <executions>
                <execution>
                    <!-- 混淆時(shí)刻,這里是打包的時(shí)候混淆-->
                    <phase>package</phase>
                    <goals>
                        <!-- 使用插件的什么功能,當(dāng)然是混淆-->
                        <goal>proguard</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                配置內(nèi)容下面介紹
            </configuration>
            <dependencies>
                <dependency>
                    <groupId>net.sf.proguard</groupId>
                    <artifactId>proguard-base</artifactId>
                    <version>6.2.2</version>
                </dependency>
            </dependencies>
        </plugin> 

2.對(duì)Proguard進(jìn)行配置

在進(jìn)行配置之前,對(duì)哪些類進(jìn)行混淆,哪些類不進(jìn)行混淆需要搞清楚。在SpringBoot項(xiàng)目中,容易混淆出問(wèn)題的有以下幾個(gè)方面:
(1)dao代碼混淆
一般dao會(huì)有對(duì)應(yīng)的mapper文件,如果對(duì)dao進(jìn)行混淆,mapper中指向的dao會(huì)找不到,報(bào)錯(cuò)。
可不進(jìn)行混淆:

<option>-keep class domain.dao.** {*;}</option>

(2)Spring中bean重名的問(wèn)題
spring容器中,默認(rèn)會(huì)將類名首字母小寫后作為bean的名稱。混淆代碼之后,不同包下的類可能被命名成相同的類,這樣就會(huì)出現(xiàn)bean重復(fù)。
解決方法:可以改變bean名稱的生成策略,可以加上包名來(lái)生成bean的名稱。修改main的方法,如下:

public class Application {
       public static class CustomGenerator implements BeanNameGenerator {
            @Override
            public String generateBeanName(BeanDefinition definition, BeanDefinitionRegistry registry) {
                return definition.getBeanClassName();
            }
        }
     
        public static void main(String[] args) {
            SpringApplicationBuilder sab=new SpringApplicationBuilder(Application.class)
                    .beanNameGenerator(new CustomGenerator());
            ApplicationContext ac =sab.run(args);
            //Arrays.stream(ac.getBeanDefinitionNames()).forEach(System.out::println);
        }
}

(3)controller方法參數(shù)名不能修改
因?yàn)閏ontroller是和前端交互的地方,controller方法的參數(shù)名不能改變,否則前臺(tái)傳參會(huì)有問(wèn)題。

<option>-keepclassmembers class domain.controller.** {*;}</option>

(4)自定義注解不能混淆
(5)實(shí)體類不能混淆
實(shí)體類混淆之后,可能會(huì)出現(xiàn)mabatis別名沖突

<option>-keep class domain.entity.** {*;}</option>

上述是代碼混淆配置的常見(jiàn)問(wèn)題,整個(gè)配置可參考下面的配置:

<configuration>
                <!-- 是否將生成的PG文件安裝部署-->
                <attach>true</attach>
                <!-- 是否混淆-->
                <!--<obfuscate>false</obfuscate>-->
                <obfuscate>true</obfuscate>
                <!-- 指定生成文件分類 -->
                <attachArtifactClassifier>pg</attachArtifactClassifier>
                <options>
                    <!-- JDK目標(biāo)版本1.8-->
                    <option>-target 1.8</option>
                    <!-- 不做收縮(刪除注釋、未被引用代碼)-->
                    <option>-dontshrink</option>
                    <option>-keepdirectories</option><!-- 配合spring -->
                    <!-- 不做優(yōu)化(變更代碼實(shí)現(xiàn)邏輯)-->
                    <option>-dontoptimize</option>
                    <!-- 不路過(guò)非公用類文件及成員-->
                    <option>-dontskipnonpubliclibraryclasses</option>
                    <option>-dontskipnonpubliclibraryclassmembers</option>
                    <!-- 混淆時(shí)不生成大小寫混合的類名 -->
                    <option>-dontusemixedcaseclassnames</option>
                    <!-- 優(yōu)化時(shí)允許訪問(wèn)并修改有修飾符的類和類的成員 --> 
                    <!--<option>-allowaccessmodification</option>-->
                    <!-- 確定統(tǒng)一的混淆類的成員名稱來(lái)增加混淆-->
                    <option>-useuniqueclassmembernames</option>
                    <!-- 不混淆所有包名-->
                    <option>-keeppackagenames</option>
                    <!-- 不混淆所有特殊的類-->
                    <option>-keepattributes Exceptions,InnerClasses,Signature,Deprecated,SourceFile,LineNumberTable,LocalVariable*Table,*Annotation*,Synthetic,EnclosingMethod</option>
                    <!-- 不混淆所有的set/get方法,畢竟項(xiàng)目中使用的部分第三方框架(例如Shiro)會(huì)用到大量的set/get映射-->
                    <!--                        <option>-keepclassmembers public class * {void set*(***);*** get*();}</option>-->

                    <!-- global -->
                    <option>-keep public class domain.Application {*;}</option>
                    <option>-keep class domain.*.aop.** {*;}</option>
                    <option>-keep class domain.dao.** {*;}</option>
                    <option>-keep class domain.entity.** {*;}</option>
                    <!-- common-->
                    <option>-keepclassmembers class domain.controller.** {*;}</option>
                    <!-- <option>-keepclassmembers class com.iot.common.config.ConfigValue {*;}</option>
                    <option>-keepclassmembers class com.iot.common.shiro.config.* {*;}</option>
                    <option>-keep class com.iot.common.log.* {*;}</option>
                    <option>-keep class com.iot.common.result.* {*;}</option> -->
                    <!-- data -->
                </options>
                <libs>
                    <lib>${java.home}/lib/rt.jar</lib>
                </libs>
                <!-- 加載文件的過(guò)濾器,也就是工程目錄-->
                <inFilter>domain/**</inFilter>
                <!-- 對(duì)什么東西進(jìn)行加載,這里僅有classes成功-->
                <injar>classes</injar>
                <outjar>${project.build.finalName}-pg.jar</outjar>
                <!-- 輸出目錄-->
                <outputDirectory>${project.build.directory}</outputDirectory>
            </configuration>
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容