ClassFinal 使用指南

1. 项目目录结构及介绍

ClassFinal 是一款专为Java应用设计的类文件加密工具，旨在增强应用程序的安全性。以下是其典型的项目结构概述：

classfinal
├── classfinal-core            # 核心加密逻辑模块
│   ├── src                     # 源代码目录
│   └── ...                     # 相关资源文件
├── classfinal-fatjar           # 可独立运行的加密工具jar包
│   └── classfinal-fatjar.jar    # 主执行文件
├── classfinal-maven-plugin     # Maven插件实现，用于自动化加密过程
│   ├── pom.xml                 # 插件配置文件
│   └── ...                     # 插件相关文件
├── classfinal-web              # 若有，则可能包含Web应用相关部分（示例或辅助模块）
├── LICENSE                     # 许可证文件
├── README.md                   # 项目说明文件
└── pom.xml                     # 项目构建主配置文件

• classfinal-core 包含核心加密算法与逻辑。
• classfinal-fatjar 提供了一个集成所有必要组件的jar文件，可以直接执行进行加密操作。
• classfinal-maven-plugin 设计用于Maven项目，简化加密流程，自动在打包阶段加密项目。
• LICENSE 和 README.md 分别记录了软件许可协议和快速入门指南。

2. 项目的启动文件介绍

ClassFinal本身作为一个工具，其启动并不是指启动应用，而是指运行classfinal-fatjar.jar来进行其他Java项目的类文件加密。主要通过命令行进行交互：

java -jar classfinal-fatjar.jar [参数]

若通过Maven插件使用，则在项目根目录执行Maven命令来间接“启动”加密流程：

mvn package

这将在构建过程中自动调用ClassFinal进行加密，生成加密后的war或jar包。

3. 项目的配置文件介绍

ClassFinal的主要配置并非传统意义上的单个配置文件，而是通过命令行参数或Maven插件配置指定。然而，如果你在加密过程中指定了配置文件的加密（如application.yml或.properties），这些配置文件将成为加密的一部分，并需在启动加密后的应用时考虑它们的位置和访问方式。

Maven插件配置示例：

在pom.xml中的插件配置可以看作是一种特殊的“配置”形式，指示加密行为：

<build>
    <plugins>
        <plugin>
            <groupId>net.roseboy</groupId>
            <artifactId>classfinal-maven-plugin</artifactId>
            <version>1.2.1</version>
            <configuration>
                <password>000000</password>
                <packages>com.yourpackage</packages>
                <cfgfiles>application.yml</cfgfiles>
            </configuration>
            <executions>
                <execution>
                    <phase>package</phase>
                    <goals>
                        <goal>classFinal</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

这里的配置决定了哪些包将被加密，加密时使用的密码，以及需要特别处理的配置文件等。

运行时配置:

对于加密后的应用，启动时通过-javaagent参数指定解密逻辑，并可能需要提供密码或者通过环境变量、密码文件等方式配置，这在实际部署和启动脚本中是非常关键的配置环节。虽然不是传统的配置文件，但同样重要，确保正确解密并运行加密过的类文件。

---

请注意，具体操作细节和版本可能会有所更新，请参照最新的官方文档或仓库 README 文件。