github.com/erda-project/erda-infra@v1.0.9/providers/component-protocol/cpregister/register_comp.go (about)

     1  // Copyright (c) 2021 Terminus, Inc.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package cpregister
    16  
    17  import (
    18  	"reflect"
    19  
    20  	"github.com/erda-project/erda-infra/providers/component-protocol/components/defaults"
    21  	"github.com/erda-project/erda-infra/providers/component-protocol/cptype"
    22  	"github.com/erda-project/erda-infra/providers/component-protocol/protocol"
    23  )
    24  
    25  // RegisterComponent register legacy component which implements protocol.RenderCreator
    26  func RegisterComponent(scenario, componentName string, componentCreator protocol.ComponentCreator) {
    27  	protocol.MustRegisterComponent(&protocol.CompRenderSpec{
    28  		Scenario: scenario,
    29  		CompName: componentName,
    30  		RenderC:  nil,
    31  		Creator: func() cptype.IComponent {
    32  			compInstance := componentCreator()
    33  			ref := reflect.ValueOf(compInstance)
    34  			ref.Elem().FieldByName(cptype.FieldImplForInject).Set(ref)
    35  			ref.Elem().FieldByName(defaults.FieldActualImplRef).Set(ref)
    36  			return compInstance
    37  		},
    38  	})
    39  }
    40  
    41  // RegisterLegacyComponent register legacy component which implements protocol.RenderCreator
    42  // For most scenarios, you should use RegisterComponent.
    43  func RegisterLegacyComponent(scenario, componentName string, componentCreator protocol.RenderCreator) {
    44  	protocol.MustRegisterComponent(&protocol.CompRenderSpec{
    45  		Scenario: scenario,
    46  		CompName: componentName,
    47  		RenderC:  componentCreator,
    48  		Creator:  nil,
    49  	})
    50  }