【Go实现】实践GoF的23种设计模式：解释器模式

2024-03-24 01:12
文章标签 实现 go 设计模式 模式 实践 23 解释器 gof

本文主要是介绍【Go实现】实践GoF的23种设计模式：解释器模式，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

上一篇：【Go实现】实践GoF的23种设计模式：适配器模式

简单的分布式应用系统（示例代码工程）：https://github.com/ruanrunxue/Practice-Design-Pattern–Go-Implementation

简介

解释器模式（Interpreter Pattern）应该是 GoF 的 23 种设计模式中使用频率最少的一种了，它的应用场景较为局限。

GoF 对它的定义如下：

Given a language, define a represention for its grammar along with an interpreter that uses the representation to interpret sentences in the language.

从定义可以看出，解释器模式主要运用于简单的语法解析场景，比如简单的领域特定语言（DSL）。举个例子，我们可以使用解析器模式来对“1+2+3-4+1”这样的文本表达式完成解析，并得到最终答案“3”。

解释器模式的整体思想是分而治之，每一个语法规则都使用一个类或者结构体（我们称之为 Rule Struct）来定义，它们相互独立，比如前一个例子中，“+” 和 “-” 都各自定义为一个 Rule Struct。因此，解释器模式的可扩展性很好。

通常，我们还能使用抽象语法树（Abstract Syntax Tree，AST）来直观地表示待解释的表达式，比如“1+2+3-4+1”可以表示成这样：

UML 结构

解释器模式通常有 4 种角色：

  • Context：解释上下文，包含了解释语法需要的所有信息，它是的生命周期贯穿整个解释过程，是一个全局对象。
  • AbstractExpression：声明了解释语法的方法，通常只有 Interpret(*Context) 一个方法。
  • TerminalExpression：实现了 AbstractExpression 接口，定义了终结表达式的解析逻辑。终结表达式在抽象语法树中作为叶子节点。
  • NonterminalExpression：实现了 AbstractExpression 接口，定义了非终结表达式的解析逻辑。在抽象语法树中，除了叶子节点，其他节点都是非终结表达式。NonterminalExpression 通常会比 TerminalExpression 更复杂一些。

场景上下文

在 简单的分布式应用系统（示例代码工程）中，db 模块用来存储服务注册信息和系统监控数据，它是一个 key-value 数据库。为了更高的易用性，它支持简单的 SQL 查询功能。用户在终端控制台上可以通过 SQL 语句来查询数据库中的数据：

简单起见，我们实现的 SQL 固定为 select xxx,xxx,xxx from xxx where xxx=xxx; 的形式，为此，我们要实现 3 个 TerminalExpression，即 SelectExpression、FromExpression 和 WhereExpression，分别解释 select 语句、from 语句、where 语句；以及 1 个 NonterminalExpression，即 CompoundExpression，用来解释整个 SQL 语句。

代码实现

