草庐IT

Go设计模式--备忘录模式,带暂存的业务功能可以参考它来实现

卡尔文_ 2023-08-21 原文

大家好,这里是每周都在陪你一起进步的网管~!今天继续学习设计模式—备忘录模式

备忘录模式(Memento Pattern)又叫作快照模式(Snapshot Pattern), 或令牌模式(Token Pattern), 指在不破坏封装的前提下, 捕获一个对象的内部状态, 并在对象之外保存这个状态。 这样以后就可将该对象恢复到原先保存的状态, 属于行为型设计模式。

备忘录模式主要适用于以下应用场景。

  1. 需要保存历史快照的场景。
  2. 希望在对象之外保存状态,且除了自己,其他类对象无法访问状态保存的具体内容。

备忘录模式是一种行为型设计模式。这种模式允许我们保存对象在某些关键节点时的必要信息,以便于在适当的时候可以将之恢复到之前的状态。通常它可以用来帮助设计撤销/恢复操作。

备忘录模式的类结构

下面是备忘录模式的类图,

图片来自https://refactoringguru.cn/design-patterns/memento,我后面实现的时候不会完全按照这个结构去实现,这里先把结构里的各个角色给大家说清楚。

备忘录模式中主要有这三个角色的类

  • Originator(发起者):Originator是当前的基础对象,它会将自己的状态保存进备忘录,此角色可以类比博客系统中的文章对象
  • 发起者中要有保存方法和从备忘录中恢复状态的方法,保存方法会返回当时状态组成的备忘录对象
  • Memento(备忘录) : 存储着Originator的状态的对象,类比理解即为文章对象的不同版本。
  • Caretaker(管理人):Caretaker是保存着多条备忘录的对象,并维护着备忘录的索引,在需要的时候会返回相应的备忘录 -- 类比理解为博客系统中的编辑器对象
  • 管理者的保存和恢复操作,会代理其持有的发起者对象的保存和恢复操作,在这些代理方法中会增加对备忘录对象列表、当前备忘录版本的维护。

上面这个类图结构是实现备忘录模式的最简单方式,真实使用的时候,Caretaker,Originator、memento 这些角色可以继续抽象出对应的接口和实现。这里就不搞那么复杂了,要举的例子比较简单,这么一拆显得这个模式用起来特别费事儿。

其实其他设计模式也是一样,学习的时候大家知道了它的结构后,在实现应用的环节不必完完全全按照结构一板一眼地全部进行实现,有的应用场景并不复杂,能合并的角色可以按需进行合并。

应用举例

场景

某线上博客平台, 需为用户提供在线编辑文章功能,文章主要包括标题 - title 和内容 - content等信息。为最大程度防止异常情况导致编辑内容的丢失, 需要提供版本暂存和Undo, Redo功能。

"版本暂存"问题可以应用备忘录模式, 将编辑器的状态完整保存起来(主要就是编辑内容),Undo和Redo的本质, 是在历史版本中前后移动把当时保存的内容加载到文章对象上。

方案设计

  • IEditor: 定义编辑器接口
  • EditorMemento: 定义编辑器的备忘录, 也就是编辑器的内部状态数据模型, 同时也对应一个历史版本
  • Editor: 编辑器类, 实现IEditor接口

这个例子里我们把原发器和管理人两个角色集中在Editor类型上一起实现,例子比较简单,就没有单独实现一个Article类型作为原发器角色,如果你想完全按照备忘录模式的结构实现,把Title、Content这写属性和Save方法抽离到单独的Article类型上,再让Editor嵌套组合Article即可。

下面我们根据UML类图实现一下这个带Undo、Redo功能的编辑器。

代码实现

首先在IEditor 接口里定义编辑器对象要实现的行为

// 编辑器接口定义
type IEditor interface {
Title(title string)
Content(content string)
Save()
Undo() error
Redo() error
Show()
}

接下来定义编辑器的备忘录, 也就是编辑器的内部状态数据模型, 同时也对应一个历史版本。

"本文使用的完整可运行源码
去公众号「网管叨bi叨」发送【设计模式】即可领取"
type Memento struct {
title string
content string
createTime int64
}

