cond

Documentation

Overview

Package cond 提供了判断 bean 注册是否有效的条件。

Index

• Constants
• func Group(op Operator, cond ...Condition) *group
• func New() *conditional
• func Not(c Condition) *not
• func On(cond Condition) *conditional
• func OnBean(selector BeanSelector) *conditional
• func OnExpression(expression string) *conditional
• func OnMatches(fn Matches) *conditional
• func OnMissingBean(selector BeanSelector) *conditional
• func OnMissingProperty(name string) *conditional
• func OnProfile(profile string) *conditional
• func OnProperty(name string, options ...PropertyOption) *conditional
• func OnSingleCandidate(selector BeanSelector) *conditional
• type BeanDefinition
• type BeanSelector
• type Condition
  • func OK() Condition
• type Context
• type Matches
• type Operator
• type PropertyOption
  • func HavingValue(havingValue string) PropertyOption
  • func MatchIfMissing() PropertyOption

Constants

const (
	Or   = Operator(1) // 条件成立必须至少一个满足。
	And  = Operator(2) // 条件成立必须所有都要满足。
	None = Operator(3) // 条件成立必须没有一个满足。
)

Functions

func Group

func Group(op Operator, cond ...Condition) *group

Group 返回基于条件组的 Condition 对象。

func New

func New() *conditional

New 返回 Condition 计算式对象。

func Not

func Not(c Condition) *not

Not 返回对一个条件取反后的 Condition 对象。

func On

func On(cond Condition) *conditional

On 返回一个以给定 Condition 为开始条件的计算式。

func OnBean

func OnBean(selector BeanSelector) *conditional

OnBean 返回一个以 onBean 为开始条件的计算式。

func OnExpression

func OnExpression(expression string) *conditional

OnExpression 返回一个以 onExpression 为开始条件的计算式。

func OnMatches

func OnMatches(fn Matches) *conditional

OnMatches 返回一个以 onMatches 为开始条件的计算式。

func OnMissingBean

func OnMissingBean(selector BeanSelector) *conditional

OnMissingBean 返回一个以 onMissingBean 为开始条件的计算式。

func OnMissingProperty

func OnMissingProperty(name string) *conditional

OnMissingProperty 返回一个以 onMissingProperty 为开始条件的计算式。

func OnProfile

func OnProfile(profile string) *conditional

OnProfile 返回一个以 spring.profile 属性值是否匹配为开始条件的计算式。

func OnProperty

func OnProperty(name string, options ...PropertyOption) *conditional

OnProperty 返回一个以 onProperty 为开始条件的计算式。

func OnSingleCandidate

func OnSingleCandidate(selector BeanSelector) *conditional

OnSingleCandidate 返回一个以 onSingleCandidate 为开始条件的计算式。

Types

type BeanDefinition

type BeanDefinition = internal.BeanDefinition

type BeanSelector

type BeanSelector = internal.BeanSelector

type Condition

type Condition interface {
	Matches(ctx Context) (bool, error)
}

Condition 条件接口，条件成立 Matches 方法返回 true，否则返回 false。

func OK

func OK() Condition

OK 永远成立的 Condition 实现。

type Context

type Context interface {
	HasProperty(key string) bool
	GetProperty(key string, opts ...conf.GetOption) string
	FindBean(selector BeanSelector) ([]BeanDefinition, error)
}

type Matches

type Matches func(ctx Context) (bool, error)

type Operator

type Operator int

Operator 条件操作符，包含 Or、And、None 三种。

type PropertyOption

type PropertyOption func(*onProperty)

func HavingValue

func HavingValue(havingValue string) PropertyOption

HavingValue 当 havingValue 与属性值相同时条件成立。

func MatchIfMissing

func MatchIfMissing() PropertyOption

MatchIfMissing 当属性不存在时条件成立。