从 WebApi 返回图像

Question

我正在制作一个 Web Api，我需要向客户端返回多个图像。我目前为每个图像使用 Base64 字符串，但这会导致每个请求花费的时间太长。有没有更好、更高效的图片返回方式？

这是我正在使用的代码：

控制器：

    public LearningUnits GetLearningUnits([FromODataUri]Guid key)
    {
        var record = db.LearningUnits.SingleOrDefault(inst => inst.LearningUnitId == key);

        record.ImageURLPath = ImageHandler.ImageToByteArrayFromFilePath(record.ImageURLPath);

        return record;
    }

ImageToByteArray 方法：

    public static string ImageToByteArrayFromFilePath(string imagefilePath)
    {
        byte[] imageArray = File.ReadAllBytes(imagefilePath);

        string baseImage = Convert.ToBase64String(imageArray);

        return baseImage;
    }

Answer 1

如果端点返回 json，那么除了base64，没有其他方法可以在响应中嵌入二进制文件。但由于性能问题，这绝对是一个坏主意。可能对于某些图标来说还可以，但对于较大的图像则不合适。

因此，这里最好的解决方案是将 url 返回到图像。客户端将进一步请求获取图像的原始字节。

另外值得一提的是，图像 url 不仅可以是静态文件的路径，还可以是某个 webapi 端点的路径，例如，通过资源 id 获取图像字节并发送客户端原始二进制文件返回，而不是 json 字符串。

Answer 2

解决方案是使用媒体格式化程序，这样当使用特定类型查询 Web API 时，您将收到特定类型的实际二进制流。

http://www.asp.net/web-api/overview/formats-and-model-binding/media-formatters

这是标准的 RESTful 模式；您有相同的 URL，但是当您想要数据的 JSON 记录时，您接受类型：应用程序/json，但是当您想要该媒体类型时，您将 MIME 请求类型更改为 image/png 或类似的东西。

更多信息可以在这里找到： How to provide custom mediatype formats for OData Api

Odata 也在这里隐式支持它：https://msdn.microsoft.com/en-us/library/system.web.http.odata.formatter.odatamediatypeformatter(v=vs.118).aspx