maven混淆打包的实现步骤

更新时间：2024年02月02日 11:40:12 作者：mob6454cc659b12

本文主要介绍了maven混淆打包的实现步骤,包含了Maven项目混淆、瘦身、打包exe这几个方面,具有一定的参考价值,感兴趣的可以了解一下

项目混淆

ProGuard 是一个混淆代码的开源项目，它的主要作用是混淆代码，ProGuard 包括以下 4 个功能：

压缩(Shrink)：检测并移除代码中无用的类、字段、方法和特性（Attribute）
优化(Optimize)：对字节码进行优化，移除无用的指令
混淆(Obfuscate)：使用 a，b，c，d 这样简短而无意义的名称，对类、字段和方法进行重命名
预检(Preveirfy)：在 Java 平台上对处理后的代码进行预检，确保加载的 class 文件是可执行的

使用 proguard 混淆代码只能增加阅读和理解的难度, 并不能百分百保证代码安全。常用的应用场景是项目需要部署到客户机器上，一定程度上防止代码泄露

具体实现

1.在原本的SpringBoot项目的pom.xml文件里面加上以下配置

<!--经过修改后，能够混淆的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>
                        <!--打包的时候开始混淆-->
                        <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>
                        <!--默认开启，不做收缩（删除注释、未被引用代码）-->
                        <option>-dontshrink</option>
                        <!--默认是开启的，这里关闭字节码级别的优化-->
                        <option>-dontoptimize</option>
                        <!--对于类成员的命名的混淆采取唯一策略-->
                        <option>-useuniqueclassmembernames</option>
                        <!--混淆时不生成大小写混合的类名，默认是可以大小写混合-->
                        <option>-dontusemixedcaseclassnames</option>
                        <!--混淆类名之后，对使用Class.forName('className')之类的地方进行相应替代-->
                        <option>-adaptclassstrings</option>
                        <!--对异常、注解信息在runtime予以保留，不然影响springboot启动-->
                        <option>-keepattributes
                            Exceptions,InnerClasses,Signature,Deprecated,SourceFile,LineNumberTable,*Annotation*,EnclosingMethod
                        </option>
                        <!--此选项将保存接口中的所有原始名称（不混淆）-->
                        <option>-keepnames interface ** { *; }</option>
                        <!--此选项将保存所有软件包中的所有原始接口文件（不进行混淆）-->
                        <!--<option>-keep interface * extends * { *; }</option>-->
                        <!--此选项将保留所有原始方法参数,controller如果参数也混淆会导致传参映射不上  -->
                        <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 *;
                            }
                        </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文件同级目录下新建一个proguard.cfg文件，这个文件是混淆的核心配置文件，根据需求进行配置

Java maven 项目混淆 maven混淆打包_java

#所有类(包括接口)的方法参数不混淆(包括没被keep的)，如果参数混淆了，mybatis的mapper参数绑定会出错(如#{id}）
-keepattributes MethodParameters

#入口程序类不能混淆，混淆会导致springboot启动不了
-keep class com.langyastudio.edu.admin.Application {
        public static void main(java.lang.String[]);
     }

#mybatis的mapper/实体类不混淆，否则会导致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

#一些配置类比如datasource,aopconfig如果混淆会导致各种启动报错
# 比如用@Pointcut("execution(public * com.langyastudio.edu.*.controller..*.*(..))")
# 指定webLog方法对应的@Pointcut作为切入点,所以包的名字不能修改
-keeppackagenames com.langyastudio.edu.*.controller.**
-keep class com.langyastudio.edu.admin.config.*

#保留Serializable序列化的类不被混淆
#例如传入/输出的Bean属性
-keepclassmembers class * implements java.io.Serializable {*;}

#保留空的构造函数
#-keepclassmembers class com.hacfin.* {
# public <init>(...);
#}

3.点击maven生命周期中的package将项目进行打包，然后点击maven插件中的proguard插件对打出来的jar进行混淆。值得注意的是，如果你使用将自己加入的jar也打包插件，他会把加入自己jar包的命名为xxxxx-jar-with-dependencies.jar，而混淆只能混淆原jar包，这时候需要你把xxxxx-jar-with-dependencies.jar修改为正常打包出来的jar名字(xxx-1.0-SNAPSHOT)，不然会混淆不了

Java maven 项目混淆 maven混淆打包_java_02

Java maven 项目混淆 maven混淆打包_maven_03

Java maven 项目混淆 maven混淆打包_spring boot_04

项目瘦身

什么是瘦身？

瘦身: thin Body 又称 "减肥"、"减重"。就是合理、科学的减轻自身重量的。SpringBoot 应用瘦身顾名思议：就是将 SpringBoot 应用打包的 jar 利用合理的方式、方法减小体积。

为什么要瘦身？

