dddfirework

type ActFunc func(ctx context.Context, container RootContainer, roots ...IEntity) error

type Action struct {
	Op OpType

	Models      []IModel    // 当前待操作模型，stage 确保一个 Action 下都是同类的模型
	PrevModels  []IModel    // 基于快照生成的模型，跟 Models 一一对应，Executor 需要对两者做差异比对后更新
	Query       IModel      // 指定查询字段的数据模型
	QueryResult interface{} // Model 的 slice 的指针，形如 *[]ExampleModel
}

type ActionResult struct {
	Data interface{}
}

type BaseEntity struct {
	// contains filtered or unexported fields
}

type BuildFunc func(ctx context.Context, h DomainBuilder) (roots []IEntity, err error)

type Command struct {
	// contains filtered or unexported fields
}

type DTimerOption struct {
	// contains filtered or unexported fields
}

type DomainBuilder struct {
	// contains filtered or unexported fields
}

type DomainEvent struct {
	ID        string
	Type      EventType
	SendType  SendType
	Sender    string // 事件发出实体 ID
	Payload   []byte
	CreatedAt time.Time
}

type DomainEventHandler func(ctx context.Context, evt *DomainEvent) error

type DomainEventTXChecker func(evt *DomainEvent) TXStatus

type Engine struct {
	// contains filtered or unexported fields
}

type EntityContainer struct {
	BaseEntity
	// contains filtered or unexported fields
}

type EntitySlice []IEntity

type ErrList []error

type EventBusOption struct {
	// contains filtered or unexported fields
}

type EventHandler interface{}

type EventHandlerConstruct interface{}

type EventOpt func(opt *EventOption)

type EventOption struct {
	SendType SendType
	SendTime time.Time // 设定发送时间
}

type EventPersist func(event *DomainEvent) (IModel, error)

type EventSaveOption EventPersist

type EventTXChecker interface{}

type EventType string

type IAfterCreate interface {
	AfterCreate(ctx context.Context) error
}

type IAfterDelete interface {
	AfterDelete(ctx context.Context) error
}

type IAfterUpdate interface {
	AfterUpdate(ctx context.Context) error
}

type IBeforeCreate interface {
	BeforeCreate(ctx context.Context) error
}

type IBeforeDelete interface {
	BeforeDelete(ctx context.Context) error
}

type IBeforeUpdate interface {
	BeforeUpdate(ctx context.Context) error
}

type ICommand interface {
	// Init 会在锁和事务之前执行，可进行数据校验，前置准备工作，可选返回锁ID
	Init(ctx context.Context) (lockKeys []string, err error)

	// Build 构建并返回聚合根实体，框架会为返回值自动生成快照，作为持久化比对的依据
	// 注意，Create 的情况不需要在 Build 方法返回
	Build(ctx context.Context, builder DomainBuilder) (roots []IEntity, err error)

	// Act 调用实体行为
	Act(ctx context.Context, container RootContainer, roots ...IEntity) (err error)

	// PostSave Save 事务完成后回调，可以执行组装返回数据等操作
	PostSave(ctx context.Context, res *Result)
}

type IConverter interface {
	// Entity2Model 实体转化为数据模型，entity: 当前实体 parent: 父实体 op: 调用场景，实体新建、实体更新、实体删除、实体查询等
	// 注意，对于Model上entity没有对应的字段，除新建场景外，其他需要保持为数据类型的零值，新建场景可以额外指定默认值
	// 实体未注册返回 ErrEntityNotRegister 错误
	Entity2Model(entity, parent IEntity, op OpType) (IModel, error)
	// Model2Entity 模型转换为实体，在创建实体的时候调用
	Model2Entity(model IModel, entity IEntity) error
}

type IDGeneratorOption struct {
	// contains filtered or unexported fields
}

type IDirty interface {
	// Dirty 标记实体对象是否需要更新
	Dirty()
	// UnDirty 取消实体的更新标记
	UnDirty()
	// IsDirty 判断实体是否需要更新
	IsDirty() bool
}

