fix(*): 大版本更新，后续代码版本为3.0

documents/LauncherCommonFunc工具函数释义-202509928.md

@@ -0,0 +1,183 @@
+# LauncherCommonFunc工具函数释义
+
+    本文档用于解释新增LauncherCommonFunc工具函数的使用释义，开发使用。
+    本文档书写事件：2025-09-28 对应 xinlauncher_20250928.zip 。
+
+## 简介
+
+    该类统一了鉴权通用的静态资源（路径、命名规范等）及通用的调用功能函数。
+
+## 调用函数
+
+    基于外部调用，针对每一个函数进行调用释义。
+    注意：该内容需要跟随版本进行修改，查看文档时请注意是否为对应版本包及文档。
+
+1. 静态资源
+   
+   定义内容以表格信息展示：
+   
+   | 资源名称                    | 调用 | 调用方式                       | 释义                   |
+   | --------------------------- | ---- | ------------------------------ | ---------------------- |
+   | BaseBoradSN                 | Y    | LauncherCommonFunc.BaseBoradSN | 主板序列号             |
+   | CpuSN                       | Y    | LauncherCommonFunc.CpuSN       | CPU序列号              |
+   | DiskSN                      | Y    | LauncherCommonFunc.DiskSN      | 硬盘S/N                |
+   | UD                          | Y    | LauncherCommonFunc.UD          | 授权唯一UUID           |
+   | configFile                  | N    | 不可外部调用                   | 系统配置文件           |
+   | cipherFile                  | Y    | LauncherCommonFunc.cipherFile  | 机械码文件             |
+   | licenseFile                 | Y    | LauncherCommonFunc.licenseFile | 系统授权文件           |
+   | cipherContent               | N    | 不可外部调用                   | 机械码信息(加密字符串) |
+   | SYSTEM_CUSTOMER_AUTHOR_CODE | N    | 不可外部调用                   | 系统授权前缀信息       |
+   
+   
+   
+2. 静态函数
+
+   依次对函数进行释义
+
+   1. 机械码初始化函数
+
+      - 函数名：init
+
+      - 调用：不可外部调用
+
+      - 调用方式：LauncherCommonFunc.init();
+
+      - 基础逻辑：初始化缓存项目所在机械对应主板序列号、CPU序列号及硬盘S/N编码。
+
+      - 入参：无
+
+      - 出参：无
+
+        
+
+   2. 获取本机机械码秘钥
+
+      - 函数名：generateKey
+
+      - 调用：不可外部调用
+
+      - 调用方式：LauncherCommonFunc.generateKey();
+
+      - 基础逻辑：获取系统授权文件秘钥信息。
+
+      - 入参：无
+
+      - 出参：无
+
+        
+
+   3. 字符串处理编码（BOM）异常
+
+      - 函数名：deleteUTF8Bom
+
+      - 调用：不可外部调用
+
+      - 调用方式：LauncherCommonFunc.deleteUTF8Bom(fileStr);
+
+      - 基础逻辑：将传入字符串去除编码过程中出现的BOM异常。
+
+      - 入参：
+
+        | 字段    | 类型   | 释义       |
+        | ------- | ------ | ---------- |
+        | fileStr | String | 文件字符串 |
+
+        
+
+      - 出参：去除异常后的字符串
+
+        
+
+   4. 获取缓存授权码内容
+
+      - 函数名：getCode
+
+      - 调用：可外部调用
+
+      - 调用方式：LauncherCommonFunc.getCode();
+
+      - 基础逻辑：获取缓存授权码内容。
+
+      - 入参：无
+
+      - 出参：无
+
+        
+
+   5. 设置机械码缓存授权码信息
+
+      - 函数名：setCode
+
+      - 调用：不可外部调用
+
+      - 调用方式：LauncherCommonFunc.setCode(content);
+
+      - 基础逻辑：设置机械码缓存授权码信息。
+
+      - 入参：
+
+        | 字段    | 类型   | 释义                     |
+        | ------- | ------ | ------------------------ |
+        | content | String | 系统机械码加密字符串信息 |
+
+        
+
+      - 出参：无
+
+        
+
+   6. 获取授权随机加密地址
+
+      - 函数名：getPathKey
+
+      - 调用：不可外部调用
+
+      - 调用方式：LauncherCommonFunc.getPathKey(text);
+
+      - 基础逻辑：根据传入随机码(生成机械码时会自动创建)，获取注册表定义地址信息。
+
+      - 入参：
+
+        | 字段 | 类型   | 释义             |
+        | ---- | ------ | ---------------- |
+        | text | String | 系统机械码随机码 |
+
+        
+
+      - 出参：返回加密结果字符串
+
+        
+
+   7. 生成系统机械码文件
+
+      - 函数名：generateCipher
+
+      - 调用：可外部调用
+
+      - 调用方式：LauncherCommonFunc.generateCipher();
+
+      - 基础逻辑：初始化生成机械码文件（存储对应服务器的硬件加密信息）。
+
+      - 入参：无
+
+      - 出参：无
+
+        
+
+   8. 获取本机硬件加密信息
+
+      - 函数名：generateCipherContent
+
+      - 调用：私有函数，不可外部调用
+
+      - 调用方式：无
+
+      - 基础逻辑：生成系统机械码必要信息对象，并转换为字符串信息。
+
+      - 入参：无
+
+      - 出参：返回存储信息JSON字符串
+
+        
+
+