用C#通過反射實現動態調用WebService 告別Web引用（轉載）

標籤：archive   html   nat   tool   rgs   匯入   url   warning   pat   

我們都知道，調用WebService可以在工程中對WebService地址進行WEB引用，但是這確實很不方便。我想能夠利用設定檔靈活調用WebService。如何?呢？

用C#通過反射實現動態調用WebService

 

下面是WebService代碼：

using System;using System.Collections.Generic;using System.Linq;using System.Web;using System.Web.Services;namespace TestWebService{    /// <summary>    /// Service1 的摘要說明    /// </summary>    [WebService(Namespace = "http://tempuri.org/",Description="我的Web服務")]    [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]    [System.ComponentModel.ToolboxItem(false)]    // 若要允許使用 ASP.NET AJAX 從指令碼中調用此 Web 服務，請取消對下行的注釋。    // [System.Web.Script.Services.ScriptService]    public class TestWebService : System.Web.Services.WebService    {        [WebMethod]        public string HelloWorld()        {            return "測試Hello World";        }        [WebMethod]        public string Test()        {            return "測試Test";        }              [WebMethod(CacheDuration = 60,Description = "測試")]        public List<String> GetPersons()        {            List<String> list = new List<string>();            list.Add("測試一");            list.Add("測試二");            list.Add("測試三");            return list;        }      }}

 

下面是用戶端的代碼：

using System.Text;using System.Net;using System.IO;using System.Web.Services.Description;using System.CodeDom;using Microsoft.CSharp;using System.CodeDom.Compiler;using System;namespace TestCommon{    public class Webservice    {        /// <summary>        /// 執行個體化WebServices        /// </summary>        /// <param name="url">WebServices地址</param>        /// <param name="methodname">調用的方法</param>        /// <param name="args">把webservices裡需要的參數按順序放到這個object[]裡</param>        public static object InvokeWebService(string url, string methodname, object[] args)        {            //這裡的namespace是需引用的webservices的命名空間，我沒有改過，也可以使用。也可以加一個參數從外面傳進來。            string @namespace = "client";            try            {                //擷取WSDL                WebClient wc = new WebClient();                Stream stream = wc.OpenRead(url + "?WSDL");                ServiceDescription sd = ServiceDescription.Read(stream);                string classname = sd.Services[0].Name;                ServiceDescriptionImporter sdi = new ServiceDescriptionImporter();                sdi.AddServiceDescription(sd, "", "");                CodeNamespace cn = new CodeNamespace(@namespace);                //產生用戶端代理類代碼                CodeCompileUnit ccu = new CodeCompileUnit();                ccu.Namespaces.Add(cn);                sdi.Import(cn, ccu);                CSharpCodeProvider csc = new CSharpCodeProvider();                //ICodeCompiler icc = csc.CreateCompiler();                                //設定編譯參數                CompilerParameters cplist = new CompilerParameters();                cplist.GenerateExecutable = false;//動態編譯後的程式集不產生可執行檔                cplist.GenerateInMemory = true;//動態編譯後的程式集只存在於記憶體中，不在硬碟的檔案上                cplist.ReferencedAssemblies.Add("System.dll");                cplist.ReferencedAssemblies.Add("System.XML.dll");                cplist.ReferencedAssemblies.Add("System.Web.Services.dll");                cplist.ReferencedAssemblies.Add("System.Data.dll");                //編譯代理類                CompilerResults cr = csc.CompileAssemblyFromDom(cplist, ccu);                if (true == cr.Errors.HasErrors)                {                    System.Text.StringBuilder sb = new System.Text.StringBuilder();                    foreach (System.CodeDom.Compiler.CompilerError ce in cr.Errors)                    {                        sb.Append(ce.ToString());                        sb.Append(System.Environment.NewLine);                    }                    throw new Exception(sb.ToString());                }                //組建代理程式執行個體，並調用方法                System.Reflection.Assembly assembly = cr.CompiledAssembly;                Type t = assembly.GetType(@namespace + "." + classname, true, true);                object obj = Activator.CreateInstance(t);                System.Reflection.MethodInfo mi = t.GetMethod(methodname);                //註：method.Invoke(o, null)返回的是一個Object,如果你服務端返回的是DataSet,這裡也是用(DataSet)method.Invoke(o, null)轉一下就行了,method.Invoke(0,null)這裡的null可以傳調用方法需要的參數,string[]形式的                return mi.Invoke(obj, args);            }            catch            {                return null;            }        }    }    class Program    {        static void Main(string[] args)        {            string url = "http://localhost:3182/Service1.asmx?WSDL";//這個地址可以寫在Config檔案裡面，這裡取出來就行了.在原地址後面加上： ?WSDL            string method = "GetPersons";            String[] item = (String[])Webservice.InvokeWebService(url, method, null);                        foreach (string str in item)                Console.WriteLine(str);        }    }}

 

注意：上述代碼需要引用如下四個名稱空間：
using System.Web.Services.Description;  //WS的描述
//以下幾個用於根據描述動態產生代碼並動態編譯擷取程式集
using System.CodeDom; 
using Microsoft.CSharp;
using System.CodeDom.Compiler;

 

代碼相對簡單，為什麼可以如此調用呢？動態編譯後用反射來讀取並執行。也許瞭解反射及如何反射對你會有協助。

反射提供了封裝程式集、模組和類型的對象（Type 類型）。可以使用反射動態建立類型的執行個體，將類型綁定到現有對象，或從現有對象擷取類型並調用其方法或訪問其欄位和屬性。詳細請查看：https://msdn.microsoft.com/zh-cn/library/ms173183(VS.80).aspx

為什麼WebServices可以通過反射實現？

WebService在傳輸過程中是通過WSDL來進行描述的（使用SOAP協議）。因此，我們需要擷取WebService的WSDL描述，並通過該描述來動態產生程式集。然後通過反射來擷取新產生的程式集，並調用其方法！

以下是MSDN對其的描述：

XML Web services 的介面通常由 Web 服務描述語言 (WSDL) 檔案來說明。例如，若要擷取有關使用 http://localhost/service.asmx 處公開的 ASP.NET 的 Web 服務的 WSDL 說明，只需導航到 http://localhost/service.asmx?WSDL。使用 ServiceDescriptionImporter 類可以方便地將 WSDL 說明中包含的資訊匯入到System.CodeDom.CodeCompileUnit 對象。通過調整 Style 參數的值，可以指示 ServiceDescriptionImporter 執行個體產生用戶端代理類（通過透明調用該類可提供 Web 服務的功能）或產生抽象類別（該類封裝 Web 服務的功能而不實現該功能）。如果將 Style 屬性設定為 Client，則 ServiceDescriptionImporter 產生用戶端代理類，通過調用這些類來提供說明的 Web 服務的功能。如果將 Style 屬性設定為 Server，則 ServiceDescriptionImporter 執行個體產生抽象類別，這些類表示所說明的 XML Web services 的功能而不進行實現。然後，可以通過編寫從這些抽象類別繼承的類來對其進行實現，並實現相關的方法。

 

關於上面代碼中CompilerParameters的配置參數，有如下說明：

CodeDom可以動態編譯Code代碼成為程式集，有時我們只想動態編譯的程式集，在記憶體中或者是硬碟上調用，這就是CodeDom的動態編譯。微軟在CodeDom中提供了動態編譯器，這是ICodeCompiler的用武之地了，它定義用於調用原始碼編譯的介面或使用指定編譯器的 CodeDOM 樹。可以從CodeDomProvider產生引用對象：CodeDomProvider.CreateProvider("").CreateCompiler();

 

在ICodeCompiler中為我們提供了程式集編譯的方法有：

CompileAssemblyFromDom ：使用指定的編譯器設定從指定的 CodeCompileUnit 所包含的 System.CodeDom 樹中編譯器集。            

CompileAssemblyFromDomBatch：基於包含在 CodeCompileUnit 對象的指定數組中的 System.CodeDom 樹，使用指定的編譯器設定編譯器集。              

CompileAssemblyFromFile：從包含在指定檔案中的原始碼，使用指定的編譯器設定編譯器集。              

CompileAssemblyFromFileBatch：從包含在指定檔案中的原始碼，使用指定的編譯器設定編譯器集。              

CompileAssemblyFromSource： 從包含原始碼的指定字串，使用指定的編譯器設定編譯器集。            

CompileAssemblyFromSourceBatch：從包含原始碼的字串的指定數組，使用指定的編譯器設定編譯器集。

 

在我們的CodeDomProvider也提供了CompileAssemblyFromDom、CompileAssemblyFromFile、CompileAssemblyFromSource。

在他們的編譯時間候都有一個變異參數CompilerParameters，提供了編譯時間參數選項:

CompilerOptions:擷取或設定調用編譯器時使用的可選附加命令列參數字串。

EmbeddedResources:擷取要在編譯器集輸出時包含的 .NET Framework 資源檔。

Evidence:指定一個證據對象，該對象表示要授予已編譯的程式集的安全性原則許可權。

GenerateExecutable:擷取或設定一個值，該值指示是否產生可執行檔。

GenerateInMemory:擷取或設定一個值，該值指示是否在記憶體中產生輸出。

IncludeDebugInformation:擷取或設定一個值，該值指示是否在已編譯的可執行檔中包含調試資訊。

LinkedResources:擷取當前源中引用的 .NET Framework 資源檔。

MainClass:擷取或設定主類的名稱。

OutputAssembly:擷取或設定輸出程式集的名稱。

ReferencedAssemblies:擷取當前項目所引用的程式集。

TempFiles:擷取或設定包含臨時檔案的集合.

TreatWarningsAsErrors:擷取或設定一個值，該值指示是否將警告視為錯誤。

UserToken:擷取或設定在建立編譯器進程時使用的使用者標記。

WarningLevel:擷取或設定使編譯器中止編譯的警告層級。

Win32Resource:擷取或設定要連結到已編譯器集中的 Win32 資源檔的檔案名稱。

 

他們的結果返回編譯結果CompilerResults，提供了編譯結果資訊：

CompiledAssembly：擷取或設定已編譯的程式集。

Errors:擷取編譯器錯誤和警告的集合。

Evidence:指示證據對象，該對象表示編譯的程式集的安全性原則許可權。

NativeCompilerReturnValue:擷取或設定編譯器的傳回值。

Output：擷取編譯器輸出訊息。

PathToAssembly：擷取或設定已編譯器集的路徑。

TempFiles：擷取或設定要使用的臨時檔案集合。

 

原文連結1

原文連結2

 

用C#通過反射實現動態調用WebService 告別Web引用（轉載）