转载

golang微服务框架go-micro 入门笔记2.4 go-micro service解读

本章节阐述go-micro 服务发现原理

go-micro架构

下图来自go-micro官方

阅读本文前你可能需要进行如下知识储备

golang分布式微服务框架go-micro 入门笔记1:搭建go-micro环境,
golang微服务框架go-micro 入门笔记2.1 micro工具之micro api
golang微服务框架go-micro 入门笔记2.2 micro工具之micro web
golang微服务框架go-micro 入门笔记2.3 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的函数调用关系如下

golang微服务框架go-micro 入门笔记2.4 go-micro service解读

该函数主要是初始化一个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))
    }
}

函数关系如下

golang微服务框架go-micro 入门笔记2.4 go-micro service解读

注意最后的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次。

golang微服务框架go-micro 入门笔记2.4 go-micro service解读

两行传入的参数通过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为例,函数流程如下

golang微服务框架go-micro 入门笔记2.4 go-micro service解读

具体代码解读如下

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
}