options

Documentation

Overview

* @Date: 2022-04-30 10:34:56 * @LastEditTime: 2022-04-30 16:26:27 * @FilePath: \go-frame\pkgs\options\gin_option.go

* @Date: 2022-04-30 16:11:43 * @LastEditTime: 2022-04-30 16:11:44 * @FilePath: \go-frame\pkgs\options\tasks_option.go

Index

• func GrpcOptionEtcd() grpcOption
• type Option
  • func WithConfigFile(configFile string) Option
  • func WithEtcd() Option
  • func WithFxOption(fxOptions ...fx.Option) Option
  • func WithFxOptions(fxOptions ...[]fx.Option) Option
  • func WithGRPCClient(options ...grpcOption) Option
  • func WithGRPCServer(options ...grpcOption) Option
  • func WithGoutConfig() Option
  • func WithGraceRestart() Option
  • func WithHttp(_ *swag.Spec) Option
  • func WithHwOBS() Option
  • func WithInvokes(Invokes ...any) Option
  • func WithKafka() Option
  • func WithLogNotice() Option
  • func WithMysql(mysqlNames ...string) Option
  • func WithProviders(providers ...any) Option
  • func WithRedis() Option
  • func WithStart() Option
  • func WithTasks() Option
• type Options

Functions

func GrpcOptionEtcd

func GrpcOptionEtcd() grpcOption

使用etcd作为服务发现

Types

type Option

type Option func(*Options) // 选项函数类型

func WithConfigFile

func WithConfigFile(configFile string) Option

配置文件路径,默认是./conf/app.toml路径

func WithEtcd

func WithEtcd() Option

func WithFxOption

func WithFxOption(fxOptions ...fx.Option) Option

一次注册单个fx.Option

func WithFxOptions

func WithFxOptions(fxOptions ...[]fx.Option) Option

一次注册多个fx.Option

func WithGRPCClient

func WithGRPCClient(options ...grpcOption) Option

GRPC client,使用etcd作为服务发现时，需要先调用options.WithEtcd(),初始化一个etcd客户端

func WithGRPCServer

func WithGRPCServer(options ...grpcOption) Option

GRPC server,使用etcd作为服务发现时，需要先调用options.WithEtcd(),初始化一个etcd客户端

func WithGoutConfig

func WithGoutConfig() Option

指定github.com/guonaihong/gout这个库的全局配置: 是否全局开启调试,设置全局的超时

func WithGraceRestart

func WithGraceRestart() Option

func WithHttp

func WithHttp(_ *swag.Spec) Option

使用gin框架，这里传递的文档参数主要用来注册文档，如果不传，在配置文件开启或者关闭文档，那么文档也不起作用 即使传了生成的文档对象，如果配置文件关闭了，那么也不起作用，所以在代码中就直接传递参数，使用配置文件来控制文档的关闭

func WithHwOBS

func WithHwOBS() Option

华为obs,这里返回的是一个interfaces.OBSInterface的接口类型,HwObs实现了这个接口

func WithInvokes

func WithInvokes(Invokes ...any) Option

注册需要被调用的函数

func WithKafka

func WithKafka() Option

使用kafka的底层sarama.Client, sarama.AsyncProducer, sarama.SyncProducer, sarama.Consumer 依赖

func WithLogNotice

func WithLogNotice() Option

错误日志企业微信通知

func WithMysql

func WithMysql(mysqlNames ...string) Option

使用mysql存储,mysqlNames参数,mysqlNames是配置在mysql段的name字段,默认(default)的可以不用传

func WithProviders

func WithProviders(providers ...any) Option

注册需要提供的对象

func WithRedis

func WithRedis() Option

使用redis

func WithStart

func WithStart() Option

使用start运行，运行完毕自行退出

func WithTasks

func WithTasks() Option

定时任务

type Options

type Options struct {
	ConfigFile      string      // 配置文件路径
	FxOptions       []fx.Option // 需要注入的对象
	IsStart         bool        // true=>运行一次就退出
	UseHttp         bool        // 是否使用http
	UseGraceRestart bool        // 是否使用优雅重启
}