GVKun编程网logo

.net – 在WebApi中,我应该在哪里调用ActionFilter之间保存数据？（调用webapi接口实例）

14

本篇文章给大家谈谈.net–在WebApi中,我应该在哪里调用ActionFilter之间保存数据？，以及调用webapi接口实例的知识点，同时本文还将给你拓展.net–IActionFiltervs

本篇文章给大家谈谈.net – 在WebApi中,我应该在哪里调用ActionFilter之间保存数据？，以及调用webapi接口实例的知识点，同时本文还将给你拓展.net – IActionFilter vs IResultFilter、.net – 为所有操作调用ActionFilterAttribute、.NetCore Web Api 利用ActionFilterAttribute统一接口返回值格式及问题解析、ActionFilter、IAuthorizationFilter 权限验证重定向跳转到其它页面等相关知识，希望对各位有所帮助，不要忘了收藏本站喔。

本文目录一览：

.net – 在WebApi中,我应该在哪里调用ActionFilter之间保存数据？（调用webapi接口实例）

.net – 在WebApi中,我应该在哪里调用ActionFilter之间保存数据？（调用webapi接口实例）

我有一个 ActionFilterAttribute,它在目标动作之前和之后做了一些事情.我想保存执行调用的状态以便在Executed调用中使用 – 但是我应该在哪里保存这些数据？

我希望这样的事情：

public override void OnActionExecuting(HttpActionContext actionContext)
{
    actionContext.SavedState = Precomputation();
}

public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
{
    var pre = actionExecutedContext.ActionContext.SavedState;
    Postcomputation(pre);
}

但是SavedState当然不存在.我应该用什么呢？

解决方法

根据需要将项添加到actionContext.Request.Properties.

.net – IActionFilter vs IResultFilter

.net – IActionFilter vs IResultFilter

请解释IActionFilter和IResultFilter之间的区别.我知道OnActionExecuting在一个action方法执行之前发生,并且OnActionExecuted在一个action方法执行之后发生,并且进一步说明了对一个action方法的执行意味着什么.在IResultFilter的上下文中,我不理解的是执行操作结果的含义.

解决方法

操作过滤器包含在执行控制器操作之前和之后执行的逻辑.例如,您可以使用操作过滤器来修改控制器操作返回的视图数据.

结果过滤器(或IResultFilters)包含在执行视图结果之前和之后执行的逻辑.例如,您可能希望在将视图呈现给浏览器之前修改视图结果.

阅读Understanding Action Filters.

要澄清ViewResult的作用,请查看ViewResultBase执行：

viewEngineResult = this.FindView(context);
      this.View = viewEngineResult.View;

      TextWriter output = context.HttpContext.Response.Output;
      this.View.Render(new ViewContext(context,this.View,this.ViewData,this.TempData,output),output);

您将看到它首先找到视图,然后将视图呈现给Response输出流.

.net – 为所有操作调用ActionFilterAttribute

.net – 为所有操作调用ActionFilterAttribute

也许我误解了ActionFilterattribute的观点,但我现在所拥有的是以下内容： 

public class MyCustomAttribute : ActionFilterattribute
{
  public override void OnActionExecuting(ActionExecutingContext filterContext)
  {
    //do something useful here
  }
}

然后在我的Home控制器中,我有以下操作方法：

public class HomeController : Controller
{
  public ActionResult Index()
  {
    return View();
  }

  [MyCustom]
  public ActionResult test()
  {
    return View();
  }
}

我现在期望OnActionExecuting在我尝试访问/ Home / Test时被触发,但在我尝试访问/ Home / Index时却没有.

但是,它会被两个动作方法触发.我还在OnActionExecuting内部验证了实际上正在调用的Index动作.

当您调用标记有属性的操作方法时,是否有可能只调用OnActionExecuting？

解决方法

检查Global.asax中的GlobalFilters集合中是否存在MyCustomAttribute.

.NetCore Web Api 利用ActionFilterAttribute统一接口返回值格式及问题解析

.NetCore Web Api 利用ActionFilterAttribute统一接口返回值格式及问题解析

