WebApi簡介

来源:https://www.cnblogs.com/taotaozhuanyong/archive/2019/09/22/11567017.html

簡單創建.NET Core WebApi:https://www.cnblogs.com/yanbigfeg/p/9197375.html 登陸驗證四種方式:https://www.cnblogs.com/zuowj/p/5123943.html 解決跨域的8種方法:https://blog.csd ...


簡單創建.NET Core WebApi:https://www.cnblogs.com/yanbigfeg/p/9197375.html

登陸驗證四種方式:https://www.cnblogs.com/zuowj/p/5123943.html

解決跨域的8種方法:https://blog.csdn.net/weixin_39939012/article/details/83822126

WebApi深入學習--特性路由:https://www.cnblogs.com/TiestoRay/p/5755454.html
本文的示例代碼是基於.NET Framework下的,.NET WebApi與.NET Core WebApi的區別,個人認為主要是來自框架的不一樣。可以參照官網https://docs.microsoft.com/en-us/aspnet/core/migration/webapi?view=aspnetcore-2.2#migrate-models-and-controllers後續介紹到.NET Core的時候再詳細做下這兩個框架的不同。

 

在WebApi中,方法名以Get開頭,WebApi會自動預設之歌請求是Get請求,而如果你以其他名稱開頭而又不標註這個方法的請求方式,那麼這個時候伺服器雖然找到了這個方法,但是由於請求方式不確定,所以直接返回給你405---方法不被允許的錯誤
最後結論:所有的WebApi方法最好是加上請求的方式[HttpGet]/[HttpPost]/[HttpPut]/[HttpDelete],不要偷懶,這樣既能防止類似的錯誤,也有利於方法的維護,被人一看就知道這個方法是什麼請求

 

 網站在啟動時執行Application_Start(),給Route增加地址規則,請求進來時,會經過路由匹配找到合適的控制器。

那怎麼找Action?

  1、根據HttpMethod找方法---用的方法名字開頭,Get就是對應的Get請求

  2、如果名字不是Get開頭,可以加上[HttpGet]

  3、按照參數找最吻合

其實資源是這樣定義的,不是一個學生,而可能是一個學校。可能是一個訂單----多件商品,一次查詢,訂單-商品,數據之間嵌套關係很複雜。還有個特性路由,可以單獨定製(config.MapHttpAttributeRoutes()、標機特性)

 

 

 IOC容器+配置文件初始化

控制器也要註入--完成容器和WebApi框架融合--實現IDependencyResolver,將容器放進去--初始化

config.DependencyResolver 換成自定義的Resolver

 public class IOCController : ApiController
 {
     private IUserService _UserService = null;
     public IOCController(IUserService userService)
     {
         this._UserService = userService;
     }

     public string Get(int id)
     {
         //IUserService service = new UserService();
         //IUserService service = ContainerFactory.BuildContainer().Resolve<IUserService>();
         return Newtonsoft.Json.JsonConvert.SerializeObject(this._UserService.Query(id));
     }
 }

在WebApiConfig中加上:

 // Web API 配置和服務
 config.DependencyResolver = new UnityDependencyResolver(ContainerFactory.BuildContainer());

UnityDependencyResolver:

 public class UnityDependencyResolver : IDependencyResolver
 {
     private IUnityContainer _UnityContainer = null;
     public UnityDependencyResolver(IUnityContainer container)
     {
         _UnityContainer = container;
     }

     public IDependencyScope BeginScope()//Scope
     {
         return new UnityDependencyResolver(this._UnityContainer.CreateChildContainer());
     }

     public void Dispose()
     {
         this._UnityContainer.Dispose();
     }

     public object GetService(Type serviceType)
     {
         try
         {
             return this._UnityContainer.Resolve(serviceType);
         }
         catch (Exception ex)
         {
             Console.WriteLine(ex.Message);
             return null;
         }
     }

     public IEnumerable<object> GetServices(Type serviceType)
     {
         try
         {
             return this._UnityContainer.ResolveAll(serviceType);
         }
         catch (Exception ex)
         {
             Console.WriteLine(ex.Message);
             return null;
         }
     }
 }
