go/go-micro
1
0
Fork 0
mirror of https://github.com/go-micro/go-micro.git synced 2025-08-04 21:42:57 +02:00
Code Issues Releases Activity

move service to service dir to make life not suck (#2753)

Browse Source
This commit is contained in:
Asim Aslam
2025-05-04 19:44:56 +01:00
committed by GitHub
parent 1040b7c58e
commit 03782bc9b3
4 changed files with 399 additions and 354 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
micro.go
View File

@@ -6,6 +6,7 @@ import (
"go-micro.dev/v5/client" "go-micro.dev/v5/client"
"go-micro.dev/v5/server" "go-micro.dev/v5/server"
"go-micro.dev/v5/service"
) )
type serviceKey struct{} type serviceKey struct{}
@@ -32,6 +33,10 @@ type Service interface {
String() string String() string
} }
type Option = service.Option
type Options = service.Options
// Event is used to publish messages to a topic. // Event is used to publish messages to a topic.
type Event interface { type Event interface {
// Publish publishes a message to the event topic // Publish publishes a message to the event topic
@@ -41,18 +46,16 @@ type Event interface {
// Type alias to satisfy the deprecation. // Type alias to satisfy the deprecation.
type Publisher = Event type Publisher = Event
type Option func(*Options)
// New represents the new service // New represents the new service
func New(name string) Service { func New(name string) Service {
return newService( return NewService(
Name(name), service.Name(name),
) )
} }
// NewService creates and returns a new Service based on the packages within. // NewService creates and returns a new Service based on the packages within.
func NewService(opts ...Option) Service { func NewService(opts ...Option) Service {
return newService(opts...) return service.New(opts...)
} }
// FromContext retrieves a Service from the Context. // FromContext retrieves a Service from the Context.

382
options.go
View File

@@ -1,352 +1,40 @@
package micro package micro
import ( import (
"context" "go-micro.dev/v5/service"
"time"
"github.com/urfave/cli/v2"
"go-micro.dev/v5/auth"
"go-micro.dev/v5/broker"
"go-micro.dev/v5/cache"
"go-micro.dev/v5/client"
"go-micro.dev/v5/cmd"
"go-micro.dev/v5/config"
"go-micro.dev/v5/debug/profile"
"go-micro.dev/v5/debug/trace"
"go-micro.dev/v5/logger"
"go-micro.dev/v5/registry"
"go-micro.dev/v5/selector"
"go-micro.dev/v5/server"
"go-micro.dev/v5/store"
"go-micro.dev/v5/transport"
) )
// Options for micro service. var Broker = service.Broker
type Options struct { var Cache = service.Cache
Registry registry.Registry var Cmd = service.Cmd
Store store.Store var Client = service.Client
Auth auth.Auth var Context = service.Context
Cmd cmd.Cmd var Handle = service.Handle
Config config.Config var HandleSignal = service.HandleSignal
Client client.Client var Profile = service.Profile
Server server.Server var Server = service.Server
var Store = service.Store
// Other options for implementations of the interface var Registry = service.Registry
// can be stored in a context var Tracer = service.Tracer
Context context.Context var Auth = service.Auth
var Config = service.Config
Cache cache.Cache var Selector = service.Selector
Profile profile.Profile var Transport = service.Transport
Transport transport.Transport var Address = service.Address
Logger logger.Logger var Name = service.Name
Broker broker.Broker var Version = service.Version
// Before and After funcs var Metadata = service.Metadata
BeforeStart []func() error var Flags = service.Flags
AfterStart []func() error var Action = service.Action
AfterStop []func() error var RegisterTTL = service.RegisterTTL
var RegisterInterval = service.RegisterInterval
BeforeStop []func() error var WrapClient = service.WrapClient
var WrapCall = service.WrapCall
Signal bool var WrapHandler = service.WrapHandler
} var WrapSubscriber = service.WrapSubscriber
var AddListenOption = service.AddListenOption
func newOptions(opts ...Option) Options { var BeforeStart = service.BeforeStart
opt := Options{ var BeforeStop = service.BeforeStop
Auth: auth.DefaultAuth, var AfterStart = service.AfterStart
Broker: broker.DefaultBroker, var AfterStop = service.AfterStop
Cache: cache.DefaultCache, var Logger = service.Logger
Cmd: cmd.DefaultCmd,
Config: config.DefaultConfig,
Client: client.DefaultClient,
Server: server.DefaultServer,
Store: store.DefaultStore,
Registry: registry.DefaultRegistry,
Transport: transport.DefaultTransport,
Context: context.Background(),
Signal: true,
Logger: logger.DefaultLogger,
}
for _, o := range opts {
o(&opt)
}
return opt
}
// Broker to be used for service.
func Broker(b broker.Broker) Option {
return func(o *Options) {
o.Broker = b
// Update Client and Server
o.Client.Init(client.Broker(b))
o.Server.Init(server.Broker(b))
}
}
func Cache(c cache.Cache) Option {
return func(o *Options) {
o.Cache = c
}
}
func Cmd(c cmd.Cmd) Option {
return func(o *Options) {
o.Cmd = c
}
}
// Client to be used for service.
func Client(c client.Client) Option {
return func(o *Options) {
o.Client = c
}
}
// Context specifies a context for the service.
// Can be used to signal shutdown of the service and for extra option values.
func Context(ctx context.Context) Option {
return func(o *Options) {
o.Context = ctx
}
}
// Handle will register a handler without any fuss
func Handle(v interface{}) Option {
return func(o *Options) {
o.Server.Handle(
o.Server.NewHandler(v),
)
}
}
// 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 HandleSignal(b bool) Option {
return func(o *Options) {
o.Signal = b
}
}
// Profile to be used for debug profile.
func Profile(p profile.Profile) Option {
return func(o *Options) {
o.Profile = p
}
}
// Server to be used for service.
func Server(s server.Server) Option {
return func(o *Options) {
o.Server = s
}
}
// Store sets the store to use.
func Store(s store.Store) Option {
return func(o *Options) {
o.Store = s
}
}
// Registry sets the registry for the service
// and the underlying components.
func Registry(r registry.Registry) Option {
return func(o *Options) {
o.Registry = r
// Update Client and Server
o.Client.Init(client.Registry(r))
o.Server.Init(server.Registry(r))
// Update Broker
o.Broker.Init(broker.Registry(r))
}
}
// Tracer sets the tracer for the service.
func Tracer(t trace.Tracer) Option {
return func(o *Options) {
o.Server.Init(server.Tracer(t))
}
}
// Auth sets the auth for the service.
func Auth(a auth.Auth) Option {
return func(o *Options) {
o.Auth = a
}
}
// Config sets the config for the service.
func Config(c config.Config) Option {
return func(o *Options) {
o.Config = c
}
}
// Selector sets the selector for the service client.
func Selector(s selector.Selector) Option {
return func(o *Options) {
o.Client.Init(client.Selector(s))
}
}
// Transport sets the transport for the service
// and the underlying components.
func Transport(t transport.Transport) Option {
return func(o *Options) {
o.Transport = t
// Update Client and Server
o.Client.Init(client.Transport(t))
o.Server.Init(server.Transport(t))
}
}
// Convenience options
// Address sets the address of the server.
func Address(addr string) Option {
return func(o *Options) {
o.Server.Init(server.Address(addr))
}
}
// Name of the service.
func Name(n string) Option {
return func(o *Options) {
o.Server.Init(server.Name(n))
}
}
// Version of the service.
func Version(v string) Option {
return func(o *Options) {
o.Server.Init(server.Version(v))
}
}
// Metadata associated with the service.
func Metadata(md map[string]string) Option {
return func(o *Options) {
o.Server.Init(server.Metadata(md))
}
}
// Flags that can be passed to service.
func Flags(flags ...cli.Flag) Option {
return func(o *Options) {
o.Cmd.App().Flags = append(o.Cmd.App().Flags, flags...)
}
}
// Action can be used to parse user provided cli options.
func Action(a func(*cli.Context) error) Option {
return func(o *Options) {
o.Cmd.App().Action = a
}
}
// RegisterTTL specifies the TTL to use when registering the service.
func RegisterTTL(t time.Duration) Option {
return func(o *Options) {
o.Server.Init(server.RegisterTTL(t))
}
}
// RegisterInterval specifies the interval on which to re-register.
func RegisterInterval(t time.Duration) Option {
return func(o *Options) {
o.Server.Init(server.RegisterInterval(t))
}
}
// 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 WrapClient(w ...client.Wrapper) Option {
return func(o *Options) {
// apply in reverse
for i := len(w); i > 0; i-- {
o.Client = w[i-1](o.Client)
}
}
}
// WrapCall is a convenience method for wrapping a Client CallFunc.
func WrapCall(w ...client.CallWrapper) Option {
return func(o *Options) {
o.Client.Init(client.WrapCall(w...))
}
}
// WrapHandler adds a handler Wrapper to a list of options passed into the server.
func WrapHandler(w ...server.HandlerWrapper) Option {
return func(o *Options) {
var wrappers []server.Option
for _, wrap := range w {
wrappers = append(wrappers, server.WrapHandler(wrap))
}
// Init once
o.Server.Init(wrappers...)
}
}
// WrapSubscriber adds a subscriber Wrapper to a list of options passed into the server.
func WrapSubscriber(w ...server.SubscriberWrapper) Option {
return func(o *Options) {
var wrappers []server.Option
for _, wrap := range w {
wrappers = append(wrappers, server.WrapSubscriber(wrap))
}
// Init once
o.Server.Init(wrappers...)
}
}
// Add opt to server option.
func AddListenOption(option server.Option) Option {
return func(o *Options) {
o.Server.Init(option)
}
}
// Before and Afters
// BeforeStart run funcs before service starts.
func BeforeStart(fn func() error) Option {
return func(o *Options) {
o.BeforeStart = append(o.BeforeStart, fn)
}
}
// BeforeStop run funcs before service stops.
func BeforeStop(fn func() error) Option {
return func(o *Options) {
o.BeforeStop = append(o.BeforeStop, fn)
}
}
// AfterStart run funcs after service starts.
func AfterStart(fn func() error) Option {
return func(o *Options) {
o.AfterStart = append(o.AfterStart, fn)
}
}
// AfterStop run funcs after service stops.
func AfterStop(fn func() error) Option {
return func(o *Options) {
o.AfterStop = append(o.AfterStop, fn)
}
}
// Logger sets the logger for the service.
func Logger(l logger.Logger) Option {
return func(o *Options) {
o.Logger = l
}
}

354
service/options.go Normal file
View File

@@ -0,0 +1,354 @@
package service
import (
"context"
"time"
"github.com/urfave/cli/v2"
"go-micro.dev/v5/auth"
"go-micro.dev/v5/broker"
"go-micro.dev/v5/cache"
"go-micro.dev/v5/client"
"go-micro.dev/v5/cmd"
"go-micro.dev/v5/config"
"go-micro.dev/v5/debug/profile"
"go-micro.dev/v5/debug/trace"
"go-micro.dev/v5/logger"
"go-micro.dev/v5/registry"
"go-micro.dev/v5/selector"
"go-micro.dev/v5/server"
"go-micro.dev/v5/store"
"go-micro.dev/v5/transport"
)
// Options for micro service.
type Options struct {
Registry registry.Registry
Store store.Store
Auth auth.Auth
Cmd cmd.Cmd
Config config.Config
Client client.Client
Server server.Server
// Other options for implementations of the interface
// can be stored in a context
Context context.Context
Cache cache.Cache
Profile profile.Profile
Transport transport.Transport
Logger logger.Logger
Broker broker.Broker
// Before and After funcs
BeforeStart []func() error
AfterStart []func() error
AfterStop []func() error
BeforeStop []func() error
Signal bool
}
type Option func(*Options)
func newOptions(opts ...Option) Options {
opt := Options{
Auth: auth.DefaultAuth,
Broker: broker.DefaultBroker,
Cache: cache.DefaultCache,
Cmd: cmd.DefaultCmd,
Config: config.DefaultConfig,
Client: client.DefaultClient,
Server: server.DefaultServer,
Store: store.DefaultStore,
Registry: registry.DefaultRegistry,
Transport: transport.DefaultTransport,
Context: context.Background(),
Signal: true,
Logger: logger.DefaultLogger,
}
for _, o := range opts {
o(&opt)
}
return opt
}
// Broker to be used for service.
func Broker(b broker.Broker) Option {
return func(o *Options) {
o.Broker = b
// Update Client and Server
o.Client.Init(client.Broker(b))
o.Server.Init(server.Broker(b))
}
}
func Cache(c cache.Cache) Option {
return func(o *Options) {
o.Cache = c
}
}
func Cmd(c cmd.Cmd) Option {
return func(o *Options) {
o.Cmd = c
}
}
// Client to be used for service.
func Client(c client.Client) Option {
return func(o *Options) {
o.Client = c
}
}
// Context specifies a context for the service.
// Can be used to signal shutdown of the service and for extra option values.
func Context(ctx context.Context) Option {
return func(o *Options) {
o.Context = ctx
}
}
// Handle will register a handler without any fuss
func Handle(v interface{}) Option {
return func(o *Options) {
o.Server.Handle(
o.Server.NewHandler(v),
)
}
}
// 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 HandleSignal(b bool) Option {
return func(o *Options) {
o.Signal = b
}
}
// Profile to be used for debug profile.
func Profile(p profile.Profile) Option {
return func(o *Options) {
o.Profile = p
}
}
// Server to be used for service.
func Server(s server.Server) Option {
return func(o *Options) {
o.Server = s
}
}
// Store sets the store to use.
func Store(s store.Store) Option {
return func(o *Options) {
o.Store = s
}
}
// Registry sets the registry for the service
// and the underlying components.
func Registry(r registry.Registry) Option {
return func(o *Options) {
o.Registry = r
// Update Client and Server
o.Client.Init(client.Registry(r))
o.Server.Init(server.Registry(r))
// Update Broker
o.Broker.Init(broker.Registry(r))
}
}
// Tracer sets the tracer for the service.
func Tracer(t trace.Tracer) Option {
return func(o *Options) {
o.Server.Init(server.Tracer(t))
}
}
// Auth sets the auth for the service.
func Auth(a auth.Auth) Option {
return func(o *Options) {
o.Auth = a
}
}
// Config sets the config for the service.
func Config(c config.Config) Option {
return func(o *Options) {
o.Config = c
}
}
// Selector sets the selector for the service client.
func Selector(s selector.Selector) Option {
return func(o *Options) {
o.Client.Init(client.Selector(s))
}
}
// Transport sets the transport for the service
// and the underlying components.
func Transport(t transport.Transport) Option {
return func(o *Options) {
o.Transport = t
// Update Client and Server
o.Client.Init(client.Transport(t))
o.Server.Init(server.Transport(t))
}
}
// Convenience options
// Address sets the address of the server.
func Address(addr string) Option {
return func(o *Options) {
o.Server.Init(server.Address(addr))
}
}
// Name of the service.
func Name(n string) Option {
return func(o *Options) {
o.Server.Init(server.Name(n))
}
}
// Version of the service.
func Version(v string) Option {
return func(o *Options) {
o.Server.Init(server.Version(v))
}
}
// Metadata associated with the service.
func Metadata(md map[string]string) Option {
return func(o *Options) {
o.Server.Init(server.Metadata(md))
}
}
// Flags that can be passed to service.
func Flags(flags ...cli.Flag) Option {
return func(o *Options) {
o.Cmd.App().Flags = append(o.Cmd.App().Flags, flags...)
}
}
// Action can be used to parse user provided cli options.
func Action(a func(*cli.Context) error) Option {
return func(o *Options) {
o.Cmd.App().Action = a
}
}
// RegisterTTL specifies the TTL to use when registering the service.
func RegisterTTL(t time.Duration) Option {
return func(o *Options) {
o.Server.Init(server.RegisterTTL(t))
}
}
// RegisterInterval specifies the interval on which to re-register.
func RegisterInterval(t time.Duration) Option {
return func(o *Options) {
o.Server.Init(server.RegisterInterval(t))
}
}
// 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 WrapClient(w ...client.Wrapper) Option {
return func(o *Options) {
// apply in reverse
for i := len(w); i > 0; i-- {
o.Client = w[i-1](o.Client)
}
}
}
// WrapCall is a convenience method for wrapping a Client CallFunc.
func WrapCall(w ...client.CallWrapper) Option {
return func(o *Options) {
o.Client.Init(client.WrapCall(w...))
}
}
// WrapHandler adds a handler Wrapper to a list of options passed into the server.
func WrapHandler(w ...server.HandlerWrapper) Option {
return func(o *Options) {
var wrappers []server.Option
for _, wrap := range w {
wrappers = append(wrappers, server.WrapHandler(wrap))
}
// Init once
o.Server.Init(wrappers...)
}
}
// WrapSubscriber adds a subscriber Wrapper to a list of options passed into the server.
func WrapSubscriber(w ...server.SubscriberWrapper) Option {
return func(o *Options) {
var wrappers []server.Option
for _, wrap := range w {
wrappers = append(wrappers, server.WrapSubscriber(wrap))
}
// Init once
o.Server.Init(wrappers...)
}
}
// Add opt to server option.
func AddListenOption(option server.Option) Option {
return func(o *Options) {
o.Server.Init(option)
}
}
// Before and Afters
// BeforeStart run funcs before service starts.
func BeforeStart(fn func() error) Option {
return func(o *Options) {
o.BeforeStart = append(o.BeforeStart, fn)
}
}
// BeforeStop run funcs before service stops.
func BeforeStop(fn func() error) Option {
return func(o *Options) {
o.BeforeStop = append(o.BeforeStop, fn)
}
}
// AfterStart run funcs after service starts.
func AfterStart(fn func() error) Option {
return func(o *Options) {
o.AfterStart = append(o.AfterStart, fn)
}
}
// AfterStop run funcs after service stops.
func AfterStop(fn func() error) Option {
return func(o *Options) {
o.AfterStop = append(o.AfterStop, fn)
}
}
// Logger sets the logger for the service.
func Logger(l logger.Logger) Option {
return func(o *Options) {
o.Logger = l
}
}

4
service.go → service/service.go
View File

@@ -1,4 +1,4 @@
package micro package service
import ( import (
"os" "os"
@@ -20,7 +20,7 @@ type service struct {
once sync.Once once sync.Once
} }
func newService(opts ...Option) Service { func New(opts ...Option) *service {
return &service{ return &service{
opts: newOptions(opts...), opts: newOptions(opts...),
} }