HttpContent Klas

Definitie

public ref class HttpContent abstract : IDisposable

public abstract class HttpContent : IDisposable

type HttpContent = class
    interface IDisposable

Public MustInherit Class HttpContent
Implements IDisposable

Overname

Object

HttpContent

Afgeleid

System.Net.Http.ByteArrayContent

System.Net.Http.MultipartContent

System.Net.Http.ReadOnlyMemoryContent

System.Net.Http.StreamContent

Implementeringen

IDisposable

Voorbeelden

In het volgende voorbeeld ziet u een aangepaste implementatie van HttpContent. Sommige methoden, ondanks dat ze zijn gedefinieerd als virtual en niet abstract, moeten nog steeds worden overschreven in de implementatie voor optimaal gedrag.

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));
}

Opmerkingen

Er zijn verschillende HTTP-inhoud die kan worden gebruikt. Deze omstandigheden zijn:

1. ByteArrayContent - Een inhoud die wordt vertegenwoordigd door een bytematrix, fungeert ook als basisklasse voor StringContent en FormUrlEncodedContent.

2. StringContent - Een inhoud op basis van tekenreeksen, standaard geserialiseerd als text/plainContent-Type met UTF-8 codering.

3. FormUrlEncodedContent - Een inhoud met tuples met naam/waarde geserialiseerd als application/x-www-form-urlencodedContent-Type.

4. MultipartContent - Een inhoud die meerdere verschillende HttpContent objecten kan serialiseren als multipart/*Content-Type.

5. JsonContent - Een inhoud waarmee objecten standaard worden geserialiseerd als application/jsonContent-Type met UTF-8 codering.

HTTP-inhoudsklasse kan worden afgeleid door een gebruiker om aangepaste logica voor inhoudsserialisatie te bieden.