func newMemento(title string, content string) *Memento {
return &Memento{
title, content, time.Now().Unix(),
}
}

然后是最复杂的Editor实现,它会实现上面IEditor接口中定义的所有行为,其中的Undo、Redo方法即回退、前进方法在实现的时候就是依赖的它内部记录的一组Memento对象,通过指向不同的Memento对象来实现回退和前进功能。

"本文使用的完整可运行源码
去公众号「网管叨bi叨」发送【设计模式】即可领取"
// 编辑器类, 实现IEditor接口
type Editor struct {
title string
content string
versions []*Memento
index int
}

func NewEditor() IEditor {
return &Editor{
"", "", make([]*Memento, 0), 0,
}
}

func (editor *Editor) Title(title string) {
editor.title = title
}

func (editor *Editor) Content(content string) {
editor.content = content
}

func (editor *Editor) Save() {
it := newMemento(editor.title, editor.content)
editor.versions = append(editor.versions, it)
editor.index = len(editor.versions) - 1
}

func (editor *Editor) Undo() error {
return editor.load(editor.index - 1)
}

func (editor *Editor) load(i int) error {
size := len(editor.versions)
if size <= 0 {
return errors.New("no history versions")
}

if i < 0 || i >= size {
return errors.New("no more history versions")
}

it := editor.versions[i]
editor.title = it.title
editor.content = it.content
editor.index = i
return nil
}

func (editor *Editor) Redo() error {
return editor.load(editor.index + 1)
}

func (editor *Editor) Show() {
fmt.Printf("MockEditor.Show, title=%s, cnotallow=%s\n", editor.title, editor.content)
}

最后我们来测试一下Editor的版本记录功能

"本文使用的完整可运行源码
去公众号「网管叨bi叨」发送【设计模式】即可领取"
func main() {
editor := NewEditor()

// test save()
editor.Title("唐诗")
editor.Content("白日依山尽")
editor.Save()

editor.Title("唐诗 登鹳雀楼")
editor.Content("白日依山尽, 黄河入海流. ")
editor.Save()

editor.Title("唐诗 登鹳雀楼 王之涣")
editor.Content("白日依山尽, 黄河入海流。欲穷千里目, 更上一层楼。")
editor.Save()

// test show()
fmt.Println("-------------Editor 当前内容-----------")
editor.Show()

fmt.Println("-------------Editor 回退内容-----------")
for {
e := editor.Undo()
if e != nil {
break
} else {
editor.Show()
}
}

fmt.Println("-------------Editor 前进内容-----------")
for {
e := editor.Redo()
if e != nil {
break
} else {
editor.Show()
}
}
}

运行程序后会有类似下面的显示


