stack

package module
v1.0.0 Latest Latest
Warning

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

 Go to latest Published: Dec 12, 2020 License: Apache-2.0 Imports: 29 Imported by: 22

README

Stack-RPC

Stack-RPC旨在为中国开发者提供通用的分布式服务微服务开发库（比如配置管理、服务发现、熔断降级、路由、服务代理、安全、主从选举等）。基于Stack，开发者可以快速投入自身的业务开发中，只需要极少的学习成本。Stack适用于中小规模的开发场景，她可以轻易在桌面电脑、服务器、容器集群中搭建分布式服务。

开发手册

开发文档

示例

插件库

交流

公众号 讨论群

讨论群：微信搜索MicroHQ，备注来源：“github”

简单易用

启动一个微服务只需要如下代码

func main() {
  service := stack.NewService(stack.Name("stack.rpc.greeter"))
  service.Init()
  service.Run()
}

我们封装了微服务内在的复杂度，比如服务注册与发现、配置管理等。用户只需要花极小的成本学习如何暴露接口，如何启动服务，剩下的精力完全投放在业务需求的开发上。

特性

Stack-RPC既提供轻量的开发库，同时也提供对应高级别的扩展库，为大家带来开箱即用的开发体验。

支持的特性主要有：

  • 分布式配置
  • 服务注册与发现
  • 服务路由
  • 远程服务调用
  • 负载均衡
  • 链路中断与降级
  • 分布式锁[todo]
  • 主从选举[todo]
  • 分布式广播

开始使用

我们为一直为大家准备持续开发、更新、愈加丰富的文档与资料：StackLabs

与Go-Micro的差异

  • 取消Micro工具集，以服务插件形式集成到Stack-RPC中
    • Web控制台插件
    • 网关插件
    • 注册中心插件
    • 配置中心插件
  • 多类型服务同时部署
    • 支持RPC与HTTP同时暴露
  • 增强日志特性
    • 支持动态修改日志级别
    • 支持日志自定义目录存储
    • 支持按级别存储不同文件
    • 支持按周期压缩日志文件
    • 支持按大小压缩日志文件
  • 增强配置特性
    • 增加默认配置命名空间
    • 定义默认配置文件存储目录
    • 支持Apollo配置中心
  • 删除不要的组件
    • Cloudflare

鸣谢

  • 感谢Go-Micro库，提供优秀的扩展性极强的原始框架，Stack-RPC作为衍生版本，受益颇多，同时Go-Micro的肄业也给Stack-RPC创造了生命
  • 感谢Spring-Cloud，作为使用最广泛的开源分布式开发库，我们参考了她许多优秀的设计与文档
  • 感谢各位Go-Micro的历史提交者，他们的代码永远运行在大家的内存中
  • 感谢各位支持StackLabs中国发展的贡献者们

Documentation

Overview

Package stack is a pluggable framework for microservices

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

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

Types

type Function 

type Function interface {
	// Inherits Service interface
	Service
	// Done signals to complete execution
	Done() error
	// Handle registers an RPC handler
	Handle(v interface{}) error
	// Subscribe registers a subscriber
	Subscribe(topic string, v interface{}) error
}

Function is a one time executing Service

func NewFunction 

func NewFunction(opts ...Option) Function

NewFunction returns a new Function for a one time executing Service

type Option 

type Option func(*Options)

func Action 

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

func Address 

func Address(addr string) Option

Address sets the address of the server

func AfterStart 

func AfterStart(fn func() error) Option

func AfterStop 

func AfterStop(fn func() error) Option

func BeforeStart 

func BeforeStart(fn func() error) Option

func BeforeStop 

func BeforeStop(fn func() error) Option

func Broker 

func Broker(b broker.Broker) Option

func Client 

func Client(c client.Client) Option

func Cmd 

func Cmd(c cmd.Cmd) Option

func Config 

func Config(c config.Config) 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. Can be used for extra option values.

func Flags 

func Flags(flags ...cli.Flag) Option

func HandleSignal 

func HandleSignal(b bool) Option

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

func Logger 

func Logger(l logger.Logger) Option

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 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 Selector 

func Selector(s selector.Selector) Option

Selector sets the selector for the service client

func Server 

func Server(s server.Server) Option

func Transport 

func Transport(t transport.Transport) Option

Transport sets the transport for the service and the underlying components

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 a 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
	Server    server.Server
	Registry  registry.Registry
	Transport transport.Transport
	Selector  selector.Selector
	Config    config.Config
	Logger    logger.Logger
	// 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
}

type Publisher 

type Publisher interface {
	Publish(ctx context.Context, msg interface{}, opts ...client.PublishOption) error
}

Publisher is syntactic sugar for publishing

func NewPublisher 

func NewPublisher(topic string, c client.Client) Publisher