.Net Core 同 Asp.Net MVC一样有几种过滤器，这里不再赘述每个过滤器的执行顺序与作用。

在实际项目开发过程中，统一API返回值格式对前端或第三方调用将是非常必要的，在.NetCore中我们可以通过ActionFilterAttribute来进行统一返回值的封装。

在封装之前我们需要考虑下面几个问题：

1，需要对哪些结果进行封装

我目前的做法是，只对ObjectResult进行封装，其他的类型：FileResult,ContentResult,EmptyResult,RedirectResult不予处理

2，对异常错误的封装

既然是统一返回值，当然也要考虑接口异常的问题了

但是不是所有的异常我们都需要返回给前端的，我们可能需要自定义一个业务异常，业务异常可以在前端进行友好提示，系统异常完全没必要抛出给前端或第三方，且需要对系统异常进行日志记录

项目结构：

Exceptions：自定义业务异常

Filters：自定义过滤器（统一结果封装，全局异常）

Models：统一结果实体

部分代码：

using System;
 
namespace NetCoreCommonResult.Exceptions
{
    /// <summary>
    /// 自定义业务异常，可以由前端抛出友好的提示
    /// </summary>
    public class BizException:Exception
    {
        public BizException()
        {
        }
        public BizException(string message):base(message)
        public BizException(string message, Exception ex) : base(message, ex)
    }
}
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Filters;
 
namespace NetCoreCommonResult.Filters
{
    public class CommonResultFilterAttribute : ActionFilterAttribute
    {
        public override void OnResultExecuting(ResultExecutingContext context)
        {
            if (context.Result is ObjectResult objRst)
            {
                if (objRst.Value is Models.ApiResult)
                    return;
                context.Result = new ObjectResult(new Models.ApiResult
                {
                    Success = true,
                    Message = string.Empty,
                    Data = objRst.Value
                });
            }
        }
    }
}
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Filters;
using Microsoft.Extensions.Logging;
 
namespace NetCoreCommonResult.Filters
{
    public class GlobalExceptionFilterAttribute : ExceptionFilterAttribute
    {
        private readonly ILogger<GlobalExceptionFilterAttribute> _logger;
        public GlobalExceptionFilterAttribute(ILogger<GlobalExceptionFilterAttribute> logger)
        {
            _logger = logger;
        }
        public override void OnException(ExceptionContext context)
        {
            context.ExceptionHandled = true;
            var isBizExp = context.Exception is Exceptions.BizException;
            context.Result = new ObjectResult(new Models.ApiResult
            {
                Success = false,
                Message = context.Exception.Message
            });
            //非业务异常记录errorLog,返回500状态码，前端通过捕获500状态码进行友好提示
            if (isBizExp == false)
            {
                _logger.LogError(context.Exception, context.Exception.Message);
                context.HttpContext.Response.StatusCode = 500;
            }
            base.OnException(context);
        }
    }
}

Startup.cs

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
 
namespace NetCoreCommonResult
{
    public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }
        public IConfiguration Configuration { get; }
        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
            services.AddLogging();
            services.AddControllers(ops =>
            {
                //添加过滤器
                ops.Filters.Add(new Filters.CommonResultFilterAttribute());
                //GlobalExceptionFilterAttribute构造中注入其他服务，需要通过ServiceFilter添加
                ops.Filters.Add(new Microsoft.AspNetCore.Mvc.ServiceFilterAttribute(typeof(Filters.GlobalExceptionFilterAttribute)));
            });
            //注册GlobalExceptionFilterAttribute
            services.AddScoped<Filters.GlobalExceptionFilterAttribute>();
        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
            if (env.IsDevelopment())
                app.UseDeveloperExceptionPage();
            }
            else
                app.UseExceptionHandler("/Error");
            app.UseStaticFiles();
            app.UseRouting();
            app.UseAuthorization();
            app.UseEndpoints(endpoints =>
                endpoints.MapControllers();
    }
}

最后新建一个Controller然后写上几个不同返回值的的Action

using Microsoft.AspNetCore.Mvc;
using System;
using System.Collections.Generic;
using System.Text;
using System.Threading.Tasks;
 
