Main Content

matlab.net.http.io.ContentProvider 类

包: matlab.net.http.io
超类: handle, matlab.mixin.Heterogeneous

HTTP 消息有效负载的 ContentProvider

说明

发送消息时,ContentProvider 为 HTTP RequestMessage 提供数据。简单的提供程序将数据从 MATLAB® 类型转换为字节流。更复杂的提供程序可将数据以流方式传输给服务器,在发送数据的同时获取或生成数据,从而不需要在开始发送消息之前将所有数据保存到内存中。

通常,向 Web 服务发送数据时(通常是在 PUT 或 POST 请求中),您会创建一个 RequestMessage,并以 MessageBody 对象形式将数据插入到 RequestMessage.Body 属性中。当您使用 RequestMessage.send 发送该消息时,MATLAB 会根据消息的 Content-Type 以及 Body.Data 中的数据类型将该数据转换为要发送给服务器的字节流。有关这些转换规则的详细信息,请参阅 MessageBody.Data

如果不想在 RequestMessage.Body 属性中插入 MessageBody 对象,则可以创建并插入 ContentProvider 对象。这样,当您发送消息时,MATLAB 会调用 ContentProvider 中的方法,在发送消息的同时获取要发送的数据缓冲区。

无论您在消息中插入 MessageBody 还是 ContentProvider,在整个消息发送完毕并且收到响应之前或者在发生错误之前,对 RequestMessage.send 的调用都不会返回(即被阻止)。但是,对于 ContentProvider,MATLAB 会在发送被阻止期间对提供程序进行周期性回调,以获取要发送的数据缓冲区。在这些回调中,您的 ContentProvider 可从任何来源获取数据,例如文件、MATLAB 数组、硬件传感器、MATLAB 函数等。提供程序的作用是以 uint8 缓冲区的形式将这些数据转换成可以发送到 Web 上的字节流。

ContentProvider 是一个抽象类,借助这个抽象类,类编写者可以使用自己的数据生成器或转换器来创建子类,也可以直接使用(或子类化)可从各来源生成数据的 MATLAB 提供程序之一,而不用自己编写子类。这些提供程序有很多选项,可以让您灵活地控制获取和转换数据的方式,比直接将数据插入 MessageBody 时发生的自动转换更灵活。可以使用下列 ContentProvider 子类之一:

即使您不需要以流方式传输数据,使用这些提供程序之一也可以简化某些内容类型的发送过程,因为它们可将数据从内部形式转换为 uint8 数据流。例如,FormProvider 允许您将表单响应发送给服务器,在服务器上,您可以很方便地将数据表示为 QueryParameter 对象数组。MultipartFormProvider 允许您发送 Multipart 表单响应,从而简化 Multipart 表单响应的创建。要使用任何 ContentProvider,您需要了解服务器期望您发送的内容类型。

matlab.net.http.io.ContentProvider 类是 handle 类。

子类编写者须知

最简单的、可能的 ContentProvider 只需实现一个 getData 方法,按 MATLAB 的要求提供数据缓冲区。要使用您的提供程序,请将其插入到 RequestMessageBody 属性中。在此示例中,RequestMessage 构造函数的第三个参数 MyProvider 对象插入到 Body 中:

provider = MyProvider;
req = matlab.net.http.RequestMessage('put', headers, provider);
resp = req.send(uri);

这是 MyProvider 类的示例,它从作为参数传递给构造函数的文件名中读取信息并发送到 Web 上。我们在最后或在删除此提供程序时还会关闭此文件。

    classdef MyProvider < matlab.net.http.io.ContentProvider
        properties
            FileID double
        end
 
        methods
            function obj = MyProvider(name)
                obj.FileID = fopen(name);
            end
 
            function [data, stop] = getData(obj, length)
                [data, len] = fread(obj.FileID, length, '*uint8');
                stop = len < length;
                if (stop)
                    fclose(obj.FileID);
                    obj.FileID = [];
                end
            end
 
            function delete(obj)
                if ~isempty(obj.FileID)
                    fclose(obj.FileID);
                    obj.FileID = [];
                end
            end
        end
    end

当提供程序产生要发送的新消息时,MATLAB 会调用提供程序的 complete 方法。目的是允许提供程序准备新消息并为消息添加任何必要的标头字段。在准备好发送数据时(但在第一次调用 getData 之前),MATLAB 会调用提供程序的 start 方法。

属性

全部展开

公共属性

消息或组成部分的标头字段,指定为由一个或多个 matlab.net.http.HeaderField 对象组成的向量。

此属性仅供子类编写者使用。MATLAB 在调用提供程序的 complete 方法之前设置此属性。对于非 Multipart 消息,MATLAB 将此属性初始化为 Request.Header 的内容减去任何 matlab.net.http.field.GenericFields 或空值字段。ContentProvider 使用此属性添加对要发送数据进行描述的标头字段,或者向消息中已有的标头字段中添加参数。在 MultipartProvider 的代理中,MATLAB 将此属性初始化为委托方提供程序打算为该部分插入的标头字段。代理可以修改或更改这些字段。

