readme更新

README.md

@@ -1,22 +1,21 @@
 
 # 代码混淆之class-winter
 
-
 - [代码混淆之class-winter](#代码混淆之class-winter)
-    - [仓库最新版本](#仓库最新版本)
-    - [<font  face="幼圆" color = "#3399EA" >环境要求</font>](#font--face幼圆-color--3399ea-环境要求font)
-    - [<font  face="幼圆" color = "#3399EA" >功能与特性</font>](#font--face幼圆-color--3399ea-功能与特性font)
-    - [<font  face="幼圆" color = "#3399EA" >加密</font>](#font--face幼圆-color--3399ea-加密font)
-    - [<font  face="幼圆" color = "#3399EA" >加密参数</font>](#font--face幼圆-color--3399ea-加密参数font)
-    - [<font  face="幼圆" color = "#3399EA" >解密(启动)</font>](#font--face幼圆-color--3399ea-解密启动font)
-    - [<font  face="幼圆" color = "#3399EA" >解密参数</font>](#font--face幼圆-color--3399ea-解密参数font)
-    - [<font  face="幼圆" color = "#3399EA" >对class-winter本身进行加密</font>](#font--face幼圆-color--3399ea-对class-winter本身进行加密font)
-    - [<font  face="幼圆" color = "#3399EA" >将已加密的包提供给客户使用</font>](#font--face幼圆-color--3399ea-将已加密的包提供给客户使用font)
-        - [<font  face="幼圆" color = "#86CA5E" >方案</font>](#font--face幼圆-color--86ca5e-方案font)
-        - [<font  face="幼圆" color = "#86CA5E" >示例</font>](#font--face幼圆-color--86ca5e-示例font)
-    - [功能扩展案例](#功能扩展案例)
-    - [<font  face="幼圆" color = "#F53B45">**FAQ**</font>](#font--face幼圆-color--f53b45faqfont)
-    - [QQ群](#qq群)
+  - [仓库最新版本](#仓库最新版本)
+  - [环境要求](#环境要求)
+  - [功能与特性](#功能与特性)
+  - [加密](#加密)
+  - [加密参数](#加密参数)
+  - [解密(启动)](#解密启动)
+  - [解密参数](#解密参数)
+  - [对class-winter本身进行加密](#对class-winter本身进行加密)
+  - [将已加密的包提供给客户使用](#将已加密的包提供给客户使用)
+    - [方案](#方案)
+    - [示例](#示例)
+  - [功能扩展案例](#功能扩展案例)
+  - [**FAQ**](#faq)
+  - [QQ群](#qq群)
 
 ---
 
@@ -26,15 +25,15 @@
     <img alt="maven" src="https://img.shields.io/maven-central/v/com.idea-aedi/class-winter-maven-plugin?style=flat-square">
   </a>
 
-<font face="幼圆"  color = "#F53B45">**郑重声明**</font>
+**郑重声明**
 
 [**class-winter**](https://gitee.com/JustryDeng/class-winter) 是本人在学习完 [**class-final(v1.1.9)**](https://gitee.com/roseboy/classfinal) 后，仿照class-final进行编写的，部分思路与class-final一致
 
-## <font  face="幼圆" color = "#3399EA" >环境要求</font>
+## 环境要求
 
 - 支持jdk8（8、11、17、21等）语法环境
 
-  > **<font face="幼圆"  color = "#F53B45">本人构建class-winter时，用的jdk版本为：`1.8.0_281`</font>**
+  > **本人构建class-winter时，用的jdk版本为：`1.8.0_281`**
 
   注：tomcat版本不能低于8（部分小版本低的tomcat8可能也不行），否则可能报错
   
@@ -45,15 +44,15 @@
   注：如果有兼容低版本jdk的需求，可以自己下载master分支代码，进行对应修改
   
 
-## <font  face="幼圆" color = "#3399EA" >功能与特性</font>
+## 功能与特性
 
 - 支持war（普通war+可执行war）加密
 - 支持jar（普通jar+可执行jar）加密
 - 支持xml加密（掩耳盗铃版）
 
-## <font  face="幼圆" color = "#3399EA" >加密</font>
+## 加密
 
-- #### <font face="幼圆" ><font face="幼圆"  color = "#86CA5E">**方式一**</font>：通过maven插件自动加密</font>
+- #### **方式一**：通过maven插件自动加密
   ```xml
   <!--
       class-winter插件``
@@ -95,7 +94,7 @@
   ```
   注：不必担心信息泄漏问题，使用此方式生成混淆的jar包时，会擦除pom.xml中关于class-winter-plugin的信息。
   
-- #### <font face="幼圆" ><font face="幼圆"  color = "#86CA5E">**方式二**</font>：通过 [**class-winter-core.jar**](https://gitee.com/JustryDeng/class-winter/raw/master/class-winter-core/src/test/resources/class-winter-core-2.9.5.jar) 主动加密</font>
+- #### **方式二**：通过[**class-winter-core.jar**](https://gitee.com/JustryDeng/class-winter/raw/master/class-winter-core/src/test/resources/class-winter-core-2.9.5.jar) 主动加密
 
   ```bash
   java -jar class-winter-core-2.9.5.jar originJarOrWar=${要加密的项目.jar或.war包} includePrefix=${加密范围} [k3=v3 k4=v4 ...]
@@ -106,9 +105,9 @@
   java -jar class-winter-core-2.9.5.jar k1="v1" k2="v2"
   ```
 
-## <font  face="幼圆" color = "#3399EA" >加密参数</font>
+## 加密参数
 
-> <font  face="幼圆" color = "#F53B45">**提示：**</font>慎用`cca（尤其）`、`cma`、`cfa`参数，如果要用，请做好充分测试。
+> **提示：**慎用`cca（尤其）`、`cma`、`cfa`参数，如果要用，请做好充分测试。
 >
 > 原因说明：部分框架在获取某些元数据时，并不全都从已被premain处理后的类中读取，而是直接去对应位置读取资源文件本身（如：spring的`SimpleMetadataReader implements MetadataReader`直接去读取.class文件本身，以知道是否需要将类注册进容器等），因为class-winter会对该位置的资源进行加密（如：使用cca、cma、cfa时会擦除类、方法、字段上的注解信息），因此此时如果直接去.class文件本身获取元信息的话，可能会丢失部分信息（如：被class-winter擦除了的类的注解信息就读取不到）
 >
@@ -315,12 +314,12 @@ linux示例：tips='请不要直接使用混淆后的jar/war'</td>
 
 
 
-## <font  face="幼圆" color = "#3399EA" >解密(启动)</font>
+## 解密(启动)
 
 > `class-winter`支持`JVM`参数校验，通过在JVM参数中加入`-XX:+DisableAttachMechanism`来防止其他工具连接到你的Java程序。这样可以阻止运行至dump class。
 > 
 > 但是有些高级开发者可能会想要使用`sa-jdi` 的 `HSDB` 来 `dump` 字节码。从`2.8.8`版本开始，支持在启动Java解密时禁用了gHotSpotVMStructs函数，避免使用sa-jdi HSDB 来dump class，提高代码安全性。
-- #### <font  face="幼圆" color = "#86CA5E" >jar解密(启动)</font>
+- #### jar解密(启动)
   ```bash
   # 假设your-project-encrypted.jar是由class-winter加密后的包，那么你可以这么启动
   java -javaagent:/your-project-encrypted.jar -jar /your-project-encrypted.jar
@@ -334,7 +333,7 @@ linux示例：tips='请不要直接使用混淆后的jar/war'</td>
   # java -javaagent:/your-project-encrypted.jar="debug=true,password=pwd12345" -jar /your-project-encrypted.jar
   ```
 
-- #### <font  face="幼圆" color = "#86CA5E" >war解密(启动)</font>
+- #### war解密(启动)
   > **以Tomcat9为例**
   - linux方式一
 
@@ -378,7 +377,7 @@ linux示例：tips='请不要直接使用混淆后的jar/war'</td>
     set JAVA_OPTS="-javaagent:D:/class-winter-core-2.9.5.jar=decryptProjectPathPrefix=/D:/tmp/"
     ```
   
-- #### <font  face="幼圆" color = "#86CA5E" >IDE解密(启动)</font>
+- #### IDE解密(启动)
 
   > 设置`-javaagent`参数指定class-winter-core或者任一加密包。有必要的话，再搭配`skipProjectPathPrefix`或者`decryptProjectPathPrefix`参数启动即可
 
@@ -386,7 +385,7 @@ linux示例：tips='请不要直接使用混淆后的jar/war'</td>
 
 
 
-## <font  face="幼圆" color = "#3399EA" >解密参数</font>
+## 解密参数
 
 <table>
   <tr align="center">
@@ -441,18 +440,18 @@ linux示例：tips='请不要直接使用混淆后的jar/war'</td>
   </tr>
 </table>
 
-## <font  face="幼圆" color = "#3399EA" >对class-winter本身进行加密</font>
+## 对class-winter本身进行加密
 
 > 感谢小伙伴[Mango](https://gitee.com/mango_ye)对class-winter的优质反馈
 
 - 背景说明：我们利用class-winter混淆项目时，项目是被混淆了，但是class-winter本身还是明文的，这就留下了一些安全隐患（即：那些不指定密码的混淆，可能会被反向破解）
 - 增强支持：我们可以对class-winter本身进行加密，你可以切换至`enhance-*`分支，在首页下载被混淆的class-winter进行测试，或者clone代码，install后进行测试
-- <font face="幼圆"  color = "#F53B45">**声明**</font>：因为在`enhance-*`分支里对class-winter本身进行加密时用到了收费工具allatori（实际上有供学习使用的破解版之类的），所以`enhance-*`分支的代码，本人并未发布至maven官方仓库
+- **声明**：因为在`enhance-*`分支里对class-winter本身进行加密时用到了收费工具allatori（实际上有供学习使用的破解版之类的），所以`enhance-*`分支的代码，本人并未发布至maven官方仓库
 
 
-## <font  face="幼圆" color = "#3399EA" >将已加密的包提供给客户使用</font>
+## 将已加密的包提供给客户使用
 
-### <font  face="幼圆" color = "#86CA5E" >方案</font>
+### 方案
 
 - 方案一（适用于encrypted-A依赖于encrypted-B.jar，启动encrypted-A的情况）
 
@@ -464,7 +463,7 @@ linux示例：tips='请不要直接使用混淆后的jar/war'</td>
 
   利用`-Dloader.path`或其它方案，将encrypted-B.jar外置，并通过`decryptProjectPathPrefix`或`skipProjectPathPrefix`来定位encrypted-B.jar
 
-### <font  face="幼圆" color = "#86CA5E" >示例</font>
+### 示例
 
 > 提示：这里以可执行的jar进行的示例，其余的外置方式也是可以的（如：tomcat部署war包解压后，lib包就相当于是外置的）
 
@@ -603,11 +602,11 @@ linux示例：tips='请不要直接使用混淆后的jar/war'</td>
 
 
 
-## <font  face="幼圆" color = "#F53B45">**FAQ**</font>
+## **FAQ**
 
 > class-winter初始能力设计理念是，只做通用能力支持，如果没法做到通用，那就干脆不做，需要的话使用者自行扩展
 
-- <font  face="幼圆" color = "#F53B45">**1. 加密失败并伴有` Ignore clear-method-body for className [xxx], Cannot find 'yyy'`提示**</font>
+- **1. 加密失败并伴有` Ignore clear-method-body for className [xxx], Cannot find 'yyy'`提示**
 
   - 原因：类`xxx`中使用到了类`yyy`，但是被加密包中不存在`yyy`类
 
@@ -617,25 +616,25 @@ linux示例：tips='请不要直接使用混淆后的jar/war'</td>
 
     注：使用supportFile时，尽量控制指定范围，如果指定的范围太大（如无脑指定整个依赖仓库），引入的相关包太多，可能导致一些意料外的加密问题。如：[issues I9VTG9](https://gitee.com/JustryDeng/class-winter/issues/I9VTG9)
 
-- <font  face="幼圆" color = "#F53B45">**2. 是否支持yml等配置文件加密？**</font>
+- **2. 是否支持yml等配置文件加密？**
 
-  <font  face="幼圆" color = "#3CAA3C">**不支持。**</font>
+  **不支持。**
 
   不同的框架加载配置文件的方式不一样，没法写一个通用的加密逻辑，需要的话自行根据所用技术框架自行实现
 
-- <font  face="幼圆" color = "#F53B45">**3. 是否支持对lib包里的xml加密？**</font>
+- **3. 是否支持对lib包里的xml加密？**
 
-  <font  face="幼圆" color = "#3CAA3C">**不支持。**</font>
+  **不支持。**
 
   首先实现起来相对麻烦，其次即便是（通用）加密也是伪加密。除非自己根据框架进行扩展进行定制加密
 
-- <font  face="幼圆" color = "#F53B45">**4. 部分版本spring-boot为啥加密后，启动时读取配置文件内容失败？**</font>
+- **4. 部分版本spring-boot为啥加密后，启动时读取配置文件内容失败？**
 
-  <font  face="幼圆" color = "#3CAA3C">**配置文件使用.yaml或.properties无此问题；部分版本的spring-boot使用.yml配置文件可能出现部分配置读取失败。**</font>
+  **配置文件使用.yaml或.properties无此问题；部分版本的spring-boot使用.yml配置文件可能出现部分配置读取失败。**
 
-- <font  face="幼圆" color = "#F53B45">**5. 启动时明明按要求指定了JVM参数，为啥还是提示Miss jvm arg？**</font>
+- **5. 启动时明明按要求指定了JVM参数，为啥还是提示Miss jvm arg？**
 
-  <font  face="幼圆" color = "#3CAA3C">**JVM参数位置不对，要放在-jar xxx.jar之前**</font>
+  **JVM参数位置不对，要放在-jar xxx.jar之前**
 
   ```bash
   # 错误案例
@@ -644,21 +643,21 @@ linux示例：tips='请不要直接使用混淆后的jar/war'</td>
   java -javaagent:cc-encrypted.jar -XX:+DisableAttachMechanism -jar cc-encrypted.jar 
   ```
 
-- <font  face="幼圆" color = "#F53B45">**6. class-winter是否支持对类名、字段名、方法名等进行混淆？**</font>
+- **6. class-winter是否支持对类名、字段名、方法名等进行混淆？**
 
-  <font  face="幼圆" color = "#3CAA3C">**不支持。**</font>
+  **不支持。**
 
   需要的话，可结合其它混淆工具（如：allatori等）一起加密，可参考enhance分支
 
-- <font  face="幼圆" color = "#F53B45">**7. includeLibs指定了要加密的lib包，为啥没生效？**</font>
+- **7. includeLibs指定了要加密的lib包，为啥没生效？**
 
-  - <font  face="幼圆" color = "#3CAA3C">**如果配置时使用的前缀匹配：**</font> 首先检查指定的前缀是否包含住了指定了lib名，然后检查includePrefix匹配范围是否包含lib中的class
+  - **如果配置时使用的前缀匹配：** 首先检查指定的前缀是否包含住了指定了lib名，然后检查includePrefix匹配范围是否包含lib中的class
 
-  - <font  face="幼圆" color = "#3CAA3C">**如果配置时使用的模糊匹配：**</font>首先检查正则语法是否配置正确（见：FAQ-8），然后检查includePrefix匹配范围是否包含lib中的class
+  - **如果配置时使用的模糊匹配：**首先检查正则语法是否配置正确（见：FAQ-8），然后检查includePrefix匹配范围是否包含lib中的class
 
-- <font  face="幼圆" color = "#F53B45">**8. 模糊匹配，正则未生效？**</font>
+- **8. 模糊匹配，正则未生效？**
 
-  <font  face="幼圆" color = "#3CAA3C">**如果用正则的话，使用【`.*`】匹配所有而不用【`*`】**</font>
+  **如果用正则的话，使用【`.*`】匹配所有而不用【`*`】**
 
   你可以这么验证自己的正则是否配置对
   ```java