HttpContent Klasse

Definition

public ref class HttpContent abstract : IDisposable

public abstract class HttpContent : IDisposable

type HttpContent = class
    interface IDisposable

Public MustInherit Class HttpContent
Implements IDisposable

Vererbung

Object

HttpContent

Abgeleitet

System.Net.Http.ByteArrayContent

System.Net.Http.MultipartContent

System.Net.Http.ReadOnlyMemoryContent

System.Net.Http.StreamContent

Implementiert

IDisposable

Beispiele

Das folgende Beispiel zeigt eine benutzerdefinierte Implementierung von HttpContent. Einige Methoden sollten trotz der Definition als virtual und nicht abstractin der Implementierung für ein optimales Verhalten überschrieben werden.

public class MyContent : HttpContent
{
    private readonly string _data;
    public MyContent(string data)
    {
        _data = data;
    }

    // Minimal implementation needed for an HTTP request content,
    // i.e. a content that will be sent via HttpClient, contains the 2 following methods.
    protected override bool TryComputeLength(out long length)
    {
        // This content doesn't support pre-computed length and
        // the request will NOT contain Content-Length header.
        length = 0;
        return false;
    }

    // SerializeToStream* methods are internally used by CopyTo* methods
    // which in turn are used to copy the content to the NetworkStream.
    protected override Task SerializeToStreamAsync(Stream stream, TransportContext? context)
        => stream.WriteAsync(Encoding.UTF8.GetBytes(_data)).AsTask();

    // Override SerializeToStreamAsync overload with CancellationToken
    // if the content serialization supports cancellation, otherwise the token will be dropped.
    protected override Task SerializeToStreamAsync(Stream stream, TransportContext? context, CancellationToken cancellationToken)
        => stream.WriteAsync(Encoding.UTF8.GetBytes(_data), cancellationToken).AsTask();

    // In rare cases when synchronous support is needed, e.g. synchronous CopyTo used by HttpClient.Send,
    // implement synchronous version of SerializeToStream.
    protected override void SerializeToStream(Stream stream, TransportContext? context, CancellationToken cancellationToken)
        => stream.Write(Encoding.UTF8.GetBytes(_data));

    // CreateContentReadStream* methods, if implemented, will be used by ReadAsStream* methods
    // to get the underlying stream and avoid buffering.
    // These methods will not be used by HttpClient on a custom content.
    // They are for content receiving and HttpClient uses its own internal implementation for an HTTP response content.
    protected override Task<Stream> CreateContentReadStreamAsync()
        => Task.FromResult<Stream>(new MemoryStream(Encoding.UTF8.GetBytes(_data)));

    // Override CreateContentReadStreamAsync overload with CancellationToken
    // if the content serialization supports cancellation, otherwise the token will be dropped.
    protected override Task<Stream> CreateContentReadStreamAsync(CancellationToken cancellationToken)
        => Task.FromResult<Stream>(new MemoryStream(Encoding.UTF8.GetBytes(_data))).WaitAsync(cancellationToken);

    // In rare cases when synchronous support is needed, e.g. synchronous ReadAsStream,
    // implement synchronous version of CreateContentRead.
    protected override Stream CreateContentReadStream(CancellationToken cancellationToken)
        => new MemoryStream(Encoding.UTF8.GetBytes(_data));
}

Hinweise

Es gibt verschiedene HTTP-Inhalte, die verwendet werden können. Im Folgenden finden sind einige Beispiele für solche Umstände.

1. ByteArrayContent - Ein durch ein Bytearray dargestellter Inhalt dient auch als Basisklasse für StringContent und FormUrlEncodedContent.

2. StringContent - Ein zeichenfolgenbasierter Inhalt, standardmäßig serialisiert wie text/plainContent-Type mit UTF-8 Codierung.

3. FormUrlEncodedContent - Ein Inhalt mit Name/Wert-Tupeln serialisiert als application/x-www-form-urlencodedContent-Type.

4. MultipartContent - Ein Inhalt, der mehrere verschiedene HttpContent Objekte serialisieren kann als multipart/*Content-Type.

5. JsonContent – Ein Inhalt, der Objekte standardmäßig serialisiert, wie application/jsonContent-Type bei der UTF-8 Codierung.

HTTP-Inhaltsklasse kann von einem Benutzer abgeleitet werden, um benutzerdefinierte Inhalts serialisierungslogik bereitzustellen.