如何根据请求控制响应包装在 Aspnetboilerplate (ABP) 中

Question

I'm using ABP (aspnetboilerplate) 7.0 thru Aspnet Zero 11 and I'm trying to get OData working. I've followed the article over at ABP and I've taken inspiration from their sample.

OData routes ( /odata and /odata/$metadata ) answers should not be wraped. ABP does provide an attribute to prevent wraping called DontWrap . However, since theses routes are not on controllers that I have direct acces to, I can't set the attribute.

The same question has been asked here Disable Wrapping of Controller Results however, they wanted to disable wrapping altogether, which is not what I want to do.

The answer to that question, is to use a ResultFilter to set the attribute's value. I have however found that setting the value thru the attribute also sets the value that comes from the injected IAbpAspNetCoreConfiguration

For example:

    public class ODataResultFilter : IResultFilter, ITransientDependency
    {
        private readonly IAbpAspNetCoreConfiguration _configuration;

        public ODataResultFilter(IAbpAspNetCoreConfiguration configuration)
        {
            _configuration = configuration;
        }

        public void OnResultExecuting(ResultExecutingContext context)
        {
            var methodInfo = context.ActionDescriptor.GetMethodInfo();

            var wrapResultAttribute =
                GetSingleAttributeOfMemberOrDeclaringTypeOrDefault(
                    methodInfo,
                    _configuration.DefaultWrapResultAttribute,
                    false
                );

            if (context.HttpContext.Request.Path.Value.Equals("/odata/$metadata") ||
                context.HttpContext.Request.Path.Value.Equals("/odata"))
            {
                wrapResultAttribute.WrapOnSuccess = false;
            }
        }

        public void OnResultExecuted(ResultExecutedContext context)
        {
            // No action
        }

        private TAttribute GetSingleAttributeOfMemberOrDeclaringTypeOrDefault<TAttribute>(MemberInfo memberInfo, TAttribute defaultValue = default(TAttribute), bool inherit = true)
            where TAttribute : class
        {
            return memberInfo.GetCustomAttributes(true).OfType<TAttribute>().FirstOrDefault()
                   ?? memberInfo.DeclaringType?.GetTypeInfo().GetCustomAttributes(true).OfType<TAttribute>().FirstOrDefault()
                   ?? defaultValue;
        }
    }

As soon as I hit wrapResultAttribute.WrapOnSuccess = false; , _configuration.DefaultWrapResultAttribute becomes false and every other request ends up not being wrapped. My front-end expects wrapped responses and thus the front-end stops working as soon as I hit an odata route once.

How can I manipulate this attribute and prevent wrapping for OData routes but leave the default + attribute-configured wrapping behavior for the other routes?

GetSingleAttributeOfMemberOrDeclaringTypeOrDefault method should work fine, except right now, since _configuration.DefaultWrapResultAttribute gets modified, a controller that doesn't explicitly sets a WrapResult attribute will get the default, overriden by the last value set...

Answer 1

Implement IWrapResultFilter , which was introduced in ABP v6.5:

using Abp.Web.Results.Filters;
using System;

namespace AbpODataDemo.Web.Host.ResultWrapping
{
    public class ODataWrapResultFilter : IWrapResultFilter
    {
        public bool HasFilterForWrapOnError(string url, out bool wrapOnError)
        {
            wrapOnError = false;
            return new Uri(url).AbsolutePath.StartsWith("/odata", StringComparison.InvariantCultureIgnoreCase);
        }

        public bool HasFilterForWrapOnSuccess(string url, out bool wrapOnSuccess)
        {
            wrapOnSuccess = false;
            return new Uri(url).AbsolutePath.StartsWith("/odata", StringComparison.InvariantCultureIgnoreCase);
        }
    }
}

Add it to WrapResultFilters in the module's PreInitialize method:

public override void PreInitialize()
{
    Configuration.Modules.AbpWebCommon().WrapResultFilters.Add(new ODataWrapResultFilter());
}

Reference:

• https://aspnetboilerplate.com/Pages/Documents/AspNet-Core#wrapresultfilters
• https://github.com/aspnetboilerplate/sample-odata/pull/20