bootstrap

package

v0.0.0-...-96f2668 Latest Latest Go to latest Published: Feb 27, 2024 License: MIT Imports: 92 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/beiduoke/go-scaffold

Links

Open Source Insights

Documentation ¶

Index ¶

func BeDaemon(arg string)
func Bootstrap(serviceInfo *ServiceInfo) (*conf.Bootstrap, log.Logger, registry.Registrar)
func CreateGrpcClient(ctx context.Context, r registry.Discovery, serviceName string, ...) grpc.ClientConnInterface
func CreateGrpcServer(cfg *conf.Bootstrap, m ...middleware.Middleware) *kratosGrpc.Server
func CreateHttpServer(cfg *conf.Bootstrap, m ...middleware.Middleware) *kratosHttp.Server
func LoadBootstrapConfig(configPath string) *conf.Bootstrap
func LoadRemoteConfigSourceConfigs(configPath string) (error, *conf.RemoteConfig)
func NewAliyunLogger(cfg *conf.Logger) log.Logger
func NewApolloConfigSource(c *conf.RemoteConfig) config.Source
func NewAuthzCasbin(enforcer *stdcasbin.SyncedEnforcer, logger log.Logger) authz.Authorized
func NewAuthzCasbinEnforcer(model model.Model, adapter persist.Adapter, watcher persist.Watcher, ...) *stdcasbin.SyncedEnforcer
func NewAuthzCasbinEntAdapter(cfg *conf.Bootstrap, logger log.Logger) (adapter persist.Adapter)
func NewAuthzCasbinFileModel(cfg *conf.Bootstrap, logger log.Logger) model.Model
func NewAuthzCasbinGormAdapter(cfg *conf.Bootstrap, logger log.Logger) (adapter persist.Adapter)
func NewAuthzCasbinModel(logger log.Logger) model.Model
func NewAuthzCasbinWatcher(cfg *conf.Bootstrap, logger log.Logger) persist.Watcher
func NewConfigProvider(configPath string) config.Config
func NewConsulConfigSource(c *conf.RemoteConfig) config.Source
func NewConsulRegistry(c *conf.Registry) *consulKratos.Registry
func NewDiscovery(cfg *conf.Registry) registry.Discovery
func NewEtcdConfigSource(c *conf.RemoteConfig) config.Source
func NewEtcdRegistry(c *conf.Registry) *etcdKratos.Registry
func NewEurekaRegistry(c *conf.Registry) *eurekaKratos.Registry
func NewFileConfigSource(filePath string) config.Source
func NewFluentLogger(cfg *conf.Logger) log.Logger
func NewGormClient(cfg *conf.Bootstrap, l *log.Helper, models ...interface{}) *gorm.DB
func NewJaegerExporter(endpoint string) (traceSdk.SpanExporter, error)
func NewJwtAuthenticator(cfg *conf.Bootstrap, logger log.Logger) authn.Authenticator
func NewKubernetesRegistry(_ *conf.Registry) *k8sRegistry.Registry
func NewLogger(cfg *conf.Logger) log.Logger
func NewLoggerProvider(cfg *conf.Logger, serviceInfo *ServiceInfo) log.Logger
func NewLogrusLogger(cfg *conf.Logger) log.Logger
func NewMeilisearchClient(cfg *conf.Bootstrap, logger *log.Helper) *meilisearch.Client
func NewMinIoClient(conf *conf.OSS) *minio.Client
func NewNacosConfigSource(c *conf.RemoteConfig) config.Source
func NewNacosRegistry(c *conf.Registry) *nacosKratos.Registry
func NewPolarisConfigSource(_ *conf.RemoteConfig) config.Source
func NewRedisClient(conf *conf.Data) (rdb *redis.Client)
func NewRegistry(cfg *conf.Registry) registry.Registrar
func NewRemoteConfigSource(c *conf.RemoteConfig) config.Source
func NewServicecombRegistry(c *conf.Registry) *servicecombKratos.Registry
func NewStdLogger() log.Logger
func NewTencentLogger(cfg *conf.Logger) log.Logger
func NewTracerExporter(exporterName, endpoint string) (traceSdk.SpanExporter, error)
func NewTracerProvider(cfg *conf.Tracer, serviceInfo *ServiceInfo) error
func NewZapLogger(cfg *conf.Logger) log.Logger
func NewZipkinExporter(endpoint string) (traceSdk.SpanExporter, error)
func NewZooKeeperRegistry(c *conf.Registry) *zookeeperKratos.Registry
type CommandFlags
- func NewCommandFlags() *CommandFlags
- func (f *CommandFlags) Init()
type ConfigType
type LoggerType
type RegistryType
type ServiceInfo
- func NewServiceInfo(name, version, id string) *ServiceInfo
- func (s *ServiceInfo) GetInstanceId() string
- func (s *ServiceInfo) SetMetaData(k, v string)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func BeDaemon ¶

