返回List< object>以Csv格式作为响应WCF c#
本文关键字:响应 WCF 格式 Csv List object 返回 | 更新日期: 2023-09-27 18:06:18
我想从我的WCF方法返回我的类对象的列表作为csv文件。我尝试使用MediaTypeFormatter在这里给出自定义格式化器
但是我无法在WCF服务方法中实现这一点。在WCF中有实现这一点的方法吗?我能以某种方式在ResponseFormat中设置我的自定义格式化器吗?我正在寻找直接将我的列表转换为csv的解决方案。我在服务接口中定义了一个简单的服务方法:
[OperationContract]
[WebInvoke(Method = "GET", BodyStyle = WebMessageBodyStyle.Bare, UriTemplate = "GetDNCList")]
List<DNC> GetDNCList();
这个列表应该以csv文件的形式发送给用户
自定义格式化器(和MediaTypeFormatter
)在ASP. js中使用。. NET Web API框架,而不是WCF。在这个框架中,您需要使用IDispatchMessageFormatter
来控制响应的格式化方式。http://blogs.msdn.com/b/carlosfigueira/archive/2011/05/03/wcf-extensibility-message-formatters.aspx上的帖子有关于如何实现这一点的详细信息,下面的代码显示了为WCF实现CSV格式化器的一种方法。
public class StackOverflow_23979866
{
public class DNC
{
public string Field1 { get; set; }
public string Field2 { get; set; }
public string Field3 { get; set; }
}
[ServiceContract]
public interface ITest
{
[OperationContract]
[WebInvoke(Method = "GET", BodyStyle = WebMessageBodyStyle.Bare, UriTemplate = "GetDNCList")]
List<DNC> GetDNCList();
}
public class Service : ITest
{
public List<DNC> GetDNCList()
{
return new List<DNC>
{
new DNC { Field1 = "Value 1-1", Field2 = "Value 2-1", Field3 = "Value 3-1" },
new DNC { Field1 = "Value 1-2", Field2 = "Value 2-2", Field3 = "Value 3-2" },
new DNC { Field1 = "Value 1-3", Field2 = "Value 2-3", Field3 = "Value 3-3" },
};
}
}
public class MyWebHttpBehavior : WebHttpBehavior
{
protected override IDispatchMessageFormatter GetReplyDispatchFormatter(OperationDescription operationDescription, ServiceEndpoint endpoint)
{
if (operationDescription.Name == "GetDNCList")
{
return new MyListOfDNCReplyFormatter();
}
else
{
return base.GetReplyDispatchFormatter(operationDescription, endpoint);
}
}
}
public class MyListOfDNCReplyFormatter : IDispatchMessageFormatter
{
public void DeserializeRequest(Message message, object[] parameters)
{
throw new NotSupportedException("This is a reply-only formatter");
}
public Message SerializeReply(MessageVersion messageVersion, object[] parameters, object result)
{
List<DNC> list = (List<DNC>)result;
StringBuilder sb = new StringBuilder();
sb.AppendLine("'"Field1'",'"Field2'",'"Field3'"");
foreach (var dnc in list)
{
// may need to escape, leaving out for brevity
sb.AppendLine(string.Format("'"{0}'",'"{1}'",'"{2}'"", dnc.Field1, dnc.Field2, dnc.Field3));
}
Message reply = Message.CreateMessage(messageVersion, null, new RawBodyWriter(sb.ToString()));
reply.Properties.Add(WebBodyFormatMessageProperty.Name, new WebBodyFormatMessageProperty(WebContentFormat.Raw));
HttpResponseMessageProperty httpResp = new HttpResponseMessageProperty();
reply.Properties.Add(HttpResponseMessageProperty.Name, httpResp);
httpResp.Headers[HttpResponseHeader.ContentType] = "text/csv";
return reply;
}
class RawBodyWriter : BodyWriter
{
string contents;
public RawBodyWriter(string contents)
: base(true)
{
this.contents = contents;
}
protected override void OnWriteBodyContents(XmlDictionaryWriter writer)
{
writer.WriteStartElement("Binary");
byte[] bytes = Encoding.UTF8.GetBytes(this.contents);
writer.WriteBase64(bytes, 0, bytes.Length);
writer.WriteEndElement();
}
}
}
public static void Test()
{
string baseAddress = "http://" + Environment.MachineName + ":8000/Service";
ServiceHost host = new ServiceHost(typeof(Service), new Uri(baseAddress));
ServiceEndpoint endpoint = host.AddServiceEndpoint(typeof(ITest), new WebHttpBinding(), "");
endpoint.Behaviors.Add(new MyWebHttpBehavior());
host.Open();
Console.WriteLine("Host opened");
WebClient c = new WebClient();
Console.WriteLine(c.DownloadString(baseAddress + "/GetDNCList"));
Console.Write("Press ENTER to close the host");
Console.ReadLine();
host.Close();
}
}