浏览代码

readme => 增加faq

JustryDeng 2 年之前
父节点
当前提交
bc77ce3777
共有 1 个文件被更改,包括 60 次插入11 次删除
  1. 60 11
      README.md

+ 60 - 11
README.md

@@ -1,18 +1,22 @@
 
 # 代码混淆之class-winter
 
+
 - [代码混淆之class-winter](#代码混淆之class-winter)
-  - [环境要求](#环境要求)
-  - [功能与特性](#功能与特性)
-  - [加密](#加密)
-  - [加密参数](#加密参数)
-  - [解密(启动)](#解密启动)
-  - [解密参数](#解密参数)
-  - [对class-winter本身进行加密](#对class-winter本身进行加密)
-  - [将已加密的包提供给客户使用](#将已加密的包提供给客户使用)
-    - [方案](#方案)
-    - [示例](#示例)
-  - [QQ群](#QQ群)
+    - [仓库最新版本](#仓库最新版本)
+    - [<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群)
 
 ---
 
@@ -601,6 +605,51 @@ linux示例:tips='请不要直接使用混淆后的jar/war'</td>
 | 1      | 机器码支持 | qq号:`85546017`<br /><br />当前(2023-06-11)状态:<br />&emsp;qq名:`╮(╯_╰)╭`<br />&emsp;是否在class-winter QQ群:是 | [点击跳转](https://gitee.com/tts2/class-winter/tree/master) |
 | ...... | ......     | ......                                                       | ......                                                      |
 
+
+
+## <font  face="幼圆" color = "#F53B45">**FAQ**</font>
+
+> class-winter初始能力设计理念是,只做通用能力支持,如果没法做到通用,那就干脆不做,需要的话使用者自行扩展
+
+- <font  face="幼圆" color = "#F53B45">**1. 是否支持yml等配置文件加密?**</font>
+
+  <font  face="幼圆" color = "#3CAA3C">**不支持。**</font>
+
+  不同的框架加载配置文件的方式不一样,没法写一个通用的加密逻辑,需要的话自行根据所用技术框架自行实现
+
+- <font  face="幼圆" color = "#F53B45">**2. 是否支持对lib包里的xml加密?**</font>
+
+  <font  face="幼圆" color = "#3CAA3C">**不支持。**</font>
+
+  首先实现起来相对麻烦,其次即便是(通用)加密也是伪加密。除非自己根据框架进行扩展进行定制加密
+
+- <font  face="幼圆" color = "#F53B45">**3. 部分版本spring-boot为啥加密后,启动时读取配置文件内容失败?**</font>
+
+  <font  face="幼圆" color = "#3CAA3C">**配置文件使用.yaml或.properties无此问题;部分版本的spring-boot对.yml配置文件不行。**</font>
+
+- <font  face="幼圆" color = "#F53B45">**4. 启动时明明按要求指定了JVM参数,为啥还是提示Miss jvm arg?**</font>
+
+  <font  face="幼圆" color = "#3CAA3C">**JVM参数位置不对,要放在-jar xxx.jar之前**</font>
+
+  ```bash
+  # 错误案例
+  java -javaagent:cc-encrypted.jar -jar cc-encrypted.jar -XX:+DisableAttachMechanism
+  # 正确案例
+  java -javaagent:cc-encrypted.jar -XX:+DisableAttachMechanism -jar cc-encrypted.jar 
+  ```
+
+- <font  face="幼圆" color = "#F53B45">**5. class-winter是否支持对类名、字段名、方法名等进行混淆?**</font>
+
+  <font  face="幼圆" color = "#3CAA3C">**不支持。**</font>
+
+  需要的话,可结合其它混淆工具(如:allatori等)一起加密,可参考enhance分支
+
+- <font  face="幼圆" color = "#F53B45">**6. includeLibs指定了要加密的lib包,为啥没生效?**</font>
+
+  <font  face="幼圆" color = "#3CAA3C">**首先检查是否正确配置了includeLibs,然后检查includePrefix匹配范围是否包含lib中的class**</font>
+
+
+
 ## QQ群
 
 > 群号:727930548