场景: 现有的应用开发中，不论是单体架构、微服务架构，如果项目采用的是 springboot、springcloud 来作为底层框架，打包时最终都会以jar包的方式打包、部署。这是就会面临一个问题，就是 jar 包非常大，单体应用还好，但是如果是微服务就非常痛苦，几十个微服务就要拆分打包几十个 jar 包，每个 jar 包都很大(几百M)，合起来就好几个 GB，非常占用空间。如果是内网部署，遇到动辄GB的升级包还能勉强接受，最多就是运维心里默默地吐槽一下，但是如果在外网云环境、或者客户现场，那令人痛不欲生的带宽加上各种网络转换限制，运维心里各种🐴。因为这个你的领导又给你各种批头盖脸一顿。

如何瘦身？

瘦身思路：

其实就是将你自己写的代码和引入依赖包进行分离操作，它并不能改变项目总体的大小，但是它方便你日后对项目进行升级操作，日后只需要换jar就可以了，不需要动固定引入依赖jar包文件夹。

Java maven 项目混淆 maven混淆打包_jar_05

具体实现

1.在原本的SpringBoot项目的pom.xml文件里面加上以下配置

<!--经过修改后，能够瘦身的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>
                        <!--这里是填写需要包含进去的jar，
                            必须项目中的某些模块，会经常变动，那么就应该将其坐标写进来
                            如果没有则non-exists ，表示不打包依赖
                        -->
                        <include>
                            <groupId>non-exists</groupId>
                            <artifactId>non-exists</artifactId>
                        </include>
                    </includes>
                </configuration>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <!-- 此插件用于将依赖包抽出-->
            <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>
                            <!--抽出到哪个目录，${project.build.directory}表示当前项目构建的目录-->
                            <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.经过以上操作你再进行项目打包后，你的项目将会分为自己写的代码jar包和分离出来的jar包目录，到这还没结束，需要配合以下参数启动项目才行。

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

项目打包exe

可以使我们的项目直接由jar包打包成exe可执行程序

具体实现

第一种实现方式

正常将我们的项目打成jar包，打包好以后先打开看一下确保可以正确执行

Java maven 项目混淆 maven混淆打包_spring boot_06

2.在当前目录加入以下脚本对jar包进行打包，根据自己的jar包名称对以下脚本进行修改即可！全部修改完成，双击此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 项目混淆 maven混淆打包_spring boot_07

Java maven 项目混淆 maven混淆打包_java_08

Java maven 项目混淆 maven混淆打包_Java maven 项目混淆_09

第二种实现方式

1.在原本的SpringBoot项目的pom.xml文件里面加上以下配置，一样的道理根据自己的情况进行修改！

2.双击package打包按钮，他就会根据你的配置生成对应的目录，目录内含有exe文件和jdk运行环境

Java maven 项目混淆 maven混淆打包_java_10

Java maven 项目混淆 maven混淆打包_jar_11

Java maven 项目混淆 maven混淆打包_java_12

总结

1.代码混淆使用的是ProGuard开源项目的插件

2.项目瘦身采用的是将jar包和依赖项分离

3.打成exe可执行文件使用的是javapackager

到此这篇关于maven混淆打包的实现步骤的文章就介绍到这了,更多相关maven混淆打包内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

SpringBoot2.3新特性优雅停机详解
这篇文章主要介绍了SpringBoot2.3新特性优雅停机详解，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-05-05
JAVA使用TreeMap对字符串进行排序
这篇文章主要介绍了JAVA使用TreeMap对字符串进行排序,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-02-02
Java从控制台读入数据的几种方法总结
下面小编就为大家带来一篇Java从控制台读入数据的几种方法总结。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2016-10-10
javaweb Servlet开发总结（二）
这篇文章主要为大家详细介绍了javaweb Servlet开发总结的第二篇，感兴趣的小伙伴们可以参考一下
2016-05-05
springboot+vue部署按照及运行方法
在本篇文章里小编给大家整理了关于springboot+vue部署按照及运行方法和实例内容，需要的朋友们学习参考下。
2020-01-01
Spring Task 动态修改任务执行计划cron方式
这篇文章主要介绍了Spring Task 动态修改任务执行计划cron方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-11-11
ElasticSearch之索引模板滚动索引实现详解
这篇文章主要为大家介绍了ElasticSearch之索引模板滚动索引实现详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-04-04
Java实现学生信息管理系统IO版本
这篇文章主要为大家详细介绍了Java实现学生信息管理系统IO版本，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-04-04
详解MyBatis中Executor执行SQL语句的过程
MyBatis中获取SqlSession时会创建执行器Executor并存放在SqlSession中，本篇文章将以MapperMethod的execute() 方法作为起点，对MyBatis中的一次实际执行请求进行说明，并结合源码对执行器Executor的原理进行阐释
2023-07-07
vue+springboot读取git的markdown文件并展示功能
Markdown-it 是一个用于解析和渲染 Markdown 标记语言的 JavaScript 库,使用 Markdown-it,你可以将 Markdown 文本解析为 HTML 输出,并且可以根据需要添加功能、扩展语法或修改解析行为,本文介绍vue+springboot读取git的markdown文件并展示,感兴趣的朋友一起看看吧
2024-01-01