[转][WebServices] 之二:支持的数据类型
ASP.NET WebService 支持绝大多数的基元类型及其数组,另外还支持自定义的结构(Struct)、类型(Class)、枚举(Enum)、DataSet、XmlElement、XmlNode、集合(IEnumerable/ICollection)等。
ASP.NET WebService 使用 XmlSerializer 进行序列化操作,对于自定义类型要注意以下几点:
1. 只能序列化可读写公共属性和字段。只读属性(get;)、只读字段(readonly)、常量(const)以及所有的非 public 数据成员都不会被序列化。
2. 自定义类型必须具有不接受任何参数的默认构造函数。
3. 不能序列化方法。客户端生成的代理对象不包含任何自定义类型方法(不是WebMethod)。
基于以上几点,因此我们最好只定义纯粹用来传输复合数据的数据类型(Data Object)。
以下是一些演示代码。
基元类型
枚举 Enum
结构 Struct
结构体默认就会创建无参数构造方法,且不允许自定义。
类型 Class
有关数据类型的更详细信息,请查看 MSDN 文档。
ms-help://MS.MSDNQTR.v80.chs/MS.MSDN.v80/MS.VisualStudio.v80.chs/dv_fxwebservices/html/70567d9f-6e53-42a8-bbd5-aee42b25dd28.htm
ASP.NET WebService 使用 XmlSerializer 进行序列化操作,对于自定义类型要注意以下几点:
1. 只能序列化可读写公共属性和字段。只读属性(get;)、只读字段(readonly)、常量(const)以及所有的非 public 数据成员都不会被序列化。
2. 自定义类型必须具有不接受任何参数的默认构造函数。
3. 不能序列化方法。客户端生成的代理对象不包含任何自定义类型方法(不是WebMethod)。
基于以上几点,因此我们最好只定义纯粹用来传输复合数据的数据类型(Data Object)。
以下是一些演示代码。
基元类型
[WebService(Namespace = "http://www.rainsts.net/", Description="我的Web服务")] [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)] public class WebService : System.Web.Services.WebService { public WebService () { } [WebMethod] public DateTime GetNowTime() { return DateTime.Now; } [WebMethod] public string[] GetStringArray() { return new string[] { "a", "b", "c"}; } [WebMethod] public float[] GetFloatArray() { return new float[]{1F, 2F, 3F}; } [WebMethod] public byte[] GetBytes() { return System.IO.File.ReadAllBytes(@"c:\windows\notepad.exe"); } }
枚举 Enum
public enum Sex { Female, Male } [WebService(Namespace = "http://www.rainsts.net/", Description="我的Web服务")] [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)] public class WebService : System.Web.Services.WebService { public WebService () { } [WebMethod] public Sex GetSex() { return Sex.Female; } [WebMethod] public Sex[] GetAllSex() { return Enum.GetValues(typeof(Sex)) as Sex[]; } }
结构 Struct
结构体默认就会创建无参数构造方法,且不允许自定义。
public struct MyStruct { public int X; public int Y; public MyStruct(int x, int y) { this.X = x; this.Y = y; } } [WebService(Namespace = "http://www.rainsts.net/", Description="我的Web服务")] [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)] public class WebService : System.Web.Services.WebService { public WebService () { } [WebMethod] public MyStruct GetMyStruct() { MyStruct st = new MyStruct(15, 16); return st; } [WebMethod] public MyStruct[] GetMyStructs() { return new MyStruct[] { new MyStruct(1, 2), new MyStruct(3, 4) }; ; } }
类型 Class
public struct MyStruct { public int X; public int Y; public MyStruct(int x, int y) { this.X = x; this.Y = y; } } public class MyClass { public MyClass() { myStruct = new MyStruct(); } public MyClass(int x, int y, string name) : this() { myStruct.X = x; myStruct.Y = y; this.name = name; } private string name; public string Name { get { return name; } set { name = value; } } private MyStruct myStruct; public MyStruct MyStruct { get { return myStruct; } set { myStruct = value; } } public void Test() // 客户端代理不会生成该方法。 { Console.WriteLine(name); } } [WebService(Namespace = "http://www.rainsts.net/", Description="我的Web服务")] [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)] public class WebService : System.Web.Services.WebService { public WebService () { } [WebMethod] public MyClass GetMyClass() { return new MyClass(1, 2, "name1"); } [WebMethod] public MyClass[] GetMyClassArray() { return new MyClass[] { new MyClass(1, 2, "name1"), new MyClass(2, 3, "name2") }; ; } }
有关数据类型的更详细信息,请查看 MSDN 文档。
ms-help://MS.MSDNQTR.v80.chs/MS.MSDN.v80/MS.VisualStudio.v80.chs/dv_fxwebservices/html/70567d9f-6e53-42a8-bbd5-aee42b25dd28.htm