View Code

ContainerFactory:

/// <summary>
/// 需要在nuget引用之後,單獨引用Unity.Configuration
/// 如果有AOP擴展,還需要引用Unity.Interception.Configuration
/// 因為我們是用配置文件來做的配置
/// </summary>
public class ContainerFactory
{
    public static IUnityContainer BuildContainer()
    {
        //get
        //{
        return _Container;
        //}
    }

    private static IUnityContainer _Container = null;
    static ContainerFactory()
    {
        ExeConfigurationFileMap fileMap = new ExeConfigurationFileMap();
        fileMap.ExeConfigFilename = Path.Combine(AppDomain.CurrentDomain.BaseDirectory + "CfgFiles\\Unity.Config");//找配置文件的路徑
        Configuration configuration = ConfigurationManager.OpenMappedExeConfiguration(fileMap, ConfigurationUserLevel.None);
        UnityConfigurationSection section = (UnityConfigurationSection)configuration.GetSection(UnityConfigurationSection.SectionName);
        _Container = new UnityContainer();
        section.Configure(_Container, "WebApiContainer");
    }
}
View Code

Basic授權認證&許可權Filter

  在Basic授權認證,(.NET Core下麵用OAuth2,後續的隨筆會記載到OAuth2),兩者的區別可以參考博客https://blog.csdn.net/qq_15028299/article/details/89028774

許可權認證,是需要的,因為是Http地址,如果不加許可權認證,別人不就可以直接拿到這邊的請求去進行操作了,然後再去猜測別的WebApi。

Session不可以嗎?WebApi預設是不支持的Session的,因為RESTFul風格,因為是狀態的。

無狀態:第二次請求和第一次請求不聯繫,沒關係。

步驟:

  1、登錄過程,是為了拿到令牌,tooken/ticket/許可證

  2、驗證成功,把賬號+密碼+其他信息+時間,加密一下,得到ticket,返回給客戶端

  3、請求時,Ajax裡面就帶上這個tooken/ticket(在header裡面驗證)

  4、介面調用時,就去驗證下ticket,解密一下,看看信息,看看時間

  5、每個方法都驗證下ticket?不是這樣的,可以基於filter來實現,FormAuthenticationTicket

用戶登錄返回的結果中會是這個樣子的。

 

 

這邊用到了AuthorizeAttribute,現在我們自定義個類CustomBasicAuthorizeAttribute繼承自AuthorizeAttribute。

1、方法註冊,標機在action上

2、控制器生效,方法全部生效,標機在Controller上

3、全局註冊:

在WebApiConfig裡面加上

 

 問題來了,現在不能每一個action都標機吧,就要用到控制器或者全局的。那麼登錄的時候也要驗證token,每次都登錄,就是登錄不上去,然後迴圈下去。。。

有一個特性AllowAnonymous,我們可以自己寫一個CustomAllowAnonymousAttribute,其實就是

下麵是示例代碼:

 #region 用戶登陸
 [CustomAllowAnonymousAttribute]
 [HttpGet]
 public string Login(string account, string password)
 {
     if ("Admin".Equals(account) && "123456".Equals(password))//應該資料庫校驗
     {
         FormsAuthenticationTicket ticketObject = new FormsAuthenticationTicket(0, account, DateTime.Now, DateTime.Now.AddHours(1), true, string.Format("{0}&{1}", account, password), FormsAuthentication.FormsCookiePath);
         var result = new
         {
             Result = true,
             Ticket = FormsAuthentication.Encrypt(ticketObject)
         };
         return JsonConvert.SerializeObject(result);
     }
     else
     {
         var result = new { Result = false };
         return JsonConvert.SerializeObject(result);
     }
 }
 #endregion



