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生成文檔)

 

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

 


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

更多相關文章
  • 0922自我總結 DJango錯誤日誌生成 setting.py設置 exception.py(拋錯設置) logging.py ...
  • 工作了兩個月了體會到了很多之前做外包小項目沒有的東西,不得不說大廠的還是有自己一套的完善的體制,不會像B站那樣泄露自己整個後臺的源碼這種事情發生。 電腦辦公 比如說在使用電腦辦公這方面,剛入職那天每個人都會領一臺電腦(MAC和Windows都有看工作需要),每個人領的電腦上都裝有 度管家 ,度管家是 ...
  • 1、ssh免密登錄 ssh ip地址 免密登錄配置 生成公鑰和私鑰 將公鑰拷貝到要免密登錄的目標機器上 .ssh文件夾下(~/.ssh)的文件功能解釋 (1)known_hosts :記錄ssh訪問過電腦的公鑰(public key) (2)id_rsa :生成的私鑰 (3)id_rsa.pub ...
  • 1、HttpClient遠程介面調用 1)用戶註冊 註冊按鈕 提交表單時,要 表單 js提交表單 2)載入外部資源文件 app.properties 編輯 RestApiServerInfo.java 3)HTTPClient工具遠程調用介面 導入依賴 發送post請求 工具類 遠程介面返回 封裝對 ...
  • 緩存的實現 我們不是做第三方比如Redis等的緩存實現,而是根據實際情況,基於C#上做一些環境變數的保存,方便項目使用。 1、系統全局變數 很多時候,在系統運行開始,需要對系統的運行參數進行保存,以便供全局使用。 代碼如下: 這裡使用一個靜態變數的Dictionary來進行保存,所有項目均可以直接獲 ...
  • 就像是.NET Framework WebApi與.NET Core WebApi一樣,.NET Framework MVC與.NET Core MVC的區別,也是框架的之間的區別。本系列先首先從.NET Framework MVC介紹,後面再去介紹.NET Core MVC 狹義MVC: MVC是 ...
  • 表達式樹練習實踐:C 值類型、引用類型、泛型、集合、調用函數 [TOC] 一,定義變數 C 表達式樹中,定義一個變數,使用 。 創建變數結點的方法有兩種, 兩種方式都是生成 類型 和 都具有兩個重載。他們創建一個 ParameterExpression節點,該節點可用於標識表達式樹中的參數或變數。 ...
  • 最近有個需求就是網頁表格裡面的數據導出到excel 於是從各位前輩的博客園搜了搜demo 大部分非為兩類 都是用的插件NPOI和Eppluse ,因此在這裡就介紹Eppluse 用法,還有就是在博客的時候 好多有留言說想看從資料庫裡面的數據進行導入 而不是寫死的,所以我就以我的案例給大家分享下用法( ...
一周排行
  • 該方式是直接對屏幕進行截圖操作UserControl chartContainPanel = new UserControl();Graphics graph = chartContainPanel.CreateGraphics();Size s = chartContainPanel.Size;B... ...
  • dotnetcore3.1 WPF 中使用依賴註入 Intro 在 ASP.NET Core 中預設就已經集成了依賴註入,最近把 "DbTool" 遷移到了 WPF dotnetcore 3.1, 在 WPF 中我們也希望能夠使用依賴註入,下麵來介紹一下如何在 WPF dotnetcore3.1 中 ...
  • 原來的C 程式都有Main的,現在用vs新建一個Wpf項目,啟動似乎變成App.xmal,前期項目中為了獲取啟動參數,很是折騰了一番: 1.先是修改App.xaml,添加StartUp事件 2.然後編輯Application_Startup,判斷e.Args數組 總感覺跟又臭又長的裹腳布一樣,不爽。 ...
  • 冒泡排序原理:(升序)通過當前位置數和後一個位置數進行比較 如果當前數比後一個數大 則交換位置, 完成後 比較基數的位置變成下一個數。直到數組末尾,當程式運行完第一遍 最大的數已經排序到最後一個位置了。次數可以減少迴圈數不用管最後一個數 降序排序同理 不過是把比較方式變成判斷當前數是否小於下一個數 ...
  • 一、前言 這方面的資料很多,重覆的寫沒必要,但是最近一直在學習身份驗證和授權相關東東,為了成體系還是寫一篇,主要是從概念上理解identity系統。 參考:https://www.cnblogs.com/r01cn/p/5179506.html 二、概述 幾乎所有系統都包含用戶、角色、許可權、登錄、註 ...
  • 首先我們使用最簡單的模板案例,裡面有一個Counter計數器,你可以在創建模板中找到。 首先需要設置運行調試方式為IIS Express。這意味著,MAC可能不能使用調試。 然後開啟運行而不調試(Ctrl+F5) 按Shift + Alt + D,會出現一個新的頁面。 如果你想用Chrome調試,復 ...
  • 實體映射時,遇到複雜類型,可選擇下述方法處理: NotMapped,跳過映射 在複雜類型上聲明 [Owned],但僅限該複雜類型是全部由簡單值類型組成的 自定義序列化方法 示例: IPInfo使用了owned,對IPEndPoint使用自定義序列化,對VersionInfo使用JSON序列化 @@@... ...
  • .NET Core 3 Web Api Cors fetch 一直 307 Temporary Redirect 繼上一篇 ".net core 3 web api jwt 一直 401" 為添加 所述的坑後, 本次為添加 ,又踩坑了。 自從 .NET Core 2.2 之後,CORS跨域配置代碼發 ...
  • 在前一章已經學習過WPF動畫的第一條規則——每個動畫依賴於一個依賴項屬性。然而,還有另一個限制。為了實現屬性的動態化(換句話說,使用基於時間的方式改變屬性的值),需要有支持相應數據類型的動畫類。例如,Button.Width屬性使用雙精度數據類型。為實現屬性的動態化,需要使用DoubleAnimat ...
  • WPF dotnet core 3.1 基於 `Microsoft.Extensions.Localization` 實現基本的多語言支持 ...
x