[源码下载]
新瓶旧酒ASP.NET AJAX(9) - 客户端脚本编程(Sys.Net命名空间下的WebServiceProxy、WebServiceError、Generated Proxy Classes以及调用WebService、PageMethod)
作者:webabcd
介绍
使用ASP.NET AJAX调用WebService(简单类型和复杂对象、JSON和XML)和PageMethod。Sys.Net命名空间下的WebServiceProxy Class、WebServiceError Class、Generated Proxy Classes
关键
1、调用WebService
·为WebService类或需要暴露给客户端的WebService方法添加[System.Web.Script.Services.ScriptService]属性
·为WebService类中需要暴露给客户端使用的方法添加[System.Web.Services.WebMethod]属性
·在ScriptManager控件的Services集合中添加对该WebService的引用
·客户端调用方法:[NameSpace].[ClassName].[MethodName](param1, param2, ..., succeededCallback, failedCallback, userContext)
·如果用GET方式的话,则在WebService方法添加[System.Web.Script.Services.ScriptMethod(UseHttpGet = true)]属性
·用到了复杂类型的话,则在WebService类上添加[System.Web.Script.Services.GenerateScriptType(typeof(TypeName))]属性。另外,该复杂类型必须要有一个无参数的构造函数
·禁止将某属性输出到客户端,则在该属性上添加[System.Web.Script.Serialization.ScriptIgnore]属性
·以XML方式输出到客户端(一般是JSON),则在WebService方法添加[ScriptMethod(ResponseFormat = ResponseFormat.Xml)]属性。如果要避免ASP.NET AJAX为我们做自动转换,则应该添加[ScriptMethod(ResponseFormat = ResponseFormat.Xml, XmlSerializeString = true)]属性
·以XML方式输出到客户端的复杂对象的属性,在属性上添加[System.Xml.Serialization.XmlAttribute]属性(可不写)。若禁止将其输出到客户端,则在属性上添加[System.Xml.Serialization.XmlIgnore]属性。
·WebService判断用户是否通过验证 - HttpContext.Current.User.Identity.IsAuthenticated
·WebService使用Session - HttpSessionState session = HttpContext.Current.Session;
2、调用PageMethod
·ASP.NET页面中的方法需要时Public和Static的
·为该方法添加[System.Web.Services.WebMethod]属性
·设置ScriptManager控件的EnablePageMethods="true"
·客户端调用方法:PageMethods.[MethodName](param1, param2, ..., callbackFunction);
3、WebServiceProxy Class
var webRequest = Sys.Net.WebServiceProxy.invoke(path, methodName, useHttpGet, parameters, succeededCallback, failedCallback, userContext, timeout);
·path - WebService的url
·methodName - 调用的方法名
·useHttpGet - 是否使用HTTP GET方式
·parameters - 参数(示例:{"param1":196610, "param2":"Hello"})
·succeededCallback - 调用成功的回调函数
·failedCallback - 调用失败的回调函数
·userContext - 用户上下文
·timeout - 超时时间
·返回值 - 相关的WebRequest对象
4、WebServiceError Class
·exceptionType - 服务器端异常的具体类型
·message - 详细的异常描述信息
·stackTrace - 服务器端异常的堆栈跟踪信息
·statusCode - 造成异常的HTTP响应的状态码
·timedOut - 异常是否是由于网络连接超时造成的
5、Generated Proxy Classes属性
·defaultSucceededCallback - 调用成功的回调函数
·defaultFailedCallback - 调用失败的回调函数
·defaultUserContext - 用户上下文
·path - WebService的路径
·timeout - 超时时间
6、Generated Proxy Classes(调用Web Service)
var myServiceProxy = MyNameSpace.MyService();
myServiceProxy.MyServiceMethod(param1, param2, ..., succeededCallback, failedCallback, userContext);
·param - 在前面顺序地写参数
·succeededCallback - 调用成功的回调函数
·failedCallback - 调用失败的回调函数
·userContext - 调用成功的回调函数
7、Generated Proxy Classes(调用成功的回调函数)
function succeededCallback(result, userContext, methodName) { }
·result - 调用WebService的方法后返回的数据
·userContext - 用户上下文
·methodName - 调用的方法名
8、Generated Proxy Classes(调用失败的回调函数)
function failedCallback(error, userContext, methodName) { }
·error - 调用WebService的方法后返回的数据(Sys.Net.WebServiceError对象)
·userContext - 用户上下文
·methodName - 调用的方法名
示例
Hello.asmx
Hello.aspx
运行结果
1、单击“HelloWebService”按钮
WebService Hello webabcd
2、单击“HelloPageMethod”按钮
PageMethod Hello webabcd
3、单击“HelloContext”按钮
WebService Hello webabcd
webabcd
27
4、单击“HelloError”按钮
Exception Type:System.DivideByZeroException
Message:试图除以零。
Stack Trace: 在 Hello.SayError(Int32 a, Int32 b) 位置 c:\Documents and Settings\wanglei\桌面\AJAX\Web\WebService\Hello.asmx:行号 25
Status Code:500
Timed Out:false
Sample.asmx
Sample.aspx
运行结果
1、单击“SimpleTypeTest”按钮
stringTest:abc;boolTest:False;intTest:1;floatTest:1.1;datetimeTest:2007-7-5 0:59:35;enumTest:Sunday
2、单击“GetPerson”按钮
Name:webabcd;Age:27
3、单击“SetPerson”按钮
Name:webabcd;Age:27
4、单击“GetList”按钮
| Name:0000 | Age:20 |
| Name:0001 | Age:21 |
| Name:0002 | Age:22 |
| Name:0003 | Age:23 |
| Name:0004 | Age:24 |
| Name:0005 | Age:25 |
| Name:0006 | Age:26 |
| Name:0007 | Age:27 |
| Name:0008 | Age:28 |
| Name:0009 | Age:29 |
5、单击“SetList”按钮
| Name:1000 | Age:20 |
| Name:1001 | Age:21 |
| Name:1002 | Age:22 |
| Name:1003 | Age:23 |
| Name:1004 | Age:24 |
| Name:1005 | Age:25 |
| Name:1006 | Age:26 |
| Name:1007 | Age:27 |
| Name:1008 | Age:28 |
| Name:1009 | Age:29 |
6、单击“GetDictionary”按钮
| Name:0000 | Age:20 |
| Name:0001 | Age:21 |
| Name:0002 | Age:22 |
| Name:0003 | Age:23 |
| Name:0004 | Age:24 |
| Name:0005 | Age:25 |
| Name:0006 | Age:26 |
| Name:0007 | Age:27 |
| Name:0008 | Age:28 |
| Name:0009 | Age:29 |
7、单击“GetDataTable”按钮
| Name:0000 | Age:20 |
| Name:0001 | Age:21 |
| Name:0002 | Age:22 |
| Name:0003 | Age:23 |
| Name:0004 | Age:24 |
| Name:0005 | Age:25 |
| Name:0006 | Age:26 |
| Name:0007 | Age:27 |
| Name:0008 | Age:28 |
| Name:0009 | Age:29 |
8、单击“GetXml”按钮
<?xml version="1.0"?>
<ArrayOfPerson xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Person><Name>0000</Name><Age>20</Age></Person>
<Person><Name>0001</Name><Age>21</Age></Person>
<Person><Name>0002</Name><Age>22</Age></Person>
<Person><Name>0003</Name><Age>23</Age></Person>
<Person><Name>0004</Name><Age>24</Age></Person>
<Person><Name>0005</Name><Age>25</Age></Person>
<Person><Name>0006</Name><Age>26</Age></Person>
<Person><Name>0007</Name><Age>27</Age></Person>
<Person><Name>0008</Name><Age>28</Age></Person>
<Person><Name>0009</Name><Age>29</Age></Person>
</ArrayOfPerson>
GeneratedProxy.aspx
运行结果
1、页面加载
弹出框,信息:/Web/WebService/Hello.asmx
弹出框,信息:0
2、单击“Hello”按钮
WebService Hello webabcd
默认的Context:webabcd
调用的方法名:Say
WebServiceProxy.aspx
运行结果
1、单击“Hello”按钮
{"name":"webabcd"}
WebService Hello webabcd
OK
[源码下载]