NewPublisher returns a new Publisher

type Service 

type Service interface {
	// The service name
	Name() string
	// Init initialises options
	Init(...Option) error
	// 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
	// The service implementation
	String() string
}

Service is an interface that wraps the lower level libraries within stack-rpc. 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
api
handler
Package handler provides http handlers
 Package handler provides http handlers
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
handler/broker
Package broker provides a stack-rpc/broker handler
 Package broker provides a stack-rpc/broker handler
handler/cloudevents
Package cloudevents provides a cloudevents handler publishing the event using the stack-rpc/client
 Package cloudevents provides a cloudevents handler publishing the event using the stack-rpc/client
handler/event
Package event provides a handler which publishes an event
 Package event provides a handler which publishes an event
handler/file
Package file serves file relative to the current directory
 Package file serves file relative to the current directory
handler/http
Package http is a http reverse proxy handler
 Package http is a http reverse proxy handler
handler/registry
Package registry is a stack-rpc/registry handler
 Package registry is a stack-rpc/registry handler
handler/rpc
Package rpc is a stack-rpc rpc handler.
 Package rpc is a stack-rpc rpc handler.
handler/udp
Package udp reads and write from a udp connection
 Package udp reads and write from a udp connection
handler/unix
Package unix reads from a unix socket expecting it to be in /tmp/path
 Package unix reads from a unix socket expecting it to be in /tmp/path
handler/web
Package web contains the web handler including websocket support
 Package web contains the web handler including websocket support
internal/proto
proto
resolver
Package resolver resolves a http request to an endpoint
 Package resolver resolves a http request to an endpoint
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
resolver/host
Package host resolves using http host
 Package host resolves using http host
resolver/path
Package path resolves using http path
 Package path resolves using http path
resolver/stack
Package stack provides a stack rpc resolver which prefixes a namespace
 Package stack provides a stack rpc resolver which prefixes a namespace
resolver/vpath
Package vpath resolves using http path and recognised versioned urls
 Package vpath resolves using http path and recognised versioned urls
router
Package router provides api service routing
 Package router provides api service routing
router/registry
Package registry provides a dynamic api service router
 Package registry provides a dynamic api service router
server
Package server provides an API gateway server which handles inbound requests
 Package server provides an API gateway server which handles inbound requests
server/acme
Package acme abstracts away various ACME libraries
 Package acme abstracts away various ACME libraries
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.
server/acme/certmagic
Package certmagic is the ACME provider from github.com/mholt/certmagic
 Package certmagic is the ACME provider from github.com/mholt/certmagic
server/http
Package http provides a http server with features; acme, cors, etc
 Package http provides a http server with features; acme, cors, etc
Package broker is an interface used for asynchronous messaging
 Package broker is an interface used for asynchronous messaging
http
memory
Package memory provides a memory broker
 Package memory provides a memory broker
nats
Package nats provides a NATS broker
 Package nats provides a NATS broker
service
Package service provides the broker service client
 Package service provides the broker service client
service/handler
service/proto
Package client is an interface for an RPC client
 Package client is an interface for an RPC client
grpc
Package grpc provides a gRPC client Package grpc provides a gRPC options
 Package grpc provides a gRPC client Package grpc provides a gRPC options
mock
Package mock provides a mock client for testing
 Package mock provides a mock client for testing
mucp
pool
Package pool is a connection pool
 Package pool is a connection pool
proto
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
selector/dns
Package dns provides a dns SRV selector
 Package dns provides a dns SRV selector
selector/registry
selector/router
Package router is a network/router selector
 Package router is a network/router selector
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
Package cmd is an interface for parsing the command line
 Package cmd is an interface for parsing the command line
Package codec is an interface for encoding messages
 Package codec is an interface for encoding messages
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
grpc
Package grpc provides a grpc codec
 Package grpc provides a grpc codec
json
Package json provides a json codec
 Package json provides a json codec
jsonrpc
Package jsonrpc provides a json-rpc 1.0 codec
 Package jsonrpc provides a json-rpc 1.0 codec
proto
Package proto provides a proto codec
 Package proto provides a proto codec
protorpc
Package proto is a generated protocol buffer package.
 Package proto is a generated protocol buffer package.