public class CustomAllowAnonymousAttribute : Attribute
{
}



 public class CustomBasicAuthorizeAttribute : AuthorizeAttribute
 {
     /// <summary>
     /// action前會先來這裡完成許可權校驗
     /// </summary>
     /// <param name="actionContext"></param>
     public override void OnAuthorization(HttpActionContext actionContext)
     {
         //actionContext.Request.Headers["Authorization"]
         if (actionContext.ActionDescriptor.GetCustomAttributes<CustomAllowAnonymousAttribute>().FirstOrDefault() != null)
         {
             return;//繼續
         }
         else if (actionContext.ActionDescriptor.ControllerDescriptor.GetCustomAttributes<CustomAllowAnonymousAttribute>().FirstOrDefault() != null)
         {
             return;//繼續
         }
         else
         {
             var authorization = actionContext.Request.Headers.Authorization;
             if (authorization == null)
             {
                 this.HandlerUnAuthorization();
             }
             else if (this.ValidateTicket(authorization.Parameter))
             {
                 return;//繼續
             }
             else
             {
                 this.HandlerUnAuthorization();
             }
         }
     }

     private void HandlerUnAuthorization()
     {
         throw new HttpResponseException(System.Net.HttpStatusCode.Unauthorized);
     }
     private bool ValidateTicket(string encryptTicket)
     {
         ////解密Ticket
         //if (string.IsNullOrWhiteSpace(encryptTicket))
         //    return false;
         try
         {
             var strTicket = FormsAuthentication.Decrypt(encryptTicket).UserData;
             //FormsAuthentication.Decrypt(encryptTicket).
             return string.Equals(strTicket, string.Format("{0}&{1}", "Admin", "123456"));//應該分拆後去資料庫驗證
         }
         catch (Exception ex)
         {
             return false;
         }

     }
 }
View Code

異常處理Filter,ExceptionFilterAttribute

1、自己定義一個類,繼承自ExceptionFilterAttribute

2、實現OnException方法

3、標機到需要的控制錢Action

4、註冊到全局

5、Filter的範圍僅僅局限在Action裡面

 public class CustomExceptionFilterAttribute : ExceptionFilterAttribute
 {
     /// <summary>
     /// 異常發生後(沒有被catch),會進到這裡
     /// </summary>
     /// <param name="actionExecutedContext"></param>
     public override void OnException(HttpActionExecutedContext actionExecutedContext)
     {
         //actionExecutedContext.Response. 可以獲取很多信息,日誌一下
         Console.WriteLine(actionExecutedContext.Exception.Message);//日誌一下
         actionExecutedContext.Response = actionExecutedContext.Request.CreateResponse(
             System.Net.HttpStatusCode.OK, new
             {
                 Result = false,
                 Msg = "出現異常,請聯繫管理員",
                 //Value=
             });//創造一個返回
         //base.OnException(actionExecutedContext);
         //ExceptionHandler
     }
 }
View Code

自定義的異常類,要在全局中進行註冊:config.Filters.Add(new CustomExceptionFilterAttribute());

WebApi全局異常處理

自定義一個類,繼承自ExceptionHandler,重寫Handle,初始化項目時,服務替換上。

 /// <summary>
 /// WEBApi的全局異常處理
 /// </summary>
 public class CustomExceptionHandler : ExceptionHandler
 {
     /// <summary>
     /// 判斷是否要進行異常處理,規則自己定
     /// </summary>
     /// <param name="context"></param>
     /// <returns></returns>
     public override bool ShouldHandle(ExceptionHandlerContext context)
     {
         string url = context.Request.RequestUri.AbsoluteUri;
         return url.Contains("/api/");

         //return base.ShouldHandle(context);
     }
     /// <summary>
     /// 完成異常處理
     /// </summary>
     /// <param name="context"></param>
     public override void Handle(ExceptionHandlerContext context)
     {
         //Console.WriteLine(context);//log
         context.Result = new ResponseMessageResult(context.Request.CreateResponse(
             System.Net.HttpStatusCode.OK, new
             {
                 Result = false,
                 Msg = "出現異常,請聯繫管理員",
                 Debug = context.Exception.Message
             }));

         //if(context.Exception is HttpException)
     }
 }



 config.Services.Replace(typeof(IExceptionHandler), new CustomExceptionHandler());//替換全局異常處理類