namespace NetCoreCommonResult.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class HomeController : ControllerBase
    {
        /// <summary>
        /// string
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        public string Index() => "Welecome to .NetCore";
        /// 跳转，不处理
        [HttpGet("redirect")]
        public ActionResult Redirect() => RedirectToAction("Index");
        ///
        [HttpGet("num")]
        public int Num() => 10;
        /// 异步
        [HttpGet("async")]
        public Task<IEnumerable<string>> TaskString() =>Task.FromResult<IEnumerable<string>>(new[] { "A","B","C"});
        /// 文件输出，不处理
        [HttpGet("file")]
        public ActionResult GetFile() => File(Encoding.UTF8.GetBytes("File String"), "text/plain");
        /// 空返回值，不处理
        [HttpGet("empty")]
        public ActionResult Empty() => Empty();
        /// contentResult 不处理
        [HttpGet("content")]
        public ActionResult Content() => Content("this is content");
        /// 异常，返回500错误
        [HttpGet("exception")]
        public ActionResult GetException() => throw new InvalidOperationException("invalid");
        /// 自定义异常，返回200
        [HttpGet("bizException")]
        public ActionResult GetBizException() => throw new Exceptions.BizException("bizException");
    }
}

下面是返回结果截图：

上图：访问/api/home和/api/home/redirect的结果

上图：Action返回数字的结果

上图：返回string集合的结果

上图：输出文本文件的结果

上图：返回ContentResult的结果

上图：系统异常的结果，输出状态码为500

上图：抛出业务异常的结果，输出状态码200

不知道如何上传ZIP包，实例代码项目已经放到Gitee上了，后面有时间也会写点简单的例子
地址：https://gitee.com/tang3402/net-core-samples.git

到此这篇关于.NetCore Web Api 利用ActionFilterAttribute统一接口返回值格式的文章就介绍到这了,更多相关.NetCore Web Api 统一接口返回值格式内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！

您可能感兴趣的文章:
  • 手把手教你AspNetCore WebApi数据验证的实现
  • 手把手教你AspNetCore WebApi认证与授权的方法
  • Netcore Webapi返回数据的三种方式示例

ActionFilter、IAuthorizationFilter 权限验证重定向跳转到其它页面

ActionFilter、IAuthorizationFilter 权限验证重定向跳转到其它页面

方法一：

public class IsAllowAttribute: ActionFilterAttribute
{
    public override void OnActionExecuting(ActionExecutingContext filterContext)
    {
        if (!Ctx.User.IsAllow) 
        {
            filterContext.Result = new RedirectToRouteResult(
                new RouteValueDictionary 
                { 
                    { "controller", "Home" }, 
                    { "action", "Index" }         //需要跳转到的 controller 对应的 action   
                });
        }
    }
}

方法二：

public class AuthorizeActionFilterAttribute : ActionFilterAttribute
{
  public override void OnActionExecuting(FilterExecutingContext filterContext)
  {
    HttpSessionStateBase session = filterContext.HttpContext.Session;　　//获取当前用户的Session
    Controller controller = filterContext.Controller as Controller;

    if (controller != null)
    {
      if (session["Login"] == null)
      {
        filterContext.Cancel = true;
        controller.HttpContext.Response.Redirect("./Login");　　//重定向到要跳转的页面
      }
    }

    base.OnActionExecuting(filterContext);
  }
}

 

今天关于.net – 在WebApi中,我应该在哪里调用ActionFilter之间保存数据？和调用webapi接口实例的介绍到此结束，谢谢您的阅读，有关.net – IActionFilter vs IResultFilter、.net – 为所有操作调用ActionFilterAttribute、.NetCore Web Api 利用ActionFilterAttribute统一接口返回值格式及问题解析、ActionFilter、IAuthorizationFilter 权限验证重定向跳转到其它页面等更多相关知识的信息可以在本站进行查询。

本文标签：

上一篇asp.net – IsPostBack,IsAsync和IsCallback有什么区别？（iis和spdif）

下一篇asp.net-mvc – 确保您的Repository和UnitOfWork类共享相同的nhibernate会话对象的正确方法是什么？

相关文章