// demo/db/sql.go
package db// 关键点1：定义Context结构体/类，这里是SqlContext，里面存放解析过程所需的状态和数据，以及结果数据
// SqlContext SQL解析器上下文，保存各个表达式解析的中间结果
// 当前只支持基于主键的查询SQL语句
type SqlContext struct {tableName  stringfields     []stringprimaryKey interface{}
}...// 关键点2：定义AbstractExpression接口，这里是SqlExpression，其中Interpret方法以Context作为入参
// SqlExpression Sql表达式抽象接口，每个词、符号和句子都属于表达式
type SqlExpression interface {Interpret(ctx *SqlContext) error
}// 关键点3：定义TerminalExpression，实现AbstractExpression接口，这里是SelectExpression、FromExpression和WhereExpression
// SelectExpression select语句解析逻辑，select关键字后面跟的为field，以,分割，比如select Id,name
type SelectExpression struct {fields string
}func (s *SelectExpression) Interpret(ctx *SqlContext) error {fields := strings.Split(s.fields, ",")if len(fields) == 0 {return ErrSqlInvalidGrammar}// 关键点4：在解析过程中将状态或者结果数据存储到Context里面ctx.SetFields(fields)return nil
}// FromExpression from语句解析逻辑，from关键字后面跟的为表名，比如from regionTable1
type FromExpression struct {tableName string
}func (f *FromExpression) Interpret(ctx *SqlContext) error {if f.tableName == "" {return ErrSqlInvalidGrammar}ctx.SetTableName(f.tableName)return nil
}// WhereExpression where语句解析逻辑，where关键字后面跟的是主键过滤条件，比如where id='1'
type WhereExpression struct {condition string
}func (w *WhereExpression) Interpret(ctx *SqlContext) error {vals := strings.Split(w.condition, "=")if len(vals) != 2 {return ErrSqlInvalidGrammar}if strings.Contains(vals[1], "'") {ctx.SetPrimaryKey(strings.Trim(vals[1], "'"))return nil}if val, err := strconv.Atoi(vals[1]); err == nil {ctx.SetPrimaryKey(val)return nil}return ErrSqlInvalidGrammar
}// 关键点5：实现NonterminalExpression，这里是CompoundExpression，它在解释过程中会引用到TerminalExpression，可以将TerminalExpression作为成员变量，也可以在Interpret方法中直接创建新对象。
// CompoundExpression SQL语句解释器，SQL固定为select xxx,xxx,xxx from xxx where xxx=xxx; 的固定格式
// 例子：select regionId from regionTable where regionId=1
type CompoundExpression struct {sql string
}func (c *CompoundExpression) Interpret(ctx *SqlContext) error {childs := strings.Split(c.sql, " ")if len(childs) != 6 {return ErrSqlInvalidGrammar}// 关键点6：在NonterminalExpression的Interpret方法中，调用TerminalExpression的Interpret方法完成对语句的解释。for i := 0; i < len(childs); i++ {switch strings.ToLower(childs[i]) {case "select":i++express := &SelectExpression{fields: childs[i]}if err := express.Interpret(ctx); err != nil {return err}case "from":i++express := &FromExpression{tableName: childs[i]}if err := express.Interpret(ctx); err != nil {return err}case "where":i++express := &WhereExpression{condition: childs[i]}if err := express.Interpret(ctx); err != nil {return err}default:return ErrSqlInvalidGrammar}}return nil
}

客户端这么使用：

// demo/db/memory_db.go
package db// memoryDb 内存数据库
type memoryDb struct {tables sync.Map // key为tableName，value为table
}...func (m *memoryDb) ExecSql(sql string) (*SqlResult, error) {ctx := NewSqlContext()express := &CompoundExpression{sql: sql}if err := express.Interpret(ctx); err != nil {return nil, ErrSqlInvalidGrammar}// 关键点7：解释成功后，从Context中获取解释结果信息table, ok := m.tables.Load(ctx.TableName())if !ok {return nil, ErrTableNotExist}record, ok := table.(*Table).records[ctx.PrimaryKey()]if !ok {return nil, ErrRecordNotFound}result := NewSqlResult()for _, f := range ctx.Fields() {field := strings.ToLower(f)if idx, ok := table.(*Table).metadata[field]; ok {result.Add(field, record.values[idx])}}return result, nil
}

总结实现解释器模式的几个关键点：

  1. 定义 Context 结构体/类，这里是 SqlContext，里面存放解释过程所需的状态和数据，也会存储解释结果。
  2. 定义 AbstractExpression 接口，这里是 SqlExpression，其中 Interpret 方法以 Context 作为入参。
  3. 定义 TerminalExpression 结构体，并实现 AbstractExpression 接口，这里是 SelectExpression、FromExpression 和 WhereExpression。
  4. 将 Interpret 方法解释过程中产生的过程状态、数据存储在 Context 上，使得其他 Expression 在解释过程中能够访问。
  5. 实现 NonterminalExpression，这里是 CompoundExpression，它在解释过程中会引用到 TerminalExpression，可以把 TerminalExpression 作为成员变量，也可以在 Interpret 方法中直接创建新对象。
  6. 在 NonterminalExpression 的 Interpret 方法中，调用 TerminalExpression 的 Interpret 方法完成对语句的解释。这里是 CompoundExpression.Interpret 调用 SelectExpression.Interpret、FromExpression.Interpret 和 WhereExpression.Interpret 完成对 SQL 的解释。
  7. 解释成功后，从 Context 中获取解释结果。

