go语言 nsq源码解读三 nsqlookupd源码nsqlookupd.go

package nsqlookupd

import (
"log"
"net"

"github.com/bitly/nsq/util"
)

type NSQLookupd struct {
//在文件nsqlookupd\options.go中定义，记录NSQLookupd的配置信息
options *nsqlookupdOptions

//nsqlookupd监听TCP数据的地址
tcpAddr *net.TCPAddr

//nsqlookupd监听HTTP数据的地址
httpAddr *net.TCPAddr

//使用上面的tcpAddr建立的Listener
tcpListener net.Listener

//使用上面的httpAddr建立的Listener
httpListener net.Listener

//在util\wait_group_wrapper.go文件中定义,与sync.WaitGroup相关，用于线程同步。
waitGroup util.WaitGroupWrapper

//在nsqlookupd\registration_db.go文件中定义，看字面意思DB(database)就可知道这涉及到数据的存取
DB *RegistrationDB
}
//
//根据配置的nsqlookupdOptions创建一个NSQLookupd的实例
//
func NewNSQLookupd(options *nsqlookupdOptions) *NSQLookupd {

//使用配置参数的TCPAddress创建TCP地址，用于和nsqd通信。
tcpAddr, err := net.ResolveTCPAddr("tcp", options.TCPAddress)
if err != nil {
log.Fatal(err)
}

//使用配置参数的HTTPAddress参数，创建http链接，可以供nsqadmin访问，以读取统计数据
httpAddr, err := net.ResolveTCPAddr("tcp", options.HTTPAddress)
if err != nil {
log.Fatal(err)
}

return &NSQLookupd{
options: options,
tcpAddr: tcpAddr,
httpAddr: httpAddr,
DB: NewRegistrationDB(),
}
}

//
//Main函数，启动时首先执行本函数
//补注：阅读options.go时，发现nsqlookupd启动时，首先运行的并不是这个Main方法。而是apps\nsqlookupd\nsqlookupd.go里的main方法，这个下篇文章会提到。
//
func (l *NSQLookupd) Main() {
//定义了Context的实例，Context在nsqlookupd\context.go文件中定义，其中只包含了一个nsqlookupd的指针,注意花括号里是字符L的小写，不是数字一.
context := &Context{l}

//监听TCP
tcpListener, err := net.Listen("tcp", l.tcpAddr.String())
if err != nil {
log.Fatalf("FATAL: listen (%s) failed - %s", l.tcpAddr, err.Error())
}

//把Listener存在NSQLookupd的struct里
l.tcpListener = tcpListener

//创建tcpServer的实例，tcpServer在nsqlookupd\tcp.go文件中定义，用于处理TCP连接中接收到的数据。通过前面阅读知道，context里只是一个NSQLookupd类型的指针。
tcpServer := &tcpServer{context: context}

//调用util.TCPServer方法（在util\tcp_server.go中定义）开始接收监听并注册handler。 //传入的两个参数第一个是tcpListener
//第二个tcpServer实现了util\tcp_server.go中定义的TCPHandler接口。
//tcpServer接到TCP数据时，会调用其Handle方法(见nsqlookupd\tcp.go)来处理。
//此处为何要用到waitGroup，目前还比较迷糊
l.waitGroup.Wrap(func() { util.TCPServer(tcpListener, tcpServer) })

//监听HTTP
httpListener, err := net.Listen("tcp", l.httpAddr.String())
if err != nil {
log.Fatalf("FATAL: listen (%s) failed - %s", l.httpAddr, err.Error())
}

//把Listener存在NSQLookupd的struct里
l.httpListener = httpListener

//创建httpServer的实例，httpServer在nsqlookupd\http.go文件中定义
httpServer := &httpServer{context: context}

//调用util.HTTPServer方法（在util\http_server.go中定义）开始在指定的httpListener上接收http连接。
//传入的两个参数第一个是httpListener
//第二个httpServer定义了http handler，用于处理HTTP请求。
//同样，对waitGroup的用法还不是很理解。
l.waitGroup.Wrap(func() { util.HTTPServer(httpListener, httpServer) })

//经过以上阅读，基本上会有两个发现：
//1、tcpServer和httpServer的代码很相似。
//2、util\tcp_server.go在注册handler之前，先定义了一个接口，而tuil\http_server.go却没有。
//如果再仔细研究这两个文件，还会发现，tcp_server里，通过go handler.Handle(clientConn)这段代码，把连接clientConn做为变量，传给了handler
//而在http_server，是把handler传给了HTTPServer
//这主要是因为net/http包和net包用法不一样，net/http做了进一步有封装。
}

//
//退出 关闭两个Listener
//
func (l *NSQLookupd) Exit() {
if l.tcpListener != nil {
l.tcpListener.Close()
}

if l.httpListener != nil {
l.httpListener.Close()
}
l.waitGroup.Wait()
}