dubbo.apache.org/dubbo-go/v3@v3.1.1/cluster/router/condition/matcher/matcher.go (about)

     1  /*
     2   * Licensed to the Apache Software Foundation (ASF) under one or more
     3   * contributor license agreements.  See the NOTICE file distributed with
     4   * this work for additional information regarding copyright ownership.
     5   * The ASF licenses this file to You under the Apache License, Version 2.0
     6   * (the "License"); you may not use this file except in compliance with
     7   * the License.  You may obtain a copy of the License at
     8   *
     9   *     http://www.apache.org/licenses/LICENSE-2.0
    10   *
    11   * Unless required by applicable law or agreed to in writing, software
    12   * distributed under the License is distributed on an "AS IS" BASIS,
    13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14   * See the License for the specific language governing permissions and
    15   * limitations under the License.
    16   */
    17  
    18  package matcher
    19  
    20  import (
    21  	"dubbo.apache.org/dubbo-go/v3/common"
    22  	"dubbo.apache.org/dubbo-go/v3/protocol"
    23  )
    24  
    25  type ConditionMatcherFactory interface {
    26  	// ShouldMatch indicates whether the key is of the form of the current matcher type which this factory instance represents.
    27  	ShouldMatch(key string) bool
    28  	// NewMatcher returns a matcher instance for the key.
    29  	NewMatcher(key string) Matcher
    30  	// Priority returns Priority in ConditionMatcherFactory
    31  	// 0 to ^int(0) is better, smaller value by better priority.
    32  	Priority() int64
    33  }
    34  
    35  // Matcher represents a specific match condition of a condition rule.
    36  // The following condition rule 'foo=bar&arguments[0]=hello* => region=hangzhou' consists of three ConditionMatchers:
    37  // 1. ParamConditionMatcher represented by 'foo=bar'
    38  // 2. ArgumentConditionMatcher represented by 'arguments[0]=hello*'
    39  // 3. ParamConditionMatcher represented by 'region=hangzhou'
    40  type Matcher interface {
    41  	// IsMatch indicates whether this matcher matches the patterns with request context.
    42  	IsMatch(value string, param *common.URL, invocation protocol.Invocation, isWhenCondition bool) bool
    43  	// GetMatches returns matches.
    44  	// match patterns extracted from when condition.
    45  	GetMatches() map[string]struct{}
    46  	// GetMismatches returns misMatches.
    47  	// mismatch patterns extracted from then condition.
    48  	GetMismatches() map[string]struct{}
    49  	// GetValue returns a value from different places of the request context, for example, url, attachment and invocation.
    50  	// This makes condition rule possible to check values in any place of a request.
    51  	GetValue(sample map[string]string, url *common.URL, invocation protocol.Invocation) string
    52  }