go-micro架構

下圖來自go-micro官方
go-micro系統架構

閱讀本文前你可能需要進行如下知識儲備

Service

實現如下接口的,都是Service

type Service interface {
	Init(...Option)
	Options() Options
	Client() client.Client
	Server() server.Server
	Run() error
	String() string
}

我們根據常見的service初始化流程來理解這個接口


func main() {
	// New Service
	service := micro.NewService(
		micro.Name("go.micro.srv.broker"),
		micro.Version("latest"),
	)

	// Initialise service
	service.Init()

	// Register Struct as Subscriber
	micro.RegisterSubscriber("go.micro.srv.broker", service.Server(), new(subscriber.Broker))

	// Register Function as Subscriber
	micro.RegisterSubscriber("go.micro.srv.broker", service.Server(), subscriber.Handler)

	// Run service
	if err := service.Run(); err != nil {
		log.Fatal(err)
	}
}

micro.NewService

micro.NewService的函數調用關系如下

該函數主要是初始化一個service並設置service的常用屬性屬性,代碼如下:

opt := micro.Options{
	Broker: broker.DefaultBroker,
	Cmd: cmd.DefaultCmd,
	Client: client.DefaultClient,
	Server: server.DefaultServer,
	Registry: registry.DefaultRegistry
	}

micro.Options全部屬性包含如下幾個方面

type micro.Options struct {
	Broker    broker.Broker  //訂閱事件用的
	Cmd       cmd.Cmd       //命令行用的
	Client    client.Client  //作為服務消費者,用來發送請求
	Server    server.Server  //作為服務提供者用來監聽請求
	Registry  registry.Registry //這個是服務發現支持
	Transport transport.Transport //這是網絡傳遞用的

	// Before and After funcs     
	BeforeStart []func() error //服務start錢的回調函數
	BeforeStop  []func() error //服務stop后的回調函數
	AfterStart  []func() error //服務start后的回調函數
	AfterStop   []func() error //服務stop后的回調函數
	// Other options for implementations of the interface
	// can be stored in a context
	Context context.Context   //有時候服務需要攜帶一些參數,需要規定時間內返回，可以用這個來承載
}

我們可以通過micro.Options.Server.Options獲得server的屬性,實際上server還有其他的屬性,server的全部參數屬性如下

type server.Options struct {
	Codecs       map[string]codec.NewCodec //訂閱事件用的
	Broker       broker.Broker             //訂閱事件用的
	Registry     registry.Registry        //這個是服務發現支持
	Transport    transport.Transport     //節點之間網絡傳遞用的
	Metadata     map[string]string       //傳遞一些k,v數據用
	Name         string                  //名稱
	Address      string                 //服務地址
	Advertise    string                  //廣播地址
	Id           string                //服務ID
	Version      string                 //處理程序wrapper
	HdlrWrappers []HandlerWrapper            //網絡處理程序封裝
	SubWrappers  []SubscriberWrapper        //訂閱程序封裝

	// RegisterCheck runs a check function before registering the service
	RegisterCheck func(context.Context) error   //注冊服務前的校驗函數
	// The register expiry time
	RegisterTTL time.Duration                      //注冊服務生命周期,過了這么長事件需要重新注冊
	// The interval on which to register
	RegisterInterval time.Duration                     //多長時間注冊一次

	// The router for requests
	Router Router     //請求的路由表

	// Other options for implementations of the interface
	// can be stored in a context
	Context context.Context   //有時候服務需要攜帶一些參數,需要規定時間內返回，可以用這個來承載
}

如果server需要配置額外的屬性,則調用屬性配置函數來刷新配置。如Name()運行結果是返回一個函數,因此最后通過server.Name(name)來刷新這個函數,

micro.Name("go.micro.srv.broker"),
// Name of the service
func Name(n string) Option {
	return func(o *Options) {
		o.Server.Init(server.Name(n))
	}
}

函數關系如下
micro.NewService的函數調用關系如下

注意最后的o.Name即設置service.Options.Name = name
micro.Version("latest")也是一樣的

service.Init

init 函數原型如下

func (s *service) Init(opts ...Option) {
	// process options
	for _, o := range opts {
		o(&s.opts)
	}

	s.once.Do(func() {
		// Initialise the command flags, overriding new service
		_ = s.opts.Cmd.Init(
			cmd.Broker(&s.opts.Broker),
			cmd.Registry(&s.opts.Registry),
			cmd.Transport(&s.opts.Transport),
			cmd.Client(&s.opts.Client),
			cmd.Server(&s.opts.Server),
		)
	})
}

