vine

command module
v0.8.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 20, 2021 License: Apache-2.0 Imports: 1 Imported by: 15

README

License Go.Dev reference Travis CI Go Report Card

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 开源许可.

起步

安装

go get github.com/gogo/protobuf
go get github.com/gogo/googleapis
go get github.com/lack-io/vine/cmd/protoc-gen-gogofaster
go get github.com/lack-io/vine/cmd/protoc-gen-vine
go get github.com/lack-io/vine

proto 文件

syntax = "proto3";

package testdata;

import "github.com/gogo/googleapis/google/api/annotations.proto";

service Rpc {
  rpc HelloWorld(HelloWorldRequest) returns (HelloWorldResponse) {
    option (google.api.http) = { post: "/api/{name}"; body: "*"; };
  };
}

message HelloWorldRequest {
  string name = 1;
}

message HelloWorldResponse {
  string reply = 1;
}

生成 golang 代码

protoc -I=. \
  -I=$GOPATH/src \
  -I=$GOPATH/src/github.com/gogo/protobuf/protobuf \
  -I=$GOPATH/src/github.com/gogo/googleapis \
  --gogofaster_out=plugins=grpc:. --vine_out=. example/proto/test.proto

服务端

package main

import (
	"context"
	"fmt"

	vine "github.com/lack-io/vine/service"
	pb "example/proto"
)

type HelloWorld struct {
}

func (t *HelloWorld) HelloWorld(ctx context.Context, req *pb.HelloWorldRequest, rsp *pb.HelloWorldResponse) error {
	fmt.Println("get echo request")
	rsp.Reply = "hello " + req.Name
	return nil
}

func main() {
	service := vine.NewService(
		vine.Name("tt"),
		vine.Address("127.0.0.1:9000"),
	)

	service.Init()

	pb.RegisterRpcHandler(service.Server(), new(HelloWorld))

	service.Run()
}

客户端

package main

import (
	"context"
	"fmt"

	vine "github.com/lack-io/vine/service"
	pb "example/proto"
)

func main() {
	srv := vine.NewService(vine.Name("tt"))
	service := pb.NewRpcService("tt", srv.Client())

	rsp, err := service.HelloWorld(context.TODO(), &pb.HelloWorldRequest{Name: "world"})
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Printf("result: %v\n", rsp)
}

启动 api

vine api --handler=rpc

验证