扩展

领域特定语言 DSL

在前文介绍解释器模式时有提到，它常用于对领域特定语言 DSL 的解释场景，那么什么是 DSL 呢？下面我们将简单介绍一下。

维基百科对 DSL 的定义如下：

A domain-specific language (DSL) is a computer language specialized to a particular application domain.

可见，DSL 是针对特定领域的一种计算机语言，与之相对的是 GPL，General Purpose Language，即通用编程语言。我们常用的 C/C++，Java，Go 等都属于 GPL 的范畴。

DSL 又可细分成 2 类：

  • External DSL ：此类 DSL 拥有独立的语法以及解释器，比如 CSS 用于定义 Web 网页的样式和布局、SQL 用于数据查询、XML 和 YAML 用于配置管理，它们都是典型的 External DSL。

    # External DSL举例，SQL
select id,name from regions where id=‘1’;

  • Internal DSL：此类 DSL 构建与 GPL 之上，比如流式接口 fluent interface、单元测试中的 Mock 库，它们可以提升 GPL 的易用性和易理解性。

// Internal DSL，Java中的Mockito库
Mockito.when(mockDemo.isTrue()).thenReturn(1);

Martin Fowler 大神专门写了一本书《领域特定语言》来介绍 DSL，更多详细、专业的知识请移步这里。

典型应用场景

  • 简单的语法解析。解释器模式的运用场景较为单一，主要运用于简单的语法解析场景，比如简单的领域特定语言（DSL）。

优缺点

优点

  • 易于扩展。前文提到，使用解释器模式进行语法解释时，每种语法规则都会有对应的 Expression 结构体/类。因此，新增一种语法规则会非常的容易；类似地，改变一种已有的语法规则的解释方式也是很容易，单点改动即可。

缺点

  • 不适用于复杂的语法解释。当语法过于复杂时，Expression 结构体/类的数量将会变得很多，从而难以维护。

与其他模式的关联

解释器模式通常与组合模式（Composite Pattern）结合在一起使用，UML 结构图中的 NonterminalExpression 和 AbstractExpression 的就是组合关系。

另外，解释器模式这种分而治之的方法，与状态模式（State Pattern）中每种状态处理各种的逻辑很是类似。

文章配图

可以在 用Keynote画出手绘风格的配图 中找到文章的绘图方法。

参考

[1] 【Go实现】实践GoF的23种设计模式：SOLID原则, 元闰子

[2] Design Patterns, Chapter 5. Behavioral Patterns, GoF

[3] Domain-Specific Languages Guide, Martin Fowler

更多文章请关注微信公众号：元闰子的邀请

这篇关于【Go实现】实践GoF的23种设计模式：解释器模式的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/840092。

相关文章

使用Python实现IP地址和端口状态检测与监控

使用Python实现IP地址和端口状态检测与监控

《使用Python实现IP地址和端口状态检测与监控》在网络运维和服务器管理中,IP地址和端口的可用性监控是保障业务连续性的基础需求,本文将带你用Python从零打造一个高可用IP监控系统,感兴趣的小伙... 目录概述：为什么需要IP监控系统使用步骤说明1. 环境准备2. 系统部署3. 核心功能配置系统效果展
阅读更多...
Python实现微信自动锁定工具

Python实现微信自动锁定工具