func BeDaemon(arg string)

BeDaemon 将当前进程转为守护进程

func Bootstrap ¶

func Bootstrap(serviceInfo *ServiceInfo) (*conf.Bootstrap, log.Logger, registry.Registrar)

Bootstrap 应用引导启动

func CreateGrpcClient ¶

func CreateGrpcClient(ctx context.Context, r registry.Discovery, serviceName string, cfg *conf.Bootstrap, m ...middleware.Middleware) grpc.ClientConnInterface

CreateGrpcClient 创建GRPC客户端

func CreateGrpcServer ¶

func CreateGrpcServer(cfg *conf.Bootstrap, m ...middleware.Middleware) *kratosGrpc.Server

CreateGrpcServer 创建GRPC服务端

func CreateHttpServer ¶

func CreateHttpServer(cfg *conf.Bootstrap, m ...middleware.Middleware) *kratosHttp.Server

CreateHttpServer 创建HTTP服务端

func LoadBootstrapConfig ¶

func LoadBootstrapConfig(configPath string) *conf.Bootstrap

LoadBootstrapConfig 加载程序引导配置

func LoadRemoteConfigSourceConfigs ¶

func LoadRemoteConfigSourceConfigs(configPath string) (error, *conf.RemoteConfig)

LoadRemoteConfigSourceConfigs 加载远程配置源的本地配置

func NewAliyunLogger ¶

func NewAliyunLogger(cfg *conf.Logger) log.Logger

NewAliyunLogger 创建一个新的日志记录器 - Aliyun

func NewApolloConfigSource ¶

func NewApolloConfigSource(c *conf.RemoteConfig) config.Source

NewApolloConfigSource 创建一个远程配置源 - Apollo

func NewAuthzCasbin ¶

func NewAuthzCasbin(enforcer *stdcasbin.SyncedEnforcer, logger log.Logger) authz.Authorized

NewAuthzCasbin casbin认证

func NewAuthzCasbinEnforcer ¶

func NewAuthzCasbinEnforcer(model model.Model, adapter persist.Adapter, watcher persist.Watcher, logger log.Logger) *stdcasbin.SyncedEnforcer

NewAuthzCasbinEnforcer 执行器

func NewAuthzCasbinEntAdapter ¶

func NewAuthzCasbinEntAdapter(cfg *conf.Bootstrap, logger log.Logger) (adapter persist.Adapter)

NewAuthzCasbinEntAdapter 适配器

func NewAuthzCasbinFileModel ¶

func NewAuthzCasbinFileModel(cfg *conf.Bootstrap, logger log.Logger) model.Model

NewAuthzCasbinModel 模型

func NewAuthzCasbinGormAdapter ¶

func NewAuthzCasbinGormAdapter(cfg *conf.Bootstrap, logger log.Logger) (adapter persist.Adapter)

NewAuthzCasbinGormAdapter 适配器

func NewAuthzCasbinModel ¶

func NewAuthzCasbinModel(logger log.Logger) model.Model

func NewAuthzCasbinWatcher ¶

func NewAuthzCasbinWatcher(cfg *conf.Bootstrap, logger log.Logger) persist.Watcher

