vine

package module

v0.20.13 Latest Latest Go to latest Published: Aug 9, 2021 License: MIT Imports: 35 Imported by: 15

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/lack-io/vine

Links

Open Source Insights

README ¶

Vine (/vaɪn/) 一套简单、高效、可插拔的分布式 RPC 框架。

简介

Vine 基于 go-micro 框架，因此继承了它的优点。并在此基础上增加性能和可用性。

主要功能

Vine 抽象化分布式系统的内部细节. 以下是主要功能.

身份验证 (Authentication) - 身份验证和授权作为一等公民而存在。身份验证和授权通过为每个服务提供一个身份和证书来确保内部服务安全。其中还包括基于规则的访问控制。
动态配置 (Dynamic Config) - 从任意地方加载和热加载动态配置。配置接口提供了一种方法，可以从任何源（如环境变量，文件，etcd）加载应用级别配置。同时支持合并源、甚至定义回退。
数据存储 (Data Storage) - 一个简单的数据存储接口，用于查询，创建，删除数据记录。内置 memory，file，postgresSQL 等
服务发现 (Service disconvery) - 自动服务注册和名称解析。服务发现是微服务开发的核心功能。当服务A与服务B通讯时，需要知道服务B的IP地址等信息。Vine 内置(mdns)作为服务发现组件，它是零配置系统。
负载均衡 (Load Balancing) - 基于服务发现的客户端负载均衡。当内部存在多个服务实例的地址时，我们需要一种方式确定路由到哪个节点，默认使用随机指定其中一个地址。同时在请求错误时重试不同的节点。
消息编码 (Message Encoding) - 基于Content-Type的动态消息编码。Codec 为客户端和服务端提供 Go 类型的编码和解码，支持各种不同的类型。默认使用 protobuf 和 json。
gRPC 传输 (gRPC transport) - 基于 gRPC 的请求响应，同时支持双向流。Vine 为同步通讯提供一个抽象，使发向服务的请求被自动解析、负载均衡、拨号和流化。
异步消息 (Async Messaging) - 内置订阅发布模型，作为异步通讯和事件驱动架构。事件通知属于微服务开发中的核心模式。默认的消息系统为 HTTP 事件代理。
同步 (Synchronization) - 分布式系统通常以最终一致性的方式构建。内置的 Sync 接口实现分布式锁和领导选举。
可插拔接口 (Pluggable Interfaces) - 得益于 Go 语言的抽象特性。 Vine 为每个模块提供抽象接口，正因为如此，这些接口都是可插拔的。可以在 github.com/lack-io/plugins 查询你需要的插件。

许可

Vine 遵守 Apache 2.0 开源许可.

文档

关于 vine 的文档可以参考 vine 文档

Documentation ¶

Overview ¶

Package vine is a pluggable framework for vine services

Index ¶

func AddJob(job *gscheduler.Job) error
func GetJob(id string) (*gscheduler.Job, error)
func GetJobs() ([]*gscheduler.Job, error)
func NewContext(ctx context.Context, s Service) context.Context
func RegisterHandler(s server.Server, h interface{}, opts ...server.HandlerOption) error
func RegisterSubscriber(topic string, s server.Server, h interface{}, opts ...server.SubscriberOption) error
func RemoveJob(job *gscheduler.Job) error
func UpdateJob(job *gscheduler.Job) error
type Event
- func NewEvent(topic string, c client.Client) Event
type Option
type Options
type Service
- func FromContext(ctx context.Context) (Service, bool)
- func NewService(opts ...Option) Service

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AddJob ¶ added in v0.12.0

func AddJob(job *gscheduler.Job) error

func GetJob ¶ added in v0.12.0

func GetJob(id string) (*gscheduler.Job, error)

func GetJobs ¶ added in v0.12.0

func GetJobs() ([]*gscheduler.Job, error)

func NewContext ¶

func NewContext(ctx context.Context, s Service) context.Context

