大橙子网站建设,新征程启航
为企业提供网站建设、域名注册、服务器等服务
这篇文章给大家介绍怎么在C#中实现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文件,编写如下代码:
[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); } }
可以看到,我们已通过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访问。
关于怎么在C#中实现WebApi框架就分享到这里了,希望以上内容可以对大家有一定的帮助,可以学到更多知识。如果觉得文章不错,可以把它分享出去让更多的人看到。
另外有需要云服务器可以了解下创新互联scvps.cn,海内外云服务器15元起步,三天无理由+7*72小时售后在线,公司持有idc许可证,提供“云服务器、裸金属服务器、高防服务器、香港服务器、美国服务器、虚拟主机、免备案服务器”等云主机租用服务以及企业上云的综合解决方案,具有“安全稳定、简单易用、服务可用性高、性价比高”等特点与优势,专为企业上云打造定制,能够满足用户丰富、多元化的应用场景需求。