聚焦目标
理解kubectl的核心实现之一：Visitor Design Pattern 访问者模式
目录
-
- 多个对象聚合为一个对象
- 多个方法聚合为一个方法
- 将对象抽象为多个底层对象，逐个调用方法
visitor design pattern
在设计模式中，访问者模式的定义为：
允许一个或者多个操作应用到对象上，解耦操作和对象本身
那么，对一个程序来说，具体的表现就是：
- 表面：某个对象执行了一个方法
- 内部：对象内部调用了多个方法，最后统一返回结果
举个例子，
- 表面：调用一个查询订单的接口
- 内部：先从
缓存中查询，没查到再去热点数据库查询，还没查到则去归档数据库里查询
Visitor
我们来看看kubeadm中的访问者模式的定义：
// Visitor 即为访问者这个对象
type Visitor interface {
Visit(VisitorFunc) error
}
// VisitorFunc对应这个对象的方法，也就是定义中的“操作”
type VisitorFunc func(*Info, error) error
基本的数据结构很简单，但从当前的数据结构来看，有两个问题：
单个操作可以直接调用Visit方法，那多个操作如何实现呢？- 在应用
多个操作时，如果出现了error，该退出还是继续应用下一个操作呢？
Chained
VisitorList
封装多个Visitor为一个，出现错误就立刻中止并返回
// VisitorList定义为[]Visitor，又实现了Visit方法，也就是将多个[]Visitor封装为一个Visitor
type VisitorList []Visitor
// 发生error就立刻返回，不继续遍历
func (l VisitorList) Visit(fn VisitorFunc) error {
for i := range l {
if err := l[i].Visit(fn); err != nil {
return err
}
}
return nil
}
EagerVisitorList
封装多个Visitor为一个，出现错误暂存下来，全部遍历完再聚合所有的错误并返回
// EagerVisitorList 也是将多个[]Visitor封装为一个Visitor
type EagerVisitorList []Visitor
// 返回的错误暂存到[]error中，统一聚合
func (l EagerVisitorList) Visit(fn VisitorFunc) error {
errs := []error(nil)
for i := range l {
if err := l[i].Visit(func(info *Info, err error) error {
if err != nil {
errs = append(errs, err)
return nil
}
if err := fn(info, nil); err != nil {
errs = append(errs, err)
}
return nil
}); err != nil {
errs = append(errs, err)
}
}
return utilerrors.NewAggregate(errs)
}
DecoratedVisitor
这里借鉴了装饰器的设计模式，将一个Visitor调用多个VisitorFunc方法，封装为调用一个VisitorFunc
// 装饰器Visitor
type DecoratedVisitor struct {
visitor Visitor
decorators []VisitorFunc
}
// visitor遍历调用decorators中所有函数，有失败立即返回
func (v DecoratedVisitor) Visit(fn VisitorFunc) error {
return v.visitor.Visit(func(info *Info, err error) error {
if err != nil {
return err
}
for i := range v.decorators {
if err := v.decorators[i](info, nil); err != nil {
return err
}
}
return fn(info, nil)
})
}
ContinueOnErrorVisitor
// 报错依旧继续
type ContinueOnErrorVisitor struct {
Visitor
}
// 报错不立即返回，聚合所有错误后返回
func (v ContinueOnErrorVisitor) Visit(fn VisitorFunc) error {
errs := []error{
}
err := v.Visitor.Visit(func(info *Info, err error) error {
if err != nil {
errs = append(errs, err)
return nil
}
if err := fn(info, nil); err != nil {
errs = append(errs, err)
}
return nil
})
if err != nil {
errs = append(errs, err)
}
if len(errs) == 1 {
return errs[0]
}
return utilerrors.NewAggregate(errs)
}
FlattenListVisitor
将runtime.ObjectTyper解析成多个runtime.Object，再转换为多个Info，逐个调用VisitorFunc
type FlattenListVisitor struct {
visitor Visitor
typer runtime.ObjectTyper
mapper *mapper
}
FilteredVisitor
对Info资源的检验
// 过滤的Info
type FilteredVisitor struct {
visitor Visitor
filters []FilterFunc
}
func (v FilteredVisitor) Visit(fn VisitorFunc) error {
return v.visitor.Visit(func(info *Info, err error) error {
if err != nil {
return err
}
for _, filter := range v.filters {
// 检验Info是否满足条件，出错则退出
ok, err := filter(info, nil)
if err != nil {
return err
}
if !ok {
return nil
}
}
return fn(info, nil)
})
}
Implements
StreamVisitor
最基础的Visitor
type StreamVisitor struct {
// 读取信息的来源，实现了Read这个接口，这个"流式"的概念，包括了常见的HTTP、文件、标准输入等各类输入
io.Reader
*mapper
Source string
Schema ContentValidator
}
FileVisitor
文件的访问，包括标准输入，底层调用StreamVisitor来访问
type FileVisitor struct {
// 表示文件路径或者STDIN
Path string
*StreamVisitor
}
URLVisitor
HTTP用GET方法获取数据，底层也是复用StreamVisitor
type URLVisitor struct {
URL *url.URL
*StreamVisitor
// 提供错误重试次数
HttpAttemptCount int
}
KustomizeVisitor
自定义的Visitor，针对自定义的文件系统
type KustomizeVisitor struct {
Path string
*StreamVisitor
}
