StructureMap вызывает исключение Stack Empty на страницах справки Web API ModelDescriptionLink.cshtml

Question

У меня есть проект веб-API, который использует StructureMap для своего DI. Некоторое время он работал нормально, но у меня возникли некоторые проблемы со страницами справки Web API (Microsoft.AspNet.WebApi.HelpPage), где InvalidOperationExceptions генерируется в результате пустого стека.

Я создал новый проект Web API со страницами справки, и он прекрасно работает, пока я не добавлю пакет StructureMap.WebApi2, в то время как ранее упомянутое исключение выдается здесь, внутри ModelDescriptionLink.cshtml.

else if (modelDescription is CollectionModelDescription)
{
    var collectionDescription = modelDescription as CollectionModelDescription;
    var elementDescription = collectionDescription.ElementDescription;
    @:Collection of @Html.DisplayFor(m => elementDescription.ModelType, "ModelDescriptionLink", new { modelDescription = elementDescription })
}
else
{
    @Html.DisplayFor(m => modelDescription)
}

Это брошено в @:Collection of @Html.DisplayFor(m => elementDescription.ModelType, "ModelDescriptionLink", new { modelDescription = elementDescription }) когда он пытается отобразить ссылку на описание ресурса для этой модели.

Это сокращенный маршрут, который все еще вызывает исключение:

[Route("Test")]
public IHttpActionResult Post([FromBody] IEnumerable<MySimpleModel> models)
{
    return null;
}

Попытка посетить документацию для этого маршрута в http://localhost:21966/Help/Api/POST-Test вызывает исключение:

Мне удалось найти только один пример того, что у кого-то возникла та же проблема, и его решения состояли в том, чтобы переключиться с StructureMap на Ninject или избежать исключения с нулевыми проверками.

Вот вершина трассировки стека:

[InvalidOperationException: Stack empty.]
System.ThrowHelper.ThrowInvalidOperationException(ExceptionResource resource) +52
System.Collections.Generic.Stack`1.Peek() +6693321
System.Web.WebPages.WebPageBase.get_Output() +51
System.Web.WebPages.WebPageBase.GetOutputWriter() +35
System.Web.WebPages.WebPageExecutingBase.BeginContext(String virtualPath, Int32 startPosition, Int32 length, Boolean isLiteral) +50
ASP._Page_Areas_HelpPage_Views_Help_DisplayTemplates_ModelDescriptionLink_cshtml.Execute() in c:...ModelDescriptionLink.cshtml:28
System.Web.WebPages.WebPageBase.ExecutePageHierarchy() +271
System.Web.Mvc.WebViewPage.ExecutePageHierarchy() +122
System.Web.WebPages.WebPageBase.ExecutePageHierarchy(WebPageContext pageContext, TextWriter writer, WebPageRenderingBase startPage) +145
System.Web.Mvc.RazorView.RenderView(ViewContext viewContext, TextWriter writer, Object instance) +695
System.Web.Mvc.BuildManagerCompiledView.Render(ViewContext viewContext, TextWriter writer) +382
System.Web.Mvc.Html.ActionCacheViewItem.Execute(HtmlHelper html, ViewDataDictionary viewData) +278

Улавливая исключение в этом месте, он появляется позже в HelpPageApiModel.cshtml на почти идентичной линии: @Html.DisplayFor(m => m.ResourceDescription.ModelType, "ModelDescriptionLink", new { modelDescription = Model.ResourceDescription }), Это вершина трассировки стека:

[InvalidOperationException: Stack empty.]
System.ThrowHelper.ThrowInvalidOperationException(ExceptionResource resource) +52
System.Collections.Generic.Stack`1.Pop() +6667365
System.Web.WebPages.WebPageBase.PopContext() +66
System.Web.WebPages.WebPageBase.ExecutePageHierarchy(WebPageContext pageContext, TextWriter writer, WebPageRenderingBase startPage) +154

Answer 1

Все еще не уверен, почему StructureMap.WebApi2 имеет эту проблему, но мое решение было в основном переписать разрешение зависимостей без этой библиотеки. Этот пост был весьма полезен для того, чтобы реализовать его без использования IDependencyScope.

Изменить: меня попросили показать пример. Это в основном решение, опубликованное в этом блоге, но я надеюсь, что оно все равно будет полезным.

Добавьте пользовательский активатор контроллера для структуры карты:

public class StructureMapWebApiControllerActivator : IHttpControllerActivator
{
    private readonly IContainer _container;

    public StructureMapWebApiControllerActivator(IContainer container)
    {
        _container = container;
    }

    public IHttpController Create(HttpRequestMessage request, HttpControllerDescriptor controllerDescriptor, Type controllerType)
    {
        var nested = _container.GetNestedContainer();
        var instance = nested.GetInstance(controllerType) as IHttpController;
        request.RegisterForDispose(nested);
        return instance;
    }
}

Вот как выглядит моя инициализация контейнера:

public class IoC
{
    public static IContainer InitializeContainer()
    {
        IContainer container = new Container
        (
            c => c.Scan
            (
                scan =>
                {
                    scan.Assembly("assembly1");
                    scan.Assembly("assembly2");
                    scan.LookForRegistries();
                    scan.WithDefaultConventions();
                }
            )
        );
        return container;
    }
}

а затем, где бы вы ни настраивали HttpConfiguration (например, для вызова MapHttpAttributeRoutes()), замените активатор контроллера вашей новой структурной картой:

HttpConfig.MapHttpAttributeRoutes();
var container = IoC.InitializeContainer();
HttpConfig.Services.Replace(typeof(IHttpControllerActivator), new StructureMapWebApiControllerActivator(container));

В моем случае я использую OWIN, поэтому я не использую GlobalConfiguration.ConfigurationHttpConfiguration, но идея та же самая. Я считаю, что обычно есть WebApiConfig класс, который имеет метод, который передал HttpConfigurationтак что вы могли бы сделать замену там.

Изменить еще раз для измененных частей HelpController.cs:

Первоначально StructureMap пытался использовать второй конструктор (который имел аргумент HttpConfiguration), из-за чего он не мог создать экземпляр HelpController. Я исправил это, отметив второй конструктор как защищенный.

Я также изменил ссылку из HttpConfiguration в GlobalConfiguration на свою собственную (из моего класса Startup) в первом вызове конструктора, потому что я использую Owin.

public HelpController(): this(Startup.HttpConfig)
{
    logger.Trace("Help controller created");
}

protected HelpController(HttpConfiguration config)
{
    Configuration = config;
}