Docker源码分析（四）之Docker Server

以你之姓@ 2022-06-11 03:23 230阅读 0赞

# 一、Docker Server创建流程 #

Docker Server是Daemon Server的重要组成部分，功能：接收Docker Client发送的请求，并按照相应的路由规则实现请求的路由分发，最终将请求处理的结果返回给Docker Client。  
  
Docker Daemon启动，在mainDaemon()运行的最后创建并运行serverapi的Job，让Docker Daemon提供API访问服务。  
  
Docker Server的整个生命周期  
  
1. 创建Docker Server的Job  
2. 配置Job的环境变量  
3. 触发执行Job

说明：本文分析的代码为Docker 1.2.0版本。

## （一）创建“serverapi”的Job ##

/docker/daemon.go

**/docker/daemon.go**

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> <p><code>func mainDaemon() { </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>...</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// Serve api</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>job := eng.Job(</code><code>"serveapi"</code><code>, flHosts...)</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>...</code></p> <p><code>&nbsp;&nbsp;</code><code>}</code></p> </td> 
  </tr> 
 </tbody> 
</table>

运行serverapi的Job时，会执行该Job的处理方法api.ServeApi。

## （二）配置Job环境变量 ##

**/docker/daemon.go**

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> <p><code>job.SetenvBool(</code><code>"Logging"</code><code>,&nbsp;</code><code>true</code><code>)</code></p> <p><code>job.SetenvBool(</code><code>"EnableCors"</code><code>, *flEnableCors)</code></p> <p><code>job.Setenv(</code><code>"Version"</code><code>, dockerversion.VERSION)</code></p> <p><code>job.Setenv(</code><code>"SocketGroup"</code><code>, *flSocketGroup)</code></p> <p>&nbsp;</p> <p><code>job.SetenvBool(</code><code>"Tls"</code><code>, *flTls)</code></p> <p><code>job.SetenvBool(</code><code>"TlsVerify"</code><code>, *flTlsVerify)</code></p> <p><code>job.Setenv(</code><code>"TlsCa"</code><code>, *flCa)</code></p> <p><code>job.Setenv(</code><code>"TlsCert"</code><code>, *flCert)</code></p> <p><code>job.Setenv(</code><code>"TlsKey"</code><code>, *flKey)</code></p> <p><code>job.SetenvBool(</code><code>"BufferRequests"</code><code>,&nbsp;</code><code>true</code><code>)</code></p> </td> 
  </tr> 
 </tbody> 
</table>

参数分为两种

*  创建Job实例时，用指定参数直接初始化Job的Args属性
 *  创建Job后，给Job添加指定的环境变量

<table> 
 <thead> 
  <tr> 
   <th style="vertical-align:top;"> <p>环境变量名</p> </th> 
   <th style="vertical-align:top;"> <p>FLAG参数</p> </th> 
   <th style="vertical-align:top;"> <p>默认</p> </th> 
   <th style="vertical-align:top;"> <p>作用值</p> </th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td style="border-color:#dddddd;vertical-align:top;">Logging</td> 
   <td style="border-color:#dddddd;vertical-align:top;">&nbsp;</td> 
   <td style="border-color:#dddddd;vertical-align:top;">true</td> 
   <td style="border-color:#dddddd;vertical-align:top;">启用Docker容器的日志输出</td> 
  </tr> 
  <tr> 
   <td style="border-color:#dddddd;vertical-align:top;">EnableCors</td> 
   <td style="border-color:#dddddd;vertical-align:top;">flEnableCors</td> 
   <td style="border-color:#dddddd;vertical-align:top;">false</td> 
   <td style="border-color:#dddddd;vertical-align:top;">在远程API中提供CORS头</td> 
  </tr> 
  <tr> 
   <td style="border-color:#dddddd;vertical-align:top;">Version</td> 
   <td style="border-color:#dddddd;vertical-align:top;">&nbsp;</td> 
   <td style="border-color:#dddddd;vertical-align:top;">&nbsp;</td> 
   <td style="border-color:#dddddd;vertical-align:top;">显示Docker版本号</td> 
  </tr> 
  <tr> 
   <td style="border-color:#dddddd;vertical-align:top;">SocketGroup</td> 
   <td style="border-color:#dddddd;vertical-align:top;">flSockerGroup</td> 
   <td style="border-color:#dddddd;vertical-align:top;">docker</td> 
   <td style="border-color:#dddddd;vertical-align:top;">在daemon模式中unix domain socket分配用户组名</td> 
  </tr> 
  <tr> 
   <td style="border-color:#dddddd;vertical-align:top;">Tls</td> 
   <td style="border-color:#dddddd;vertical-align:top;">flTls</td> 
   <td style="border-color:#dddddd;vertical-align:top;">false</td> 
   <td style="border-color:#dddddd;vertical-align:top;">使用TLS安全传输协议</td> 
  </tr> 
  <tr> 
   <td style="border-color:#dddddd;vertical-align:top;">TlsVerify</td> 
   <td style="border-color:#dddddd;vertical-align:top;">flTlsVerify</td> 
   <td style="border-color:#dddddd;vertical-align:top;">false</td> 
   <td style="border-color:#dddddd;vertical-align:top;">使用TLS并验证远程客户端</td> 
  </tr> 
  <tr> 
   <td style="border-color:#dddddd;vertical-align:top;">TlsCa</td> 
   <td style="border-color:#dddddd;vertical-align:top;">flCa</td> 
   <td style="border-color:#dddddd;vertical-align:top;">&nbsp;</td> 
   <td style="border-color:#dddddd;vertical-align:top;">指定CA文件路径</td> 
  </tr> 
  <tr> 
   <td style="border-color:#dddddd;vertical-align:top;">TlsCert</td> 
   <td style="border-color:#dddddd;vertical-align:top;">flCert</td> 
   <td style="border-color:#dddddd;vertical-align:top;">&nbsp;</td> 
   <td style="border-color:#dddddd;vertical-align:top;">TLS证书文件路径</td> 
  </tr> 
  <tr> 
   <td style="border-color:#dddddd;vertical-align:top;">TlsKey</td> 
   <td style="border-color:#dddddd;vertical-align:top;">flKey</td> 
   <td style="border-color:#dddddd;vertical-align:top;">&nbsp;</td> 
   <td style="border-color:#dddddd;vertical-align:top;">TLS密钥文件路径</td> 
  </tr> 
  <tr> 
   <td style="border-color:#dddddd;vertical-align:top;">BufferRequest</td> 
   <td style="border-color:#dddddd;vertical-align:top;">&nbsp;</td> 
   <td style="border-color:#dddddd;vertical-align:top;">true</td> 
   <td style="border-color:#dddddd;vertical-align:top;">缓存Docker Client请求</td> 
  </tr> 
 </tbody> 
</table>

## （三）运行Job ##

**/api/server/server.go**

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> <p><code>if</code>&nbsp;<code>err := job.Run(); err != nil { </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>log</code><code>.Fatal(err)</code></p> <p><code>}</code></p> </td> 
  </tr> 
 </tbody> 
</table>

Docker在eng对象中注册过键位serverapi的处理方法，在运行Job的时候执行这个处理方法的值函数，相应的处理方法的值为api.ServeApi。

# 二、ServeApi运行流程 #

ServeApi属于Docker Server提供API服务的部分，作为一个监听请求、处理请求、响应请求的服务端，支持三种协议：TCP协议、UNIX Socket形式以及fd的形式。功能是：循环检查Docker Daemon支持的所有协议，并为每一种协议创建一个协程goroutine，并在协程内部配置一个服务于HTTP请求的服务端。

**/api/server/server.go**

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> <p><code>// ServeApi loops through all of the protocols sent in to docker and spawns</code></p> <p><code>// off a go routine to setup a serving http.Server for each.</code></p> <p><code>func ServeApi(job *engine.Job) engine.Status { </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code>&nbsp;<code>len(job.Args) == 0 { </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>job.Errorf(</code><code>"usage: %s PROTO://ADDR [PROTO://ADDR ...]"</code><code>, job.Name)</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>var (</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>protoAddrs = job.Args</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>chErrors&nbsp;&nbsp; = make(chan error, len(protoAddrs))</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>)</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>activationLock = make(chan&nbsp;</code><code>struct</code><code>{})</code></p> <p>&nbsp;</p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>for</code>&nbsp;<code>_, protoAddr := range protoAddrs { </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>protoAddrParts := strings.SplitN(protoAddr,&nbsp;</code><code>"://"</code><code>, 2)</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code>&nbsp;<code>len(protoAddrParts) != 2 { </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>job.Errorf(</code><code>"usage: %s PROTO://ADDR [PROTO://ADDR ...]"</code><code>, job.Name)</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>go func() { </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>log</code><code>.Infof(</code><code>"Listening for HTTP on %s (%s)"</code><code>, protoAddrParts[0], protoAddrParts[1])</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>chErrors &lt;- ListenAndServe(protoAddrParts[0], protoAddrParts[1], job)</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}()</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code></p> <p>&nbsp;</p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>for</code>&nbsp;<code>i := 0; i &lt; len(protoAddrs); i += 1 { </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>err := &lt;-chErrors</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code>&nbsp;<code>err != nil { </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>job.Error(err)</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code></p> <p>&nbsp;</p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>engine.StatusOK</code></p> <p><code>}</code></p> </td> 
  </tr> 
 </tbody> 
</table>

ServeApi执行流程：  
1. 检查Job参数，确保传入参数无误  
2. 定义Docker Server的监听协议与地址，以及错误信息管理channel  
3. 遍历协议地址，针对协议创建相应的服务端  
4. 通过chErrors建立goroutine与主进程之间的协调关系

## （一）判断Job参数 ##

判断Job参数，job.Args，即数组flHost，若flHost的长度为0，则说明没有监听的协议与地址，参数有误。

**/api/server/server.go**

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> <p><code>func ServeApi(job *engine.Job) engine.Status { </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code>&nbsp;<code>len(job.Args) == 0 { </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>job.Errorf(</code><code>"usage: %s PROTO://ADDR [PROTO://ADDR ...]"</code><code>, job.Name)</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>...</code></p> <p><code>}</code></p> </td> 
  </tr> 
 </tbody> 
</table>

## （二）定义监听协议与地址及错误信息 ##

**/api/server/server.go**

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> <p><code>var (</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>protoAddrs = job.Args</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>chErrors&nbsp;&nbsp; = make(chan error, len(protoAddrs))</code></p> <p><code>&nbsp;&nbsp;&nbsp;</code><code>)</code></p> <p><code>&nbsp;&nbsp;&nbsp;</code><code>activationLock = make(chan&nbsp;</code><code>struct</code><code>{})</code></p> </td> 
  </tr> 
 </tbody> 
</table>

定义protoAddrs\[flHosts的内容\]、chErrors\[错误类型管道\]与activationLock\[同步serveapi和acceptconnections两个job执行的管道\]三个变量，

## （三）遍历协议地址 ##

**/api/server/server.go**

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> <p><code>for</code>&nbsp;<code>_, protoAddr := range protoAddrs { </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>protoAddrParts := strings.SplitN(protoAddr,&nbsp;</code><code>"://"</code><code>, 2)</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code>&nbsp;<code>len(protoAddrParts) != 2 { </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>job.Errorf(</code><code>"usage: %s PROTO://ADDR [PROTO://ADDR ...]"</code><code>, job.Name)</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>go func() { </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>log</code><code>.Infof(</code><code>"Listening for HTTP on %s (%s)"</code><code>, protoAddrParts[0], protoAddrParts[1])</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>chErrors &lt;- ListenAndServe(protoAddrParts[0], protoAddrParts[1], job)</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}()</code></p> <p><code>}</code></p> </td> 
  </tr> 
 </tbody> 
</table>

遍历协议地址，针对协议创建相应的服务端。协议地址

## （四）协调chErrors与主进程关系 ##

根据chErrors的值运行，如果chErrors这个管道中有错误内容，则ServerApi一次循环结束，若无错误内容，循环被阻塞。即chErrors确保ListenAndServe所对应的协程能和主函数ServeApi进行协调，如果协程出错，主函数ServeApi仍然可以捕获这样的错误，从而导致程序退出。

**/api/server/server.go**

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> <p><code>for</code>&nbsp;<code>i := 0; i &lt; len(protoAddrs); i += 1 { </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>err := &lt;-chErrors</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code>&nbsp;<code>err != nil { </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>job.Error(err)</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code></p> <p><code>}</code></p> <p><code>return</code>&nbsp;<code>engine.StatusOK</code></p> </td> 
  </tr> 
 </tbody> 
</table>

# 三、ListenAndServe实现 #

ListenAndServe的功能：使Docker Server监听某一指定地址，并接收该地址的请求，并对以上请求路由转发至相应的处理方法处。  
  
ListenAndServe执行流程：  
  
1. 创建route路由实例  
2. 创建listener监听实例  
3. 创建http.Server  
4. 启动API服务  
  
流程图：  
  
![Center][]

## （一）创建route路由实例 ##

**/api/server/server.go**

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> <p><code>// ListenAndServe sets up the required http.Server and gets it listening for</code></p> <p><code>// each addr passed in and does protocol specific checking.</code></p> <p><code>func ListenAndServe(proto, addr string, job *engine.Job) error { </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>var l net.Listener</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>r, err := createRouter(job.Eng, job.GetenvBool(</code><code>"Logging"</code><code>), job.GetenvBool(</code><code>"EnableCors"</code><code>), job.Getenv(</code><code>"Version"</code><code>))</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code>&nbsp;<code>err != nil { </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>err</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>...</code></p> <p><code>}</code></p> </td> 
  </tr> 
 </tbody> 
</table>

路由实例的作用：负责Docker Server对外部请求的路由及转发。  
  
实现过程：  
  
1. 创建全新的route路由实例  
2. 为route实例添加路由记录

### 1、创建空路由实例 ###

**/api/server/server.go**

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> <p><code>func createRouter(eng *engine.Engine, logging, enableCors&nbsp;</code><code>bool</code><code>, dockerVersion string) (*mux.Router, error) { </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>r := mux.NewRouter()</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>...</code></p> <p><code>&nbsp;</code><code>}</code></p> </td> 
  </tr> 
 </tbody> 
</table>

**/vendor/src/github.com/gorilla/mux/mux.go**

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> <p><code>// NewRouter returns a new router instance.</code></p> <p><code>func NewRouter() *Router { </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>&amp;Router{namedRoutes: make(map[string]*Route), KeepContext:&nbsp;</code><code>false</code><code>}</code></p> <p><code>}</code></p> <p>&nbsp;</p> <p><code>// This will send all incoming requests to the router.</code></p> <p><code>type Router&nbsp;</code><code>struct</code>&nbsp;<code>{ </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// Configurable Handler to be used when no route matches.</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>NotFoundHandler http.Handler</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// Parent route, if this is a subrouter.</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>parent parentRoute</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// Routes to be matched, in order.</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>routes []*Route</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// Routes by name for URL building.</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>namedRoutes map[string]*Route</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// See Router.StrictSlash(). This defines the flag for new routes.</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>strictSlash&nbsp;</code><code>bool</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// If true, do not clear the request context after handling the request</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>KeepContext&nbsp;</code><code>bool</code></p> <p><code>}</code></p> </td> 
  </tr> 
 </tbody> 
</table>

NewRoute()函数返回一个全新的route实例r，类型为mux.Router。实例初始化nameRoutes和KeepContext。

*  nameRoutes：map类型，key为string类型，value为Route路由记录类型
 *  KeepContext：属性为false，则处理完请求后清除请求内容，不对请求做存储操作

mux.Router会通过一系列已经注册过的路由记录，来匹配接收的请求。先通过请求的URL或者其他条件找到相应的路由记录，并调用这条记录中的执行处理方法。  
  
mux.Router特性

*  请求可以基于URL的主机名、路径、路径前缀、shemes、请求头和请求值、HTTP请求方法类型或者使用自定义的匹配规则
 *  URL主机名和路径可以通过一个正则表达式来表示
 *  注册的URL可以直接被运用，也可以保留从而保证维护资源的使用
 *  路由记录同样看可以作用于子路由记录

### 2、添加路由记录 ###

**/api/server/server.go**

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> <p><code>if</code>&nbsp;<code>os.Getenv(</code><code>"DEBUG"</code><code>) !=&nbsp;</code><code>""</code>&nbsp;<code>{ </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>AttachProfiler(r)</code></p> <p><code>&nbsp;&nbsp;&nbsp;</code><code>}</code></p> <p>&nbsp;</p> <p><code>&nbsp;&nbsp;&nbsp;</code><code>m := map[string]map[string]HttpApiFunc{ </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"GET"</code><code>: { </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/_ping"</code><code>:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ping,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/events"</code><code>:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; getEvents,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/info"</code><code>:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; getInfo,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/version"</code><code>:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; getVersion,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/images/json"</code><code>:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; getImagesJSON,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/images/viz"</code><code>:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; getImagesViz,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/images/search"</code><code>:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; getImagesSearch,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/images/{name:.*}/get"</code><code>:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; getImagesGet,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/images/{name:.*}/history"</code><code>:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; getImagesHistory,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/images/{name:.*}/json"</code><code>:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; getImagesByName,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/containers/ps"</code><code>:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; getContainersJSON,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/containers/json"</code><code>:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; getContainersJSON,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/containers/{name:.*}/export"</code><code>:&nbsp;&nbsp;&nbsp; getContainersExport,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/containers/{name:.*}/changes"</code><code>:&nbsp;&nbsp; getContainersChanges,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/containers/{name:.*}/json"</code><code>:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; getContainersByName,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/containers/{name:.*}/top"</code><code>:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; getContainersTop,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/containers/{name:.*}/logs"</code><code>:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; getContainersLogs,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/containers/{name:.*}/attach/ws"</code><code>: wsContainersAttach,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>},</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"POST"</code><code>: { </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/auth"</code><code>:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; postAuth,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/commit"</code><code>:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; postCommit,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/build"</code><code>:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; postBuild,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/images/create"</code><code>:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; postImagesCreate,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/images/load"</code><code>:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; postImagesLoad,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/images/{name:.*}/push"</code><code>:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; postImagesPush,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/images/{name:.*}/tag"</code><code>:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; postImagesTag,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/containers/create"</code><code>:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; postContainersCreate,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/containers/{name:.*}/kill"</code><code>:&nbsp;&nbsp;&nbsp; postContainersKill,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/containers/{name:.*}/pause"</code><code>:&nbsp;&nbsp; postContainersPause,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/containers/{name:.*}/unpause"</code><code>: postContainersUnpause,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/containers/{name:.*}/restart"</code><code>: postContainersRestart,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/containers/{name:.*}/start"</code><code>:&nbsp;&nbsp; postContainersStart,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/containers/{name:.*}/stop"</code><code>:&nbsp;&nbsp;&nbsp; postContainersStop,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/containers/{name:.*}/wait"</code><code>:&nbsp;&nbsp;&nbsp; postContainersWait,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/containers/{name:.*}/resize"</code><code>:&nbsp; postContainersResize,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/containers/{name:.*}/attach"</code><code>:&nbsp; postContainersAttach,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/containers/{name:.*}/copy"</code><code>:&nbsp;&nbsp;&nbsp; postContainersCopy,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>},</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"DELETE"</code><code>: { </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/containers/{name:.*}"</code><code>: deleteContainers,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"/images/{name:.*}"</code><code>:&nbsp;&nbsp;&nbsp;&nbsp; deleteImages,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>},</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"OPTIONS"</code><code>: { </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>""</code><code>: optionsHandler,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>},</code></p> <p><code>&nbsp;&nbsp;&nbsp;</code><code>}</code></p> </td> 
  </tr> 
 </tbody> 
</table>

m的类型为映射，key表示HTTP的请求类型，如GET、POST、DELETE等，value为映射类型，代表URL与执行处理方法的映射。

**/api/server/server.go**

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> <p><code>type HttpApiFunc func(eng *engine.Engine, version version.Version, w http.ResponseWriter, r *http.Request, vars map[string]string) error</code></p> </td> 
  </tr> 
 </tbody> 
</table>

## （二）创建listener监听实例 ##

路由模块完成请求的路由与分发，监听模块完成请求的监听功能。Listener是一种面向流协议的通用网络监听模块。

**/api/server/server.go**

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> <p><code>var l net.Listener</code></p> <p><code>&nbsp;</code><code>...</code></p> <p><code>&nbsp;</code><code>if</code>&nbsp;<code>job.GetenvBool(</code><code>"BufferRequests"</code><code>) { </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>l, err = listenbuffer.NewListenBuffer(proto, addr, activationLock)</code></p> <p><code>&nbsp;</code><code>}&nbsp;</code><code>else</code>&nbsp;<code>{ </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>l, err = net.Listen(proto, addr)</code></p> </td> 
  </tr> 
 </tbody> 
</table>

Listenbuffer的作用：让Docker Server立即监听指定协议地址上的请求，但将这些请求暂时先缓存下来，等Docker Daemon全部启动完毕之后才让Docker Server开始接受这些请求。

**/pkg/listenbuffer/buffer.go**

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> <p><code>// NewListenBuffer returns a listener listening on addr with the protocol.</code></p> <p><code>func NewListenBuffer(proto, addr string, activate chan&nbsp;</code><code>struct</code><code>{}) (net.Listener, error) { </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>wrapped, err := net.Listen(proto, addr)</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code>&nbsp;<code>err != nil { </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>nil, err</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code></p> <p>&nbsp;</p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>&amp;defaultListener{ </code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>wrapped:&nbsp; wrapped,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>activate: activate,</code></p> <p><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}, nil</code></p> <p><code>}</code></p> </td> 
  </tr> 
 </tbody> 
</table>

若协议类型为TCP，Job环境变量中Tls或TlsVerity有一个为true，则说明Docker Server需要支持HTTPS服务。需要建立一个tls.Config类型实例tlsConfig，在tlsConfig中加载证书、认证信息，通过tls包中的NewListener函数创建HTTPS协议请求的Listener实例。

**/api/server/server.go**

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> <p><code>l = tls.NewListener(l, tlsConfig)</code></p> </td> 
  </tr> 
 </tbody> 
</table>

## （三）创建http.Server ##

**/api/server/server.go**

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> <p><code>httpSrv := http.Server{Addr: addr, Handler: r}</code></p> </td> 
  </tr> 
 </tbody> 
</table>

Docker Server需要创建一个Server对象来运行HTTP/HTTPS服务端，创建http.Server，addr为需要监听的地址，r为mux.Router。

## （四）启动API服务 ##

创建http.Server实例后，即启动API服务，监听请求，并对每一个请求生成一个新的协程来做专属服务。对于每个请求，协程会读取请求，查询路由表中的路由记录项，找到匹配的路由记录，最终调用路由记录中的处理方法，执行完毕返回响应信息。

**/api/server/server.go**

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> <p><code>return</code>&nbsp;<code>httpSrv.Serve(l)</code></p> </td> 
  </tr> 
 </tbody> 
</table>

文章参考：

《Docker源码分析》

[Center]: /images/20220611/94002f02ddbf4ce8817e8148b02d573d.png