curl -H 'Content-Type: application/json' -d '{}' http://localhost:8080/api/vine

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
client
api
Package api is an API Gateway
Package api is an API Gateway
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
cli
Package cli is a command line interface
Package cli is a command line interface
cli/new
Package new generates vine service templates
Package new generates vine service templates
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
proxy
Package proxy is a cli proxy
Package proxy is a cli proxy
resolver/api
Package vine provides a vine rpc resolver which prefixes a namespace
Package vine provides a vine rpc resolver which prefixes a namespace
web
Package web is a web dashboard
Package web is a web dashboard
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.
protoc-gen-gogo
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-validator
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-vine
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.
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/debug
Package debug implements metrics/logging/introspection/...
Package debug implements metrics/logging/introspection/...
vine/service/debug/stats
Package handler is the handler for the `vine debug stats` service
Package handler is the handler for the `vine debug stats` service
vine/service/debug/trace
Package handler is the handler for the `vineadm debug trace` service
Package handler is the handler for the `vineadm debug trace` service
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/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/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
proto
api
bot
Package vine is a pluggable framework for vine services
Package vine is a pluggable framework for vine services
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
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/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/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/acme
Package acme abstracts away various ACME libraries
Package acme abstracts away various ACME libraries
api/server/acme/autocert
Package autocert is the ACME provider from golang.org/x/crypto/acme/autocert This provider does not take any config.
Package autocert is the ACME provider from golang.org/x/crypto/acme/autocert This provider does not take any config.
api/server/acme/certmagic
Package certmagic is the ACME provider from github.com/caddyserver/certmagic
Package certmagic is the ACME provider from github.com/caddyserver/certmagic
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
auth
Package auth provides authentication and authorization capability
Package auth provides authentication and authorization capability
auth/provider
Package provider is an external auth provider e.g oauth
Package provider is an external auth provider e.g oauth
broker
Package broker is an interface used for asynchronous messaging Package http provides a http based message broker
Package broker is an interface used for asynchronous messaging Package http provides a http based message broker
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/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
config/loader
Package loader manages loading from multiple sources
Package loader manages loading from multiple sources
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/file
Package file is a file source.
Package file is a file source.
config/source/memory
Package memory is a memory source
Package memory is a memory source
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/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
logger
Package log provides a log interface
Package log provides a log interface
network
Package network is for creating internetworks
Package network is for creating internetworks
network/resolver
Package resolver resolves network names to addresses
Package resolver resolves network names to addresses
network/resolver/dns
Package dns resolves names to dns records
Package dns resolves names to dns records
network/resolver/dnssrv
Package dns srv resolves names to dns srv records
Package dns srv resolves names to dns srv records
network/resolver/http
Package http resolves names to network addresses using a http request
Package http resolves names to network addresses using a http request
network/resolver/registry
Package registry resolves names using the vine registry
Package registry resolves names using the vine registry
network/resolver/static
Package static is a static resolver
Package static is a static resolver
network/transport
Package transport is an interface for synchronous connection based communication
Package transport is an interface for synchronous connection based communication
network/transport/grpc
Package grpc provides a grpc transport
Package grpc provides a grpc transport
network/transport/memory
Package memory is an in-memory transport
Package memory is an in-memory transport
network/transport/quic
Package quic provides a QUIC based transport
Package quic provides a QUIC based transport
network/tunnel
Package tunnel provides gre network tunnelling
Package tunnel provides gre network tunnelling
network/tunnel/broker
Package broker is a tunnel broker
Package broker is a tunnel broker
network/tunnel/transport
Package transport provides a tunnel transport
Package transport provides a tunnel transport
plugin
Package plugin provides the ability to load plugins Package plugin provides the ability to load plugins
Package plugin provides the ability to load plugins Package plugin provides the ability to load plugins
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.
registry/grpc
Package service uses the registry service
Package 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
runtime
Package runtime is a service runtime manager
Package runtime is a service runtime manager
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/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
server/mucp
Package mucp provides an mucp server
Package mucp provides an mucp server
store
Package store is an interface for distributed data storage.
Package store is an interface for distributed data storage.
store/bolt
Package local is a bolt system backed store
Package local is a bolt system backed store
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/grpc
Package service implements the store service interface
Package service implements the store service interface
store/memory
Package memory is a in-memory store store
Package memory is a in-memory store store
store/postgres
Package postgres implements the postgres store
Package postgres implements the postgres store
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
util
context/metadata
Package metadata is a way of defining message headers
Package metadata is a way of defining message headers
is
jsonpb
Package jsonpb provides marshaling and unmarshaling between protocol buffers and JSON.
Package jsonpb provides marshaling and unmarshaling between protocol buffers and JSON.
muxer
Package mux provides proxy muxing
Package mux provides proxy muxing
net
platform
Package platform manages the runtime services as a platform
Package platform manages the runtime services as a platform
plugins
Package plugins includes the plugins we want to load
Package plugins includes the plugins we want to load
plugins/store/cloudflare
Package cloudflare is a store implementation backed by cloudflare workers kv Note that the cloudflare workers KV API is eventually consistent.
Package cloudflare is a store implementation backed by cloudflare workers kv Note that the cloudflare workers KV API is eventually consistent.
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
socket
Package socket provides a pseudo socket
Package socket provides a pseudo socket
tls
usage
Package usage tracks vine usage
Package usage tracks vine usage
version
Package version
Package version

Jump to

Keyboard shortcuts

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