从提供程序的 complete 方法返回时,如果这不是 Multipart 消息,则 MATLAB 会读取此属性并将其内容与 Request 的标头合并。此 HeaderNames 未出现在 Request.Header 中的字段将被添加到 Request.Header 的末尾。如果此 Header 中的某个字段与 Request.Header 中的某个字段具有相同的 Name,而且都具有非空 Values,则:

  • 如果 Request.Header 中的字段是 GenericField,则忽略 Header 中的字段。

  • 如果 Request.Header 中的字段不是 GenericField,则将其替换为 Header 中的字段。

如果两个字段或其中之一具有空 Value,则将该字段从 Request.Header 中删除,且不会添加为正常的完整消息的一部分。

如果这是 MultipartProvider 的代理,则将此 Header 的全部内容用作该部分的标头。Multipart 代理绝不能假定 Request.Header 包含的任何字段与自己的 Header 相关。提供程序可以通过检查 MyDelegator 是否为 MultipartProvider 来确定它是否为 Multipart 代理,尽管需要进行这种检验的可能性并不大。

MATLAB 仅在调用提供程序的 complete 方法返回时读取此属性。一旦 MATLAB 调用 start,对此数组所做的更改将被忽略。

类编写者应该明白,在超类中调用 complete 之前,子类可能已经向此 Header 中添加字段(在子类的 complete 方法中)。最好保留这些字段,而且不要添加同名字段。但是,为字段添加参数是可以的。例如,超类可以为没有字符集参数的现有 Content-Type 字段添加一个字符集参数。

属性:

GetAccess
public
SetAccess
public

指示是否强制进行分块传输编码,指定为布尔值。此属性仅对子类编写者有用,并且仅适用于不是作为 Multipart 代理的提供程序。子类通过设置 ForceChunked 来控制是否应使用分块传输编码发送内容。如果为 false(默认值),MATLAB 将根据消息待发送时是否了解消息的内容长度来决定是否发送分块内容:

  • 如果 MATLAB 知道内容长度(例如,消息中包含 Content-Length 字段,或者此提供程序的 expectedContentLength 方法返回一个数字),则由 MATLAB 决定是否发送分块消息。

  • 如果 MATLAB 不知道内容长度(标头中没有 Content-Length 字段而且 expectedContentLength 返回空),则 MATLAB 始终发送分块消息。

如果 ForceChunkedtrue,则无论 MATLAB 是否知道内容长度都会发送分块消息,除非已知长度小于块大小。如果此属性为 true,则消息中不能包含 Content-Length 字段,因为 HTTP 不允许分块消息具有 Content-Length 字段。但是,如果您希望 MATLAB 验证您返回的是预期的数据长度,则仍可以在 expectedContentLength 方法中返回非零值。

当 MATLAB 选择发送分块消息时,每个块的大小等于 getData 返回的数据长度。

MATLAB 在调用 complete 方法之后、调用 start 之前读取此值。它不会设置此字段。

属性:

GetAccess
public
SetAccess
public

要发送的请求消息,指定为 matlab.net.http.RequestMessage 对象。

此属性仅由子类编写者使用。在调用此使用程序中的其他方法之前,以及在添加其他标头字段或验证消息之前,RequestMessage.sendRequestMessage.complete 方法将此属性设置为此提供程序原来所在的 BodyRequestMessage。提供程序可以检查此消息,以查看原始请求中包含的内容。

代理与委托方看到的此属性值是相同的。ContentProviders 应该明白,如果它们是代理,则不一定提供请求消息的完整主体,因此不应该假定此 Request 中的标头字段与它们提供的数据相关。通常,代理应忽略此请求中与数据相关的标头字段,例如 Content-Type。

如果提供程序希望为此消息添加任何标头字段或修改现有标头字段,应在其 complete 方法中将这些字段添加到 Header 属性中。complete 的调用方(RequestMessage 或委托方提供程序)决定如何处理这些字段。RequestMessage.sendRequestMessage.complete 始终将这些字段复制到 RequestMessageHeader 中。委托方提供程序可将这些字段复制到自己的 Header 属性中,或者将它们插入到消息中(就像在 MultipartProvider 中那样)。有关详细信息,请参阅 Header 属性。

此属性是只读的。

属性:

GetAccesspublic
SetAccessmatlab.net.http.RequestMessage

受保护的属性

接受此提供程序委托的 ContentProvider,指定为 matlab.net.http.io.ContentProvider 对象。此属性在调用方提供程序(委托方)中由 delegateTo 方法设置,以指示当前接受委托的提供程序。如果当前没有委托,则此值为空。

complete 方法将此属性设置为空。

属性:

GetAccess
protected
SetAccess
protected

向此提供程序进行委托的 ContentProvider,指定为 matlab.net.http.io.ContentProvider 对象。

如果 ContentProvider 将发送全部或部分消息数据的责任委托给另一个提供程序,则此属性向代理标识委托方提供程序。例如,MultipartProvider 将消息的各个部分委托给其他提供程序,因此它会在每个代理中插入自己的句柄。否则,MyDelegator 为空。delegateTo 方法在代理中设置此属性。

属性:

GetAccess
protected
SetAccess
protected

方法

全部展开

详细信息

全部展开

版本历史记录

在 R2018a 中推出