JS 做一个简单的 Parser

西丽玛哈

前言

前些天偶然看到以前写的一份代码，注意有一段尘封的代码，被我遗忘了。这段代码是一个简单的解析器，当时是为了解析日志而做的。最初解析日志时，我只是简单的正则加上分割，写着写着，我想，能不能用一个简单的方案做个解析器，这样可以解析多种日志。于是就有了这段代码，后来日志解析完了，没有解析其它日志就给忘了。再次看到这段代码，用非常简单易读的代码就实现了一个解析器，觉得非常值得分享。
思路

言归正传，这个简单的解析器是怎么构思的呢？那要先从模式匹配开始。解析与模式匹配有很多相似之处，比如解析一个整数，跟匹配一个整数就是相似的。都需要根据整数的文法 0|[1-9]\d* 把文本中满足文法的部分找出来，不同的是，当说到解析整数的时候，我们希望得到的结果是一个整数，而不是一段文本。更进一步，如果我们已经知道如何解析整数，那么解析加减表达式又可以看到一些相似性。加减表达式的文法可以表示为 num ('+'|'-' num)*，就像文本模式匹配一样，需要对一些“东西”的到达顺序、重复次数、分支进行匹配。
从上面的描述可以看出，我们要做的是某种模式匹配。模式匹配的明星非正则表达式莫数。观察正则表达式，我们基本的需求都有啥？比如有，匹配一个字符或者按顺序出现的字符。好了，就从这两点出发。我们可以设计两个函数，一个 match 函数用来匹配单个字符，一个 seq 函数表示按顺序匹配。显然，多个 match 就可以形成 seq，seq 是一个高阶函数。但是，seq 是直接组合 match 吗？当然不是，因为 match 需要一个参数，表示需要匹配的字符是哪个，所以 match 也是一个高阶函数，而 seq 需要 match 产生的函数组合成新函数，即 seq([match('a'), match('b'), match('c')])。那 match 和 seq 生成的函数是什么？答案是匹配器。允许我们直接对文本进行匹配：

1. const match_a = match('a');
2. match_a('abc');
4. const match_abc = seq([match('a'), match('b'), match('c')]);
5. match_abc('abc');

复制代码

由于我们要组合函数，所以匹配器不是只简单返回 bool 值，这样组合过程中，状态会丢失。我们让匹配器返回两个值：一个是匹配后剩余的字符串；一个是匹配是否成功。于是我们就有了：

1. declare type Matcher = (src: string) => [string, bool];
3. function match(ch): Matcher {
4.     return src => {
5.         if (src.startsWith(ch)) return [src.substring(1), true];
6.         return [src, false];
7.     };
8. }
10. // 顺序匹配，其中一个失败则整体失败
11. function seq(steps: Matcher[]): Matcher {
12.     return src => {
13.         for (const step of steps) {
14.             const [rest, ok] = step(src);
15.             if (!ok) return [src, false];
16.             src = rest;
17.         }
18.         return [src, true];
19.     };
20. }

复制代码

试试看。

1. const match_a = match('a');
2. console.log(...match_a('abc')); // "bc" true
3. console.log(...match_a('def')); // "def" false
5. const match_abc = seq([match('a'), match('b'), match('c')]);
6. match_abc('abc');
7. console.log(...match_abc('abc')); // "" true
8. console.log(...match_abc('abd')); // "abd" false

复制代码

妙极了！

拥抱正则表达式

接下来，我们可以在这个基础上实现正则表达式的其它模式，比如：

• alt。候选列表，列表中有一个匹配成功则成功，一个失败则整体失败。是正则表达式中是 | 和 []。
  
• opt。可选，正则表达的 ? 模式。
  
• many。多次重复，正则表达式中的 * 模式。
  

其它不一一列举，如果继续下去，应该能实现一个自己的正则表达式，但不是我们的目标，我想先回到“解析”上。
观察 match 函数，它只能匹配一个字符，如果要匹配多个则要使用 seq 进行组合，不是很方便。既然正则表达式可以进行文本匹配，我们没有必要重复正则表达式的工作，直接利用它就好。所以，我们可以把正则表达式作为 match 的参数：

1. function match(pattern: RegExp): Matcher {
2.     // ...
3. }

复制代码

解析

前面说过，解析整数的结果是整数而不是长得像整数的字符串，因此，Matcher 不能返回 bool，而应该是某个“结果”。所以 Matcher 的签名应该是 (src: string) => [string, any]。怎么把文本变成那个“结果”呢，可以在 match 后面加一个回调，表示匹配到了文本后，应该如何处理这个文本。显然，这个回调的输入参数是匹配到的文本，输出是“结果”，即 (token: string) => any。我们把这个回调函数取名为 Action。
如果现在尝试去改 match 函数，就会发现一个问题，seq 函数也返回 Matcher，但这个匹配器执行后应该返回什么“结果”呢？为解决这个问题，我们也需要给 seq 函数添加 Action，只不过 seq 函数的 Action 的输入参数是一个列表。还有，匹配成功后，我也可以不做任何动作，此时把匹配的文本继续往下传即可。现在我们再修改代码：