NewAuthzCasbinWatcher 监视器

func NewConfigProvider ¶

func NewConfigProvider(configPath string) config.Config

NewConfigProvider 创建一个配置

func NewConsulConfigSource ¶

func NewConsulConfigSource(c *conf.RemoteConfig) config.Source

NewConsulConfigSource 创建一个远程配置源 - Consul

func NewConsulRegistry ¶

func NewConsulRegistry(c *conf.Registry) *consulKratos.Registry

NewConsulRegistry 创建一个注册发现客户端 - Consul

func NewDiscovery ¶

func NewDiscovery(cfg *conf.Registry) registry.Discovery

NewDiscovery 创建一个发现客户端

func NewEtcdConfigSource ¶

func NewEtcdConfigSource(c *conf.RemoteConfig) config.Source

NewEtcdConfigSource 创建一个远程配置源 - Etcd

func NewEtcdRegistry ¶

func NewEtcdRegistry(c *conf.Registry) *etcdKratos.Registry

NewEtcdRegistry 创建一个注册发现客户端 - Etcd

func NewEurekaRegistry ¶

func NewEurekaRegistry(c *conf.Registry) *eurekaKratos.Registry

NewEurekaRegistry 创建一个注册发现客户端 - Eureka

func NewFileConfigSource ¶

func NewFileConfigSource(filePath string) config.Source

NewFileConfigSource 创建一个本地文件配置源

func NewFluentLogger ¶

func NewFluentLogger(cfg *conf.Logger) log.Logger

NewFluentLogger 创建一个新的日志记录器 - Fluent

func NewGormClient ¶

func NewGormClient(cfg *conf.Bootstrap, l *log.Helper, models ...interface{}) *gorm.DB

NewGormClient 创建数据库客户端

func NewJaegerExporter ¶

func NewJaegerExporter(endpoint string) (traceSdk.SpanExporter, error)

NewJaegerExporter 创建一个jaeger导出器

func NewJwtAuthenticator ¶

func NewJwtAuthenticator(cfg *conf.Bootstrap, logger log.Logger) authn.Authenticator

NewJwtAuthenticator Jwt创建认证器

func NewKubernetesRegistry ¶

func NewKubernetesRegistry(_ *conf.Registry) *k8sRegistry.Registry

NewKubernetesRegistry 创建一个注册发现客户端 - Kubernetes

func NewLogger ¶

func NewLogger(cfg *conf.Logger) log.Logger

NewLogger 创建一个新的日志记录器

func NewLoggerProvider ¶

func NewLoggerProvider(cfg *conf.Logger, serviceInfo *ServiceInfo) log.Logger

NewLoggerProvider 创建一个新的日志记录器提供者

func NewLogrusLogger ¶

func NewLogrusLogger(cfg *conf.Logger) log.Logger

NewLogrusLogger 创建一个新的日志记录器 - Logrus

func NewMeilisearchClient ¶

func NewMeilisearchClient(cfg *conf.Bootstrap, logger *log.Helper) *meilisearch.Client

NewMeilisearchClient 创建Meilisearch客户端

func NewMinIoClient ¶

func NewMinIoClient(conf *conf.OSS) *minio.Client

func NewNacosConfigSource ¶

func NewNacosConfigSource(c *conf.RemoteConfig) config.Source

NewNacosConfigSource 创建一个远程配置源 - Nacos

func NewNacosRegistry ¶

func NewNacosRegistry(c *conf.Registry) *nacosKratos.Registry

NewNacosRegistry 创建一个注册发现客户端 - Nacos

func NewPolarisConfigSource ¶

func NewPolarisConfigSource(_ *conf.RemoteConfig) config.Source

NewPolarisConfigSource 创建一个远程配置源 - Polaris

func NewRedisClient ¶

func NewRedisClient(conf *conf.Data) (rdb *redis.Client)

NewRedisClient create go-redis client

func NewRegistry ¶

func NewRegistry(cfg *conf.Registry) registry.Registrar

NewRegistry 创建一个注册客户端