NewContext returns a new Context with the Service embedded within it.

func RegisterHandler ¶

func RegisterHandler(s server.Server, h interface{}, opts ...server.HandlerOption) error

RegisterHandler is syntactic sugar for registering a handler

func RegisterSubscriber ¶

func RegisterSubscriber(topic string, s server.Server, h interface{}, opts ...server.SubscriberOption) error

RegisterSubscriber is syntactic sugar for registering a subscriber

func RemoveJob ¶ added in v0.12.0

func RemoveJob(job *gscheduler.Job) error

func UpdateJob ¶ added in v0.12.0

func UpdateJob(job *gscheduler.Job) error

Types ¶

type Event ¶

type Event interface {
	// Publish publishes a message to the event topic
	Publish(ctx context.Context, msg interface{}, opts ...client.PublishOption) error
}

Event is used to publish messages to topic

type Option ¶

type Option func(*Options)

func Action ¶

func Action(a func(*cli.Context) error) Option

Action can be used to parse user provided cli options

func AfterStart ¶

func AfterStart(fn func() error) Option

AfterStart run funcs after service starts

func BeforeStart ¶

func BeforeStart(fn func() error) Option

BeforeStart run functions before service starts

func BeforeStop ¶

func BeforeStop(fn func() error) Option

BeforeStop run funcs before service stops

func Cmd ¶

func Cmd(c cmd.Cmd) Option

func Context ¶

func Context(ctx context.Context) Option

Context specifies a context for the service. Can be used to signal shutdown of the service and for extra option values.

func Dialect ¶ added in v0.10.7

func Dialect(d dao.Dialect) Option

Dialect sets the dialect to use

func HandleSignal ¶

func HandleSignal(b bool) Option

HandleSignal toggle automatic installation of the signal handler that traps TERM, INT, and QUIT. Users of this future to disable the signal handler, should control liveness of the service through the context

func Id ¶ added in v0.15.0

func Id(id string) Option

Id of the service

func Metadata ¶

func Metadata(md map[string]string) Option

Metadata associated with the service

func Name ¶

func Name(n string) Option

Name of the service

func Profile ¶

func Profile(p profile.Profile) Option

Profile to be used for debug profile

func RegisterInterval ¶

func RegisterInterval(t time.Duration) Option

RegisterInterval specifies the interval on which to re-register

func RegisterTTL ¶

func RegisterTTL(t time.Duration) Option

RegisterTTL specifies the TTL to use when registering the service

func Registry ¶

func Registry(r registry.Registry) Option

Registry sets the registry for the service and the underlying components

func Runtime ¶

func Runtime(r runtime.Runtime) Option

Runtime sets the runtime

func Selector ¶

func Selector(s selector.Selector) Option

Selector sets the selector for the service client

func Server ¶

func Server(s server.Server) Option

Server to be used for service

func Store ¶

func Store(s store.Store) Option

Store sets the store to use

func Tracer ¶

func Tracer(t trace.Tracer) Option

Tracer sets the tracer for the service

func Version ¶

func Version(v string) Option

Version of the service

func WrapCall ¶

func WrapCall(w ...client.CallWrapper) Option

WrapCall is a convenience method for wrapping a Client CallFunc

func WrapClient ¶

func WrapClient(w ...client.Wrapper) Option

WrapClient is a convenience method for wrapping a Client with some middleware component. A list of wrappers can be provided. Wrappers are applied in reverse order so the last is executed first.

func WrapHandler ¶

func WrapHandler(w ...server.HandlerWrapper) Option

WrapHandler adds a handler Wrapper to a list of options passed into the server

func WrapSubscriber ¶

func WrapSubscriber(w ...server.SubscriberWrapper) Option

WrapSubscriber adds subscriber Wrapper to a list of options passed into the server

type Options ¶

