matlab.net.http.HeaderField 类

命名空间: matlab.net.http

HTTP 消息的标头字段

描述

使用 HeaderField 类为 HTTP 消息实现标头字段。该类支持标头中的字符串与 MATLAB^® 对象、数组和结构体之间的相互转换。虽然您可以将 HeaderField 属性设置为任意值，但 HTTP 标头字段对允许使用的字符有限制。

Name 属性定义标头字段的类型。MATLAB 在 matlab.net.http.field 命名空间中为常用字段提供了子类。要查看支持的子类列表，请调用 HeaderField.displaySubclasses 方法。

创建对象

描述

obj = matlab.net.http.HeaderField(name,value) 创建一个标头字段，并将 Name 属性设置为 name，将 Value 属性设置为 value。其中任何一个参量都可以是空的双精度值 []。您可以采用任意顺序指定多个对组参量，例如 name1,value1,...,nameN,valueN。如果最后一个 value 参量缺失，则 HeaderField 将它视为空。

示例

属性

全部展开

`Name` — 标头字段的名称
字符串 | 字符向量

标头字段的名称，指定为字符串或字符向量。Name 决定字段的类型，字段的类型决定 Value 属性的有效值。如果您将 Name 设置为 [] 或空字符串，则 Value 为 []。

如果此对象是实现特定标头字段类型的子类的一个实例，则该类会对 Name 属性强制应用约束。

示例: 'Content-Type'

属性：

`GetAccess`	`public`
`SetAccess`	`public`

`Value` — 标头字段的值
字符串 | 对 `Name` 有效的任何类型

标头字段的值，指定为字符串或对 Name 属性有效的任何类型。

当您读取此属性时，Value 是代表该字段值的字符串。

当您设置此属性时，Value 可以是该字段基于 Name 属性和/或此对象的类能够接受的任何类型。其结果会转换为字符串。如果字段类型具有默认值，请将 Value 设置为空字符串（'' 或 string('')）。如果您指定了一个空的双精度值 []，则请求消息的 send 和 complete 方法不会将此字段添加到消息中。

示例: 'text/html'

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`Dependent`	`true`

方法

全部展开

公共方法

`convert`	将标头字段值转换为 MATLAB 类型
`convertLike`	以与另一个标头字段类似的转换方式来转换标头字段的值
`parse`	解析标头字段值并返回为字符串
`addFields`	向 HeaderField 数组中添加字段
`removeFields`	从标头字段数组中删除字段
`changeFields`	更改 HeaderField 数组中的现有值
`replaceFields`	更改 HeaderField 数组中的值或向其中添加字段
`getFields`	返回与名称或类匹配的标头字段
`eq`	比较两个 HeaderField 数组
`displaySubclasses`	显示支持的 HeaderField 子类

专用运算符和函数

这些方法将标准的 MATLAB 运算符和函数应用于此类中的对象。

`isequal`	如果两个标头字段数组大小相同且对应元素相等，则返回 `true`，如 `eq` 方法所述。
`string`	以字符串形式返回标头字段数组，如其在消息中所示。字段之间会插入换行符，但不会在所有字段的末尾插入换行符。
`char`	以字符向量形式返回标头字段数组，如 `string` 方法所述

示例

全部折叠

选择标头字段构造函数

要创建 Content-Type 标头字段，可以使用 HeaderField 类或 ContentTypeField 类构造函数。

使用 HeaderField 类构造函数时，可将 Name 属性指定为 'Content-Type'。但是，如果您拼错了字段名称，您可能发现不了这个错误，直到消息被服务器拒绝为止。某些服务器会以静默方式忽略未知的字段名称。

f1 = matlab.net.http.HeaderField('Content-Type','text/plain');

最好使用 ContentTypeField 类构造函数，因为这样您就不会拼错字段名称。

f2 = matlab.net.http.field.ContentTypeField('text/plain');

不管您使用哪个构造函数，只要 Value 属性相同，字段就相同。

f1 == f2

ans =    1

在 HTTP HeaderField 数组中查找值

打开实时脚本

此示例说明如何在来自 mathworks.com 的响应中找到特定的标头字段 Cache-Control。

向 mathworks.com 发送一条消息。

request = matlab.net.http.RequestMessage;
uri = matlab.net.URI('https://www.mathworks.com');
response = send(request,uri);

搜索 Cache-Control 并显示该值。

field = response.getFields('Cache-Control');
value = field.Value

value = 
"max-age=14400"

提示

HeaderField 构造函数可创建 HeaderField 类的字段。要创建 matlab.net.http.field 命名空间中定义的类的字段，请改用子类构造函数。要查看子类列表，请调用 HeaderField.displaySubclasses 方法。
例如，matlab.net.http.field.DateField 子类创建一个 Date 标头字段。如果您使用 HeaderField 类创建 Date 字段，则 DateField 类将解释并强制应用该值，即使 HeaderField 不是 DateField 的实例也是如此。同样，如果您将该字段值转换为 MATLAB datetime 值，将使用 DateField.convert 方法。
如果 HeaderField 构造函数拒绝 Name 和 Value 参量，请改用 GenericField 类构造函数。

版本历史记录

在 R2016b 中推出

另请参阅

matlab.net.http.field.GenericField