1. declare type Matcher = (src: string) => [string, any];
2. declare type Action = (val: any) => any;
4. function noop(tok: any){ return tok; }
6. // 用 `pattern` 匹配文本的开头
7. function match(pattern: RegExp, action: Action = noop): Matcher {
8.     return src => {
9.         const m = pattern.exec(src);
10.         if (!m || m.index !== 0) throw new Error(`unexpected token '${src[0]}'`);
11.         const rest = src.substring(m[0].length);
12.         return [rest, action(m[0])];
13.     };
14. }
16. // 顺序匹配，其中一个失败则整体失败
17. function seq(steps: Matcher[], action: Action = noop): Matcher {
18.     return src => {
19.         const list: any[] = [];
21.         for (const step of steps) {
22.             const [rest, val] = step(src); // `step` 函数会 `throw`，因此一个失败整体就会失败
23.             src = rest;
24.             list.push(val);
25.         }
27.         return [src, action(list)];
28.     };
29. }

复制代码

玩玩看：

1. const match_helloworld = seq([match(/hello/), match(/ /), match(/world/)]);
3. console.log(...match_helloworld('hello world')); // "" ["hello", " ", "world"]
4. console.log(...match_helloworld('helloworld'));  // Error: unexpected token 'w'

复制代码

还是妙，但目前为止还算常规，跟正则表达式差不多。那么，接下来看下面这个例子：

1. const int = match(/0|[1-9]\d*/, Number); // 用整数的文法匹配文本，并把匹配到的文本直接转成 js 的 `number`
3. // 根据文法 `int('+'|'-')int` 进行匹配，并根据中间 token 进行计算
4. const Exp = seq([int, match(/\+|\-/), int], toks => {
5.     if (toks[1] === '+') return toks[0] + toks[2]; // 因为 `int` 函数返回的是 `number`，所以这里可以直接进行计算！
6.     if (toks[1] === '-') return toks[0] - toks[2];
7.     return toks;
8. });
10. console.log(...Exp('1+2')); // "" 3
11. console.log(...Exp('5-3')); // "" 2

复制代码

现在是不是更妙了。

完全体

光有 seq 可不能满足解析的全部需求，还得要把其它模式加进来，我就不一一说明其它模式的实现方法了，直接给出全部代码，相信看代码也很好理解：

1. declare type Matcher = (src: string) => [string, any];
2. declare type Action = (val: any) => any;
4. function noop(tok: any){ return tok; }
6. // 原来的 `match` 函数，改了个名字
7. function token(pattern: string|RegExp, action: Action = noop): Matcher {
8.     if (pattern instanceof RegExp) {
9.         return (src) => {
10.             if (src.length === 0) throw new SyntaxError("Unexpected EOS");
11.             const regex = new RegExp(pattern.source[0] === '^' ? pattern.source : '^' + pattern.source);
12.             const m = regex.exec(src);
13.             if (!m || m.index !== 0)
14.                 throw new SyntaxError(`Unexpected token '${src[0]}', expected: ${pattern}`);
15.             const rest = src.substring(m[0].length);
16.             return [rest, action(m[0])];
17.         };
18.     } else if (typeof pattern === "string") {
19.         return (src) => {
20.             if (src.length === 0) throw new SyntaxError("Unexpected EOS");
21.             if (!src.startsWith(pattern))
22.                 throw new SyntaxError(`Unexpected token '${src[0]}', expected: ${pattern}`);
23.             const rest = src.substring(pattern.length);
24.             if (action) return [rest, action(pattern)];
25.             return [rest, pattern];
26.         };
27.     }
28.     throw Error("pattern must to be instance of string or RegExp");
29. }
31. // 顺序匹配，其中一个失败则整体失败
32. function seq(steps: Matcher[], action: Action = noop): Matcher {
33.     return src => {
34.         const list: any[] = [];
36.         for (const step of steps) {
37.             const [rest, val] = step(src); // `step` 函数会 `throw`，因此一个失败整体就会失败
38.             src = rest;
39.             list.push(val);
40.         }
42.         return [src, action(list)];
43.     };
44. }
46. // 可选匹配
47. function opt(step: Matcher, action: Action = noop): Matcher {
48.     return (src) => {
49.         try {
50.             const [rest, v] = step(src);
51.             return [rest, action(v)];
52.         } catch (err) {
53.             return [src, undefined]; // 也许这里可以改成 `return [src, action("")]`;
54.         }
55.     };
56. }
58. // 候选列表匹配，列表中其中一个匹配即可
59. function alt(steps: Matcher[], action: Action = noop): Matcher {
60.     return (src) => {
61.         for (const step of steps) {
62.             try {
63.                 const [rest, v] = step(src);
64.                 return [rest, action(v)];
65.             } catch (_) {
66.                 // mute
67.             }
68.         }
70.         throw new Error(`unknown token ${src[0]}`);
71.     };
72. }
74. // 重复任意次数
75. function many(item: Matcher, action: (vals: any[]) => any = noop): Matcher {
76.     return src => {
77.         let list: any[] = [];
78.         let val = undefined;
80.         while (true) {
81.             try {
82.                 [src, val] = item(src);
83.                 list.push(val);
84.             } catch (_) {
85.                 break;
86.             }
87.         }
89.         return [src, action(list)];
90.     };
91. }
93. // 带分隔符的重复，即满足 `item (sep item)*` 这种文法的
94. function many_sep(sep: Matcher, item: Matcher, action: (vals: any[]) => any = noop): Matcher {
95.     const etc = seq([sep, item], vs => vs[1]);
96.     return (src) => {
97.         let list: any[] = [];
98.         let val = undefined;
100.         try {
101.             [src, val] = item(src);
102.             list.push(val);
103.         } catch (_) {
104.             return [src, action(list)];
105.         }
107.         // 以下逻辑也可通过调用 `many` 实现
108.         while (true) {
109.             try {
110.                 [src, val] = etc(src);
111.                 list.push(val);
112.             } catch (_) {
113.                 break;
114.             }
115.         }
117.         return [src, action(list)];
118.     };
119. }