type Options struct {
	Broker    broker.Broker
	Cmd       cmd.Cmd
	Client    client.Client
	Config    config.Config
	Server    server.Server
	Trace     trace.Tracer
	Dialect   dao.Dialect
	Store     store.Store
	Registry  registry.Registry
	Runtime   runtime.Runtime
	Profile   profile.Profile
	Scheduler gscheduler.Scheduler

	// Before and After funcs
	BeforeStart []func() error
	BeforeStop  []func() error
	AfterStart  []func() error
	AfterStop   []func() error

	// Other options for implementations of the interface
	// can be stored in a context
	Context context.Context

	Signal bool
}

Options for vine service

type Service ¶

type Service interface {
	// Name The service name
	Name() string
	// Init initialises options
	Init(...Option)
	// Options returns the current options
	Options() Options
	// Client is used to call services
	Client() client.Client
	// Server is for handling requests and events
	Server() server.Server
	// Run the service
	Run() error
	// String The service implementation
	String() string
}

Service is an interface that wraps the lower level libraries within vine. Its a convenience method for building and initialising services.

func FromContext ¶

func FromContext(ctx context.Context) (Service, bool)

FromContext retrieves a Service from the Context.

func NewService ¶

func NewService(opts ...Option) Service

NewService creates and returns a new Service based on the packages within.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
generator The code generator for the plugin for the Google protocol buffer compiler.	The code generator for the plugin for the Google protocol buffer compiler.
generator/internal/remap Package remap handles tracking the locations of Go tokens in a source text across a rewrite by the Go formatter.	Package remap handles tracking the locations of Go tokens in a source text across a rewrite by the Go formatter.
generator/vanity
generator/vanity/command
protoc-gen-cli command protoc-gen-cli is a plugin for the Google protocol buffer compiler to generate Go code.	protoc-gen-cli is a plugin for the Google protocol buffer compiler to generate Go code.
protoc-gen-cli/plugin
protoc-gen-dao command protoc-gen-dao is a plugin for the Google protocol buffer compiler to generate Go code.	protoc-gen-dao is a plugin for the Google protocol buffer compiler to generate Go code.
protoc-gen-dao/plugin
protoc-gen-deepcopy command protoc-gen-deepcopy is a plugin for the Google protocol buffer compiler to generate Go code.	protoc-gen-deepcopy is a plugin for the Google protocol buffer compiler to generate Go code.
protoc-gen-deepcopy/plugin
protoc-gen-go command Package main define the proto-gen-go binary we use to generate out proto go file,	Package main define the proto-gen-go binary we use to generate out proto go file,
protoc-gen-gogo command Package main define the proto-gen-gogo binary we use to generate out proto go file,	Package main define the proto-gen-gogo binary we use to generate out proto go file,
protoc-gen-gogo/plugin The marshalto plugin generates a Marshal and MarshalTo method for each message.	The marshalto plugin generates a Marshal and MarshalTo method for each message.
protoc-gen-validator command protoc-gen-validator is a plugin for the Google protocol buffer compiler to generate Go code.	protoc-gen-validator is a plugin for the Google protocol buffer compiler to generate Go code.
protoc-gen-validator/plugin
protoc-gen-vine command protoc-gen-vine is a plugin for the Google protocol buffer compiler to generate Go code.	protoc-gen-vine is a plugin for the Google protocol buffer compiler to generate Go code.
protoc-gen-vine/plugin
vine command
vine/app
vine/app/api Package api is an API Gateway	Package api is an API Gateway
vine/app/api/handler
vine/app/cli Package cli is a command line interface	Package cli is a command line interface
vine/app/cli/build
vine/app/cli/mg Package mg new generates vine service templates	Package mg new generates vine service templates
vine/app/cli/mg/template
vine/app/cli/run
vine/app/cli/util Package cliutil contains methods used across all cli commands @todo: get rid of os.Exits and use errors instread	Package cliutil contains methods used across all cli commands @todo: get rid of os.Exits and use errors instread
vine/app/cli/util/tool
vine/client/bot Package bot is a Hubot style bot that sits a vineservice environment	Package bot is a Hubot style bot that sits a vineservice environment
vine/client/proxy Package proxy is a cli proxy	Package proxy is a cli proxy
vine/client/resolver/api Package api provides a vine rpc resolver which prefixes a namespace	Package api provides a vine rpc resolver which prefixes a namespace
vine/client/resolver/web
vine/client/web Package web is a web dashboard	Package web is a web dashboard
vine/service Package service provides a vine service	Package service provides a vine service
vine/service/broker Package broker is the vine broker	Package broker is the vine broker
vine/service/broker/handler
vine/service/config
vine/service/config/handler
vine/service/debug Package debug implements metrics/logging/introspection/...	Package debug implements metrics/logging/introspection/...
vine/service/debug/log
vine/service/debug/stats Package stats is the handler for the `vine debug stats` service	Package stats is the handler for the `vine debug stats` service
vine/service/debug/trace Package trace the handler for the `vine debug trace` service	Package trace the handler for the `vine debug trace` service
vine/service/handler/exec
vine/service/handler/file
vine/service/health Package health is a healthchecking sidecar	Package health is a healthchecking sidecar
vine/service/network package network implements vine network node	package network implements vine network node
vine/service/network/api Package api is the network api	Package api is the network api
vine/service/network/dns Package dns provides a DNS registration service for autodiscovery of core network nodes.	Package dns provides a DNS registration service for autodiscovery of core network nodes.
vine/service/network/dns/handler Package handler is the handler for the `vine network dns` command	Package handler is the handler for the `vine network dns` command
vine/service/network/dns/provider Package provider lets you abstract away any number of DNS providers	Package provider lets you abstract away any number of DNS providers
vine/service/network/dns/provider/cloudflare Package cloudflare is a dns Provider for cloudflare	Package cloudflare is a dns Provider for cloudflare
vine/service/network/handler Package handler implements network RPC handler	Package handler implements network RPC handler
vine/service/registry Package registry is the vine registry	Package registry is the vine registry
vine/service/registry/handler
vine/service/router
vine/service/router/handler
vine/service/runtime Package runtime is the vine runtime Package runtime is the vine runtime	Package runtime is the vine runtime Package runtime is the vine runtime
vine/service/runtime/handler
vine/service/runtime/manager
vine/service/runtime/profile Package profile is for specific profiles @todo this package is the definition of cruft and should be rewritten in a more elegant way	Package profile is for specific profiles @todo this package is the definition of cruft and should be rewritten in a more elegant way
vine/service/runtime/scheduler Package scheduler is a file server notifer	Package scheduler is a file server notifer
vine/service/server
vine/service/store
vine/service/store/handler
vine/service/tunnel
vine/version
core
broker Package broker is an interface used for asynchronous messaging	Package broker is an interface used for asynchronous messaging
broker/grpc
broker/http Package http provides a http based message broker	Package http provides a http based message broker
broker/memory
client
client/grpc
client/selector Package selector is a way to pick a list of service nodes	Package selector is a way to pick a list of service nodes
client/selector/dns Package dns provides a dns SRV selector	Package dns provides a dns SRV selector
client/selector/router Package router is a network/router selector	Package router is a network/router selector
client/selector/static Package static provides a static resolver which returns the name/ip passed in without any change	Package static provides a static resolver which returns the name/ip passed in without any change
codec
codec/bytes Package bytes provides a bytes codec which does not encode or decode anything	Package bytes provides a bytes codec which does not encode or decode anything
codec/grpc Package grpc provides a grpc codec	Package grpc provides a grpc codec
codec/json
codec/jsonrpc
codec/proto
codec/protorpc
codec/text
registry
registry/cache
registry/etcd
registry/grpc Package grpc service uses the registry service	Package grpc service uses the registry service
registry/mdns Package mdns provides a multicast dns registry	Package mdns provides a multicast dns registry
registry/memory Package memory provides an in-memory registry	Package memory provides an in-memory registry
router
router/grpc
router/handler
router/registry
server
server/grpc
lib
agent
agent/command Package command is an interface for defining bot commands	Package command is an interface for defining bot commands
agent/input Package input is an interface for bot inputs	Package input is an interface for bot inputs
agent/input/discord
agent/input/slack
agent/input/telegram
api
api/handler Package handler provides http handlers	Package handler provides http handlers
api/handler/api Package api provides an http-rpc handler which provides the entire http request over rpc	Package api provides an http-rpc handler which provides the entire http request over rpc
api/handler/event Package event provides a handler which publishes an event	Package event provides a handler which publishes an event
api/handler/http Package http is a http reverse proxy handler	Package http is a http reverse proxy handler
api/handler/openapi
api/handler/openapi/statik
api/handler/rpc Package rpc is a vine rpc handler.	Package rpc is a vine rpc handler.
api/handler/web Package web contains the web handler including websocket support	Package web contains the web handler including websocket support
api/resolver Package resolver resolves a http request to an endpoint	Package resolver resolves a http request to an endpoint
api/resolver/grpc Package grpc resolves a grpc service like /greeter.Say/Hello to greeter service	Package grpc resolves a grpc service like /greeter.Say/Hello to greeter service
api/resolver/host Package host resolves using http host	Package host resolves using http host
api/resolver/path Package path resolves using http path	Package path resolves using http path
api/resolver/vpath Package vpath resolves using http path and recognised versioned urls	Package vpath resolves using http path and recognised versioned urls
api/router Package router provides api service routing	Package router provides api service routing
api/router/registry Package registry provides a dynamic api service router	Package registry provides a dynamic api service router
api/router/static
api/router/util
api/server Package server provides an API gateway server which handles inbound requests	Package server provides an API gateway server which handles inbound requests
api/server/cors
api/server/http Package http provides a http server with features; acme, cors, etc	Package http provides a http server with features; acme, cors, etc
cmd
config
config/encoder
config/encoder/hcl
config/encoder/json
config/encoder/toml
config/encoder/xml
config/encoder/yaml
config/loader Package loader manages loading from multiple sources	Package loader manages loading from multiple sources
config/loader/memory
config/memory
config/reader
config/reader/json
config/secrets Package secrets is an interface for encrypting and decrypting secrets	Package secrets is an interface for encrypting and decrypting secrets
config/secrets/box Package box is an asymmetric implementation of config/secrets using nacl/box	Package box is an asymmetric implementation of config/secrets using nacl/box
config/secrets/secretbox Package secretbox is a config/secrets implementation that uses nacl/secretbox to do symmetric encryption / verification	Package secretbox is a config/secrets implementation that uses nacl/secretbox to do symmetric encryption / verification
config/source
config/source/cli
config/source/env
config/source/file Package file is a file source.	Package file is a file source.
config/source/flag
config/source/memory Package memory is a memory source	Package memory is a memory source
config/source/service
dao
dao/callbacks
dao/clause
dao/logger
dao/migrator
dao/nop
dao/schema
dao/utils
dao/utils/tests
debug Package service provides the service log	Package service provides the service log
debug/handler Package handler implements service debug handler embedded in vine services	Package handler implements service debug handler embedded in vine services
debug/log Package log provides debug logging	Package log provides debug logging
debug/log/memory Package memory provides an in memory log buffer	Package memory provides an in memory log buffer
debug/log/noop
debug/profile Package profile is for profilers	Package profile is for profilers
debug/profile/http Package http enables the http profiler	Package http enables the http profiler
debug/profile/pprof Package pprof provides a pprof profiler	Package pprof provides a pprof profiler
debug/stats Package stats provides runtime stats	Package stats provides runtime stats
debug/trace Package trace provides an interface for distributed tracing	Package trace provides an interface for distributed tracing
debug/trace/memory
logger Package log provides a log interface	Package log provides a log interface
proxy Package proxy is a transport proxy built on the vine/server Package proxy is a transport proxy built on the vine/server	Package proxy is a transport proxy built on the vine/server Package proxy is a transport proxy built on the vine/server
proxy/grpc Package grpc transparently forwards the grpc protocol using a vine client.	Package grpc transparently forwards the grpc protocol using a vine client.
proxy/http Package http provides a vine rpc to http proxy Package http provides a vine rpc to http proxy	Package http provides a vine rpc to http proxy Package http provides a vine rpc to http proxy
proxy/mucp Package mucp transparently forwards the incoming request using a vine client.	Package mucp transparently forwards the incoming request using a vine client.
runtime Package runtime is a service runtime manager	Package runtime is a service runtime manager
runtime/grpc
runtime/local Package local provides a local runtime	Package local provides a local runtime
runtime/local/build Package build builds a vine runtime package	Package build builds a vine runtime package
runtime/local/build/docker Package docker builds docker images	Package docker builds docker images
runtime/local/build/go Package golang is a go package manager	Package golang is a go package manager
runtime/local/git
runtime/local/process Package process executes a binary	Package process executes a binary
runtime/local/process/os Package os runs processes locally Package os runs processes locally	Package os runs processes locally Package os runs processes locally
runtime/local/source Package source retrieves source code	Package source retrieves source code
runtime/local/source/git Package git provides a git source	Package git provides a git source
runtime/local/source/go Package golang is a source for Go	Package golang is a source for Go
store Package store is an interface for distributed data storage.	Package store is an interface for distributed data storage.
store/cache Package cache implements a faulting style read cache on top of multiple vine stores	Package cache implements a faulting style read cache on top of multiple vine stores
store/cli Package cli implements the `vine store` subcommands for example: vine store snapshot vine store restore vine store sync	Package cli implements the `vine store` subcommands for example: vine store snapshot vine store restore vine store sync
store/cli/snapshot
store/grpc Package grpc implements the store service interface	Package grpc implements the store service interface
store/memory Package memory is a in-memory store store	Package memory is a in-memory store store
store/noop
sync Package sync is an interface for distributed synchronization	Package sync is an interface for distributed synchronization
sync/memory Package memory provides a sync.Mutex implementation of the lock for local use	Package memory provides a sync.Mutex implementation of the lock for local use
web Package web provides web based vine services	Package web provides web based vine services
proto
apis/api
apis/errors
apis/openapi
apis/registry
apis/usage
services/bot
services/broker
services/config
services/debug
services/debug/log
services/debug/stats
services/debug/trace
services/file
services/registry
services/router
services/runtime
services/store
util
addr
backoff
client
client/buf
client/pool
command/bot
command/cli
config
context
context/metadata Package metadata is a way of defining message headers	Package metadata is a way of defining message headers
file
helper
http
is
jsonpb Package jsonpb provides marshaling and unmarshaling between protocol buffers and JSON.	Package jsonpb provides marshaling and unmarshaling between protocol buffers and JSON.
mdns
muxer Package mux provides proxy muxing	Package mux provides proxy muxing
name
namespace
net
proto Package proto contains utility functions for working with protobufs	Package proto contains utility functions for working with protobufs
qson Package qson implmenets decoding of URL query params into JSON and Go values (using JSON struct tags).	Package qson implmenets decoding of URL query params into JSON and Go values (using JSON struct tags).
ring Package ring provides a simple ring buffer for storing local data	Package ring provides a simple ring buffer for storing local data
runtime
signal
socket Package socket provides a pseudo socket	Package socket provides a pseudo socket
stats
tls
update
usage Package usage tracks vine usage	Package usage tracks vine usage
version Package version	Package version
wrapper

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