type IEntity interface {
	IDirty

	SetID(id string)
	GetID() string

	GetChildren() map[string][]IEntity
	GetEvents() []*DomainEvent
}

type IEvent interface {
	GetType() EventType // 事件类型
	GetSender() string  // 发送者id，可以用来实现事件保序
}

type IEventBus interface {
	// Dispatch 发送领域事件到 EventBus，该方法会在事务内被同步调用
	// 对于每个事件，EventBus 必须要至少保证 at least once 送达
	Dispatch(ctx context.Context, evt ...*DomainEvent) error

	// RegisterEventHandler 注册事件回调，IEventBus 的实现必须保证收到事件同步调用该回调
	RegisterEventHandler(cb DomainEventHandler)
}

type IExecutor interface {
	ITransaction
	IConverter

	Exec(ctx context.Context, actions *Action) error
}

type IIDGenerator interface {
	NewID() (string, error)
}

type ILock interface {
	Lock(ctx context.Context, key string) (keyLock interface{}, err error)
	UnLock(ctx context.Context, keyLock interface{}) error
}

type IModel interface {
	GetID() string
}

type IStageSetter interface {
	SetStage(s StageAgent)
}

type ITimer interface {
	// RegisterTimerHandler 注册定时任务，定时到来时候调用该回调函数
	RegisterTimerHandler(cb TimerHandler)

	// RunCron 按照 cron 语法设置定时，并在定时到达后作为参数调用定时任务回调
	// key: 定时任务唯一标识，重复调用时不覆盖已有计时; cron: 定时配置; data: 透传数据，回调函数传入
	RunCron(key, cron string, data []byte) error

	// RunOnce 指定时间单次运行
	// key: 定时任务唯一标识，重复调用时不覆盖已有计时; t: 执行时间; data: 透传数据，回调函数传入
	RunOnce(key string, t time.Time, data []byte) error

	// Cancel 删除某个定时
	Cancel(key string) error
}

type ITransaction interface {
	// Begin 开启事务，返回带有事务标识的 context，该 context 会原样传递给 Commit 或者 RollBack 方法
	Begin(ctx context.Context) (context.Context, error)
	// Commit 提交事务
	Commit(ctx context.Context) error
	// RollBack 回滚事务
	RollBack(ctx context.Context) error
}

type ITransactionEventBus interface {
	IEventBus

	// RegisterEventTXChecker 注册事件回查
	RegisterEventTXChecker(cb DomainEventTXChecker)

	// DispatchBegin 开始发送事务，eventbus 需要保证同步成功，但是暂不发送到消费端
	// 返回值 context.Context 会传递给 Commie 和 Rollback 接口，实现方可以利用机制传递上下文信息
	DispatchBegin(ctx context.Context, evt ...*DomainEvent) (context.Context, error)

	// Commit 发送事件到消费端
	Commit(ctx context.Context) error

	// Rollback 回滚事件
	Rollback(ctx context.Context) error
}

type LoggerOption struct {
	// contains filtered or unexported fields
}

type OpType int8

type Option interface {
	ApplyToOptions(*Options)
}

type Options struct {
	WithTransaction bool
	RecursiveDelete bool         // 删除根实体是否递归删除所有子实体
	EventPersist    EventPersist // 是否保存领域事件到 DB
	Logger          logr.Logger
	EventBus        IEventBus
	Timer           ITimer
	IDGenerator     IIDGenerator
	PostSaveHooks   []PostSaveFunc
}

type PostSaveFunc func(ctx context.Context, res *Result)

type PostSaveOption PostSaveFunc

type RecursiveDeleteOption bool

type Result struct {
	Error   error
	Break   bool
	Actions []*Action
	Output  interface{}
}

type RootContainer struct {
	// contains filtered or unexported fields
}

type SendType string

type Stage struct {
	// contains filtered or unexported fields
}

type StageAgent struct {
	// contains filtered or unexported fields
}

type TXStatus int

type TimerEvent struct {
	Key     string
	Cron    string
	Payload []byte
}

type TimerHandler func(ctx context.Context, key, cron string, data []byte) error

type TransactionOption bool