From cf3ac4978f97c2ced52c1ca37fef7bb956cb2171 Mon Sep 17 00:00:00 2001 From: gh0stkey <24655118+gh0stkey@users.noreply.github.com> Date: Wed, 15 Nov 2023 13:18:50 +0800 Subject: [PATCH] Update README.md --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 66c88e2..0d67be4 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,22 @@ 除此之外，您也可以选择将配置文件存放在`HaE Jar包`的同级目录下的`/.config/HaE/`中，**以便于离线携带**。 +### 规则释义 + +HaE目前的规则一共有6个字段，分别是规则名称、规则正则、规则作用域、正则引擎、规则匹配颜色、规则敏感性。 + +详细的含义如下所示： + +| 字段 | 含义 | +|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Name | 规则名称，主要用于简短概括当前规则的作用。 | +| Regex | 规则正则，主要用于填写正则表达式。在HaE中所需提取匹配的内容需要用`(`、`)`将正则表达式进行包裹。 | +| Scope | 规则作用域，主要用于表示当前规则作用与HTTP报文的哪个部分。 | +| Engine | 正则引擎，主要用于表示当前规则的正则表达式所使用的引擎。**DFA引擎**：对于文本串里的每一个字符只需扫描一次，速度快、特性少；**NFA引擎**：要翻来覆去标注字符、取消标注字符，速度慢，但是特性（如:分组、替换、分割）丰富。 | +| Color | 规则匹配颜色，主要用于表示当前规则匹配到对应HTTP报文时所需标记的高亮颜色。 | +| Sensitive | 规则敏感性，主要用于表示当前规则对于大小写字母是否敏感，敏感（`True`）则严格按照大小写要求匹配，不敏感（`False`）则反之。 | + + ## 优势特点 1. 精细配置：高度自由的配置选项，以满足各类精细化场景需求。