maven混淆打包的實(shí)現(xiàn)步驟

更新時(shí)間：2024年02月02日 11:40:12 作者：mob6454cc659b12

本文主要介紹了maven混淆打包的實(shí)現(xiàn)步驟,包含了Maven項(xiàng)目混淆、瘦身、打包exe這幾個(gè)方面,具有一定的參考價(jià)值,感興趣的可以了解一下

項(xiàng)目混淆

ProGuard 是一個(gè)混淆代碼的開(kāi)源項(xiàng)目，它的主要作用是混淆代碼，ProGuard 包括以下 4 個(gè)功能：

壓縮(Shrink)：檢測(cè)并移除代碼中無(wú)用的類(lèi)、字段、方法和特性（Attribute）
優(yōu)化(Optimize)：對(duì)字節(jié)碼進(jìn)行優(yōu)化，移除無(wú)用的指令
混淆(Obfuscate)：使用 a，b，c，d 這樣簡(jiǎn)短而無(wú)意義的名稱(chēng)，對(duì)類(lèi)、字段和方法進(jìn)行重命名
預(yù)檢(Preveirfy)：在 Java 平臺(tái)上對(duì)處理后的代碼進(jìn)行預(yù)檢，確保加載的 class 文件是可執(zhí)行的

使用 proguard 混淆代碼只能增加閱讀和理解的難度, 并不能百分百保證代碼安全。常用的應(yīng)用場(chǎng)景是項(xiàng)目需要部署到客戶(hù)機(jī)器上，一定程度上防止代碼泄露

具體實(shí)現(xiàn)

1.在原本的SpringBoot項(xiàng)目的pom.xml文件里面加上以下配置

<!--經(jīng)過(guò)修改后，能夠混淆的build段-->
    <build>
        <plugins>
            <!--maven打包插件-->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>3.0.2</version>
                <configuration>
                    <archive>
                        <manifest>
                            <addClasspath>true</addClasspath>
                            <mainClass>com.mmg.Main</mainClass> <!-- 此處為主入口-->
                        </manifest>
                    </archive>
                </configuration>
            </plugin>
            <!--proguard混淆插件-->
            <plugin>
                <groupId>com.github.wvengen</groupId>
                <artifactId>proguard-maven-plugin</artifactId>
                <version>2.5.3</version>
                <executions>
                    <execution>
                        <!--打包的時(shí)候開(kāi)始混淆-->
                        <phase>package</phase>
                    </execution>
                </executions>
                <configuration>
                    <proguardVersion>${proguard.version}</proguardVersion>
                    <injar>${project.build.finalName}.jar</injar>
                    <!--輸出的jar-->
                    <outjar>${project.build.finalName}.jar</outjar>
                    <!--是否混淆-->
                    <obfuscate>true</obfuscate>
                    <proguardInclude>${basedir}/proguard.cfg</proguardInclude>
                    <options>
                        <!--默認(rèn)開(kāi)啟，不做收縮（刪除注釋、未被引用代碼）-->
                        <option>-dontshrink</option>
                        <!--默認(rèn)是開(kāi)啟的，這里關(guān)閉字節(jié)碼級(jí)別的優(yōu)化-->
                        <option>-dontoptimize</option>
                        <!--對(duì)于類(lèi)成員的命名的混淆采取唯一策略-->
                        <option>-useuniqueclassmembernames</option>
                        <!--混淆時(shí)不生成大小寫(xiě)混合的類(lèi)名，默認(rèn)是可以大小寫(xiě)混合-->
                        <option>-dontusemixedcaseclassnames</option>
                        <!--混淆類(lèi)名之后，對(duì)使用Class.forName('className')之類(lèi)的地方進(jìn)行相應(yīng)替代-->
                        <option>-adaptclassstrings</option>
                        <!--對(duì)異常、注解信息在runtime予以保留，不然影響springboot啟動(dòng)-->
                        <option>-keepattributes
                            Exceptions,InnerClasses,Signature,Deprecated,SourceFile,LineNumberTable,*Annotation*,EnclosingMethod
                        </option>
                        <!--此選項(xiàng)將保存接口中的所有原始名稱(chēng)（不混淆）-->
                        <option>-keepnames interface ** { *; }</option>
                        <!--此選項(xiàng)將保存所有軟件包中的所有原始接口文件（不進(jìn)行混淆）-->
                        <!--<option>-keep interface * extends * { *; }</option>-->
                        <!--此選項(xiàng)將保留所有原始方法參數(shù),controller如果參數(shù)也混淆會(huì)導(dǎo)致傳參映射不上  -->
                        <option>-keepparameternames</option>
                        <!--保留枚舉成員及方法-->
                        <option>-keepclassmembers enum * { *; }</option>
                        <!--不混淆所有類(lèi),保存原始定義的注釋-->
                        <!--<option>-keepclassmembers class * {
                            @org.springframework.context.annotation.Bean *;
                            @org.springframework.beans.factory.annotation.Autowired *;
                            @org.springframework.beans.factory.annotation.Value *;
                            @org.springframework.stereotype.Service *;
                            @org.springframework.stereotype.Component *;
                            }
                        </option>-->
                        <!--忽略warn消息-->
                        <option>-ignorewarnings</option>
                        <!--忽略note消息-->
                        <option>-dontnote</option>
                    </options>
                    <!--java 11-->
                    <libs>
                        <lib>${java.home}/jmods/</lib>
                    </libs>
                    <!--java 8-->
                    <!-- <libs>
                         <lib>${java.home}/lib/rt.jar</lib>
                         <lib>${java.home}/lib/jsse.jar</lib>
                     </libs>-->
                </configuration>
                <dependencies>
                    <dependency>
                        <groupId>com.guardsquare</groupId>
                        <artifactId>proguard-base</artifactId>
                        <version>7.2.1</version>
                    </dependency>
                </dependencies>
            </plugin>
            <!--將自己加入的jar也打包插件 可加可不加-->
            <plugin>
                <artifactId>maven-assembly-plugin</artifactId>
                <configuration>
                    <archive>
                        <manifest>
                            <mainClass>com.mmg.Main</mainClass>
                        </manifest>
                        <manifestEntries>
                            <Class-Path>.</Class-Path>
                        </manifestEntries>
                    </archive>
                    <descriptorRefs>
                        <descriptorRef>jar-with-dependencies</descriptorRef>
                    </descriptorRefs>
                </configuration>
                <executions>
                    <execution>
                        <id>make-assembly</id>
                        <phase>package</phase>
                        <goals>
                            <goal>single</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

