iocli 工具

iocli 是一款命令行工具，提供了以下能力：

  • 代码调试

    开发者启动 ioc-golang 框架提供的调试能力，iocli 作为调试客户端。

  • 结构描述注册信息生成

    开发者可以为需要依赖注入的结构体增加注解，iocli 会识别这些注解，自动生成SD(结构描述符)代码，注册至框架。

安装

go install github.com/alibaba/ioc-golang/iocli@latest

代码调试能力

ioc-golang 框架拥有首创的基于 AOP 思路的 Go 运行时程序调试能力。基于 ioc debug 协议

代码调试示例可参考 调试能力示例 或 快速开始

基于该思路，我们可以扩展出更丰富的 cli 端调试能力，例如：

  • 流量过滤、监控
  • 参数编辑
  • 故障注入
  • 耗时瓶颈分析
  • …

结构注解与SD代码生成

iocli 可以一键生成当前目录和子目录下的所有标记结构的描述符

sudo iocli gen

可以识别以下注解：

// +ioc:autowire=true
// +ioc:autowire:type=normal
// +ioc:autowire:interface=Redis
// +ioc:autowire:paramLoader=paramLoader
// +ioc:autowire:paramType=Config
// +ioc:autowire:constructFunc=New
// +ioc:autowire:baseType=true
// +ioc:autowire:alias=myAppAliasName

  • ioc:autowire

    bool 类型，为 true 则该结构被识别到。

  • ioc:autowire:type

    string类型，表示依赖注入模型，目前支持四种：

    • singleton

      单例模型，该结构体全局只能产生一个对象，无论是 API 获取还是字段注入。

    • normal

      多例模型，每一个标签注入字段、每一次 API 获取，都会产生一个新的对象。

    • config:

      配置模型是基于多例模型的封装扩展，基于配置模型定义的结构体方便从 yaml 配置文件中注入信息。

    • grpc:

      grpc 模型是基于单例模型的封装扩展，基于 grpc 模型可以方便地从 yaml 配置文件中读取参数，生成 grpc 客户端。

  • ioc:autowire:interface（非必填）

    string类型，表示实现的接口名，如果不存在这个标注，将作为结构体指针注入给使用方。

  • ioc:autowire:paramLoader（非必填）

    string类型，表示需要定制的“参数加载器“类型名

    参数加载器由结构定义者可选定制。可参考：ioc-go-extension/normal/redis

    参数加载器需要实现Load方法：

    // ParamLoader is interface to load param
type ParamLoader interface {
	Load(sd *StructDescriptor, fi *FieldInfo) (interface{}, error)
}

    定义结构的开发者可以通过实现参数加载器，来定义自己的结构初始化参数。例如，一个 redis 客户端结构 ‘Impl’，需要从Config 参数来加载，如下所示 New 方法。

    type Config struct {
	Address  string
	Password string
	DB       string
}

func (c *Config) New(impl *Impl) (*Impl, error) {
	dbInt, err := strconv.Atoi(c.DB)
	if err != nil {
		return impl, err
	}
	client := redis.NewClient(&redis.Options{
		Addr:     c.Address,
		Password: c.Password,
		DB:       dbInt,
	})
	_, err = client.Ping().Result()
	if err != nil {
		return impl, err
	}
	impl.client = client
	return impl, nil
}

    Config 包含的三个字段：Address Password DB，需要由使用者传入。

    从哪里传入？这就是参数加载器所做的事情。

    结构定义者可以定义如下加载器，从而将字段通过注入该结构的 tag 标签获取，如果tag信息标注了配置位置，则通过配置文件获取。

    type paramLoader struct {
}

func (p *paramLoader) Load(sd *autowire.StructDescriptor, fi *autowire.FieldInfo) (interface{}, error) {
	splitedTagValue := strings.Split(fi.TagValue, ",")
	param := &Config{}
	if len(splitedTagValue) == 1 {
		return nil, fmt.Errorf("file info %s doesn't contain param infomration, create param from sd paramLoader failed", fi)
	}
	if err := config.LoadConfigByPrefix("extension.normal.redis."+splitedTagValue[1], param); err != nil {
		return nil, err
	}
	return param, nil
}

    例如

    type App struct {
	NormalDB3Redis normalRedis.Redis `normal:"Impl,address=127.0.0.1:6379&db=3"`
}

    当然也可以从配置文件读入，tag中指定了key为 db1-redis

    type App struct {
	NormalDB3Redis normalRedis.Redis `normal:"Impl,db1-redis"`
}

    ioc-go.yaml： autowire.normal.Redis.Impl.db1-redis.param 读入参数

    autowire:
  normal:
    Redis:
      Impl:
        db1-redis:
          param:
            address: localhost:6379
            db: 1

我们提供了预置的参数加载器

除非用户有强烈需求，我们更推荐用户直接使用我们预置的参数加载器：http://github.com/alibaba/ioc-golang/tree/master/autowire/param_loader。

我们会先后尝试：标签重定向到配置、标签读入参数、配置文件的默认位置读入参数。每个注册到框架的结构都有唯一的ID，因此也会在配置文件中拥有配置参数的位置，这一默认位置在这里定义：http://github.com/alibaba/ioc-golang/blob/master/autowire/param_loader/default_config.go#L21，我们更希望和用户约定好这一点。

当所有加载器都加载参数失败后，将会抛出错误。使用者应当查阅自己引入的结构加载器实现，并按照要求配置好参数。

  • ioc:autowire:paramType（非必填）

    string类型，表示依赖参数的类型名，在上述例子，该类型名为 Config

  • ioc:autowire:constructFunc（非必填）

    string类型，表示结构的构造方法名，作为依赖参数的一个函数。

    在上述例子中，该方法名为 New。

    思路为：依赖参数是构造对象的前提，因此该方法放置在参数下，会被框架调用。对于不依赖外部传递参数，但拥有构造函数的对象，可以使用一个空Struct 作为参数，在这一Struct 内实现构造方法。

    我们要求该构造方法的函数签名是固定的，即：

    func (*$(结构名)) (*$(结构名）, error)

  • ioc:autowire:baseType=true （非必填）

    该类型是否为基础类型

    go 基础类型不可直接通过&在构造时取地址，因此我们针对基础类型单独设计了该注解。在 http://github.com/alibaba/ioc-golang/extension/tree/master/config 配置扩展中被使用较多。

  • ioc:autowire:alias=MyAppAliasName （非必填）

    该类型的别名，可在标签、API获取、配置中，通过该别名替代掉较长的类型全名来指定结构。


Last modified June 21, 2022: Fix: remove unused file (0fc728c)