SpringBoot?+?proguard+maven多模塊實現(xiàn)代碼混淆的方法
上文介紹了單個springboot的maven工程實現(xiàn)代碼混淆,本文將會介紹多maven工程實現(xiàn)代碼混淆。
多模塊跟單模塊一樣,在需要混淆模塊的pom文件中加入proguard依賴及配置。
演練版本
springboot:2.5.8
jdk:1.8
proguard: 7.1.0
新建springboot多Maven工程
新建springboot多maven工程,結構如下圖,proguard-root 是頂級父工程,proguard-modu01、proguard-mudu02是兩個業(yè)務模塊,proguard-server是springboot啟動服務類模塊。
接下來會對proguard-modu01、proguard-mudu02兩個模塊實現(xiàn)proguard代碼混淆。
下面以proguard-modu01工程為例介紹。
proguard-modu01 工程結構
proguard-modu01 的pom.xml配置代碼混淆
本次我將proguard配置項放入 <options> </options>內(nèi),也可以單獨配置在proguard.cfg文件內(nèi)。
特別注意避坑:多maven工程代碼混淆一定要配置:<option>-keepdirectories</option>,否則在以后訪問代碼混淆子模塊的controller時會提示404錯誤。
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>com.proguard</groupId> <artifactId>proguard-root</artifactId> <version>1.0</version> </parent> <artifactId>proguard-modu02</artifactId> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-devtools</artifactId> <scope>runtime</scope> <optional>true</optional> </dependency> </dependencies> <!-- 配置代碼混淆 開始--> <build> <plugins> <plugin> <groupId>com.github.wvengen</groupId> <artifactId>proguard-maven-plugin</artifactId> <version>2.6.0</version> <executions> <!-- 以下配置說明執(zhí)行mvn的package命令時候,會執(zhí)行proguard--> <execution> <phase>package</phase> <goals> <goal>proguard</goal> </goals> </execution> </executions> <configuration> <proguardVersion>7.1.0</proguardVersion> <!-- 原始jar --> <injar>${project.build.finalName}.jar</injar> <!-- 混淆后的jar --> <outjar>${project.build.finalName}.jar</outjar> <!-- 是否混淆 默認是true --> <obfuscate>true</obfuscate> <!-- 是否將生成的PG文件安裝部署 --> <!-- <attach>true</attach> --> <!--指定生成文件分類--> <!--<attachArtifactClassifier>pg</attachArtifactClassifier>--> <!-- 將pom.xml打包至jar文件中 --> <addMavenDescriptor>true</addMavenDescriptor> <!-- 混淆配置文件proguard.cfg <proguardInclude>${project.basedir}/proguard.cfg</proguardInclude>--> <!-- 項目編譯所需要的jar --> <libs> <lib>${java.home}/lib/rt.jar</lib> </libs> <!-- 對輸入jar進行過濾比如,如下配置就是對META-INFO文件不處理。 <inLibsFilter>!META-INF/**,!META-INF/versions/9/**.class</inLibsFilter>--> <!-- 輸出路徑配置,但是要注意這個路徑必須要包括injar標簽填寫的jar --> <outputDirectory>${project.basedir}/target</outputDirectory> <!--配置混淆的一些細節(jié)選項,可在proguard.cfg中配置--> <options> <!-- JDK目標版本1.8--> <option>-target 1.8</option> <!-- 不做收縮(刪除注釋、未被引用代碼)--> <option>-dontshrink</option> <!-- 不做優(yōu)化(變更代碼實現(xiàn)邏輯)--> <option>-dontoptimize</option> <!-- 不混忽略非公用類文件及成員--> <option>-dontskipnonpubliclibraryclasses</option> <option>-dontskipnonpubliclibraryclassmembers</option> <!--不用大小寫混合類名機制--> <option>-dontusemixedcaseclassnames</option> <!-- 優(yōu)化時允許訪問并修改有修飾符的類和類的成員 --> <option>-allowaccessmodification</option> <!-- 確定統(tǒng)一的混淆類的成員名稱來增加混淆--> <option>-useuniqueclassmembernames</option> <!-- 保持目錄結構--> <option>-keepdirectories</option> <!-- 不混淆所有包名--> <!--<option>-keeppackagenames</option>--> <!-- 混淆類名之后,對使用Class.forName('className')之類的地方進行相應替代--> <option>-adaptclassstrings</option> <!-- 需要保持的屬性:異常,注解等--> <option>-keepattributes Exceptions,InnerClasses,Signature,Deprecated,SourceFile,LocalVariable*Table,*Annotation*,Synthetic,EnclosingMethod</option> <!-- 此選項將保存所有軟件包中的所有原始接口文件(不進行混淆) --> <option>-keepnames interface ** { *; }</option> <!-- 此選項將保存所有軟件包中的所有原始接口文件(不進行混淆) --> <option>-keep interface * extends * { *; }</option> <!-- 保留參數(shù)名,因為控制器,或者Mybatis等接口的參數(shù)如果混淆會導致無法接受參數(shù),xml文件找不到參數(shù) --> <option>-keepparameternames</option> <!-- 保留枚舉成員及方法 --> <option>-keepclassmembers enum * { *; }</option> <!-- 不混淆所有類,保存原始定義的注釋 --> <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 *; @org.springframework.web.bind.annotation.RestController *; } </option> <!-- 忽略warn消息 --> <option>-ignorewarnings</option> --> <!-- 忽略note消息 --> <option>-dontnote</option> --> <!-- 打印配置信息 --> <option>-printconfiguration</option> <!-- 不混淆controller入口類 <option>-keep class com.platform.scamp.entity.** {*;}</option> <option>-keep class com.platform.scamp.service.ScampVehicleTrackService {*;}</option> <option>-keep class com.platform.scamp.controller.** {*;}</option>--> </options> <injarNotExistsSkip>true</injarNotExistsSkip> <!-- 把jar包放到臨時目錄以便縮短命令行 --> <putLibraryJarsInTempDir>true</putLibraryJarsInTempDir> </configuration> <dependencies> <dependency> <groupId>com.guardsquare</groupId> <artifactId>proguard-base</artifactId> <version>7.1.0</version> <scope>runtime</scope> </dependency> <dependency> <groupId>com.guardsquare</groupId> <artifactId>proguard-core</artifactId> <version>7.1.0</version> <scope>runtime</scope> </dependency> </dependencies> </plugin> </plugins> </build> <!-- 配置代碼混淆 結束--> </project>
此時,已完成proguard-modu01模塊的代碼混淆配置,proguard-modu02模塊同上配置即可。
proguard-server 啟動服務模塊的啟動類配置
由于代碼混淆,會存在大量的類名重名問題,因此需要在springboot啟動類中修改 BeanName 生成策略。
方式一:
package com.proguard; import org.springframework.beans.factory.config.BeanDefinition; import org.springframework.beans.factory.support.BeanDefinitionRegistry; import org.springframework.beans.factory.support.BeanNameGenerator; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.builder.SpringApplicationBuilder; @SpringBootApplication public class ProguardServerApplication { public static class CustomGenerator implements BeanNameGenerator { public String generateBeanName(BeanDefinition definition, BeanDefinitionRegistry registry) { return definition.getBeanClassName(); } } public static void main(String[] args) { new SpringApplicationBuilder(ProguardServerApplication.class) .beanNameGenerator(new CustomGenerator()) .run(args); } }
方式二:若是maven工程師引用了springfox-boot-starter組件、springfox-*.jar相關組件,會產(chǎn)生異常,重寫springboot啟動類,如下:
@SpringBootApplication public class ProguardServerApplication { public static void main(String[] args) { new SpringApplicationBuilder(ProguardServerApplication .class) .beanNameGenerator(new ProGuardBeanNameGenerator()).run(); } /** * 代碼混淆后,包名、類名會存在重復,重寫buildDefaultBeanName方法,獲取全限定的類名 */ static class ProGuardBeanNameGenerator extends AnnotationBeanNameGenerator { @Override protected String buildDefaultBeanName(BeanDefinition definition) { return definition.getBeanClassName(); } } }
啟動,驗證
通過Java反編譯工具 查看源代碼結果如下圖,包名、類名已經(jīng)重新命名,代表代碼混淆已生效。
proguard-modu01:
proguard-modu02:
啟動訪問
訪問proguard-modu01中接口:
訪問proguard-modu02中接口:
踩過坑
1. proguard-modu01、proguard-modu02配置混淆后,訪問接口提示404。去掉代碼混淆恢復正常訪問。
解決:在proguard-modu01、proguard-modu02的pom.xml文件中配置保持目錄結構:<option>-keepdirectories</option>
2. 若是maven工程師引用了springfox-boot-starter組件、springfox-*.jar相關組件,會產(chǎn)生異常。
2023-06-05 17:07:38.322[0;39m [31mERROR[0;39m [35m19088[0;39m [2m---[0;39m [2m[ restartedMain][0;39m [36mo.s.boot.SpringApplication [0;39m [2m:[0;39m Application run failed
org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'springfox.documentation.spring.web.scanners.ApiDocumentationScanner' defined in URL [jar:file:/D:/maven/maven-repository/io/springfox/springfox-spring-web/3.0.0/springfox-spring-web-3.0.0.jar!/springfox/documentation/spring/web/scanners/ApiDocumentationScanner.class]: Unsatisfied dependency expressed through constructor parameter 1; nested exception is org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'springfox.documentation.spring.web.scanners.ApiListingScanner' defined in URL [jar:file:/D:/maven/maven-repository/io/springfox/springfox-spring-web/3.0.0/springfox-spring-web-3.0.0.jar!/springfox/documentation/spring/web/scanners/ApiListingScanner.class]: Unsatisfied dependency expressed through constructor parameter 1; nested exception is org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'springfox.documentation.spring.web.scanners.ApiModelReader' defined in URL [jar:file:/D:/maven/maven-repository/io/springfox/springfox-spring-web/3.0.0/springfox-spring-web-3.0.0.jar!/springfox/documentation/spring/web/scanners/ApiModelReader.class]: Unsatisfied dependency expressed through constructor parameter 0; nested exception is org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'springfox.documentation.schema.CachingModelProvider' defined in URL [jar:file:/D:/maven/maven-repository/io/springfox/springfox-schema/3.0.0/springfox-schema-3.0.0.jar!/springfox/documentation/schema/CachingModelProvider.class]: Unsatisfied dependency expressed through constructor parameter 0; nested exception is org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'springfox.documentation.schema.DefaultModelProvider' defined in URL [jar:file:/D:/maven/maven-repository/io/springfox/springfox-schema/3.0.0/springfox-schema-3.0.0.jar!/springfox/documentation/schema/DefaultModelProvider.class]: Unsatisfied dependency expressed through constructor parameter 0; nested exception is org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'springfox.documentation.schema.property.CachingModelPropertiesProvider' defined in URL [jar:file:/D:/maven/maven-repository/io/springfox/springfox-schema/3.0.0/springfox-schema-3.0.0.jar!/springfox/documentation/schema/property/CachingModelPropertiesProvider.class]: Unsatisfied dependency expressed through constructor parameter 1; nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'springfox.documentation.schema.property.ModelPropertiesProvider' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {@org.springframework.beans.factory.annotation.Qualifier(value=optimized)}
at org.springframework.beans.factory.support.ConstructorResolver.createArgumentArray(ConstructorResolver.java:800) ~[spring-beans-5.3.14.jar:5.3.14]
at org.springframework.beans.factory.support.ConstructorResolver.autowireConstructor(ConstructorResolver.java:229) ~[spring-beans-5.3.14.jar:5.3.14]
at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.autowireConstructor(AbstractAutowireCapableBeanFactory.java:1372) ~[spring-beans-5.3.14.jar:5.3.14]
at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.createBeanInstance(AbstractAutowireCapableBeanFactory.java:1222) ~[spring-beans-5.3.14.jar:5.3.14]
at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.doCreateBean(AbstractAutowireCapableBeanFactory.java:582) ~[spring-beans-5.3.14.jar:5.3.14]
at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.createBean(AbstractAutowireCapableBeanFactory.java:542) ~[spring-beans-5.3.14.jar:5.3.14]
at org.springframework.beans.factory.support.AbstractBeanFactory.lambda$doGetBean$0(AbstractBeanFactory.java:335) ~[spring-beans-5.3.14.jar:5.3.14]
at org.springframework.beans.factory.support.DefaultSingletonBeanRegistry.getSingleton(DefaultSingletonBeanRegistry.java:234) ~[spring-beans-5.3.14.jar:5.3.14]
at org.springframework.beans.factory.support.AbstractBeanFactory.doGetBean(AbstractBeanFactory.java:333) ~[spring-beans-5.3.14.jar:5.3.14]
at org.springframework.beans.factory.support.AbstractBeanFactory.getBean(AbstractBeanFactory.java:208) ~[spring-beans-5.3.14.jar:5.3.14]
at org.springframework.beans.factory.support.DefaultListableBeanFactory.preInstantiateSingletons(DefaultListableBeanFactory.java:953) ~[spring-beans-5.3.14.jar:5.3.14]
at org.springframework.context.support.AbstractApplicationContext.finishBeanFactoryInitialization(AbstractApplicationContext.java:918) ~[spring-context-5.3.14.jar:5.3.14]
at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:583) ~[spring-context-5.3.14.jar:5.3.14]
at org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext.refresh(ServletWebServerApplicationContext.java:145) ~[spring-boot-2.5.8.jar:2.5.8]
at org.springframework.boot.SpringApplication.refresh(SpringApplication.java:765) ~[spring-boot-2.5.8.jar:2.5.8]
at org.springframework.boot.SpringApplication.refreshContext(SpringApplication.java:445) ~[spring-boot-2.5.8.jar:2.5.8]
at org.springframework.boot.SpringApplication.run(SpringApplication.java:338) ~[spring-boot-2.5.8.jar:2.5.8]
at org.springframework.boot.builder.SpringApplicationBuilder.run(SpringApplicationBuilder.java:143) [spring-boot-2.5.8.jar:2.5.8]
at com.proguard.ProguardServerApplication.main(ProguardServerApplication.java:22) [classes/:na]
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) ~[na:1.8.0_192]
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62) ~[na:1.8.0_192]
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) ~[na:1.8.0_192]
at java.lang.reflect.Method.invoke(Method.java:498) ~[na:1.8.0_192]
at org.springframework.boot.devtools.restart.RestartLauncher.run(RestartLauncher.java:49) [spring-boot-devtools-2.5.8.jar:2.5.8]
解決方式:重寫springboot啟動類
@SpringBootApplication public class ProguardServerApplication { public static void main(String[] args) { new SpringApplicationBuilder(ProguardServerApplication .class) .beanNameGenerator(new ProGuardBeanNameGenerator()).run(); } /** * 代碼混淆后,包名、類名會存在重復,重寫buildDefaultBeanName方法,獲取全限定的類名 */ static class ProGuardBeanNameGenerator extends AnnotationBeanNameGenerator { @Override protected String buildDefaultBeanName(BeanDefinition definition) { return definition.getBeanClassName(); } } }
到此這篇關于SpringBoot + proguard+maven多模塊實現(xiàn)代碼混淆的文章就介紹到這了,更多相關SpringBoot maven多模塊代碼混淆內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
SpringBoot?項目的創(chuàng)建與啟動步驟詳解
這篇文章主要介紹了SpringBoot?項目的創(chuàng)建與啟動,本文分步驟給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2023-03-03Springboot基于BCrypt非對稱加密字符串的實現(xiàn)
本文主要介紹了Springboot基于BCrypt非對稱加密字符串的實現(xiàn),文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2023-04-04SpringBoot整合ip2region獲取客戶端IP地理位置信息
在我們?nèi)粘EB開發(fā)工作中,經(jīng)常會有需要獲取客戶端地理位置的需求,本文主要介紹了SpringBoot整合ip2region獲取客戶端IP地理位置信息,具有一定的參考價值,感興趣的可以了解一下2024-08-08