for _, o := range opts代碼片段的作用是設置service的屬性,底層也是通過類似o.Server.Init(server.NaME(n)來實現的。

s.once.Do(func) 這里利用了sync.Once特性,這里預示着func只會運行1次。

micro.NewService的函數調用關系如下

兩行傳入的參數通過c := a.Command(name)來獲得需要運行的命令行

service.Run

源代碼如下

func (s *service) Run() error {
	// 這一段代碼的作用其實只開啟調試支持
	s.opts.Server.Handle(
		s.opts.Server.NewHandler(
			handler.DefaultHandler,//默認處理腳本handler就是調試
			server.InternalHandler(true),//把這個標記為成內置的handler
		),
	)

	if err := s.Start(); err != nil {
		return err
	}

	ch := make(chan os.Signal, 1)
	signal.Notify(ch, syscall.SIGTERM, syscall.SIGINT, syscall.SIGQUIT)

	select {
	// wait on kill signal
	case <-ch:
	// wait on context cancel
	case <-s.opts.Context.Done():
	}

	return s.Stop()
}

s.Start()作用是啟動服務,目前micro支持的rpcservce/httpservice/apiservice/websercice等,他們都實現了這個Start()方法。以RPCService為例,函數流程如下

micro.NewService的函數調用關系如下

具體代碼解讀如下

func (s *rpcServer) Start() error {
	config := s.Options()

	//啟動監聽
	ts, err := config.Transport.Listen(config.Address)
	if err != nil {
		return err
	}


	// 連接消息代理
	if err := config.Broker.Connect(); err != nil {
		return err
	}


	// 注冊發現,嚴格校驗注冊服務,
	if err = s.opts.RegisterCheck(s.opts.Context); err != nil {
		log.Logf("Server %s-%s register check error: %s", config.Name, config.Id, err)
	} else {
		// 注冊發現,匿名注冊
		if err = s.Register(); err != nil {
			log.Logf("Server %s-%s register error: %s", config.Name, config.Id, err)
		}
	}

	exit := make(chan bool)

	//啟動監聽服務
	go func() {
		for {
			// 監聽
			err := ts.Accept(s.ServeConn)

			// TODO: listen for messages
			// msg := broker.Exchange(service).Consume()

			select {
			// check if we're supposed to exit
			case <-exit:
				return
			// check the error and backoff
			default:
				if err != nil {
					log.Logf("Accept error: %v", err)
					time.Sleep(time.Second)
					continue
				}
			}

			// no error just exit
			return
		}
	}()

	//開啟定時注冊攜程
	go func() {
		t := new(time.Ticker)

		// only process if it exists
		if s.opts.RegisterInterval > time.Duration(0) {
			// new ticker
			t = time.NewTicker(s.opts.RegisterInterval)
		}

		// return error chan
		var ch chan error

	Loop:
		for {
			select {
			// register self on interval
			case <-t.C:
				s.RLock()
				registered := s.registered
				s.RUnlock()
				//校驗注冊
				if err = s.opts.RegisterCheck(s.opts.Context); err != nil && registered {
					log.Logf("Server %s-%s register check error: %s, deregister it", config.Name, config.Id, err)
					// deregister self in case of error
					if err := s.Deregister(); err != nil {
						log.Logf("Server %s-%s deregister error: %s", config.Name, config.Id, err)
					}
				} else {
					//匿名注冊
					if err := s.Register(); err != nil {
						log.Logf("Server %s-%s register error: %s", config.Name, config.Id, err)
					}
				}
			// wait for exit
			case ch = <-s.exit:
				t.Stop()
				close(exit)
				break Loop
			}
		}

		// 如果退出來了,那么注銷服務
		if err := s.Deregister(); err != nil {
			log.Logf("Server %s-%s deregister error: %s", config.Name, config.Id, err)
		}

		// 等到請求完成
		if s.wg != nil {
			s.wg.Wait()
		}

		// 關閉
		ch <- ts.Close()

		// 關閉消息代理連接
		config.Broker.Disconnect()

		// swap back address
		s.Lock()
		s.opts.Address = addr
		s.Unlock()
	}()

	return nil
}

相關代碼獲得

關注公眾號回復micro-broker即可獲得

公眾號betaidea

golang微服務框架go-micro 入門筆記2.4 go-micro service解讀