在 WebService 中发布一个方法很简单,只要将你要发布的方法用 System.Web.Services.WebMethodAttribute 属性类来标识出就可以了,但是该属性只能应用于方法而不能应用到属性。该类的MSDN文档可以见到(C#):
[AttributeUsage(AttributeTargets.Method)]
public sealed class WebMethodAttribute : Attribute
那么,如果我们需要将一个属性也发布成一个Web方法,该如何做呢?在讨论这个问题之前,先来看看为什么我们需要发布属性为一个Web方法?因为有人可能会这么告诉你,你可以把你的属性改写成两个对应的getXXXXX/setXXXXX方法来分别发布成WebMethod。哦,是的,这么做看似可以达到目的,但是这样做损害了我们的接口定义,使得我们无法享受属性为我们所带来的快乐(请不要问我是什么快乐),其实最重要的一个原因就是无法完成对接口的实现了,此话怎讲?且看下面代码(C#):
public interface IDataService
{
// 该属性指示当前使用的是什么数据库系统(例如:MS-SQLServer、Orcale、IBM-DB2 等等)
int DataProvider
{
get;
}
// 该方法执行一段指定的SQL脚本,并返回其结果集
System.Data.DataSet Execute(String sqlText);
// 该方法将指定的数据集保存到数据库中
void Update(System.Data.DataSet dataSet);
}
现在我们写一个 WebService 其需要实现 IDataService 接口,必须在该 WebService 中包含并发布该属性。这时我们该怎么办?呵呵,且看
public class DataService : System.Web.Services.WebSerbice, IDataService
{
...
public int DataProvider
{
[WebMethod(MessageName="GetDataProvider")]
get
{
...
}
}
[WebMethod()]
public System.Data.DataSet Execute(String sqlText)
{
...
}
}
OK,大家看到了,将一个方法发布成Web方法是在其函数体前指定 WebMethod 属性,而属性则是在其get或set器之前指定 WebMethod 属性,如果不指定属性的 MessageName 属性值,则发布的属性的Web方法名将被置为get_XXXXX和set_XXXXX。
在使用VS.net生成的 WebService 代理类(通过添加Web引用,Reference.cs)中的成员都是方法,因此需要手动修改代理类中的相关方法为属性,例如上例的本地代理类的相关代码看起来是这样的:
[System.Web.Services.Protocols.SoapDocumentMethodAttribute(... ...)]
[return: System.Xml.Serialization.XmlElementAttribute("GetDataProviderResult")]
public int GetDataProvider()
{
object[] results = this.Invoke("GetDataProvider", new object[0]);
return (int)results[0];
}
那么,你只需将该方法的主体部分大概改成这个样子即可:
public int GetDataProvider
{
[System.Web.Services.Protocols.SoapDocumentMethodAttribute(... ...)]
[return: System.Xml.Serialization.XmlElementAttribute("GetDataProviderResult")]
get
{
object[] results = this.Invoke("GetDataProvider", new object[0]);
return (int)results[0];
}
}