20、ASP.NET MVC入門到精通——WebAPI
微軟有了Webservice和WCF,為什麼還要有WebAPI?
用過WCF的人應該都清楚,面對那一大堆複雜的配置檔案,有時候一出問題,真的會叫人抓狂。而且供不同的客戶端呼叫不是很方便。不得不承認WCF的功能確實非常強大,可是有時候我們通常不需要那麼複雜的功能,只需要簡單的僅通過使用Http或Https來呼叫的增刪改查功能,這時,WebAPI應運而生。那麼什麼時候考慮使用WebAPI呢?
當你遇到以下這些情況的時候,就可以考慮使用Web API了。
- 需要Web Service但是不需要SOAP
- 需要在已有的WCF服務基礎上建立non-soap-based http服務
- 只想釋出一些簡單的Http服務,不想使用相對複雜的WCF配置
- 釋出的服務可能會被頻寬受限的裝置訪問
- 希望使用開源框架,關鍵時候可以自己除錯或者自定義一下框架
熟悉MVC的朋友你可能會覺得Web API 與MVC很類似。
Demo
1、新建專案,WebApi
2、新建類Product
public class Product { public int Id { get; set; } public string Name { get; set; } public string Category { get; set; } public decimalPrice { get; set; } }
3、新建控制器Products,為了演示,我這裡不連線資料庫,直接程式碼中構造假資料
using System.Net.Http;
using System.Web.Http;
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 IHttpActionResult GetProduct(int id) { var product = products.FirstOrDefault((p) => p.Id == id); if (product == null) { return NotFound(); } return Ok(product); } }
4、新建Index.html來測試WebAPI的呼叫,程式碼如下:
<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>Product App</title> </head> <body> <div> <h2>All Products</h2> <ul id="products" /> </div> <div> <h2>Search by ID</h2> <input type="text" id="prodId" size="5" /> <input type="button" value="Search" onclick="find();" /> <p id="product" /> </div> <script src="http://ajax.aspnetcdn.com/ajax/jQuery/jquery-2.0.3.min.js"></script> <script> var uri = 'api/products'; $(document).ready(function () { $.getJSON(uri) .done(function (data) { $.each(data, function (key, item) { $('<li>', { text: formatItem(item) }).appendTo($('#products')); }); }); }); function formatItem(item) { return item.Name + ': $' + item.Price; } function find() { var id = $('#prodId').val(); $.getJSON(uri + '/' + id) .done(function (data) { $('#product').text(formatItem(data)); }) .fail(function (jqXHR, textStatus, err) { $('#product').text('Error: ' + err); }); } </script> </body> </html>View Code
執行結果如下:
WebAPI授權
1、新建授權過濾器類APIAuthorizeAttribute.cs
/* ============================================================================== * 功能描述:APIAuthorizeAttribute * 創 建 者:Zouqj * 建立日期:2015/11/3 11:37:45 ==============================================================================*/ using System; using System.Collections.Generic; using System.Linq; using System.Net; using System.Net.Http; using System.Security.Principal; using System.Text; using System.Threading; using System.Web; using System.Web.Http.Filters; using Uuch.HP.WebAPI.Helper; namespace Uuch.HP.WebAPI.Filter { public class APIAuthorizeAttribute : AuthorizationFilterAttribute { public override void OnAuthorization(System.Web.Http.Controllers.HttpActionContext actionContext) { //如果使用者使用了forms authentication,就不必在做basic authentication了 if (Thread.CurrentPrincipal.Identity.IsAuthenticated) { return; } var authHeader = actionContext.Request.Headers.Authorization; if (authHeader != null) { if (authHeader.Scheme.Equals("basic", StringComparison.OrdinalIgnoreCase) && !String.IsNullOrWhiteSpace(authHeader.Parameter)) { var credArray = GetCredentials(authHeader); var userName = credArray[0]; var key = credArray[1]; string ip = System.Web.HttpContext.Current.Request.UserHostAddress; //if (IsResourceOwner(userName, actionContext)) //{ //You can use Websecurity or asp.net memebrship provider to login, for //for he sake of keeping example simple, we used out own login functionality if (APIAuthorizeInfoValidate.ValidateApi(userName,key,ip))//Uuch.HPKjy.Core.Customs.APIAuthorizeInfo.GetModel(userName, key, ip) != null { var currentPrincipal = new GenericPrincipal(new GenericIdentity(userName), null); Thread.CurrentPrincipal = currentPrincipal; return; } //} } } HandleUnauthorizedRequest(actionContext); } private string[] GetCredentials(System.Net.Http.Headers.AuthenticationHeaderValue authHeader) { //Base 64 encoded string var rawCred = authHeader.Parameter; var encoding = Encoding.GetEncoding("iso-8859-1"); var cred = encoding.GetString(Convert.FromBase64String(rawCred)); var credArray = cred.Split(':'); return credArray; } private bool IsResourceOwner(string userName, System.Web.Http.Controllers.HttpActionContext actionContext) { var routeData = actionContext.Request.GetRouteData(); var resourceUserName = routeData.Values["userName"] as string; if (resourceUserName == userName) { return true; } return false; } private void HandleUnauthorizedRequest(System.Web.Http.Controllers.HttpActionContext actionContext) { actionContext.Response = actionContext.Request.CreateResponse(HttpStatusCode.Unauthorized); actionContext.Response.Headers.Add("WWW-Authenticate", "Basic Scheme='eLearning' location='http://localhost:8323/APITest'"); } } }View Code
2、新增驗證方法類APIAuthorizeInfoValidate.cs
using Newtonsoft.Json; /* ============================================================================== * 功能描述:APIAuthorizeInfoValidate * 創 建 者:Zouqj * 建立日期:2015/11/3 16:26:10 ==============================================================================*/ using System; using System.Collections.Generic; using System.Linq; using System.Web; namespace Uuch.HP.WebAPI.Helper { public class APIAuthorizeInfo { public string UserName { get; set; } public string Key { get; set; } } public class APIAuthorizeInfoValidate { public static bool ValidateApi(string username, string key, string ip) { var _APIAuthorizeInfo = JsonConvert.DeserializeObject <List<APIAuthorizeInfo>>(WebConfigHelper.ApiAuthorize); var ips = WebConfigHelper.IPs.Contains(",") ? WebConfigHelper.IPs.Split(',') : new string[] { WebConfigHelper.IPs }; if (_APIAuthorizeInfo != null && _APIAuthorizeInfo.Count > 0) { foreach (var v in _APIAuthorizeInfo) { if (v.UserName == username && v.Key == key && ips.Contains(ip)) { return true; } } } return false; } } }View Code
3、把新增到全域性過濾器中,這裡要注意了,不要新增到FilterConfig.cs,而要新增到WebApiConfig.cs,因為FilterConfig是MVC用的,我們這裡是WebAPI。
public static class WebApiConfig { public static void Register(HttpConfiguration config) { config.Routes.MapHttpRoute( name: "DefaultApi", routeTemplate: "api/{controller}/{id}", defaults: new { id = RouteParameter.Optional } ); config.Filters.Add(new APIAuthorizeAttribute()); } }
使用C#來呼叫WebAPI
以下用到的幾個類,已經被我封裝好了,可以直接使用。
1、新建webAPI站點,然後新建控制器RProducts
public class RProductsController : ApiController { /// <summary> /// 備案商品回執記錄回撥介面 /// </summary> /// <param name="lst"></param> /// <returns></returns> public int Put(List<RProduct> lst) { return ReceiptInfo.UpdateReceiptProductInfo(lst); } }
2、新建類WebApiClient.cs
using System; using System.Collections.Generic; using System.Linq; using System.Net; using System.Net.Http; using System.Net.Http.Headers; using System.Text; using DBHelper.Entitys; namespace DBHelper { public static class WebApiClient<T> { static void SetBasicAuthorization(HttpClient client) { HttpRequestHeaders header=client.DefaultRequestHeaders; string user = ConfigHelper.UserName; string key = ConfigHelper.Key; Encoding encoding = Encoding.UTF8; // Add an Accept header for JSON format. // 為JSON格式新增一個Accept報頭 client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json")); //Base64編碼 var data = Convert.ToBase64String(encoding.GetBytes(user + ":" + key)); //設定AuthenticationHeaderValue header.Authorization = new AuthenticationHeaderValue("Basic", data); //通過HttpRequestHeaders.Add //header.Add("Authorization", "Basic " + data); } public static List<T> GetAll(string url) { List<T> li = new List<T>(); HttpClient client = new HttpClient(); SetBasicAuthorization(client); // List all products. // 列出所有產品 HttpResponseMessage response = client.GetAsync(url).Result;// Blocking call(阻塞呼叫)! if (response.IsSuccessStatusCode) { // Parse the response body. Blocking! // 解析響應體。阻塞! li = response.Content.ReadAsAsync<List<T>>().Result; } else { Console.WriteLine("{0} ({1})", (int)response.StatusCode, response.ReasonPhrase); } return li; } public static T GetByFilter(string url) { T entity = default(T); HttpClient client = new HttpClient(); SetBasicAuthorization(client); // List all products. // 列出所有產品 HttpResponseMessage response = client.GetAsync(url).Result;// Blocking call(阻塞呼叫)! if (response.IsSuccessStatusCode) { // Parse the response body. Blocking! // 解析響應體。阻塞! entity = response.Content.ReadAsAsync<T>().Result; } return entity; } public static T Get(string url,string id) { T entity=default(T); HttpClient client = new HttpClient(); SetBasicAuthorization(client); // List all products. // 列出所有產品 HttpResponseMessage response = client.GetAsync(string.Format("{0}/{1}",url,id)).Result;// Blocking call(阻塞呼叫)! if (response.IsSuccessStatusCode) { // Parse the response body. Blocking! // 解析響應體。阻塞! entity = response.Content.ReadAsAsync<T>().Result; } return entity; } public static bool Edit(string url,List<int> value) { HttpClient client = new HttpClient(); SetBasicAuthorization(client); var response = client.PutAsJsonAsync(url,value).Result; if (response.IsSuccessStatusCode) { return true; } else { return false; } } public static bool Edit(string url, Dictionary<int, string> dic) { HttpClient client = new HttpClient(); SetBasicAuthorization(client); var response = client.PutAsJsonAsync(url, dic).Result; if (response.IsSuccessStatusCode) { return true; } else { return false; } } public static bool EditModel(string url, List<T> value) { HttpClient client = new HttpClient(); SetBasicAuthorization(client); var response = client.PutAsJsonAsync(url, value).Result; if (response.IsSuccessStatusCode) { return true; } else { return false; } } public static List<TI> GetList<TI>(string url, List<int> value) { List<TI> list = new List<TI>(); HttpClient client = new HttpClient(); SetBasicAuthorization(client); var response = client.PostAsJsonAsync(url, value).Result; if (response.IsSuccessStatusCode) { list = response.Content.ReadAsAsync<List<TI>>().Result; } else { list = new List<TI>(); } return list; } } }View Code
3、新建類BaseEntity.cs
using NHibernate; using NHibernate.Criterion; using System; using System.Collections.Generic; using System.Configuration; using System.Data.Common; using System.Linq; using System.Text; namespace DBHelper { public abstract class BaseEntity<T, TID> where T : BaseEntity<T, TID> { #region 屬性 /// <summary> /// 編號 /// </summary> public string V_PreInvtId { get; set; } /// <summary> /// 回執狀態 /// </summary> public int V_OpResult { get; set; } /// <summary> /// 操作時間 /// </summary> public DateTime D_optime { get; set; } /// <summary> /// 備註 /// </summary> public string V_NoteS { get; set; } #endregion public virtual TID ID { get; set; } #region /// <summary> /// Session配置檔案路徑 /// </summary> protected static readonly string SessionFactoryConfigPath = System.IO.Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "NHibernate.config"); /// <summary> /// 返回對應的Session. /// </summary> protected static ISession NHibernateSession { get { return NHibernateSessionManager.Instance.GetSessionFrom(SessionFactoryConfigPath); } } #endregion #region common /// <summary> /// 根據ID從資料庫獲取一個型別為T的例項 /// </summary> public static T GetById(TID id, bool shouldLock) { T entity; if (shouldLock) { entity = NHibernateSession.Get<T>(id, LockMode.Upgrade); } else { entity = NHibernateSession.Get<T>(id); } return entity; } /// <summary> /// 根據ID從資料庫獲取一個型別為T的例項 /// </summary> public static T GetById(TID id) { return GetById(id, false); } /// <summary> /// 獲取所有的型別為T的物件 /// </summary> public static IList<T> GetAll() { return GetByCriteria(); } /// <summary> /// 根據給定的 <see cref="ICriterion" /> 來查詢結果 /// 如果沒有傳入 <see cref="ICriterion" />, 效果與 <see cref="GetAll" />一致. /// </summary> public static IList<T> GetByCriteria(params ICriterion[] criterion) { ICriteria criteria = NHibernateSession.CreateCriteria(typeof(T)); foreach (ICriterion criterium in criterion) { criteria.Add(criterium); } criteria.AddOrder(new Order("ID", false)); return criteria.List<T>(); } #endregion #region entity /// <summary> /// 根據exampleInstance的屬性值來查詢物件,返回與其值一樣的物件對錶。 /// exampleInstance中值為0或NULL的屬性將不做為查詢條件 /// </summary> /// <param name="exampleInstance">參考物件</param> /// <param name="propertiesToExclude">要排除的查詢條件屬性名</param> /// <returns></returns> public virtual IList<T> GetByExample(T exampleInstance, params string[] propertiesToExclude) { ICriteria criteria = NHibernateSession.CreateCriteria(exampleInstance.GetType()); Example example = Example.Create(exampleInstance); foreach (string propertyToExclude in propertiesToExclude) { example.ExcludeProperty(propertyToExclude); } example.ExcludeNone(); example.ExcludeNulls(); example.ExcludeZeroes(); criteria.Add(example); criteria.AddOrder(new Order("ID", false)); return criteria.List<T>(); } /// <summary> /// 使用<see cref="GetByExample"/>來返回一個唯一的結果,如果結果不唯一會丟擲異常 /// </summary> /// <exception cref="NonUniqueResultException" /> public virtual T GetUniqueByExample(T exampleInstance, params string[] propertiesToExclude) { IList<T> foundList = GetByExample(exampleInstance, propertiesToExclude); if (foundList.Count > 1) { throw new NonUniqueResultException(foundList.Count); } if (foundList.Count > 0) { return foundList[0]; } else { return default(T); } } /// <summary> /// 將指定的物件儲存到資料庫,並立限提交,並返回更新後的ID /// See http://www.hibernate.org/hib_docs/reference/en/html/mapping.html#mapping-declaration-id-assigned. /// </summary> //public virtual T Save() //{ // T entity = (T)this; // NHibernateSession.Save(entity); // NHibernateSession.Flush(); // return entity; //} /// <summary> /// 將指定的物件儲存或更新到資料庫,並返回更新後的ID /// </summary> //public virtual T Merge() //{ // T entity = (T)this; // NHibernateSession.Merge<T>(entity); // NHibernateSession.Flush(); // return entity; //} ///// <summary> ///// 從資料庫中刪除指定的物件 ///// </summary> //public virtual void Delete() //{ // T entity = (T)this; // NHibernateSession.Delete(entity); // NHibernateSession.Flush(); //}相關推薦
20、ASP.NET MVC入門到精通——WebAPI
微軟有了Webservice和WCF,為什麼還要有WebAPI? 用過WCF的人應該都清楚,面對那一大堆複雜的配置檔案,有時候一出問題,真的會叫人抓狂。而且供不同的客戶端呼叫不是很方便。不得不承認WCF的功能確實非常強大,可是有時候我們通常不需要那麼複雜的功能,只需要簡單的僅通過使用Http或Https
19、ASP.NET MVC入門到精通——Unity
一、IOC介紹 IOC(Inversion of Control),中文譯為控制反轉,又稱為“依賴注入”(DI =Dependence Injection) IOC的基本概念是:不建立物件,但是描述建立它們的方式。在程式碼中不直接與物件和服務連線,但在配置檔案中描述哪一個元件需要哪一項服務。容器負
2、ASP.NET MVC入門到精通——Entity Framework入門
實體框架(Entity Framework)簡介 簡稱EF 與ADO.NET關係 ADO.NET Entity Framework 是微軟以 ADO.NET 為基礎所發展出來的物件關係對應 (O/R Mapping) 解決方案,早期被稱為 ObjectSpace,最新版本是EF7【CodeOnly功能得
6、ASP.NET MVC入門到精通——ASP.Net的兩種開發方式
目前,ASP.NET中兩種主流的開發方式是:ASP.NET Webform和ASP.NET MVC。從下圖可以看到ASP.NET WebForms和ASP.NET MVC是並行的,也就是說MVC不會取代WebForms(至少目前是這樣)而是多了一個選擇,Webform在短期之內不會消亡,儘管存在許多缺點,
8、ASP.NET MVC入門到精通——View(檢視)
View檢視職責是向用戶提供介面。負責根據提供的模型資料,生成準備提供給使用者的格式介面。 支援多種檢視引擎(Razor和ASPX檢視引擎是官方預設給出的,其實還支援其它N種檢視引擎,甚至你自己都可以寫一套檢視引擎) View和Action之間資料傳遞(前後臺數據傳遞) 弱型別 View
5、ASP.NET MVC入門到精通——NHibernate程式碼對映
使用的是xml進行orm對映,那麼這一篇就來講下程式碼對映。 新建一個抽象的資料化持久基類AbstractNHibernateDao.cs /// <summary> /// 資料持久化基本 /// </summary> ///
12、ASP.NET MVC入門到精通——HtmlHelper
HtmlHelper:是為了方便View的開發而產生 HtmlHelper的演變 普通首頁超級連結為:<a href="/home/index">首頁</a> 當路由改變時候則可能需要修改為:<a href="/home/index1">首頁</a&
9、ASP.NET MVC入門到精通——Controller(控制器)
Controller主要負責響應使用者的輸入。主要關注的是應用程式流,輸入資料的處理,以及對相關檢視(View)輸出資料的提供。 繼承自:System.Web.Mvc.Controller 一個Controller可以包含多個Action. 每一個Action都是一個方法, 返回一個Act
22、ASP.NET MVC入門到精通——搭建專案框架
前面的章節,說了ASP.NET MVC專案中常用的一些技術和知識點,更多的是理論上面的東西,接下來,我將通過一個簡單的OA專案來應用我們之前涉及到的一些技術,為了兼顧初學者,所以我儘量把操作步驟說得足夠詳細。(本來想用VS2015來演示MVC5開發的,無奈家裡的筆記本是11年2月份的老爺機了,一直未曾捨得
7、ASP.NET MVC入門到精通——第一個ASP.NET MVC程式
開發流程 新建Controller 建立Action 根據Action建立View 在Action獲取資料並生產ActionResult傳遞給View。 View是顯示資料的模板 Url請求→Controller.Action處理→View響應 url請求→Controller.Ac
3、ASP.NET MVC入門到精通——Entity Framework增刪改查
這裡我接上講Entity Framework入門。從網上下載Northwind資料庫,新建一個控制檯程式,然後重新新增一個ado.net實體資料模型。 EF中操作資料庫的"閘道器"(操作上下文) DBContext封裝 .NET Framework 和資料庫之間的連線。此類用作“建立”、“讀取”、“更
11、ASP.NET MVC入門到精通——AspnetMVC分頁
說起分頁,這基本上是我們Web開發中遇見得最多的場景,沒有之一,可即便如此,要做出比較優雅的分頁還是需要技巧的。這裡我先說一種ASP.NET MVC中很常見的一種分頁的實現方式,很low,但是很多公司的專案就是這麼用的,我現在公司的專案就是也是,有時候面對公司專案屎一樣的使用者體驗和雜亂的程式碼,真是恨不
13、ASP.NET MVC入門到精通——MVC請求管道
ASP.NET MVC的請求管道和ASP.NET請求管道基本上一模一樣,如果你對ASP.NET請求管道十分熟悉的話,你只要關注一下不同點。看懂下面兩張圖,你就基本上明瞭了,這兩張圖是從鄒華棟部落格上面取的。(說明:我不是給傳智帶鹽的,這圖確實畫得通俗易懂)不明白的地方,用reflector工具檢視MVC的
25、ASP.NET MVC入門到精通——Spring.net-業務層倉儲
上一節,我們已經把專案框架的雛形搭建好了,那麼現在我來開始業務實現,在業務實現的過程當中,不斷的來完善我們現有的框架。 1、假設我們來做一個使用者登入的業務 那麼我們可以現在IDAL專案中定義的的介面IOu_UserInfoDAL,注意是部分類partial,為了方便管理,把這些擴充套件的部分介面都統
17、ASP.NET MVC入門到精通——Spring.net入門
Spring.NET環境準備 下載後解壓 Spring.NET-1.3.2.7z:這個裡面有我們需要用到的所有東西。 Spring.NET-1.3.2.exe:安裝檔案 Spring.NET-1.3.2-API.chm:幫助文件 NHibernate 3.2 的下載地址:
26、ASP.NET MVC入門到精通——後臺管理區域及分離、Js壓縮、css、jquery擴充套件
有好一段時間沒更新博文了,最近在忙兩件事:1、看書,學習中...2、為公司年會節目做準備,由於許久沒有練習雙截棍了,難免生疏,所以現在臨時抱佛腳。深圳最近的天氣反常,許多人感冒了,我也成為其中之一,大家注意身體... 這一篇,我來簡單的講一下接下來專案中會用到的一些雜七雜八的技術。 區域及分離
21、ASP.NET MVC入門到精通——ASP.NET MVC4優化
刪除無用的檢視引擎 預設情況下,ASP.NET MVCE同時支援WebForm和Razor引擎,而我們通常在同一個專案中只用到了一種檢視引擎,如Razor,那麼,我們就可以移除掉沒有使用的檢視引擎,提高View檢視的檢索效率。在沒有刪除WebForm引擎之前,檢索控制器中不存在的檢視時,我們可以從下圖看
23、ASP.NET MVC入門到精通——業務層和資料層父類及介面-T4模板
在上一篇中,我們已經把專案的基本框架搭起來了,這一篇我們就來實現業務層和資料層的父介面及父類。 1、我們先來定義一個業務層父介面IBaseBLL.cs using System; using System.Collections.Generic; using System.Linq; u
1、ASP.NET MVC入門到精通——新語法
在學習ASP.NET MVC之前,有必要先了解一下C#3.0所帶來的新的語法特性,這一點尤為重要,因為在MVC專案中我們利用C#3.0的新特性將會大大的提高我們的開發效率,同時,在MVC專案中你將到處可以看到C#3.0新特性的身影。其本質都是“語法糖”,由編譯器在編譯時轉成原始語法。 目錄 自動屬
10、ASP.NET MVC入門到精通——Model(模型)和驗證
模型就是處理業務,想要儲存、建立、更新、刪除的物件。 註解(通過特性實現) DisplayName Required StringLength(20,MinimumLength=2) DataType(System.ComponentModel.DataAnnotations.Dat