C#中的[WebMethod]的用法

Posted 2022-11-25 小蚂蚁_CrkRes

前言
    自己在订餐系统中接触到了一个[WebMethod]的属性，通过调试和查找的方法，发现了有一个特点，带有这个标识的方法，可以在在前端直接利用ajax方法调用，那么它具体是如何使用的，原理又是什么呢？下面小编结合网上的一些介绍来进行总结一下。

一、三种情况的服务端
1.可以调用aspx.cs 中声明带有[WebMehtod]的public static 的方法(不需要自己手动添加web.config的配置)

2.可以调用 *.asmx (web服务) 里面加了[webmethod]的方法（不能写静态,写静态就调用不到了）需要在asmx里面 去掉 [System.Web.Script.Services.ScriptService] 的注释 

3.可以调用 *.ashx (一般处理程序)，它和aspx一样都实现了IHttpHandler接口。

二、三种方法的调用
  方法调用也分不同返回情况：

<span style="font-family:SimHei;font-size:18px;">    无参数的方法调用    public static string SayHello()   
    带参数的方法调用     public static string GetStr(string str, string str2)
    返回数组方法的调用   public static List<string> GetArray()</span>

三、代码示例
1. aspx.cs 服务端
（1）后端--静态方法

[WebMethod]   
public static string SayHello()   
  
     return "Hello Ajax!";   

（2）前端--ajax方法
$(function()   
    $("#btnOK").click(function()   
        $.ajax(   
            //要用post方式   
            type: "Post",   
            //方法所在页面和方法名   
            url: "data.aspx/SayHello",   
            contentType: "application/json; charset=utf-8",   
            dataType: "json",   
            success: function(data)   
                //返回的数据用data.d获取内容   
                alert(data.d);   
            ,   
            error: function(err)   
                alert(err);   
              
        );   
 
        //禁用按钮的提交   
        return false;   
    );   
);

2.WebService1.asmx
（1）后端

[WebMethod]
    public List<int> CreateArray(int i)
   
       List<int> list = new List<int>(); 
       while (i >= 0)
       
           list.Add(i--);
        
       return list;
   

（2）前端

//返回泛型列表
    $("#btnArray").click(function()
       $.ajax(
         type: "POST",
         contentType:"application/json",
         url:"WebService1.asmx/CreateArray",
         data:"i:10",
         dataType:'json',
         success:function(result)                    
             alert(result.d.join(" | "));
           
        );
    );

3.handler处理程序
（1）后端--handler处理程序 

（2）前端--直接调用这个处理程序即可

$("#dbtn").click(function()  
  $.ajax( 
     type: "POST",  
     dataType:"Text", 
     url: "AjaxHandler.ashx", 
     data: name: "admin", pass: "admin" ,  
     beforeSend: function() $("#ds").html("loading"); ,  
     success: function(msg) $("#ds").html("<p>" + msg + "</p>");  
    ); 
); 

补充一点：mvc中的ajax异步请求，由于mvc采用基于路由映射，所以Controller中的Action可以直接通过url请求。