View Code

ActionFilter,可以在Action前/後增加邏輯

 public class CustomActionFilterAttribute : ActionFilterAttribute
 {
     public override void OnActionExecuting(HttpActionContext actionContext)
     {
         Console.WriteLine("1234567");
     }

     public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
     {
         Console.WriteLine("2345678");
         actionExecutedContext.Response.Headers.Add("Access-Control-Allow-Origin",
"*");
     }
 }
View Code

WebApi跨域請求

  這裡對WebApi跨域請求做下簡單介紹。什麼是跨域請求呢?就是瀏覽器請求時,如果A網站(功能變數名稱+埠)頁面裡面,通過XMLHTTPRequest去請求B功能變數名稱,這個就是跨域。這個請求時是跨域正常到達B伺服器後端的,正常的響應(200)。但是瀏覽器是不允許這樣操作的,除非在相應裡面有聲明(Access-Control-Allow-Origin)。

  這個是因為瀏覽器同源策略。出於安全考慮,瀏覽器限制腳本去發起蛞蝓請求。比如你想攻擊別人的網站,得自己伺服器發起請求,如果你搞個js,等於在客戶端的電腦上去攻擊別人。但是頁面是script-src、img-href、jss/css/圖片,這些是瀏覽器自己發起的,是可以跨域的。還有a標簽,iframe標簽也是可以的。瀏覽器自己的可以,但是用XHR去請求就是不行。

解決跨域的方法

  1、Jsonp:腳本標簽自動請求,請求回來的內容執行回調方法,解析數據

  2、CORS,跨域資源共用。允許伺服器在響應時,指定Access-Control-Allow-Origin,瀏覽器按照響應來操作

  nuget下麵添加cors

 

 

 全局的都允許:

 

Action級別的:

 

自定義一個一個標簽,繼承ActionFilter Attribute,執行完城後,加上actionExecutedContext.Response.Headers.Add("Access-Control-Allow-Origin", "*");

public class CustomActionFilterAttribute : ActionFilterAttribute
{
    public override void OnActionExecuting(HttpActionContext actionContext)
    {
        Console.WriteLine("1234567");
    }

    public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
    {
        Console.WriteLine("2345678");
        actionExecutedContext.Response.Headers.Add("Access-Control-Allow-Origin", "*");
    }
}
View Code

因為跨域是瀏覽器控制的,在後端並沒有跨域。

自動生成WebApi文檔(.NET Core下麵基於Swagger生成文檔)

 

 可以在瀏覽器中直接訪問。

 


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

