默认消息协定示例演示了一个服务,在该服务中,用户定义的自定义消息会在服务操作来回传递。 此示例基于Getting Started实现将计算器接口作为类型化的服务。 而不是为加法、 减法、 乘法和除法中使用的各个服务操作Getting Started,此示例还传递包含操作数和运算符,并返回的自定义消息算术计算的结果。
客户端是一种控制台程序 (.exe),服务库 (.dll) 是由 Internet 信息服务 (IIS) 承载的。 客户端活动显示在控制台窗口中。
Note: 本主题的最后介绍了此示例的设置过程和生成说明。
在服务中,定义了单个服务操作,该操作接受和返回 MyMessage 类型的自定义消息。 在该示例中,尽管请求消息和响应消息属于同一种类型,但必要时当然也可以属于不同的消息协定。
[ServiceContract(Namespace="http://Microsoft.ServiceModel.Samples")]
public interface ICalculator
{
[OperationContract(Action="http://test/MyMessage_action",
ReplyAction="http://test/MyMessage_action")]
MyMessage Calculate(MyMessage request);
}
自定义消息 MyMessage 是在用 xref:System.ServiceModel.MessageContractAttribute、xref:System.ServiceModel.MessageHeaderAttribute 和 xref:System.ServiceModel.MessageBodyMemberAttribute 属性进行批注的类中定义的。 本示例中只使用第三个构造函数。 使用消息协定,您可以对 SOAP 消息进行完全控制。 在本示例中,xref:System.ServiceModel.MessageHeaderAttribute 属性用来将 Operation 放在 SOAP 头中。 操作数 N1 和 N2 以及 Result 出现在 SOAP 正文中,因为它们应用了 xref:System.ServiceModel.MessageBodyMemberAttribute 属性。
[MessageContract]
public class MyMessage
{
private string operation;
private double n1;
private double n2;
private double result;
//Constructor - create an empty message.
public MyMessage() {}
//Constructor - create a message and populate its members.
public MyMessage(double n1, double n2, string operation,
double result)
{
this.n1 = n1;
this.n2 = n2;
this.operation = operation;
this.result = result;
}
//Constructor - create a message from another message.
public MyMessage(MyMessage message)
{
this.n1 = message.n1;
this.n2 = message.n2;
this.operation = message.operation;
this.result = message.result;
}
[MessageHeader]
public string Operation
{
get { return operation; }
set { operation = value; }
}
[MessageBodyMember]
public double N1
{
get { return n1; }
set { n1 = value; }
}
[MessageBodyMember]
public double N2
{
get { return n2; }
set { n2 = value; }
}
[MessageBodyMember]
public double Result
{
get { return result; }
set { result = value; }
}
}
实现类包含 Calculate 服务操作的代码。 CalculateService 类从请求消息获取操作数和运算符,并创建一条包含所请求的计算的结果的响应消息,如下面的示例代码所示。
// Service class which implements the service contract.
public class CalculatorService : ICalculator
{
// Perform a calculation.
public MyMessage Calculate(MyMessage request)
{
MyMessage response = new MyMessage(request);
switch (request.Operation)
{
case "+":
response.Result = request.N1 + request.N2;
break;
case "-":
response.Result = request.N1 - request.N2;
break;
case "*":
response.Result = request.N1 * request.N2;
break;
case "/":
response.Result = request.N1 / request.N2;
break;
default:
response.Result = 0.0D;
break;
}
return response;
}
}
客户端生成的客户端代码使用创建ServiceModel Metadata Utility Tool (Svcutil.exe)工具。 在必要时,该工具会自动在所生成的客户端代码中创建消息协定类型。 可以指定 /messageContract 命令选项来强制生成消息协定。
svcutil.exe /n:"http://Microsoft.ServiceModel.Samples,Microsoft.ServiceModel.Samples" /o:client\generatedClient.cs http://localhost/servicemodelsamples/service.svc/mex
下面的示例代码演示使用 MyMessage 消息的客户端。
// Create a client with given client endpoint configuration
CalculatorClient client = new CalculatorClient();
// Perform addition using a typed message.
MyMessage request = new MyMessage()
{
N1 = 100D,
N2 = 15.99D,
Operation = "+"
};
MyMessage response = ((ICalculator)client).Calculate(request);
Console.WriteLine("Add({0},{1}) = {2}", request.N1, request.N2, response.Result);
运行示例时,计算结果将显示在客户端控制台窗口中。 在客户端窗口中按 Enter 可以关闭客户端。
Add(100,15.99) = 115.99
Subtract(145,76.54) = 68.46
Multiply(9,81.25) = 731.25
Divide(22,7) = 3.14285714285714
Press <ENTER> to terminate client.
此时,用户定义的自定义消息已经在客户端和服务操作之间传递。 消息协定进行了如下定义:操作数和结果位于消息正文中,运算符位于消息头中。 消息日志记录可以配置为遵守这个消息结构。
设置、生成和运行示例
-
若要生成 C# 或 Visual Basic .NET 版本的解决方案,请按照 Building the Windows Communication Foundation Samples中的说明进行操作。
-
若要在单或跨计算机配置中运行示例,请按照中的说明运行 Windows Communication Foundation 示例。
Important: 您的计算机上可能已安装这些示例。 在继续操作之前,请先检查以下(默认)目录:
<InstallDrive>:\WF_WCF_Samples如果此目录不存在,请转到Windows Communication Foundation (WCF) 和.NET Framework 4 的 Windows Workflow Foundation (WF) 示例若要下载所有 Windows Communication Foundation (WCF) 和WF示例。 此示例位于以下目录:
<InstallDrive>:\WF_WCF_Samples\WCF\Basic\Contract\Message\Default
历史资料。此文对应 2019-08-18 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站展开固定版本仓库内的引用内容,将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。