2.在與pom.xml文件同級(jí)目錄下新建一個(gè)proguard.cfg文件，這個(gè)文件是混淆的核心配置文件，根據(jù)需求進(jìn)行配置

Java maven 項(xiàng)目混淆 maven混淆打包_java

#所有類(lèi)(包括接口)的方法參數(shù)不混淆(包括沒(méi)被keep的)，如果參數(shù)混淆了，mybatis的mapper參數(shù)綁定會(huì)出錯(cuò)(如#{id}）
-keepattributes MethodParameters

#入口程序類(lèi)不能混淆，混淆會(huì)導(dǎo)致springboot啟動(dòng)不了
-keep class com.langyastudio.edu.admin.Application {
        public static void main(java.lang.String[]);
     }

#mybatis的mapper/實(shí)體類(lèi)不混淆，否則會(huì)導(dǎo)致xml配置的mapper找不到
-keep class com.langyastudio.edu.admin.dao.*
-keeppackagenames com.langyastudio.edu.admin.dao

#考慮到scanBasePackages，需要包名不被修改
-keeppackagenames com.langyastudio.edu
-keeppackagenames com.langyastudio.edu.admin.common

#一些配置類(lèi)比如datasource,aopconfig如果混淆會(huì)導(dǎo)致各種啟動(dòng)報(bào)錯(cuò)
# 比如用@Pointcut("execution(public * com.langyastudio.edu.*.controller..*.*(..))")
# 指定webLog方法對(duì)應(yīng)的@Pointcut作為切入點(diǎn),所以包的名字不能修改
-keeppackagenames com.langyastudio.edu.*.controller.**
-keep class com.langyastudio.edu.admin.config.*

#保留Serializable序列化的類(lèi)不被混淆
#例如傳入/輸出的Bean屬性
-keepclassmembers class * implements java.io.Serializable {*;}

#保留空的構(gòu)造函數(shù)
#-keepclassmembers class com.hacfin.* {
# public <init>(...);
#}

3.點(diǎn)擊maven生命周期中的package將項(xiàng)目進(jìn)行打包，然后點(diǎn)擊maven插件中的proguard插件對(duì)打出來(lái)的jar進(jìn)行混淆。值得注意的是，如果你使用將自己加入的jar也打包插件，他會(huì)把加入自己jar包的命名為xxxxx-jar-with-dependencies.jar，而混淆只能混淆原jar包，這時(shí)候需要你把xxxxx-jar-with-dependencies.jar修改為正常打包出來(lái)的jar名字(xxx-1.0-SNAPSHOT)，不然會(huì)混淆不了

Java maven 項(xiàng)目混淆 maven混淆打包_java_02

Java maven 項(xiàng)目混淆 maven混淆打包_maven_03

Java maven 項(xiàng)目混淆 maven混淆打包_spring boot_04

項(xiàng)目瘦身

什么是瘦身？

瘦身: thin Body 又稱(chēng) "減肥"、"減重"。就是合理、科學(xué)的減輕自身重量的。SpringBoot 應(yīng)用瘦身顧名思議：就是將 SpringBoot 應(yīng)用打包的 jar 利用合理的方式、方法減小體積。

為什么要瘦身？