更多相關文章
  • 非標設備多相機流水線模式緩存圖片(C/S客戶端,c 開發語言) ​ 本文所說流水線方式下存儲圖像是在軟體測量周期慢於圖片周期前提下講解的,如果軟體一直在等待圖片數據,邏輯就沒有那麼複雜。 1、非標設備項目,常規模式測量流程 常規模式下,相機採集圖像信號由上位機控制(無論軟觸發、硬觸發)。每個周期內的 ...
  • 參考文檔:Dapper one to many Table C Code pulic List GetPersons(){ var sql = @"SELECT 1 AS Id, 'Daniel Dennett' AS Name, 1942 AS Born, 1 AS CountryId, 'Uni ...
  • 你一定看過這篇文章 《進擊的 Java ,雲原生時代的蛻變》, 本篇文章的靈感來自於這篇文章。北京時間9.24 就將正式發佈.NET Core 3.0, 所以寫下這篇文章讓大家全面認識.NET Core。.NET 生態系統是一個不斷變化的生態圈,我相信它正在朝著一個偉大的方向發展。正好 最近 Inf... ...
  • 一、前言 在.Net Framework框架有專門獲取webconfig配置的方法供我們使用,但是在.Net Core或者.Net Standard中沒有可以直接使用的方法來獲取配置文件信息,下麵就來實現獲取配置信息。 二、獲取配置信息的實現 在.Net Core中,他的配置信息的載體是一個json ...
  • 首先給大家介紹一下序列化是用來乾什麼的,他為什麼出現 序列化這種技術說到底其實就是把臨時數據保存在電腦上。大家都知道對於程式而言對象是一種稍縱即逝的數據,不僅僅是程式重啟、電腦重啟,就連內部函數的變化也有可能導致對象的消失,但是總有一些對象是大家不想讓其隨意消失的並且想在下一次開啟程式的時候進行載入 ...
一周排行
  • 一、背景 代碼實例:https://gitee.com/D_C_L/CurtainEtcAOP.git我們實際系統中有很多操作,是不管做多少次,都應該產生一樣的效果或返回一樣的結果。 例如: 1. 前端重覆提交選中的數據,應該後臺只產生對應這個數據的一個反應結果。 2. 我們發起一筆付款請求,應該只 ...
  • 關鍵字:流程未來節點處理人 工作流快速開發平臺 工作流流設計 業務流程管理 asp.net 開源工作流 業務背景:一個流程在啟動起來後,是可以對一些節點計算出來處理人是誰,流程的走向。對於另外一些節點處理人有可能需要相關的人員調整的。在一些審批的環境下,需要把能夠計算出來的節點處理人在發起時計算出來... ...
  • 簡述 我們做軟體工作的雖然每天都離不開網路,可網路協議細節卻不是每個人都會接觸和深入瞭解。我今天就來和大家一起學習下Socket,並寫一個簡單的聊天程式。 一些基礎類 首先我們每天打開瀏覽器訪問網頁信息都是使用的HTTP/HTTPS協議,而HTTP是通過的TCP建立的連接。TCP底層又是通過的Soc ...
  • 點這裡進入ABP進階教程目錄 在功能按鈕區增加一個自定義按鈕 - Add(創建課程) 添加按鈕 打開展示層(即JD.CRS.Web.Mvc)的\wwwroot\view-resources\Views\Course\Index.js //用以存放Course查詢相關腳本 自帶按鈕已有五個我們再添加一 ...
  • 點這裡進入ABP進階教程目錄 我們嘗試在新增/編輯界面增加一個下拉框用來代替輸入框編輯Status 添加實體 打開領域層(即JD.CRS.Core)的Entitys目錄 //用以存放實體對象添加一個類StatusCode.cs //狀態信息 更新模型 更新查詢視圖模型 打開展示層(即JD.CRS.W ...
  • 在項目視圖中,找到-》輸出 視窗,在視窗中選擇ASP.NET Core Web伺服器,調試項目即可看到執行的sql語句 ...
  • 前言: 通過Fiddler抓取瀏覽器請求數據,相信大家已經都會用了,我們知道Fiddler是通過在本機計算器添加一個預設的代理伺服器來實現的抓包數據的,埠號為:8888。 其實當我們打開Fiddler的設置也可以看到: 然後查看本地計算器的網路代理設置: 基於上面的原理,Fiddler就實現了經過 ...
  • 場景 Winform控制項-DevExpress18下載安裝註冊以及在VS中使用: https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/100061243 在上面已經實現DevExpress的安裝之後,拖拽一個TreeList,然後怎樣給 ...
  • 場景 Winform控制項-DevExpress18下載安裝註冊以及在VS中使用: https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/100061243 DevExpress的TreeList怎樣設置數據源,從實例入手: https:/ ...
  • 場景 在開發中,經常會有一些全局作用域的常量、欄位、屬性、方法等。 需要將這些設置為全局作用域保存且其實例唯一。 註: 博客主頁: https://blog.csdn.net/badao_liumang_qizhi 關註公眾號 霸道的程式猿 獲取編程相關電子書、教程推送與免費下載。 實現 首先新建一 ...
x