text
Package text reads any text/* content-type
 Package text reads any text/* content-type
Package debug provides stack debug packages
 Package debug provides stack debug packages
buffer
Package buffer provides a simple ring buffer for storing local data
 Package buffer provides a simple ring buffer for storing local data
log
Package log provides debug logging
 Package log provides debug logging
profile
Package profile is for profilers
 Package profile is for profilers
profile/pprof
Package pprof provides a pprof profiler
 Package pprof provides a pprof profiler
service
service/handler
Pacjage handler implements service debug handler
 Pacjage handler implements service debug handler
service/proto
stats
Package stats provides runtime stats
 Package stats provides runtime stats
Package log provides a log interface
 Package log provides a log interface
Package monitor monitors service health
 Package monitor monitors service health
pkg
cli
Package cli provides a minimal framework for creating and organizing command line Go applications.
 Package cli provides a minimal framework for creating and organizing command line Go applications.
cli/altsrc
config
Package config is an interface for dynamic configuration.
 Package config is an interface for dynamic configuration.
config/encoder
Package encoder handles source encoding formats
 Package encoder handles source encoding formats
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/reader
Package reader parses change sets and provides config values
 Package reader parses change sets and provides config values
config/reader/json
config/source
Package source is the interface for sources
 Package source is the interface for sources
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/storage
config/storage/file
mdns
mdns/examples/client
mdns/examples/service
metadata
Package metadata is a way of defining message headers
 Package metadata is a way of defining message headers
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
Package proxy is a transparent proxy built on the stack-rpc/server
 Package proxy is a transparent proxy built on the stack-rpc/server
grpc
Package grpc transparently forwards the grpc protocol using a stack-rpc client.
 Package grpc transparently forwards the grpc protocol using a stack-rpc client.
http
Package http provides a stack rpc to http proxy
 Package http provides a stack rpc to http proxy
mucp
Package mucp transparently forwards the incoming request using a stack-rpc client.
 Package mucp transparently forwards the incoming request using a stack-rpc client.
Package registry is an interface for service discovery
 Package registry is an interface for service discovery
cache
Package cache provides a registry cache
 Package cache provides a registry cache
mdns
Package mdns is a multicast dns registry Package mdns provides a multicast dns registry
 Package mdns is a multicast dns registry Package mdns provides a multicast dns registry
memory
Package memory provides an in-memory registry
 Package memory provides an in-memory registry
service
Package service uses the registry service
 Package service uses the registry service
service/handler
service/proto
Package router provides a network routing control plane
 Package router provides a network routing control plane
handler
proto
service
Package server is an interface for a stack server
 Package server is an interface for a stack server
grpc
Package grpc provides a grpc server
 Package grpc provides a grpc server
grpc/proto
mock
mucp
proto
service
grpc
grpc/proto
Package store is an interface for distribute data storage.
 Package store is an interface for distribute data storage.
memory
Package memory is a in-memory store store
 Package memory is a in-memory store store
mock
postgresql
Package postgresql implements a stack Store backed by sql
 Package postgresql implements a stack Store backed by sql
service
Package service implements the store service interface
 Package service implements the store service interface
service/handler
service/proto
Package sync is a distributed synchronization framework
 Package sync is a distributed synchronization framework
event
Package event provides a distributed log interface
 Package event provides a distributed log interface
leader
Package leader provides leader election
 Package leader provides leader election
lock
Package lock provides distributed locking
 Package lock provides distributed locking
lock/http
Package http adds a http lock implementation
 Package http adds a http lock implementation
lock/http/server
Package server implements the sync http server
 Package server implements the sync http server
lock/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
task
Package task provides an interface for distributed jobs
 Package task provides an interface for distributed jobs
task/broker
Package broker provides a distributed task manager built on the stack broker
 Package broker provides a distributed task manager built on the stack broker
task/local
Package local provides a local task runner
 Package local provides a local task runner
time
Package time provides clock synchronization
 Package time provides clock synchronization
time/local
Package local provides a local clock
 Package local provides a local clock
time/ntp
Package ntp provides ntp synchronized time
 Package ntp provides ntp synchronized time
Package transport is an interface for synchronous connection based communication
 Package transport is an interface for synchronous connection based communication
grpc
Package grpc provides a grpc transport
 Package grpc provides a grpc transport
grpc/proto
http
memory
Package memory is an in-memory transport
 Package memory is an in-memory transport
quic
Package quic provides a QUIC based transport
 Package quic provides a QUIC based transport
util
addr
buf
codec
ctx
errors
Package errors provides a way to return detailed information for an RPC request error.
 Package errors provides a way to return detailed information for an RPC request error.
file
grpc
http
io
Package io is for io management
 Package io is for io management
log
Package log is a global internal logger
 Package log is a global internal logger
net
options
Package options provides a way to initialise options
 Package options provides a way to initialise options
protoc-gen-stack
protoc-gen-stack is a plugin for the Google protocol buffer compiler to generate Go code.
 protoc-gen-stack is a plugin for the Google protocol buffer compiler to generate Go code.
protoc-gen-stack/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-stack/plugin/stack
registry
socket
Package socket provides a pseudo socket
 Package socket provides a pseudo socket
stackctl
stackctl/new
Package new generates stack service templates
 Package new generates stack service templates
stackctl/new/template
test
tls
wrapper
Package web provides web based stack services
 Package web provides web based stack services

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.