場(chǎng)景: 現(xiàn)有的應(yīng)用開(kāi)發(fā)中，不論是單體架構(gòu)、微服務(wù)架構(gòu)，如果項(xiàng)目采用的是 springboot、springcloud 來(lái)作為底層框架，打包時(shí)最終都會(huì)以jar包的方式打包、部署。這是就會(huì)面臨一個(gè)問(wèn)題，就是 jar 包非常大，單體應(yīng)用還好，但是如果是微服務(wù)就非常痛苦，幾十個(gè)微服務(wù)就要拆分打包幾十個(gè) jar 包，每個(gè) jar 包都很大(幾百M(fèi))，合起來(lái)就好幾個(gè) GB，非常占用空間。如果是內(nèi)網(wǎng)部署，遇到動(dòng)輒GB的升級(jí)包還能勉強(qiáng)接受，最多就是運(yùn)維心里默默地吐槽一下，但是如果在外網(wǎng)云環(huán)境、或者客戶(hù)現(xiàn)場(chǎng)，那令人痛不欲生的帶寬加上各種網(wǎng)絡(luò)轉(zhuǎn)換限制，運(yùn)維心里各種??。因?yàn)檫@個(gè)你的領(lǐng)導(dǎo)又給你各種批頭蓋臉一頓。

如何瘦身？

瘦身思路：

其實(shí)就是將你自己寫(xiě)的代碼和引入依賴(lài)包進(jìn)行分離操作，它并不能改變項(xiàng)目總體的大小，但是它方便你日后對(duì)項(xiàng)目進(jìn)行升級(jí)操作，日后只需要換jar就可以了，不需要?jiǎng)庸潭ㄒ胍蕾?lài)jar包文件夾。

Java maven 項(xiàng)目混淆 maven混淆打包_jar_05

具體實(shí)現(xiàn)

1.在原本的SpringBoot項(xiàng)目的pom.xml文件里面加上以下配置

<!--經(jīng)過(guò)修改后，能夠瘦身的build段-->
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <fork>true</fork>
                    <finalName>${project.build.finalName}</finalName>
                    <!--解決windows命令行窗口中文亂碼-->
                    <jvmArguments>-Dfile.encoding=UTF-8</jvmArguments>
                    <layout>ZIP</layout>
                    <includes>
                        <!--這里是填寫(xiě)需要包含進(jìn)去的jar，
                            必須項(xiàng)目中的某些模塊，會(huì)經(jīng)常變動(dòng)，那么就應(yīng)該將其坐標(biāo)寫(xiě)進(jìn)來(lái)
                            如果沒(méi)有則non-exists ，表示不打包依賴(lài)
                        -->
                        <include>
                            <groupId>non-exists</groupId>
                            <artifactId>non-exists</artifactId>
                        </include>
                    </includes>
                </configuration>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <!-- 此插件用于將依賴(lài)包抽出-->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-dependency-plugin</artifactId>
                <executions>
                    <execution>
                        <id>copy-dependencies</id>
                        <phase>package</phase>
                        <goals>
                            <goal>copy-dependencies</goal>
                        </goals>
                        <configuration>
                            <!--抽出到哪個(gè)目錄，${project.build.directory}表示當(dāng)前項(xiàng)目構(gòu)建的目錄-->
                            <outputDirectory>${project.build.directory}/lib</outputDirectory>
                            <!--是否排除傳遞性-->
                            <excludeTransitive>false</excludeTransitive>
                            <!--是否去掉 jar 包版本信息-->
                            <stripVersion>false</stripVersion>
                            <!--包含范圍-->
                            <includeScope>runtime</includeScope>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <artifactId>maven-surefire-plugin</artifactId>
                <configuration>
                    <skip>true</skip>
                </configuration>
            </plugin>
        </plugins>
    </build>

2.經(jīng)過(guò)以上操作你再進(jìn)行項(xiàng)目打包后，你的項(xiàng)目將會(huì)分為自己寫(xiě)的代碼jar包和分離出來(lái)的jar包目錄，到這還沒(méi)結(jié)束，需要配合以下參數(shù)啟動(dòng)項(xiàng)目才行。

java -Dloader.path=./lib -jar xxx.jar

項(xiàng)目打包exe

可以使我們的項(xiàng)目直接由jar包打包成exe可執(zhí)行程序

具體實(shí)現(xiàn)

第一種實(shí)現(xiàn)方式

正常將我們的項(xiàng)目打成jar包，打包好以后先打開(kāi)看一下確保可以正確執(zhí)行

Java maven 項(xiàng)目混淆 maven混淆打包_spring boot_06

2.在當(dāng)前目錄加入以下腳本對(duì)jar包進(jìn)行打包，根據(jù)自己的jar包名稱(chēng)對(duì)以下腳本進(jìn)行修改即可！全部修改完成，雙擊此bat腳本即可

@echo off
echo package current jar to exe
set USE_JAR=PackageExe-1.0-SNAPSHOT.jar
set USE_CONFIG=config
set APP_CLASS=
set APP_NAME="SpringBootTest"
set OUT_FILE="SpringBootTest"
set TITLE="SpringBootTestDemo"

javapackager -deploy -native -outdir packages -outfile %OUT_FILE% -srcfiles %USE_JAR% -appclass org.springframework.boot.loader.JarLauncher -name %APP_NAME% -title %TITLE%

pause

Java maven 項(xiàng)目混淆 maven混淆打包_spring boot_07