asp.net webapi 自托管插件式服務

来源:http://www.cnblogs.com/NotAnEmpty/archive/2016/07/14/5667582.html
-Advertisement-
Play Games

webapi問世已久,稀里糊塗的人哪它都當mvc來使,畢竟已mvc使用級別的經驗就可以應對webapi。 webapi和mvc在asp.net5時代合體了,這告訴我們,其實 它倆還是有區別的,要不現在也不會取兩個名字,但是由於本人歸納總結能力較差,各種不同也無法一一列出了。 在webapi中 Hel ...


  webapi問世已久,稀里糊塗的人哪它都當mvc來使,畢竟已mvc使用級別的經驗就可以應對webapi。

  webapi和mvc在asp.net5時代合體了,這告訴我們,其實 它倆還是有區別的,要不現在也不會取兩個名字,但是由於本人歸納總結能力較差,各種不同也無法一一列出了。

 

  在webapi中 HelpPage是個突出而又實用的東西,它尼瑪會把我們code中的註釋生成xml,然後以web頁面的方式把介面文檔展示出來,這尼瑪無形就下崗一批文案了,以社會責任感角度來講,ms的這個HelpPage挺不地道的,但我表示就喜歡這樣的東西。。

  步驟也很簡單:

    1、negut 搜 helppage ,認準Id是Microsoft.AspNet.WebApi.HelpPage就Install它;

    2、新建一個xml文件,在項目屬性-生成中 xml文檔文件路徑指向它 勾選;

    3、引入生成的HelpPage中HelpPageConfig.cs中,此代碼“config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/ApiDocument.xml")));”,修改xml路徑 然後解註釋;

    4、最後一生成就會發現你寫的並沒有卵用的註釋被一坨一坨塞入了那個xml文件當中,當訪問help/index 就會看到配圖如下:

    (附詳細參考一份:http://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/creating-api-help-pages)

    

 

    5、Negut認準Id:WebApiTestClient,Install它,你會發現多了一個js、一個cs、兩個cshtml文件,都是TestClient開頭的,別處用的時候不要忘了靠它。

      Api.cshtml文件中加入兩行代碼   

@Html.DisplayForModel("TestClientDialogs")
@section Scripts{
    <link href="~/Areas/HelpPage/TestClient.css" rel="stylesheet" />
    @Html.DisplayForModel("TestClientReferences")
}

      點入某一個介面以後,戳那個Test Api,你的項目就可以進行介面測試了。此刻你會更堅定自己身為碼農的存在,我們並不是coder,我們不生產代碼,我們只是代碼的搬運工。

    (附詳細參考一份:https://blogs.msdn.microsoft.com/yaohuang1/2012/12/02/adding-a-simple-test-client-to-asp-net-web-api-help-page/)

    

 

 

  微幅扯淡之後,言入主題,畢竟文章精髓的要藏在後面。

  從文章標題來看,就可以分成兩個部分,webapi可以寄宿iis、console、winform、winservice等,插件開發大家也不陌生,所以精髓的部分也言簡意賅了,這也是很無奈的事情啊。

  1、使用Self Host自托管方式,negut-Id:Microsoft.AspNet.WebApi.SelfHost

    1.1 首先準備一個contrller和model,代碼很簡單

public class Product
    {
        public int Id { get; set; }
        public string Name { get; set; }
        public string Category { get; set; }
        public decimal Price { get; set; }
    }

public class ProductsController : ApiController
    {
        Product[] products = new Product[]  
        {  
            new Product { Id = 1, Name = "Tomato Soup", Category = "Groceries", Price = 1 },  
            new Product { Id = 2, Name = "Yo-yo", Category = "Toys", Price = 3.75M },  
            new Product { Id = 3, Name = "Hammer", Category = "Hardware", Price = 16.99M }  
        };

        public IEnumerable<Product> GetAllProducts()
        {
            return products;
        }

        public Product GetProductById(int id)
        {
            var product = products.FirstOrDefault((p) => p.Id == id);
            if (product == null)
            {
                throw new HttpResponseException(HttpStatusCode.NotFound);
            }
            return product;
        }

        public IEnumerable<Product> GetProductsByCategory(string category)
        {
            return products.Where(p => string.Equals(p.Category, category,
                    StringComparison.OrdinalIgnoreCase));
        }
    }

    1.2 寄宿於console,監聽port,配置route,啟動service,一目瞭然

 class Program
    {
        static void Main(string[] args)
        {
            Console.WriteLine("請輸入監聽埠");
            string port = Console.ReadLine();

            var config = new HttpSelfHostConfiguration(string.Format("http://localhost:{0}", port ?? "8080"));

            config.Routes.MapHttpRoute(
                "API Default", "api/{controller}/{id}",
                new { id = RouteParameter.Optional });

            using (HttpSelfHostServer server = new HttpSelfHostServer(config))
            {
                server.OpenAsync().Wait();
                Console.WriteLine("Press ESC to quit.");
                while (
               !Console.ReadKey().Key.Equals(ConsoleKey.Escape))
                { }
            }
        }
    }

    1.3 用winservice來承載webapi服務

      首先: Install-Package Microsoft.AspNet.WebApi.OwinSelfHost  (提到Asp.Net Owin一句話可形容,Asp.Net5跨平臺,此逼功不可沒啊)

      新建好winserver項目後就可以新建一個Owin的啟動類別,在其當中構建webapi的配置

public class Startup
    {
        public void Configuration(IAppBuilder appBuilder)
        {
            // Configure Web API for self-host. 
            HttpConfiguration config = new HttpConfiguration();
            config.Routes.MapHttpRoute(
                name: "DefaultApi",
                routeTemplate: "api/{controller}/{id}",
                defaults: new { id = RouteParameter.Optional }
            );
            //config.Services.Replace(typeof(IAssembliesResolver), new PluginsResolver());
            appBuilder.UseWebApi(config);
        }
    }

      在service中啟動,over。

private IDisposable _apiserver = null;
        protected override void OnStart(string[] args)
        {
            //Services URI 
            string serveruri = string.Format("http://localhost:{0}/", System.Configuration.ConfigurationManager.AppSettings["port"]);

            // Start OWIN host  
            _apiserver = WebApp.Start<Startup>(url: serveruri);
            base.OnStart(args);
        }

        protected override void OnStop()
        {
            if (_apiserver != null)
            {
                _apiserver.Dispose();
            }
            base.OnStop();
        }

  2、插件式服務,看似逼格很高,其實只是標題黨,畫龍點睛的代碼到了...

    重寫DefaultAssembliesResolver的GetAssemblies,反射載入指定文件下的dll中的controller,在WebApiConifg添加其實現

public class PluginsResolver : DefaultAssembliesResolver
    {
        public override ICollection<Assembly> GetAssemblies()
        {
            //動態載入dll中的Controller,類似於插件服務,在WebApiConifg中添加配置
            // config.Services.Replace(typeof(IAssembliesResolver), new PluginsResolver());

            List<Assembly> assemblies = new List<Assembly>(base.GetAssemblies());
            string directoryPath = Path.Combine(System.AppDomain.CurrentDomain.BaseDirectory, "dynamic_services");
            string[] files = Directory.GetFiles(directoryPath);
            foreach (var fileName in files)
            {
                assemblies.Add(Assembly.LoadFrom(Path.Combine(directoryPath, fileName)));
            }
            return assemblies;
        }
    }

    需要什麼介面服務直接寫好dll仍進dynamic_services文件夾下就有了。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 起因 最近在對接一個第三方平臺。該平臺只提供了Java版本的SDK,C#版本的還處於敬請期待狀態。由於C#可以復用絕大部分代碼,便考慮找一個Java到C#的轉換器,在試用了幾個軟體之後,發現還是Java to C# Converter(下文簡稱Converter)好用一點。然而基本版功能受限(文件夾 ...
  • 說是手機充值系統有點裝了,其實就是調用了聚合數據的支付介面,其實挺簡單的事 但是我發現博客園竟然沒有類似文章,我就個出頭鳥把我的代碼貢獻出來吧 首先說準備工作: 去聚合數據申請賬號-添加手機支付的認證-認證通過後為賬戶充值。 上述工作完成後,開始準備開發要用到的必要參數: appid:在個人中心-我 ...
  • 就在去年Insus.NET已經寫好的一個WebAPI項目,並且發佈在IIS中。參考《創建與使用Web API》http://www.cnblogs.com/insus/p/5019088.html 從上面的鏈接可以查看到那篇實例。今天Insus.NET就另開一個ASP.NET MVC項目,去操作這個 ...
  • 最近看書比較多,正好對過去幾年的軟體開發做個總結。寫這個的初衷只是為了簡單的做一些記錄。 前言 複雜的應用程式總是面臨很多的頁面之間的數據交互,怎樣創建松耦合的程式一直是多數工程師所思考的問題。諸如依賴註入,PubSub模式,MVVM等概念,都致力於幫助我們創建更加松耦合易於維護的程式,也有不少框架 ...
  • 模擬Visual Studio中的完全匹配查找 轉載請註明出處:http://www.cnblogs.com/jzblogs/p/5670397.html ...
  • 1,document.getElementById getElementById是通過Id來設置/返回HTML標簽的屬性及調用其事件與方法。用這個方法基本上可以控制頁面所有標簽,條件很簡單,就是給每個標簽分配一個ID號。返回具有指定ID屬性值的第一個對象的一個引用。 語法: var inTag = ...
  • 第一步:購買功能變數名稱、伺服器、DNS解析這裡我們是在準備做一個網站的原材料,這三樣缺一不可。目前來說,可以租用的虛擬伺服器的商家很多,像亞馬遜、騰訊、阿裡等,當然,你也可以去找國外的一些免費的伺服器來用。實際一點來說,亞馬遜的伺服器你在成功註冊後有一年的試用期,這個倒是挺不錯的,不過他需要國外的一個信用... ...
  • 原文地址:http://docode.top/Article/Detail/10003 目錄: 1、.Net(C#)平臺下Des加密解密源代碼 2、.Net(C#)平臺下Aes加密解密源代碼 3、.Net(C#)平臺下Sha1加密解密源代碼 4、.Net(C#)平臺下MD5加密解密源代碼 5、總結 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...