C#净化版WebApi框架

前言

咱们都知道WebApi是依赖于Asp.Net MVC的HttpRouteCollection进行路由 。

但WebApi和MVC之间是没有依赖关系的， WebApi的基类ApiController继承于IHttpController，而MVC的基类Controller 继承于IController。

WebApi和MVC虽然都使用HttpRouteCollection进行路由，但WebApi经历的通道是ServicesContainer，而MVC经历通道仍是原始的IHttpModule。

但用Visual Studio建立的MVC WebApi项目一般会带不少功能，而这些功能，不少是咱们并不想用的，或者咱们想用其余开源控件代替它。

而直接建立空项目的WebApi又太原始。

因此，让咱们编写一个简洁版本的WebApi吧。

净化版WebApi预览

首先，咱们先看下净化版WebApi的结构。

如上图所示，代码结构很简单，除开配置文件，整个Web项目只有2个文件；而须要被调用的WebApi都被封装到了WebApi程序集中了。

接下来咱们一块儿看下编写这个净化版WebApi的过程吧。

净化版WebApi编写

WebApiConfig

首先，引入必要的Dll，以下图所示。

而后，咱们编写Web项目的写WebApiConfig；代码以下：

 public static class WebApiConfig
 {
     public static void Register(HttpConfiguration config)
     { 
         config.Filters.Add(new WebApiAttribute());
         // 解决json序列化时的循环引用问题
         config.Formatters.JsonFormatter.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore; 
         // 对 JSON 数据使用混合大小写。跟属性名一样的大小.输出
         config.Formatters.JsonFormatter.SerializerSettings.ContractResolver = new DefaultContractResolver(); 
         // Web API 路由
         config.MapHttpAttributeRoutes();
         config.Routes.MapHttpRoute(
             name: "DefaultApi",
             routeTemplate: "webapi/{controller}/{id}",
             defaults: new { id = RouteParameter.Optional }
         ); 
     }
 }

能够看到WebApiConfig是个静态类中，咱们在其中建立了静态注册方法Register，在方法内，咱们主要在作一件事，那就是为HttpConfiguration对象作配置。

而在配置中，咱们将WepApi的路由配置成了webapi/{controller}/{id}，也就是说，咱们的WebApi将来的访问地址将为【http://localhost:5180/webapi/Login】这样的模式。

在WebApiConfig类中，咱们还用到了这样一个类WebApiAttribute，咱们在为HttpConfiguration对象的Filters属性，添加了这个类的对象。

经过Filters属性这个字样，咱们能够得出，这个类主要应用应该是过滤。

下面咱们看一下这个类的代码：

[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, Inherited = true, AllowMultiple = true)]
public class WebApiAttribute : ActionFilterAttribute
{ 
    public override void OnActionExecuting(HttpActionContext actionContext)
    { 
        //API执行前触发
        if (true)//当前设置，全部API均可以被调用
        {
            base.OnActionExecuting(actionContext);
        }
        else
        {
            throw new Exception("Error");
        } 
    }  
    public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
    {
        //API执行后触发 若发生例外则不在这边处理
        if (actionExecutedContext.Exception != null)
            return; 
        base.OnActionExecuted(actionExecutedContext);
    }
}

经过阅读代码，咱们应该能够发现，这是一个AOP的过滤器。

在执行真正WebApi以前，会先进入这里进行过滤，过滤经过的API，才会调用 base.OnActionExecuting(actionContext)方法进行调用和执行。

结束调用同理，结束调用前，会在该类中进行拦截和过滤处理。

配置文件

WebApiConfig编写结束了，如今，咱们须要将这个静态类注册到项目中。

打开Global.asax文件，编写以下代码：

protected void Application_Start()
{ 
    GlobalConfiguration.Configure(WebApiConfig.Register);  
    GlobalConfiguration.Configuration.Formatters.XmlFormatter.SupportedMediaTypes.Clear();//删除XML格式 回應
}

能够看到，咱们已经过Configure方法，将咱们编写好的WebApiConfig添加到了全局配置中了。

由于网站访问都存在跨域问题，因此咱们再向Global.asax中添加以下代码处理：

protected void Application_BeginRequest(object sender, System.EventArgs e)
{
    var req = System.Web.HttpContext.Current.Request;
    if (req.HttpMethod == "OPTIONS")//过滤options请求，用于js跨域
    {
        Response.StatusCode = 200;
        Response.SubStatusCode = 200;
        Response.End();
    }
}

到此Web项目的编写就完成了，下面咱们在WebApi程序集中，编写个简单的WebApi，代码以下：

public class LoginController : BaseApiController
{ 
    public BaseResult Get()
    { 
        try
        {  
            return new BaseResult() { IsSuccess=true }; 
        }
        catch (Exception ex)
        {
            
            throw ex;
        } 
    }
}
public class BaseApiController : ApiController
{   
    public string Options()
    {
        return null;
    }
}

而后咱们运行网站，进行WebApi访问。

如上图所示，咱们的WebApi访问成功。

----------------------------------------------------------------------------------------------------

到此C#净化版WebApi框架就介绍完了。

框架代码已经传到Github上了，欢迎你们下载。

Github地址：https://github.com/kiba518/WebApi

----------------------------------------------------------------------------------------------------

注：此文章为原创，任何形式的转载都请联系做者得到受权并注明出处！
若您以为这篇文章还不错，请点击下方的【推荐】，很是感谢！