ClassFinal 项目使用教程

ClassFinal 项目使用教程

classfinal ClassFinal是一款java class文件安全加密工具，支持直接加密jar包或war包，无需修改任何项目代码，兼容spring-framework；可避免源码泄漏或字节码被反编译。 项目地址: https://gitcode.com/gh_mirrors/cla/classfinal

1. 项目介绍

ClassFinal 是一款 Java class 文件安全加密工具，支持直接加密 jar 包或 war 包，无需修改任何项目代码，兼容 spring-framework，可避免源码泄漏或字节码被反编译。ClassFinal 通过 AES 算法加密 class 文件，确保项目的安全性。

主要特性

• 无需修改原项目代码：只需将编译好的 jar/war 包用本工具加密即可。
• 运行时无需修改 Tomcat/Spring 等源代码。
• 支持普通 jar 包、Spring Boot jar 包以及普通 Java Web 项目编译的 war 包。
• 支持 Spring Framework、Swagger 等需要在启动过程中扫描注解或生成字节码的框架。
• 支持 Maven 插件：添加插件后在打包过程中自动加密。
• 支持加密 WEB-INF/lib 或 BOOT-INF/lib 下的依赖 jar 包。

2. 项目快速启动

环境依赖

• JDK 1.8+

下载与安装

1. 克隆项目到本地：

   git clone https://github.com/li571312729/classfinal.git
   

2. 进入项目目录：

   cd classfinal
   

3. 编译项目：

   mvn clean install
   

加密 jar 包

1. 使用命令行加密 jar 包：

   java -jar classfinal-fatjar.jar -file yourproject.jar -packages com.yourpackage -pwd 123456 -Y
   

   参数说明：

   • -file：加密的 jar/war 完整路径。
   • -packages：加密的包名（可为空，多个用“,”分割）。
   • -pwd：加密密码。
   • -Y：无需确认，不加此参数会提示确认以上信息。

2. 加密后的 jar 包将生成在同一目录下，文件名为 yourproject-encrypted.jar。

启动加密后的 jar 包

1. 启动加密后的 jar 包：

   java -javaagent:yourproject-encrypted.jar -jar yourproject-encrypted.jar
   

3. 应用案例和最佳实践

案例一：Spring Boot 项目加密

假设你有一个 Spring Boot 项目 demo.jar，你可以使用 ClassFinal 对其进行加密，防止源码泄漏。

1. 加密命令：

   java -jar classfinal-fatjar.jar -file demo.jar -packages com.demo -pwd 123456 -Y
   

2. 启动加密后的 jar 包：

   java -javaagent:demo-encrypted.jar -jar demo-encrypted.jar
   

案例二：Maven 插件自动加密

在 Maven 项目中，可以通过配置插件在打包过程中自动加密。

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

   <build>
       <plugins>
           <plugin>
               <groupId>net.roseboy</groupId>
               <artifactId>classfinal-maven-plugin</artifactId>
               <version>1.2.1</version>
               <configuration>
                   <password>123456</password>
                   <packages>com.demo</packages>
               </configuration>
               <executions>
                   <execution>
                       <phase>package</phase>
                       <goals>
                           <goal>classFinal</goal>
                       </goals>
                   </execution>
               </executions>
           </plugin>
       </plugins>
   </build>
   

2. 运行 mvn package 命令，自动生成加密后的 jar 包。

4. 典型生态项目

Spring Boot

ClassFinal 与 Spring Boot 项目完美兼容，可以在不修改任何 Spring Boot 代码的情况下，对 Spring Boot 项目进行加密。

Maven

通过 Maven 插件，可以在打包过程中自动加密项目，简化加密流程。

Tomcat

ClassFinal 支持在 Tomcat 下运行加密后的 war 包，无需修改 Tomcat 配置。

Swagger

对于使用 Swagger 的项目，ClassFinal 能够保留注解信息，确保 Swagger 功能正常运行。

通过以上步骤，你可以轻松使用 ClassFinal 对 Java 项目进行加密，保护你的源码安全。

classfinal ClassFinal是一款java class文件安全加密工具，支持直接加密jar包或war包，无需修改任何项目代码，兼容spring-framework；可避免源码泄漏或字节码被反编译。 项目地址: https://gitcode.com/gh_mirrors/cla/classfinal