复制代码

好了，直接攒个大活儿，咱们用这些东西解析 JSON 看看：

1. const ws = token(/\s*/);
3. const Sep = seq([token(','), opt(ws)], v => v[0]); // 也可以简写为 `token(/,\s*/)`
5. const Str = token(/"([^\"]|\\[\\\/bfrtn]|\\u[0-9a-fA-F]{0})*"/, JSON.parse); // 这里使用 `JSON.parse` 算是作弊，不过用它让演示代码缩短了不少
7. const Num = token(/-?(0|[1-9]\d*)(\.\d+)?([eE][\+\-]?\d+)?/, Number);
9. // Elems = Val (',' Val)*
10. const Elems = many_sep(Sep, src => Val(src));
12. // KVs = KV (',' KV)*
13. const KVs = many_sep(Sep, src => KV(src));
15. // js 中可以直接使用 `Object.fromEntries`
16. function objFromKVs(kvs: [string, any][]) {
17.     return kvs.reduce((obj, [k, v]) => { obj[k] = v; return obj; }, {} as any);
18. }
20. // Val = Str | Num | 'true' | 'false' | 'null' | '[' ws Elems ws ']' | '{' ws KVs ws '}'
21. const Val = alt([
22.     Str,
23.     Num,
24.     token(/true|false/, token => token === 'true'),
25.     token(/null/, _ => null),
26.     seq([token('['), ws, Elems, ws, token(']')], v => v[2]),                   // '[' ws Elems ws ']'
27.     seq([token('{'), ws, KVs, ws, token('}')], v => objFromKVs(v[2] as any[])) // '{' ws KVs ws '}'
28. ]);
30. // KV = Str ws ':' ws Val
31. const KV = seq([
32.     Str,
33.     ws,
34.     token(':'),
35.     ws,
36.     Val,
37. ], kv => [kv[0], kv[4]]); // 匹配 KV 列表，并转换成 `[[key, val]...]` 的形式
39. // 演示
40. console.log(...Val('[1, 2.3e4, true, null, "\\t"]')); // "" [1, 23000, true, null, "        "]
41. console.log(...Val('{ "k1": 123, "k2": true }'));     // "" {k1: 123, k2: true}

复制代码

怎么样，相当不错吧!!!

接下来再演示下进阶版本的表达式解析与求值，支持加、减、乘、除和括号：

1. // Factor = '(' ws Exp ws ')' | Num
2. const Factor = alt([
3.     seq([token('('), ws, src => Exp(src), ws, token(')')], vals => vals[2]),
4.     Num,
5. ]);
7. // Term = Factor (ws '*|/' ws Factor)*
8. const Term = seq([Factor, many(seq([ws, token(/\*|\//), ws, Factor]))], ([head, tail]) => {
9.     return (tail as any[]).reduce((acc, x) => {
10.         if (x[1] === '*') return acc * x[3];
11.         if (x[1] === '/') return acc / x[3];
12.         return acc;
13.     }, head);
14. });
16. // Exp = Term (ws '+|-' ws Term)*
17. const Exp = seq([Term, many(seq([ws, token(/\+|-/), ws, Term]))], ([head, tail]) => {
18.     return (tail as any[]).reduce((acc, x) => {
19.         if (x[1] === '+') return acc + x[3];
20.         if (x[1] === '-') return acc - x[3];
21.         return acc;
22.     }, head);
23. });
25. console.log(...Exp('( 1 + 2 * 5 ) * 3')); // "" 33

复制代码

总结

本文使用简单易懂的代码，实现了一组可以构造解析器的函数。相信通过本文的演示，你应该对解析器的基本工作原理有了一个浅浅的了解。实际上，我们实现的这一组函数是一种领域特定语言，即 DSL。虽然实现方式简单，但不妨碍这种 DSL 的实用性，在日常的小脚本中，更加体现它的小巧、易懂、功能强大。不过也要注意的是，我是以小巧、简易为目标实现的，所以性能不是首要目标，将本文的实现用于性能挑剔的场合肯定是不合适的。

来源:https://www.cnblogs.com/1bite/p/17252162.html
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！