有关Go设计模式--备忘录模式,带暂存的业务功能可以参考它来实现的更多相关文章

  1. ruby - 为什么我可以在 Ruby 中使用 Object#send 访问私有(private)/ protected 方法? - 2

    类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc

  2. ruby-on-rails - Rails - 子类化模型的设计模式是什么? - 2

    我有一个模型:classItem项目有一个属性“商店”基于存储的值,我希望Item对象对特定方法具有不同的行为。Rails中是否有针对此的通用设计模式?如果方法中没有大的if-else语句,这是如何干净利落地完成的? 最佳答案 通常通过Single-TableInheritance. 关于ruby-on-rails-Rails-子类化模型的设计模式是什么?,我们在StackOverflow上找到一个类似的问题: https://stackoverflow.co

  3. ruby - 解析 RDFa、微数据等的最佳方式是什么,使用统一的模式/词汇(例如 schema.org)存储和显示信息 - 2

    我主要使用Ruby来执行此操作,但到目前为止我的攻击计划如下:使用gemsrdf、rdf-rdfa和rdf-microdata或mida来解析给定任何URI的数据。我认为最好映射到像schema.org这样的统一模式,例如使用这个yaml文件,它试图描述数据词汇表和opengraph到schema.org之间的转换:#SchemaXtoschema.orgconversion#data-vocabularyDV:name:namestreet-address:streetAddressregion:addressRegionlocality:addressLocalityphoto:i

  4. ruby - 使用 Vim Rails,您可以创建一个新的迁移文件并一次性打开它吗? - 2

    使用带有Rails插件的vim,您可以创建一个迁移文件,然后一次性打开该文件吗?textmate也可以这样吗? 最佳答案 你可以使用rails.vim然后做类似的事情::Rgeneratemigratonadd_foo_to_bar插件将打开迁移生成的文件,这正是您想要的。我不能代表textmate。 关于ruby-使用VimRails,您可以创建一个新的迁移文件并一次性打开它吗?,我们在StackOverflow上找到一个类似的问题: https://sta

  5. ruby - 我可以使用 Ruby 从 CSV 中删除列吗? - 2

    查看Ruby的CSV库的文档,我非常确定这是可能且简单的。我只需要使用Ruby删除CSV文件的前三列,但我没有成功运行它。 最佳答案 csv_table=CSV.read(file_path_in,:headers=>true)csv_table.delete("header_name")csv_table.to_csv#=>ThenewCSVinstringformat检查CSV::Table文档:http://ruby-doc.org/stdlib-1.9.2/libdoc/csv/rdoc/CSV/Table.html

  6. ruby - 如何在续集中重新加载表模式? - 2

    鉴于我有以下迁移:Sequel.migrationdoupdoalter_table:usersdoadd_column:is_admin,:default=>falseend#SequelrunsaDESCRIBEtablestatement,whenthemodelisloaded.#Atthispoint,itdoesnotknowthatusershaveais_adminflag.#Soitfails.@user=User.find(:email=>"admin@fancy-startup.example")@user.is_admin=true@user.save!ende

  7. ruby - 我可以使用 aws-sdk-ruby 在 AWS S3 上使用事务性文件删除/上传吗? - 2

    我发现ActiveRecord::Base.transaction在复杂方法中非常有效。我想知道是否可以在如下事务中从AWSS3上传/删除文件:S3Object.transactiondo#writeintofiles#raiseanexceptionend引发异常后,每个操作都应在S3上回滚。S3Object这可能吗?? 最佳答案 虽然S3API具有批量删除功能,但它不支持事务,因为每个删除操作都可以独立于其他操作成功/失败。该API不提供任何批量上传功能(通过PUT或POST),因此每个上传操作都是通过一个独立的API调用完成的

  8. ruby-on-rails - 使用 rails 4 设计而不更新用户 - 2

    我将应用程序升级到Rails4,一切正常。我可以登录并转到我的编辑页面。也更新了观点。使用标准View时,用户会更新。但是当我添加例如字段:name时,它​​不会在表单中更新。使用devise3.1.1和gem'protected_attributes'我需要在设备或数据库上运行某种更新命令吗?我也搜索过这个地方,找到了许多不同的解决方案,但没有一个会更新我的用户字段。我没有添加任何自定义字段。 最佳答案 如果您想允许额外的参数,您可以在ApplicationController中使用beforefilter,因为Rails4将参数

  9. ruby - 有人可以帮助解释类创建的 post_initialize 回调吗 (Sandi Metz) - 2

    我正在阅读SandiMetz的POODR,并且遇到了一个我不太了解的编码原则。这是代码:classBicycleattr_reader:size,:chain,:tire_sizedefinitialize(args={})@size=args[:size]||1@chain=args[:chain]||2@tire_size=args[:tire_size]||3post_initialize(args)endendclassMountainBike此代码将为其各自的属性输出1,2,3,4,5。我不明白的是查找方法。当一辆山地自行车被实例化时,因为它没有自己的initialize方法

  10. ruby - 是否可以覆盖 gemfile 进行本地开发? - 2

    我们的git存储库中目前有一个Gemfile。但是,有一个gem我只在我的环境中本地使用(我的团队不使用它)。为了使用它,我必须将它添加到我们的Gemfile中,但每次我checkout到我们的master/dev主分支时,由于与跟踪的gemfile冲突,我必须删除它。我想要的是类似Gemfile.local的东西,它将继承从Gemfile导入的gems,但也允许在那里导入新的gems以供使用只有我的机器。此文件将在.gitignore中被忽略。这可能吗? 最佳答案 设置BUNDLE_GEMFILE环境变量:BUNDLE_GEMFI

随机推荐