我的Ajax服務端框架 - (1) JS直接調用C#方法

返回到目錄：曬曬我的Ajax服務端框架

在Ajax網站中，Javascript經常需要請求服務器，比如：提交一個小的狀態修改請求，獲取某個對象的JOSN字符串，獲取一小段HTML，等等。

FishWebLib的Ajax服務端框架提供的這個功能將讓您可以在Javascript直接調用一個C＃方法，用來完成上述需求。示例代碼如下：

C#方法

namespace MyLab.AjaxService
{
    /// <summary>
    /// Ajax服務類，提供“商品記錄”相關操作
    /// </summary>
    public class AjaxProduct
    {
        public int ChangeProductQuantity(int productId, int quantity)
        {
            if( productId < 0 )
                throw new MyMessageException("沒有指定ProductID");

            return BllFactory.GetProductBLL().ChangeProductQuantity(productId, quantity);
        }
    }
}

說明：對于方法的參數個數，以及返回值的類型，本框架并沒有特別的限制，可以根據您的要求隨意指定。
示例代碼中雖然將返回值定義為int類型，你完全可以使用其它的類型，甚至沒有返回值。

Javascript調用代碼

function SetQuantityTextboxEvent(){
    $("input.quantityTextbox").change(function(){
        var j_textbox = $(this);
        var recId = j_textbox.attr("pid");
        var newValue = j_textbox.val();

        $.ajax({
            dataType: "text", type: "POST",
            url: "/AjaxProduct.ChangeProductQuantity.cs",
            data: {productId: recId, quantity: newValue  },
            success: function (responseText) {
                // ............
            }
        });
    });
}

C#方法的參數形式

上面示例代碼中包含二個參數：productId和quantity。
事實上，也可以是自定義的類型，但需要將productId和quantity定義成屬性或者字段，訪問性請設置為public
此時完全不要修改JS代碼。

C#方法可以是實例方法，也可以是靜態方法。類可以是靜態，也可以是非靜態的。

由于".cs" 文件是不能直接訪問的，所以還需要以下配置：

<httpHandlers>
    <add verb="*" path="*.cs" validate="false" type="FishWebLib.Ajax.AjaxMethodV2Handler, FishWebLib, 
		Version=3.0.0.0, Culture=neutral, PublicKeyToken=04db02423b9ebbb2"/>
</httpHandlers>

或者不使用以上配置，但需要一個 ashx 處理器

public class ajax : IHttpHandler
{
    // 說明：
    // 在本網站的示例中，有些JS調用的URL諸如：url: "/AjaxOrder.AddOrder.cs"
    // 由于 ".cs"這種擴展名一般是被Asp.net禁止訪問的。
    // 所以如果您沒有機會修改IIS級別的設置或者Web.config，則不能使用上面的格式，
    //
    // 而只能使用這種格式的URL了：url: "handler/ajax.ashx?class=AjaxOrder&method=AddOrder"
    // URL參數中的 class 的含義是：指定要調用哪個Ajax服務類（包含命名空間）， method 的含義是：指定要調用哪個方法。
    //
    // 這也是當前文件"ajax.ashx"存在的意義了。
    // 在這個文件中，只需要簡單的“轉發”一下調用就可以了。
    // 
    // 如果你覺得 class, method 這二個參數的名稱不恰當，也可以用這種方法來“重定義”，
    // 最后可以調用 FishWebLib.Ajax.MethodExecutor.ProcessRequest(HttpContext context, Type type, string method)
    // 或者：ProcessRequest(HttpContext context, string AssemblyName, string className, string method)


    // assemblyName 指定了所有供Ajax可以調用的類型的程序程序集。
    private static readonly string assemblyName = typeof(MyLab.AjaxService.AjaxCustomer).Assembly.ToString();
    
    public void ProcessRequest (HttpContext context) {
        // 轉發調用。第二個參數是說：要調用的類在哪個程序集中。
        // 這個重載要求在URL參數中存在這二個參數項：class, method
        FishWebLib.Ajax.MethodExecutor.ProcessRequest(context, assemblyName);
    }

}

Javascript調用代碼

$.ajax({
    url: "ajax.ashx?class=AjaxProduct&method=ChangeProductQuantity", 
    data: {productId: recId, quantity: newValue  },
    // ......
});

好了，這個演示就寫到這里，更多細節請查看用戶手冊。

返回到目錄：曬曬我的Ajax服務端框架

點擊此處進入示例展示及下載頁面