Apache Tomcat 连接器 - AJP 协议参考

原始文档由 Dan Milstein 撰写，danmil@shore.net于2000年12月。本文档由 XML 文件生成，以便更轻松地集成到 Tomcat 文档中。

本文描述了 Apache JServ 协议版本 1.3 (以下简称 ajp13)。目前似乎没有关于该协议如何工作的文档。本文旨在弥补这一不足，以便为 JK 的维护者以及任何想将该协议移植到其他地方（例如 Jakarta 4.x）的人提供便利。

我不是这个协议的设计者之一——我相信 Gal Shachor 是最初的设计者。本文中的所有内容都来自于我在 Tomcat 3.x 代码中发现的实际实现。我希望它有用，但我无法保证其完美准确性。我也不知道为什么会做出某些设计决策。在力所能及的范围内，我为某些选择提供了一些可能的理由，但那些只是我的猜测。总的来说，Shachor 编写的 C 代码非常干净和易于理解（尽管几乎完全没有文档）。我已经清理了 Java 代码，我认为它相当易读。

根据 Gal Shachor 发送给 jakarta-dev 邮件列表的电子邮件，JK（以及因此 ajp13）的最初目标是通过（我只包含与 Web 服务器和 Servlet 容器之间通信相关的目标）扩展 mod_jserv 和 ajp12：

• 提高性能（特别是速度）。
• 增加对 SSL 的支持，以便 isSecure() 和 getScheme() 能够在 servlet 容器内正常工作。客户端证书和密码套件将作为请求属性提供给 servlet。

ajp13 协议是面向数据包的。选择二进制格式而非更易读的纯文本，大概是出于性能原因。Web 服务器通过 TCP 连接与 Servlet 容器通信。为了减少套接字创建的昂贵过程，Web 服务器将尝试维护到 Servlet 容器的持久 TCP 连接，并为多个请求/响应周期重用连接。

一旦一个连接被分配给一个特定的请求，在请求处理周期结束之前，它将不会被用于其他任何请求。换句话说，请求不会在连接上多路复用。这使得连接两端的代码大大简化，尽管它确实会导致同时打开更多的连接。

一旦 Web 服务器打开与 Servlet 容器的连接，该连接可以处于以下状态之一：

• 空闲
  此连接没有正在处理的请求。
• 已分配
  此连接正在处理一个特定的请求。

一旦连接被分配用于处理特定请求，基本请求信息（例如 HTTP 头等）将以高度压缩的形式通过连接发送（例如，常用字符串被编码为整数）。有关该格式的详细信息，请参见下面的请求数据包结构。如果请求有正文（content-length > 0），则会在其后立即以单独的数据包发送。

此时，Servlet 容器应已准备好开始处理请求。在此过程中，它可以向 Web 服务器发送以下消息：

• 发送头信息 (SEND_HEADERS)
  将一组头信息发送回浏览器。
• 发送正文块 (SEND_BODY_CHUNK)
  将正文数据块发送回浏览器。
• 获取正文块 (GET_BODY_CHUNK)
  如果请求尚未完全传输，则获取更多数据。这是必要的，因为数据包具有固定的最大大小，并且请求正文（例如上传文件）可以包含任意数量的数据。（注意：这与 HTTP 分块传输无关）。
• 结束响应 (END_RESPONSE)
  结束请求处理周期。

每条消息都附带一个格式不同的数据包。有关详细信息，请参阅下面的响应数据包结构。

这个协议有点 XDR 传统，但在很多方面有所不同（例如，没有 4 字节对齐）。

AJP13 对所有数据类型都使用网络字节序。

协议中有四种数据类型：字节、布尔值、整数和字符串。

字节 (Byte)

一个单字节。

布尔值 (Boolean)

一个单字节，1 = 真，0 = 假。使用其他非零值作为真（即 C 风格）可能在某些地方有效，但在其他地方则无效。

整数 (Integer)

一个介于 0 到 2^16 (32768) 之间的数字。以 2 字节存储，高位字节在前。

字符串 (String)

可变大小的字符串（长度上限为 2^16）。编码时，长度先打包成两个字节，然后是字符串（包括终止符 '\0'）。请注意，编码长度不包括末尾的 '\0'——它类似于 strlen。这在 Java 端有点令人困惑，那里充斥着奇怪的自增语句来跳过这些终止符。我相信这样做的原因是允许 C 代码在读取 servlet 容器发回的字符串时效率更高——有了终止符 \0 字符，C 代码可以传递单个缓冲区中的引用，而无需复制。如果缺少 \0，C 代码就必须复制内容才能获得其对字符串的概念。请注意，大小为 -1 (65535) 表示空字符串，并且在这种情况下，长度后不跟数据。

对于从服务器发送到容器的“转发请求”类型的消息：

AJP13_FORWARD_REQUEST :=
    prefix_code      (byte) 0x02 = JK_AJP13_FORWARD_REQUEST
    method           (byte)
    protocol         (string)
    req_uri          (string)
    remote_addr      (string)
    remote_host      (string)
    server_name      (string)
    server_port      (integer)
    is_ssl           (boolean)
    num_headers      (integer)
    request_headers *(req_header_name req_header_value)
    attributes      *(attribut_name attribute_value)
    request_terminator (byte) OxFF

request_headers 具有以下结构：

req_header_name := 
    sc_req_header_name | (string)  [see below for how this is parsed]

sc_req_header_name := 0xA0xx (integer)

req_header_value := (string)

attributes 是可选的，具有以下结构：

attribute_name := sc_a_name | (sc_a_req_attribute string)

attribute_value := (string)

需要注意的是，最重要的头是“content-length”，因为它决定了容器是否会立即寻找另一个数据包。

“转发请求”元素的详细描述。

详细信息

AJP13_SEND_BODY_CHUNK := 
  prefix_code   3
  chunk_length  (integer)
  chunk        *(byte)


AJP13_SEND_HEADERS :=
  prefix_code       4
  http_status_code  (integer)
  http_status_msg   (string)
  num_headers       (integer)
  response_headers *(res_header_name header_value)

res_header_name := 
    sc_res_header_name | (string)   [see below for how this is parsed]

sc_res_header_name := 0xA0 (byte)

header_value := (string)

AJP13_END_RESPONSE :=
  prefix_code       5
  reuse             (boolean)


AJP13_GET_BODY_CHUNK :=
  prefix_code       6
  requested_length  (integer)

该块基本上是二进制数据，并直接发送回浏览器。

关于认证？Web 服务器和容器之间的连接似乎没有任何认证。这在我看来可能很危险。

版权所有 © 1999-2024, Apache 软件基金会