- [SharedInformer](#sharedinformer)

- [Informer](#informer)

- [processorListener](#processorlistener)

- [add() 方法](#add-方法)

- [pop() 方法](#pop-方法)

- [HandleDeltas() 方法](#handledeltas-方法)

- [WaitForCacheSync() 函数](#waitforcachesync-函数)

- [codegen 为特定资源类型创建的 SharedIndexInformer](#codegen-为特定资源类型创建的-sharedindexinformer)

- [SharedInformer 的使用场景](#sharedinformer-的使用场景)

- [GenericInformer 接口](#genericinformer-接口)

Inforer 的主要使用场景是自定义 Controller,它需要从 apiserver List/Watch 特定类型的资源对象的所有事件,缓存到内存,供后续快速查找,根据事件类型,调用用户注册的回调函数。

[前面分析了] (3.listwatch-reflector-controller.md) NewInformer()、NewIndexInformer() 函数使用 controller 的 Reflector List/Watch 特定资源类型的对象,缓存到本地,并调用用户设置的 OnAdd/OnUpdate/OnDelete 回调函数(保存在 ResourceEventHandler 中)。

这两个函数返回的 Store 和 Index 都缓存了从 apiserver List/Watch 更新的资源类型对象,并保持与 etcd 同步。另外,可以使用 Index 创建 Lister,进而更方便的从本地缓存中 List 和 Get 符合条件的资源对象。

SharedInformer 和 SharedIndexInformer 一般和 workqueue 同时使用,具体参考:[8.customize-controller.md](8.customize-controller.md)

在分析 SharedInformer 和 SharedIndexInformer 之前,先分析它使用的 processorListener 和 sharedProcessor 结构类型。

processorListener 封装了监听器处理函数 ResourceEventHandler 以及 RingGrowing 类型的循环队列。

// GetStore returns the Store.

GetStore() Store

// GetController gives back a synthetic interface that "votes" to start the informer

GetController() Controller

//Run starts the shared informer, which will be stopped when stopCh is closed.

Run(stopCh <-chan struct{})

GetContrtarts the shared informer, which will be stopped when stopCh is closed.

Run(stopoller() Controller

//Run sCh <-chan struct{})

// HasSynced returns true if the shared informer's store has synced.

HasSynced() bool

// LastSyncResourceVersion is the resource version observed when last synced with the underlying

+ 传给 NewSharedIndexInformer () 的 indexers 一般是 `cache.Indexers{cache.NamespaceIndex: cache.MetaNamespaceIndexFunc}`,然后用 `DeletionHandlingMetaNamespaceKeyFunc` 作为对象的 KeyFunc 创建 Indexer 缓存;

后文会介绍,一般情况下,我们不需要使用 NewSharedInformer() 和 NewSharedIndexInformer() 函数为特定资源类型创建 SharedInformer,而是使用 codegen 为特定资源类型创建的 NewXXXInformer() 和 NewFilteredXXXInformer() 函数来创建。

这两个 Informer 包含:

return v1.NewDeploymentLister(f.Informer().GetIndexer())

}

+ client 一般是 client-go 的 kubernets 或 CRD 的 clientset,如:

``` go

一般情况下,我们不直接使用上面的 NewXXX 函数创建各资源类型的 SharedInformer,而是使用 codegen 生成的 sharedInformerFactory 来创建它们,具体参考:[6.sharedInformerFactory.md](6.sharedInformerFactory.md)

SharedInforer 的主要使用场景是自定义 Controller,它需要从 apiserver List/Watch 特定类型的资源对象的所有事件,缓存到内存,供后续快速查找,根据事件类型,调用用户注册的回调函数。

``` go

type GenericInformer interface {

Informer() cache.SharedIndexInformer

Lister() cache.GenericLister

}

内置类型 genericInformer 实现了该接口:

``` go

type genericInformer struct {

informer cache.SharedIndexInformer

resource schema.GroupResource

}

func (f *genericInformer) Informer() cache.SharedIndexInformer {

return f.informer

}

func (f *genericInformer) Lister() cache.GenericLister {

return cache.NewGenericLister(f.Informer().GetIndexer(), f.resource)

}

- [使用 InformerFactory 创建特定资源类型的 SharedIndexInformer 过程分析](#使用-informerfactory-创建特定资源类型的-sharedindexinformer-过程分析)

- [extensions informers](#extensions-informers)

- [extensions v1beat1 informers](#extensions-v1beat1-informers)

- [GenericInformer 接口](#genericinformer-接口)

return v1beta1.NewDeploymentLister(f.Informer().GetIndexer())

}

GenericInformer 接口封装了 SharedIndexInformer 接口,codegen 为各 K8S 资源类型生成的 XXXInformer(如上面的 DeploymentInformer) 均实现了该接口:

``` go

type GenericInformer interface {

Informer() cache.SharedIndexInformer

Lister() cache.GenericLister

}

内置类型 genericInformer 实现了该接口:

``` go

type genericInformer struct {

informer cache.SharedIndexInformer

resource schema.GroupResource

}

func (f *genericInformer) Informer() cache.SharedIndexInformer {

return f.informer

}

func (f *genericInformer) Lister() cache.GenericLister {

return cache.NewGenericLister(f.Informer().GetIndexer(), f.resource)

}

一般情况下,我们可用通过以下两种方式创建 GenericInformer 接口:

1. 直接使用 codegen 为各 K8S 资源类型生成的 XXXInformer;

2. 或者使用 sharedInformerFactory 的 ForResource() 方法;

``` go

func (f *sharedInformerFactory) ForResource(resource schema.GroupVersionResource) (GenericInformer, error) {

switch resource {

...

// Group=extensions, Version=v1beta1

case extensionsv1beta1.SchemeGroupVersion.WithResource("deployments"):

return &genericInformer{resource: resource.GroupResource(), informer: f.Extensions().V1beta1().Deployments().Informer()}, nil

...

}

}