README
¶
funcs
Function call by its name in golang
Get started
Install
go get github.com/hslam/funcs
Import
import "github.com/hslam/funcs"
Usage
First create an instance of the funcs:
Funcs:=funcs.New()
Then register your Struct:
type Service struct {
}
func (s *Service) Method(params ...interface{}) error {
//to do
return nil
}
Funcs.Register(new(Service))
And then call your function by name.
Function's Name Format : "StructName.MethodName"
if err := Funcs.Call("Service.Method", params...);err != nil {
log.Fatalln("Call Service.Method error: ", err)
}
Logging.
Funcs.SetLog(true)
if a function has 2 input parameters ,You can get the function's first input parameter and second input parameter.
Funcs.GetFuncIn("Service.Method",0)
Funcs.GetFuncIn("Service.Method",1)
//and so on
Example
package main
import (
"errors"
"fmt"
"github.com/hslam/funcs"
"log"
)
//ArithRequest is the first input parameter.
type ArithRequest struct {
A int
B int
}
//ArithResponse is the second input parameter.
type ArithResponse struct {
Quo int // quotient
Rem int // remainder
}
//Arith is the Service struct.
type Arith struct {
}
//Divide is the Arith's Method.
func (a *Arith) Divide(req *ArithRequest, res *ArithResponse) error {
if req.B == 0 {
return errors.New("divide by zero")
}
res.Quo = req.A / req.B
res.Rem = req.A % req.B
return nil
}
func main() {
Funcs := funcs.New()
Funcs.SetLog(true)
//Funcs.RegisterName("Arith",new(Arith))
Funcs.Register(new(Arith))
f := Funcs.GetFunc("Arith.Divide")
fmt.Printf("num of args : %d\n", f.NumIn())
//req := &ArithRequest{A: 9, B: 2}
req := Funcs.GetFuncIn("Arith.Divide", 0).(*ArithRequest)
req.A = 9
req.B = 2
//res := &ArithResponse{}
res := Funcs.GetFuncIn("Arith.Divide", 1).(*ArithResponse)
if err := Funcs.Call("Arith.Divide", req, res); err != nil {
log.Fatalln("Call Arith.Divide error: ", err)
return
}
fmt.Printf("%d / %d, quo is %d, rem is %d\n", req.A, req.B, res.Quo, res.Rem)
}
Output
[funcs] 2020/01/09 10:12:19.065121 StructName:Arith,NumMethod:1
[funcs] 2020/01/09 10:12:19.065246 MethodIndex:0,CallName:Arith.Divide,NumIn:2,NumOut:1
num of args : 2
9 / 2, quo is 4, rem is 1
License
This package is licensed under a MIT license (Copyright (c) 2019 Meng Huang)
Author
funcs was written by Meng Huang.
Documentation
¶
Overview ¶
Package funcs implements function call by its name.
Index ¶
- Constants
- Variables
- func Call(name string, params ...interface{}) (err error)
- func GetFuncIn(name string, i int) interface{}
- func ReflectValueOf(param interface{}) reflect.Value
- func Register(obj interface{}) (err error)
- func RegisterName(name string, obj interface{}) error
- func Services() []string
- func SetLog(enable bool)
- func ValueCall(name string, in ...Value) (err error)
- type Func
- func (f *Func) Call(params ...interface{}) (err error)
- func (f *Func) GetIn(i int) interface{}
- func (f *Func) GetValueIn(i int) Value
- func (f *Func) NumCalls() (n int64)
- func (f *Func) NumIn() int
- func (f *Func) NumOut() int
- func (f *Func) ValueCall(in ...Value) (err error)
- func (f *Func) WithContext() bool
- type Funcs
- func (f *Funcs) Call(name string, params ...interface{}) (err error)
- func (f *Funcs) GetFunc(name string) (F *Func)
- func (f *Funcs) GetFuncIn(name string, i int) interface{}
- func (f *Funcs) GetFuncValueIn(name string, i int) Value
- func (f *Funcs) Register(obj interface{}) (err error)
- func (f *Funcs) RegisterName(name string, obj interface{}) (err error)
- func (f *Funcs) Services() []string
- func (f *Funcs) SetLog(enable bool)
- func (f *Funcs) ValueCall(name string, in ...Value) (err error)
- type Value
Constants ¶
const LogPrefix = "funcs"
LogPrefix is the prefix of log.
Variables ¶
var ( //ZeroValue is the Value of zero ZeroValue = Value{} //ErrNumParams is the error of params number. ErrNumParams = errors.New("The number of params is not adapted") //ErrObject is the error of nil. ErrObject = errors.New("The object is nil") //DefalutFuncs is the defalut Funcs. DefalutFuncs = New() )
Functions ¶
func Call ¶
Call calls the function with the input arguments. For example, Call("v",arg1,arg2) represents the Go call v(arg1,arg2). Call panics if v's Kind is not Func. As in Go, each input argument must be assignable to the type of the function's corresponding input parameter.
func ReflectValueOf ¶
ReflectValueOf returns a new reflect.Value.
func Register ¶
func Register(obj interface{}) (err error)
Register publishes the set of struct's methods in the DefalutFuncs. If the function has a context.Context parameter, the context.Context must be the first parameter of the function.
func RegisterName ¶
RegisterName is like Register but uses the provided name for the type instead of the struct's concrete type.
Types ¶
type Func ¶
type Func struct {
// contains filtered or unexported fields
}
Func defines the struct of func.
func (*Func) GetValueIn ¶
GetValueIn returns the Value of index'th input parameter by index.
func (*Func) WithContext ¶ added in v1.0.1
WithContext returns whether calling with context.
type Funcs ¶
type Funcs struct {
// contains filtered or unexported fields
}
Funcs defines the struct of Funcs.
func (*Funcs) Call ¶
Call calls the function with the input arguments. For example, Call("v",arg1,arg2) represents the Go call v(arg1,arg2). Call panics if v's Kind is not Func. As in Go, each input argument must be assignable to the type of the function's corresponding input parameter.
func (*Funcs) GetFuncIn ¶
GetFuncIn returns index'th input parameter by name and index in the Funcs.
func (*Funcs) GetFuncValueIn ¶
GetFuncValueIn returns the Value of index'th input parameter by name and index in the Funcs.
func (*Funcs) Register ¶
Register publishes the set of struct's methods in the Funcs. If the function has a context.Context parameter, the context.Context must be the first parameter of the function.
func (*Funcs) RegisterName ¶
RegisterName is like Register but uses the provided name for the type instead of the struct's concrete type.
type Value ¶
Value is the reflection interface to a Go value.
func GetFuncValueIn ¶
GetFuncValueIn returns the Value of index'th input parameter by name and index in the DefalutFuncs.
Source Files