ASP.NET MVC API 接口验证的示例代码

2023-09-22 23:21:08 112

项目中有一个留言消息接口，接收其他系统的留言和展示留言，参考了网上的一些API验证方法，发现使用通用权限管理系统提供的验证方法最完美。

下面将实现的完整思路共享

1、WebApiConfig全局处理

///
///WebApiConfig
///路由基础配置。
///
///
///修改记录
///
///2016.11.01版本：2.0宋彪对日期格式进行统一处理。
///2016.10.30版本：2.0宋彪解决json序列化时的循环引用问题。
///2016.10.28版本：2.0宋彪回传响应格式$format支持。
///2016.09.01版本：1.0宋彪创建。
///
///版本：1.0
///
///
///宋彪
///2016.09.01
///
///
publicstaticclassWebApiConfig
{
///
///注册全局配置服务
///
///
publicstaticvoidRegister(HttpConfigurationconfig)
{
//WebAPIconfigurationandservices

//强制https访问
//config.Filters.Add(newForceHttpsAttribute());
//统一回传格式
config.Filters.Add(newApiResultAttribute());
//发生异常时处理
config.Filters.Add(newApiErrorHandleAttribute());
//ToKen身份验证过滤器更方便不需要在这里了具有改标签的就会自动检查
//config.Filters.Add(newApiAuthFilterAttribute());
//解决json序列化时的循环引用问题
config.Formatters.JsonFormatter.SerializerSettings.ReferenceLoopHandling=Newtonsoft.Json.ReferenceLoopHandling.Ignore;
//对日期格式进行统一处理
config.Formatters.JsonFormatter.SerializerSettings.Converters.Add(
newIsoDateTimeConverter()
{
DateTimeFormat="yyyy-MM-ddhh:mm:ss"
}
);

//WebAPIroutes路由
config.MapHttpAttributeRoutes();

config.Routes.MapHttpRoute(
name:"DefaultApi",
routeTemplate:"api/{controller}/{action}/{id}",
defaults:new{id=RouteParameter.Optional}
);

//干掉XML序列化器
//config.Formatters.Remove(config.Formatters.XmlFormatter);
//在请求的Url加上?$format=xml，便可以指定响应格式
config.Formatters.XmlFormatter.AddQueryStringMapping("$format","xml","application/xml");
config.Formatters.JsonFormatter.AddQueryStringMapping("$format","json","application/json");
}
}

2、身份验证过滤器

usingDotNet.Business;
usingDotNet.Utilities;
usingDotNet.Tracking.API.Common;

///
///ApiAuthFilterAttribute
///身份验证过滤器,具有ApiAuthFilterAttribute标签属性的方法会自动检查
///
///
///修改纪录
///
///2016-10-11版本：1.0SongBiao创建文件。
///
///
///SongBiao
///2016-10-11
///
///
[AttributeUsage(AttributeTargets.Class|AttributeTargets.Method,Inherited=true,AllowMultiple=true)]
publicclassApiAuthFilterAttribute:AuthorizationFilterAttribute
{
///
///未授权时的提示信息
///
privateconststringUnauthorizedMessage="请求未授权，拒绝访问。";

///
///权限进入
///
///
publicoverridevoidOnAuthorization(HttpActionContextactionContext)
{
base.OnAuthorization(actionContext);
//允许匿名访问
if(actionContext.ActionDescriptor.GetCustomAttributes().Count>0)
{
return;
}

stringsystemCode=APIOperateContext.Current.SystemCode;
stringpermissionCode=APIOperateContext.Current.PermissionCode;
stringappKey=APIOperateContext.Current.AppKey;
stringappSecret=APIOperateContext.Current.AppSecret;
if(string.IsNullOrWhiteSpace(appKey)||string.IsNullOrWhiteSpace(appSecret))
{
//未验证（登录）的用户,而且是非匿名访问，则转向登录页面
//actionContext.Response=actionContext.Request.CreateResponse(HttpStatusCode.Unauthorized);
//actionContext.Response.Content=newStringContent("Unauthorized",Encoding.UTF8,"text/html");
varresponse=actionContext.Response=actionContext.Response??newHttpResponseMessage();
response.StatusCode=HttpStatusCode.Unauthorized;
BaseResultresult=newBaseResult
{
Status=false,
StatusMessage=UnauthorizedMessage
};
response.Content=newStringContent(result.ToJson(),Encoding.UTF8,"application/json");
}
else
{
//检查AppKey和AppSecret
BaseResultresult=BaseServicesLicenseManager.CheckService(appKey,appSecret,false,0,0,systemCode,permissionCode);
if(!result.Status)
{
varresponse=actionContext.Response=actionContext.Response??newHttpResponseMessage();
response.Content=newStringContent(result.ToJson(),Encoding.UTF8,"application/json");
}
}

}
}

3、统一回传格式

///
///ApiResultAttribute
///统一回传格式
///
///修改纪录
///
///2016-10-31版本：1.0宋彪创建文件。
///
///
///宋彪
///2016-10-31
///
///
publicclassApiResultAttribute:ActionFilterAttribute
{
///
///重写回传的处理
///
///
publicoverridevoidOnActionExecuted(HttpActionExecutedContextactionExecutedContext)
{
//快件跟踪接口传的是format，不用走这里
if(actionExecutedContext.Request.Properties.ContainsKey("format"))
{
//若发生例外则不在这边处理在异常中处理ApiErrorHandleAttribute
if(actionExecutedContext.Exception!=null)
return;
base.OnActionExecuted(actionExecutedContext);
varresult=newApiResultModel();
//取得由API返回的状态码
result.Status=actionExecutedContext.ActionContext.Response.StatusCode;
//取得由API返回的资料
result.Data=actionExecutedContext.ActionContext.Response.Content.ReadAsAsync

ASP.NET MVC API 接口验证的示例代码

热门推荐

随机推荐