使用 WCF Web HTTP 编程模型创建返回任意数据的服务

时间：2023-01-04 13:20:51

有时，开发人员必须完全控制从服务操作返回数据的方式。 当服务操作必须以 WCF 不支持的格式返回数据时，就会出现这种情况。 本主题讨论使用 WCF WEB HTTP 编程模型来创建此类服务。 此服务具有一个返回流的操作。

实现服务协定

  1. 定义服务协定。 该协定名为 IImageServer，具有一个名为 GetImage 的方法，该方法返回 Stream。

    复制 
    [ServiceContract]
    public interface IImageServer
    {
        [WebGet]
        Stream GetImage(int width, int height);
    }

    由于该方法返回 Stream，因此 WCF 假定服务操作返回的字节由该操作完全控制，自己无需对返回的数据应用任何格式设置。

  2. 实现服务协定。 该协定只有一个操作：GetImage。 此方法生成一个位图，再以 .jpg 格式将其保存到 MemoryStream。 随后，操作将该流返回给调用方。

    复制 
     public class Service : IImageServer
    {
        public Stream GetImage(int width, int height)
        {
            Bitmap bitmap = new Bitmap(width, height);
            for (int i = 0; i < bitmap.Width; i++)
            {
                for (int j = 0; j < bitmap.Height; j++)
                {
                    bitmap.SetPixel(i, j, (Math.Abs(i - j) < 2) ? Color.Blue : Color.Yellow);
                }
            }
            MemoryStream ms = new MemoryStream();
            bitmap.Save(ms, System.Drawing.Imaging.ImageFormat.Jpeg);
            ms.Position = 0;
            WebOperationContext.Current.OutgoingResponse.ContentType = "image/jpeg";
            return ms;
        }
    }

    请注意代码的倒数第二行：WebOperationContext.Current.OutgoingResponse.ContentType = "image/jpeg";

    这是将内容类型标头设置为 “image/jpeg”。虽然此示例演示如何返回 .jpg 文件，但可以对其进行修改，以任意格式返回所需的任意类型的数据。该操作必须检索或生成数据，然后将它写入流。

承载服务

  1. 创建用于承载服务的控制台应用程序。

    复制 
    class Program
{
    static void Main(string[] args)
    {
    } 
}

  2. 在 Main 方法中创建一个变量以保存服务的基址。

    复制 
    string baseAddress = "http://" + Environment.MachineName + ":8000/Service";

  3. 为服务创建一个 ServiceHost 实例，指定服务类和基址。

    复制 
    ServiceHost host = new ServiceHost(typeof(Service), new Uri(baseAddress));

  4. 使用 WebHttpBinding 和 WebHttpBehavior 添加一个终结点。

    复制 
    host.AddServiceEndpoint(typeof(IImageServer), new WebHttpBinding(), "").Behaviors.Add(new WebHttpBehavior());

  5. 打开服务主机。

    复制 
    host.Open()

  6. 等待用户按 Enter 终止服务。

    复制 
    Console.WriteLine("Service is running");
Console.Write("Press ENTER to close the host");
Console.ReadLine();
host.Close();

使用 Internet Explorer 调用原始服务

  1. 运行该服务，您应看到来自它的以下输出。 Service is running Press ENTER to close the host

  2. 打开 Internet Explorer 并键入 http://localhost:8000/Service/GetImage?width=50&height=40，您应看到一个黄色矩形，有蓝色对角线穿过其中心。

下面列出了此主题的完整代码。

复制 
using System;
using System.Collections.Generic;
using System.Text;
using System.ServiceModel;
using System.ServiceModel.Web;
using System.ServiceModel.Description;
using System.IO;
using System.Drawing;


namespace RawImageService
{
    // Define the service contract
    [ServiceContract]
    public interface IImageServer
    {
        [WebGet]
        Stream GetImage(int width, int height);
    }

    // implement the service contract
    public class Service : IImageServer
    {
        public Stream GetImage(int width, int height)
        {
            // Although this method returns a jpeg, it can be
            // modified to return any data you want within the stream
            Bitmap bitmap = new Bitmap(width, height);
            for (int i = 0; i < bitmap.Width; i++)
            {
                for (int j = 0; j < bitmap.Height; j++)
                {
                    bitmap.SetPixel(i, j, (Math.Abs(i - j) < 2) ? Color.Blue : Color.Yellow);
                }
            }
            MemoryStream ms = new MemoryStream();
            bitmap.Save(ms, System.Drawing.Imaging.ImageFormat.Jpeg);
            ms.Position = 0;
            WebOperationContext.Current.OutgoingResponse.ContentType = "image/jpeg";
            return ms;
        }
    }

    class Program
    {
        static void Main(string[] args)
        {
            string baseAddress = "http://" + Environment.MachineName + ":8000/Service";
            ServiceHost host = new ServiceHost(typeof(Service), new Uri(baseAddress));
            host.AddServiceEndpoint(typeof(IImageServer), new WebHttpBinding(), "").Behaviors.Add(new WebHttpBehavior());
            host.Open();
            Console.WriteLine("Service is running");
            Console.Write("Press ENTER to close the host");
            Console.ReadLine();
            host.Close();

        }
    }
}

  • 编译示例代码时，请引用 System.ServiceModel.dll 和 System.ServiceModel.Web.dll。

标签：

相关文章