func NewRemoteConfigSource ¶

func NewRemoteConfigSource(c *conf.RemoteConfig) config.Source

NewRemoteConfigSource 创建一个远程配置源

func NewServicecombRegistry ¶

func NewServicecombRegistry(c *conf.Registry) *servicecombKratos.Registry

NewServicecombRegistry 创建一个注册发现客户端 - Servicecomb

func NewStdLogger ¶

func NewStdLogger() log.Logger

NewStdLogger 创建一个新的日志记录器 - Kratos内置，控制台输出

func NewTencentLogger ¶

func NewTencentLogger(cfg *conf.Logger) log.Logger

NewTencentLogger 创建一个新的日志记录器 - Tencent

func NewTracerExporter ¶

func NewTracerExporter(exporterName, endpoint string) (traceSdk.SpanExporter, error)

NewTracerExporter 创建一个导出器，支持：jaeger和zipkin

func NewTracerProvider ¶

func NewTracerProvider(cfg *conf.Tracer, serviceInfo *ServiceInfo) error

NewTracerProvider 创建一个链路追踪器

func NewZapLogger ¶

func NewZapLogger(cfg *conf.Logger) log.Logger

NewZapLogger 创建一个新的日志记录器 - Zap

func NewZipkinExporter ¶

func NewZipkinExporter(endpoint string) (traceSdk.SpanExporter, error)

NewZipkinExporter 创建一个zipkin导出器

func NewZooKeeperRegistry ¶

func NewZooKeeperRegistry(c *conf.Registry) *zookeeperKratos.Registry

NewZooKeeperRegistry 创建一个注册发现客户端 - ZooKeeper

Types ¶

type CommandFlags ¶

type CommandFlags struct {
	Conf       string // 引导配置文件路径，默认为：../../configs
	Env        string // 开发环境：dev、debug……
	ConfigHost string // 远程配置服务端地址
	ConfigType string // 远程配置服务端类型
	Daemon     bool   // 是否转为守护进程
}

func NewCommandFlags ¶

func NewCommandFlags() *CommandFlags

func (*CommandFlags) Init ¶

func (f *CommandFlags) Init()

type ConfigType ¶

type ConfigType string

const (
	ConfigTypeLocalFile ConfigType = "file"
	ConfigTypeNacos     ConfigType = "nacos"
	ConfigTypeConsul    ConfigType = "consul"
	ConfigTypeEtcd      ConfigType = "etcd"
	ConfigTypeApollo    ConfigType = "apollo"
	ConfigTypePolaris   ConfigType = "polaris"
)

type LoggerType ¶

type LoggerType string

const (
	LoggerTypeStd     LoggerType = "std"
	LoggerTypeFluent  LoggerType = "fluent"
	LoggerTypeLogrus  LoggerType = "logrus"
	LoggerTypeZap     LoggerType = "zap"
	LoggerTypeAliyun  LoggerType = "aliyun"
	LoggerTypeTencent LoggerType = "tencent"
)

type RegistryType ¶

type RegistryType string

const (
	RegistryTypeConsul    RegistryType = "consul"
	LoggerTypeEtcd        RegistryType = "etcd"
	LoggerTypeZooKeeper   RegistryType = "zookeeper"
	LoggerTypeNacos       RegistryType = "nacos"
	LoggerTypeKubernetes  RegistryType = "kubernetes"
	LoggerTypeEureka      RegistryType = "eureka"
	LoggerTypePolaris     RegistryType = "polaris"
	LoggerTypeServicecomb RegistryType = "servicecomb"
)

type ServiceInfo ¶

type ServiceInfo struct {
	Name     string
	Version  string
	Id       string
	Metadata map[string]string
}

func NewServiceInfo ¶

func NewServiceInfo(name, version, id string) *ServiceInfo

func (*ServiceInfo) GetInstanceId ¶

func (s *ServiceInfo) GetInstanceId() string

func (*ServiceInfo) SetMetaData ¶

func (s *ServiceInfo) SetMetaData(k, v string)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL