如何使用ServiceStack客户端来使用文件

本文关键字：文件 客户端 何使用 ServiceStack | 更新日期: 2023-09-27 17:50:35

我正在尝试使用ServiceStack以RESTful方式将文件返回给ServiceStack客户端。

我在SO(这里和这里)上读过其他问题，建议使用HttpResult和FileInfo对象或MemoryStream来允许ContentType头更改为相关的文件类型。

当我通过浏览器调用该服务时，正确的文件自动开始下载。但是，我如何使用ServiceStack客户机之一来使用该文件呢?

我正在使用请求DTO并尝试使用类似于

的东西返回
return new HttpResult(new FileInfo("file.xml"), asAttachment:true) {
   ContentType = "text/xml"
};
例如，我将如何使用JsonServiceClient ?

如何使用ServiceStack客户端来使用文件

我有一个类似的需求，它也要求我跟踪流文件下载的进度。我大致是这样做的:

端:

服务:

public object Get(FooRequest request)
{
    var stream = ...//some Stream
    return new StreamedResult(stream);
}

StreamedResult类:

public class StreamedResult : IHasOptions, IStreamWriter
{
    public IDictionary<string, string> Options { get; private set; }
    Stream _responseStream;
    public StreamedResult(Stream responseStream)
    {
        _responseStream = responseStream;
        long length = -1;
        try { length = _responseStream.Length; }
        catch (NotSupportedException) { }
        Options = new Dictionary<string, string>
        {
            {"Content-Type", "application/octet-stream"},
            { "X-Api-Length", length.ToString() }
        };
    }
    public void WriteTo(Stream responseStream)
    {
        if (_responseStream == null)
            return;
        using (_responseStream)
        {
            _responseStream.WriteTo(responseStream);
            responseStream.Flush();
        }
    }
}

客户端: 

string path = Path.GetTempFileName();//in reality, wrap this in try... so as not to leave hanging tmp files
var response = client.Get<HttpWebResponse>("/foo/bar");
long length;
if (!long.TryParse(response.GetResponseHeader("X-Api-Length"), out length))
    length = -1;
using (var fs = System.IO.File.OpenWrite(path))
    fs.CopyFrom(response.GetResponseStream(), new CopyFromArguments(new ProgressChange((x, y) => { Console.WriteLine(">> {0} {1}".Fmt(x, y)); }), TimeSpan.FromMilliseconds(100), length));

"CopyFrom"扩展方法直接从这个项目的源代码文件"StreamHelper.cs"中借用:复制一个带有进度报告的流(向Henning Dieterichs致敬)

向mythz和ServiceStack的任何贡献者致敬。伟大的项目!

你不会使用ServiceStack的。net服务客户端来消费文件，因为它们主要用于发送DTO。

你可以使用任何正常的WebRequest来下载文件，在ServiceStack的v3.9.33中引入了一些方便的WebRequest扩展HTTP Utils，使这变得容易，例如:

对于文本文件:

var xmlFile = downloadUrl.GetXmlFromUrl(responseFilter: httpRes => {
        var fileInfoHeaders = httpRes.Headers[HttpHeaders.ContentDisposition];
    });

fileInfoHeaders包含W3C ContentDisposition HTTP报头，例如，当返回FileInfo时，ServiceStack返回:

attachment;filename="file.xml";size={bytesLen};
creation-date={date};modification-date={date};read-date={date};

要下载二进制文件，可以使用:

var rawBytes = downloadUrl.GetBytesFromUrl(httpRes => ...);

我发现mythz的答案工作得很好，但也可以使用他们内置的JSonServiceClient来处理文件请求，只是以一种稍微不直观的方式，因为你不能实际使用你所期望的返回类型。

对于这样的模型定义:

[Route("/filestorage/outgoing/{Name}.{Extension}", "GET")]
[Route("/filestorage/outgoing", "GET")]
public class GetFileStorageStream : IReturn<HttpResult>
{
    public string Name { get; set; }
    public string Extension { get; set; }
    public bool ForDownload { get; set; }
}

你可以定义你的服务返回HttpResult:

public class FileStorageService : Service
{
    public HttpResult Get(GetFileStorageStream fileInformation)
    {
        var internalResult = GetFromFileStorage(fileInformation);
        var fullFilePath = Path.Combine("C:'Temp", internalResult.FileName);
        return new HttpResult(new FileInfo(fullFilePath), asAttachment: fileInformation.ForDownload);
    }
}

然后在客户端，你可以使用这个Get模板来正确地获取web上下文:

var client = new JsonServiceClient("http://localhost:53842");
var httpResponse = client.Get<HttpWebResponse>("/filestorage/outgoing/test.jpg");
pictureBox1.Image = Image.FromStream(httpResponse.GetResponseStream());

我发现使用新的API Get方法是不可能的，因为它们会试图反序列化HttpResult，它实际上不是一个真正的返回类型，而是一个代表服务堆栈创建的web上下文的类。

您可以在使用响应过滤器处理响应之前拦截响应，如下所示:

ServiceClientBase.HttpWebResponseFilter = response =>
{
    if (response.Headers["Content-Disposition"] != null)
    {
        var t = response.DownloadText();
        Console.WriteLine(t);
    }
};

然而，这不是处理它的最好方法，因为当客户端试图读取响应流(因为它之前已经被response.DownloadFile(...)读取)时，对client.Method()的实际调用将导致ArgumentException。我还没有找到一个优雅地处理它的方法，但如果我找到了，我会更新我的答案。

相关文章：