您可以在转换为 C# 对象的 JSON 中序列化 ByteArrayContent 吗？

Posted 2023-04-12

【中文标题】您可以在转换为 C# 对象的 JSON 中序列化 ByteArrayContent 吗？

【英文标题】：Can you serialize ByteArrayContent in a JSON that translates to C# object?

【发布时间】：2021-06-17 00:07:53

【问题描述】：

我在 VS Studio 中编写了一个 C# Web API，并创建了许多 DTO，这些 DTO 被序列化为任何客户端都可以使用的 JSON 实体。我的 API 调用之一是返回 PDF 文件，因此经过一些在线研究，我设置了一个 DTO，其设置为以下格式。我在某处读到你可以做到这一点，但不是 100% 确定：

public class MyCustomResult

   public bool Success;
   public DateTime? LastRunDate;
   public string ErrorCode;
   public string Message;
   public ByteArrayContent ReportBody;

将对象作为 IHttpActionResult 返回时没有任何错误：

return Ok(result);

我可以在服务器上看到报告字节[] 的字节大小约为 700K。但是，当我在客户端检索对象时，JSON 实体大约为 400B，并且 ByteContentStream 中没有字节内容。当我在 Postman 中运行查询时，我得到一个空 Header，因此 Newtonsoft JSON 似乎无法序列化 ByteContentStream。

有什么我应该考虑的选择吗？

【问题讨论】：

你不会使用ByteArrayContent，你只会使用byte[]。 Newtonsoft 会将其序列化为 Base64 字符串。消费者必须将 base64 字符串解码回 byte[]，或者如果它是另一个 Newtonsoft 客户端，它会自动为您完成。 ByteArrayContent 是 HttpContent 的实现，它应该只用作响应体。它不能与 JSON 响应一起使用。

啊，所以 C# 对象中的参数将是“byte[]”。好的，让我试一试，如果一切正常，我将编辑/更新答案。

我将添加一个答案，使其更正式/更容易理解。

【参考方案1】：

这是一个使用 ByteArrayContent 的场景：

using(var req = new HttpRequestMessage(HttpMethod.Post, new Uri("https://example.com"))

    req.Content = new ByteArrayContent(...);
    using(var resp = await _client.SendAsync(req))
    
        var data = await resp.Content.ReadAsAsync<object>();
    

你想做的是：

public class MyCustomResult

   public bool Success;
   public DateTime? LastRunDate;
   public string ErrorCode;
   public string Message;
   public byte[] ReportBody; // <-- change this to byte[]


var dataToSend = new MyCustomResult(); // fill this in

using(var req = new HttpRequestMessage(HttpMethod.Post, new Uri("https://example.com"))

    req.Content = new StringContent(
        JsonConvert.SerializeObject(dataToSend, Encoding.UTF8, "application/json"));
    using(var resp = await _client.SendAsync(req))
    
        var data = await resp.Content.ReadAsAsync<object>();
    

(注意：此代码未经测试)

所以SerializeObject 会将该字节数组转换为 Base64 字符串然后发送。

然后，消费者必须对该 Base64 字符串进行解码。如果它是另一个 Newtonsoft.Json 客户端并且模型定义匹配，那么它会自动为您解码。

我了解您正在做一个 API 端点。上面的例子是为了展示ByteArrayContent 的使用以及它为什么存在于.NET 中。您返回数据的方式是正确的：return Ok(response);，只要您修复模型即可。

总结一下：

ByteArrayContent 是HttpContent 的一个实现，它应该仅用作响应正文。它不能与 JSON 响应一起使用。