《Python实现微信自动锁定工具》在数字化办公时代,微信已成为职场沟通的重要工具,但临时离开时忘记锁屏可能导致敏感信息泄露,下面我们就来看看如何使用Python打造一个微信自动锁定工具吧... 目录引言：当微信隐私遇到自动化守护效果展示核心功能全景图技术亮点深度解析1. 无操作检测引擎2. 微信路径智能获
阅读更多...
Python中pywin32 常用窗口操作的实现

Python中pywin32 常用窗口操作的实现

《Python中pywin32常用窗口操作的实现》本文主要介绍了Python中pywin32常用窗口操作的实现,pywin32主要的作用是供Python开发者快速调用WindowsAPI的一个... 目录获取窗口句柄获取最前端窗口句柄获取指定坐标处的窗口根据窗口的完整标题匹配获取句柄根据窗口的类别匹配获取句
阅读更多...
在 Spring Boot 中实现异常处理最佳实践

在 Spring Boot 中实现异常处理最佳实践

《在SpringBoot中实现异常处理最佳实践》本文介绍如何在SpringBoot中实现异常处理,涵盖核心概念、实现方法、与先前查询的集成、性能分析、常见问题和最佳实践,感兴趣的朋友一起看看吧... 目录一、Spring Boot 异常处理的背景与核心概念1.1 为什么需要异常处理？1.2 Spring B
阅读更多...
Python位移操作和位运算的实现示例

Python位移操作和位运算的实现示例

《Python位移操作和位运算的实现示例》本文主要介绍了Python位移操作和位运算的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一... 目录1. 位移操作1.1 左移操作 (<<)1.2 右移操作 (>>)注意事项：2. 位运算2.1
阅读更多...
如何在 Spring Boot 中实现 FreeMarker 模板

如何在 Spring Boot 中实现 FreeMarker 模板

《如何在SpringBoot中实现FreeMarker模板》FreeMarker是一种功能强大、轻量级的模板引擎,用于在Java应用中生成动态文本输出（如HTML、XML、邮件内容等）,本文... 目录什么是 FreeMarker 模板？在 Spring Boot 中实现 FreeMarker 模板1. 环
阅读更多...
Qt实现网络数据解析的方法总结

Qt实现网络数据解析的方法总结

《Qt实现网络数据解析的方法总结》在Qt中解析网络数据通常涉及接收原始字节流,并将其转换为有意义的应用层数据,这篇文章为大家介绍了详细步骤和示例,感兴趣的小伙伴可以了解下... 目录1. 网络数据接收2. 缓冲区管理（处理粘包/拆包）3. 常见数据格式解析3.1 jsON解析3.2 XML解析3.3 自定义
阅读更多...
SpringMVC 通过ajax 前后端数据交互的实现方法

SpringMVC 通过ajax 前后端数据交互的实现方法

《SpringMVC通过ajax前后端数据交互的实现方法》：本文主要介绍SpringMVC通过ajax前后端数据交互的实现方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价... 在前端的开发过程中，经常在html页面通过AJAX进行前后端数据的交互，SpringMVC的controll
阅读更多...
Spring Security自定义身份认证的实现方法

Spring Security自定义身份认证的实现方法

《SpringSecurity自定义身份认证的实现方法》：本文主要介绍SpringSecurity自定义身份认证的实现方法,下面对SpringSecurity的这三种自定义身份认证进行详细讲解,... 目录1.内存身份认证（1）创建配置类（2）验证内存身份认证2.JDBC身份认证（1）数据准备 （2）配置依
阅读更多...
利用python实现对excel文件进行加密

利用python实现对excel文件进行加密

《利用python实现对excel文件进行加密》由于文件内容的私密性,需要对Excel文件进行加密,保护文件以免给第三方看到,本文将以Python语言为例,和大家讲讲如何对Excel文件进行加密,感兴... 目录前言方法一：使用pywin32库（仅限Windows）方法二：使用msoffcrypto-too
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2