客户端访问WebService(1)

WebService 2020-09-22
1，客户端访问WebService基础
   步骤：新建一个普通的webService
            为webService类添加自定义标记属性[ScriptService]Attibute
            释放webService方法  a,访问级别public; 
                                          b,给方法添加[WebMethod]Attribute
            为页面中的ScriptManager或者ScriptManagerProxy注册webService

   客户端代码方法webService方法：
           如果webService的代码类有命名空间，命名空间下的类的名字的方法名字
           1，[NameSpaceName].ClassName.MethodName()   
           2，依次传入参数
           3，传入一个方法作为成功后的回调函数
           4，即时没有返回值,也会调用回调函数
   
下面是简单的例子：

webService中的内容
  1. using System;
  2. using System.Collections;
  3. using System.ComponentModel;
  4. using System.Data;
  5. using System.Web;
  6. using System.Web.Services;
  7. using System.Web.Services.Protocols;
  9. namespace AJAXEnabledWebApplication2
  10. {
  11.     /// <summary>
  12.     /// WebService1 的摘要说明
  13.     /// </summary>
  14.     [WebService(Namespace = "http://tempuri.org/")]
  15.     [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
  16.     [ToolboxItem(false)]
  18.     //为类添加自己定义属性[ScriptService]
  19.     [System.Web.Script.Services.ScriptService]
  20.     public class WebService1 : System.Web.Services.WebService
  21.     {
  22.         //释放WebService方法
  23.         [WebMethod]
  24.         public int GetRandom()
  25.         {
  26.             return new Random(DateTime.Now.Millisecond).Next();
  27.         }
  28.         [WebMethod]
  29.         public int GetRandomBetween(int min, int max)
  30.         {
  31.             return new Random(DateTime.Now.Millisecond).Next(min, max);
  32.         }
  33.         [WebMethod]
  34.         public void Test()
  35.         {
  37.         }
  38.     }
  39. }
页面中的内容 ：
  1. <%@ Page Language="C#" AutoEventWireup="true" CodeBehind="Default.aspx.cs" Inherits="AJAXEnabledWebApplication2._Default" %>
  3. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  5. <html xmlns="http://www.w3.org/1999/xhtml" >
  6. <head runat="server">
  7.     <title>Untitled Page</title>
  8. </head>
  9. <body>
  10.     <form id="form1" runat="server">
  11.       <!--InlineScript为true的时候webservice的方法生成的script代码会释放在页面中,默认为false-->
  12.         <asp:ScriptManager ID="ScriptManager1" runat="server" >
  13.         <Services>
  14.         <asp:ServiceReference Path="WebService1.asmx" InlineScript="true" />
  15.         </Services>
  16.         </asp:ScriptManager>
  17.         <div>
  18.         <input type="button" value="无返回值" onclick="test()" />
  19.         <input type="button" value="无参数返回一个随机数字" onclick="GetRandom()" />
  20.         <input type="button" value="返回一个0到100之间的随机数字" onclick="GetRandom(0,100)" />
  21.         <script type="text/javascript" language="javascript">
  22.         
  23.         function GetRandom(max,min){
  24.         //js函数默认的属性,argument 参数信息,一种js重载的实现方法
  25.            if(arguments.length!=2){
  26.                 AJAXEnabledWebApplication2.WebService1.GetRandom(successed);
  27.             }
  28.             else{
  29.                  AJAXEnabledWebApplication2.WebService1.GetRandomBetween(max,min,successed);
  30.             }
  31.         }
  32.         function test(){
  33.            //无返回值,回调函数会弹出个null值
  34.             AJAXEnabledWebApplication2.WebService1.Test(successed);
  35.         }
  36.         function successed(result){
  37.             alert(result);
  38.         }
  39.         </script>
  40.         </div>
  41.     </form>
  42. </body>
  43. </html>

2，客户端访问PageMethod基础

服务器端步骤：客户端对应的服务器段的aspx页面中定义
                     公开的静态方法
                     方法上面使用[WebMethod]Attribute
                     ScriptManager的EnablePageMethod属性为true

客户端方法：通过PageMethods.MethodName()方法访问

简单例子： 
后台类：
  1. using System;
  2. using System.Collections;
  3. using System.Configuration;
  4. using System.Data;
  5. using System.Web;
  6. using System.Web.Security;
  7. using System.Web.UI;
  8. using System.Web.UI.HtmlControls;
  9. using System.Web.UI.WebControls;
  10. using System.Web.UI.WebControls.WebParts;
  12. namespace AJAXEnabledWebApplication2
  13. {
  14.     public partial class WebForm1 : System.Web.UI.Page
  15.     {
  16.         protected void Page_Load(object sender, EventArgs e)
  17.         {
  19.         }
  20.         //向客户端释放方法
  21.         [System.Web.Services.WebMethod]
  22.         //public类型的static
  23.         public static DateTime GetDateTimeNow()
  24.         {
  25.             return DateTime.UtcNow;
  26.         }
  27.     }
  28. }
页面代码：

  1. <%@ Page Language="C#" AutoEventWireup="true" CodeBehind="WebForm1.aspx.cs" Inherits="AJAXEnabledWebApplication2.WebForm1" %>
  3. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  5. <html xmlns="http://www.w3.org/1999/xhtml" >
  6. <head runat="server">
  7.     <title>无标题页</title>
  8. </head>
  9. <body>
  10.     <form id="form1" runat="server">
  11.     <!---ScriptManager的 EnablePageMethods="true"->
  12.     <asp:ScriptManager ID="ScriptManager1" runat="server" EnablePageMethods="true">
  13.     </asp:ScriptManager>
  14.     <input type="button" value="调用pageMethod方法" onclick="GetDateTimeNow()" />
  15.     <script type="text/javascript" language="javascript">
  16.     function GetDateTimeNow(){
  17.     //PageMethods.释放的方法名字
  18.        PageMethods.GetDateTimeNow(seccessed);
  19.     }
  20.     function seccessed(result){
  21.         alert(result);
  22.     }
  23.     </script>
  24.     </form>
  25. </body>
  26. </html>
3，错误处理
          客户端调用错误处理时候可以提供一个额外的错误的回调函数
          错误包括超时和服务器抛出的异常
          超时只能设置在webService级别或者pageMetehod对象上 无法在方法调用时候设置

 错误信息类：Sys.Net.WebServicError
                  Sys.Net.WebServicError类提供了 timeout  ,message,exceptionType,stackTrace 4个属性

例子：

webService代码：

  1. using System;
  2. using System.Collections;
  3. using System.ComponentModel;
  4. using System.Data;
  5. using System.Web;
  6. using System.Web.Services;
  7. using System.Web.Services.Protocols;
  9. namespace AJAXEnabledWebApplication2
  10. {
  11.     /// <summary>
  12.     /// Error 的摘要说明
  13.     /// </summary>
  14.     [WebService(Namespace = "http://tempuri.org/")]
  15.     [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
  16.     [ToolboxItem(false)]
  17.     [System.Web.Script.Services.ScriptService]
  18.     public class Error : System.Web.Services.WebService
  19.     {
  20.         [WebMethod]
  21.         public int GetDivsion(int a, int b)
  22.         {
  23.             return a / b;
  24.         }
  25.         [WebMethod]
  26.         public int Timeout()
  27.         {
  28.             //设置等待5秒后返回值
  29.             System.Threading.Thread.Sleep(5000);
  30.             return 0;
  31.         }
  32.     }
  33. }
页面代码：

  1. <%@ Page Language="C#" AutoEventWireup="true" CodeBehind="WebForm2.aspx.cs" Inherits="AJAXEnabledWebApplication2.WebForm2" %>
  3. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  5. <html xmlns="http://www.w3.org/1999/xhtml" >
  6. <head runat="server">
  7.     <title>无标题页</title>
  8. </head>
  9. <body>
  10.     <form id="form1" runat="server">
  11.     <asp:ScriptManager ID="ScriptManager1" runat="server">
  12.     <Services>
  13.     <asp:ServiceReference Path="Error.asmx" />
  14.     </Services>
  15.     </asp:ScriptManager>
  16.     <input id="Button1" type="button" value="调用一个除零函数抛出异常" onclick="getDivsion(4,0)" />
  17.       <input id="Button2" type="button" value="调用一个除非零函数得到结果" onclick="getDivsion(4,4)" />
  18.     <input id="Button3" type="button" value="触发一个超时的错误" onclick="getTimeout()" />
  19.     <script type="text/javascript" language="javascript">
  20.     function getDivsion(a,b){
  21.         //参数后跟成功后的回调函数，和错误的回调函数 
  22.         AJAXEnabledWebApplication2.Error.GetDivsion(a,b,seccessed,failed);
  23.      
  24.       
  25.     }
  26.     function getTimeout(){
  27.     //这里设置等待服务器多久还没有返回数据 就给客户端提醒超时了 服务器中设置了5秒，等俩秒后会返回超时，如果设置为6000则正常返回1
  28.         AJAXEnabledWebApplication2.Error.set_timeout(2000);
  29.         AJAXEnabledWebApplication2.Error.Timeout(seccessed,failed);
  30.     }
  31.        //调用成功的回调函数
  32.    function seccessed(result){
  33.             alert(result);
  34.         }
  35.         //调用失败的回调函数
  36.      function failed(error){
  37.             var message=String.format("Timeout:{0}/n Message:{1}/n exceptionType:{2}/n stackTrace:{3}",
  38.             error.get_timedOut(),
  39.             error.get_message(),
  40.             error.get_exceptionType(),
  41.             error.get_stackTrace()
  42.             );
  43.             alert(message);
  44.         }
  45.     
  46.     </script>
  47.     </form>
  48. </body>
  49. </html>
4，复杂数据类型使用基础

调用的时候有时候我们需要调用一些复杂的自定义的数据类型，

1，定义了自己的数据类型时候，类型的一些共有属性和字段都被释放(返回值)和接受(参数)
2，容器对象
     --实现了 IList接口的对象
     --实现了IDictionary接口的对象 (客户端是用一个对象来模拟字典的，所以字典数据中的key必须是string类型)

例子：
自定义类：
  1. using System;
  2. using System.Data;
  3. using System.Configuration;
  4. using System.Web;
  5. using System.Web.Security;
  6. using System.Web.UI;
  7. using System.Web.UI.HtmlControls;
  8. using System.Web.UI.WebControls;
  9. using System.Web.UI.WebControls.WebParts;
  11. namespace AJAXEnabledWebApplication2
  12. {
  13.     public class Person
  14.     {
  15.         public string firstName;
  16.         public string lastName;
  17.         public int age;
  18.         public string FullName
  19.         {
  20.             get
  21.             {
  22.                 return firstName + " " + lastName;
  23.             }
  24.         }
  25.         public  override string  ToString()
  26.         {
  27.             return "Name:"+this.FullName+" Age:"+age.ToString();
  28.         }
  29.     }
  30. }
webService：

  1. using System;
  2. using System.Collections;
  3. using System.ComponentModel;
  4. using System.Data;
  5. using System.Web;
  6. using System.Web.Services;
  7. using System.Web.Services.Protocols;
  9. namespace AJAXEnabledWebApplication2
  10. {
  11.     /// <summary>
  12.     /// WebService2 的摘要说明
  13.     /// </summary>
  14.     [WebService(Namespace = "http://tempuri.org/")]
  15.     [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
  16.     [ToolboxItem(false)]
  17.     [System.Web.Script.Services.ScriptService]
  18.     public class WebService2 : System.Web.Services.WebService
  19.     {
  21.         [WebMethod]
  22.         //一个人的年龄增加了一岁
  23.         public Person AddAge(Person p)
  24.         {
  25.             p.age += 1;
  26.             return p;
  27.         }
  28.         [WebMethod]
  29.         //数组
  30.         public System.Collections.Generic.List<int> Reverse(System.Collections.Generic.List<int> list)
  31.         {
  32.             //反转数组
  33.             list.Reverse();
  34.             return list;
  35.         }
  36.         [WebMethod]
  37.         ////数据字典
  38.         public System.Collections.Generic.IDictionary<string, Person> GetPersons()
  39.         {
  40.             System.Collections.Generic.Dictionary<string, Person> result = new System.Collections.Generic.Dictionary<string, Person>();
  41.             Person p1 = new Person();
  42.             Person p2 = new Person();
  43.             p1.firstName = "Si";
  44.             p1.lastName = "Li";
  45.             p1.age = 23;
  46.             result[p1.FullName] = p1;
  47.             p2.age = 25;
  48.             p2.firstName = "Wu";
  49.             p2.lastName = "Wang";
  50.             result[p2.FullName] = p2;
  52.             return result;
  53.         }
  54.     }
  55. }

aspx页面

  1. <%@ Page Language="C#" AutoEventWireup="true" CodeBehind="WebForm3.aspx.cs" Inherits="AJAXEnabledWebApplication2.WebForm3" %>
  3. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  5. <html xmlns="http://www.w3.org/1999/xhtml" >
  6. <head runat="server">
  7.     <title>无标题页</title>
  8. </head>
  9. <body>
  10.     <form id="form1" runat="server">
  11.     <asp:ScriptManager ID="ScriptManager1" runat="server">
  12.     <Services>
  13.     <asp:ServiceReference Path="WebService2.asmx" />
  14.     </Services>
  15.     </asp:ScriptManager>
  16.     <input id="Button1" type="button" value="年龄增加一岁" onclick="AddAge()" />
  17.     <input id="Button2" type="button" value="反转数组[1,2,3,4,5,6s]" onclick="revers([1,6])" />
  18.     <input id="Button3" type="button" value="返回一个数据字典数据" onclick="getPersons()" />
  19.     <script language="javascript" type="text/javascript">
  20.     //年龄增加一岁
  21.     function AddAge(){
  22.         var person=new Object();
  23.        person.firstName="Stone";
  24.        person.lastName="Zhang";
  25.        person.age=23;
  26.        //调用webservice中的年龄增加一岁的方法 
  27.        AJAXEnabledWebApplication2.WebService2.AddAge(person,AddAgeseccessed);
  28.     }
  29.     function AddAgeseccessed(result){
  30.         //结果是24
  31.         var message=String.format("FirstName:{0}/n LastName:{1}/nFullName:{2}/nAge:{3}",
  32.         result.firstName,
  33.         result.lastName,
  34.         result.FullName,
  35.         result.age
  36.         );
  37.          alert(message);
  38.     }
  39.     //数组
  40.     function revers(array){
  41.      AJAXEnabledWebApplication2.WebService2.Reverse(array,seccessed);
  42.     }
  43.     function seccessed(result){
  44.         alert(result);
  45.     }
  46.     //数据字典
  47.     
  48.     function getPersons(){
  49.          AJAXEnabledWebApplication2.WebService2.GetPersons(getPersonsSeccssed);
  50.     }
  51.     function getPersonsSeccssed(result){
  52.     //枚举字典中的每一项
  53.     //这里得不到字典对象中的方法
  54.         for(var key in result){
  55.             alert(key+": "+result[key].age);
  56.         }
  57.     }
  58.     </script>
  59.     </form>
  60. </body>
  61. </html>
5，客户端代理使用基础

客户端函数调用完整签名：
    Invoke(arg1,...,argN,onSucceeded,onFailed,userContext)
    参数，成功时的回调函数，出错后的回调函数，userContext为任意的自定义类型(可以传入数据字典)
回调函数完整签名：
    onSucceeded(result,userContext,methodName)
    结果，调用函数传入的userContext
    onFailed(error,methodName)
     error对象

 webservice级别默认属性：
  -timeout 比较常用
  -defaultUserContext
  -defaultSucceededCallBack
  -defaultFailedCallBack 比较常用，出错后调用统一的webservice中默认的

例子：

webservice代码用了上面用过的一个webservice：

  1. using System;
  2. using System.Collections;
  3. using System.ComponentModel;
  4. using System.Data;
  5. using System.Web;
  6. using System.Web.Services;
  7. using System.Web.Services.Protocols;
  9. namespace AJAXEnabledWebApplication2
  10. {
  11.     /// <summary>
  12.     /// Error 的摘要说明
  13.     /// </summary>
  14.     [WebService(Namespace = "http://tempuri.org/")]
  15.     [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
  16.     [ToolboxItem(false)]
  17.     [System.Web.Script.Services.ScriptService]
  18.     public class Error : System.Web.Services.WebService
  19.     {
  20.         [WebMethod]
  21.         public int GetDivsion(int a, int b)
  22.         {
  23.             return a / b;
  24.         }
  25.         [WebMethod]
  26.         public int Timeout()
  27.         {
  28.             //设置等待5秒后返回值
  29.             System.Threading.Thread.Sleep(5000);
  30.             return 0;
  31.         }
  32.     }
  33. }
asp页面代码：

  1. <%@ Page Language="C#" AutoEventWireup="true" CodeBehind="WebForm4.aspx.cs" Inherits="AJAXEnabledWebApplication2.WebForm4" %>
  3. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  5. <html xmlns="http://www.w3.org/1999/xhtml" >
  6. <head runat="server">
  7.     <title>无标题页</title>
  8. </head>
  9. <body>
  10.     <form id="form1" runat="server">
  11.      <asp:ScriptManager ID="ScriptManager1" runat="server">
  12.     <Services>
  13.     <asp:ServiceReference Path="Error.asmx" />
  14.     </Services>
  15.     </asp:ScriptManager>
  16.     <input id="Button1" type="button" value="调用一个除零函数抛出异常" onclick="getDivsion(4,0)" />
  17.       <input id="Button2" type="button" value="调用一个除非零函数得到结果" onclick="getDivsion(4,4)" />
  18.     <input id="Button3" type="button" value="触发一个超时的错误" onclick="getTimeout()" />
  19.     <script type="text/javascript" language="javascript">
  20.     //webmethod默认属性
  21.     AJAXEnabledWebApplication2.Error.set_defaultFailedCallback(failed);
  22.     AJAXEnabledWebApplication2.Error.set_timeout(2000);
  23.     function getDivsion(a,b){
  24.         //参数后跟成功后的回调函数，和错误的回调函数 
  25.        // AJAXEnabledWebApplication2.Error.GetDivsion(a,failed);
  26.        //去掉了上面的出错的回调函数，系统会默认找set_defaultFailedCallBack()
  27.        AJAXEnabledWebApplication2.Error.GetDivsion(a,seccessed);
  28.      
  29.       
  30.     }
  31.     function getTimeout(){
  32.     //这里设置等待服务器多久还没有返回数据 就给客户端提醒超时了 服务器中设置了5秒，等俩秒后会返回超时，如果设置为6000则正常返回1
  33.       //  AJAXEnabledWebApplication2.Error.set_timeout(2000);
  34.       //  AJAXEnabledWebApplication2.Error.Timeout(seccessed,failed);
  35.       AJAXEnabledWebApplication2.Error.Timeout(seccessed);
  36.     }
  37.        //调用成功的回调函数
  38.    function seccessed(result){
  39.             alert(result);
  40.         }
  41.         //调用失败的回调函数
  42.      function failed(error){
  43.             var message=String.format("Timeout:{0}/n Message:{1}/n exceptionType:{2}/n stackTrace:{3}",
  44.             error.get_stackTrace()
  45.             );
  46.             alert(message);
  47.         }
  48.     
  49.     </script>
  50.     </form>
  51. </body>
  52. </html>

目前就了解了这些总结下~

相关文章

WebService学习(十三)——调用webservice的方式其他方式
1.使用ajax调用varxhr;functioninvoke(){if(window.ActiveXO...
如何用IDEA一步一步开发WebService客户端程序
               好不容易把WebService服务器...
Java WebService之入门
1新建一个工程项目用来做服务端增加一个MyService1类文件pac...
WebService方法进行接口连接
packagecom.transsion.util;importjava.io.BufferedReader;i...
.net的webservice中内外网端口不一致导致无法调用的解决方案
再生产wsdl文件时重写描述文件1usingSystem;2usingSystem.Co...
Jax-ws 开发webService ，并使用spring注入service类中遇到 空指针
一般情况下，使用eclipse自带的jax-ws生成webservice会自动生...