尝试在 Umbraco 7 中使用自定义路由生成 sitemap.xml 时出错

Question

我构建了一个 Umbraco 7 站点并创建了一个站点地图文档类型，该文档类型在其 Razor 视图中呈现 XML 站点地图。

这工作正常，从 URL /sitemap/ 运行。

我现在正在尝试使用自定义路由来使该站点地图在 /sitemap.xml 中可用。根据各种在线建议，我使用以下方法创建了IApplicationEventHandler 的实现：

public void OnApplicationInitialized(UmbracoApplicationBase umbracoApplication, ApplicationContext applicationContext)
{
    //custom route
    RouteTable.Routes.MapUmbracoRoute(
    "sitemap",
    "sitemap.xml",
    new
    {
        controller = "XMLSitemap"
    },
    new XmlSitemapRouteHandler());
}

XmlSitemapRouteHandler 实现 UmbracoVirtualNodeRouteHandler 并覆盖以下方法：

protected override IPublishedContent FindContent(RequestContext requestContext, UmbracoContext umbracoContext)
{
    var umbracoHelper = new UmbracoHelper(umbracoContext);

    return umbracoHelper.TypedContent(_sitemapNodeId);
}

现在我有一个非常简单的关联控制器：

public class XMLSitemapController : RenderMvcController
{
    public override ActionResult Index(RenderModel model)
    {
        return this.CurrentTemplate(model);
    }
}

当我在浏览器中加载 /sitemap.xml 时，出现以下异常：

值不能为空。 参数名称：umbracoContext

这在var umbracoHelper = new UmbracoHelper(umbracoContext); 行。当我使用 UmbracoContext.Current 代替 umbracoContext 时，我得到了同样的结果。

似乎没有创建 UmbracoContext。我的应用程序使用依赖注入（StructureMap）并且确实为 UmbracoContext 指定了一个绑定：

For<Umbraco.Web.UmbracoContext>().Use(() => Umbraco.Web.UmbracoContext.Current);

我想知道这是否与 .xml 扩展名有关，所以我尝试将自定义路由 URL 更改为“sitemapxml”。现在，当我加载此 URL 时，出现以下异常：

RouteData 必须包含一个名为 'action' 且具有非空字符串值的项目。

我确实找到了一些建议 here，这表明在这种情况下可以使用 UmbracoContext.EnsureContext，因此我尝试将路由处理程序方法更新为以下内容：

protected override IPublishedContent FindContent(RequestContext requestContext, UmbracoContext umbracoContext)
{
    var httpBase = new System.Web.HttpContextWrapper(System.Web.HttpContext.Current);
    UmbracoContext.EnsureContext(
        httpBase,
        Umbraco.Core.ApplicationContext.Current,
        new Umbraco.Web.Security.WebSecurity(httpBase, Umbraco.Core.ApplicationContext.Current),
        true); 

    var umbracoHelper = new UmbracoHelper(UmbracoContext.Current);

    return umbracoHelper.TypedContent(1090);
}

虽然代码报告此 EnsureContext 方法已过时，但我至少现在看到 UmbracoContext.Current 是一个有效的参考。但是，这次我仍然遇到异常：

对象引用未设置为对象的实例。

这是从 Umbraco.Web.Mvc.UmbracoVirtualNodeRouteHandler.GetHttpHandler(RequestContext requestContext) 的 Umbraco 程序集抛出的。

所以我被困住了。我原以为提供这样的自定义路线会相对容易。也许我完全采取了错误的方法。非常感谢您的建议。

Answer 1

有同样的问题，并进一步研究了这一点。问题出现在UmbracoVirtualNodeRouteHandler.GetHttpHandler(RequestContext requestContext) 中，因为UmbracoContext.Current 为空，但需要创建PublishedContentRequest。我不认为你可以通过继承UmbracoVirtualNodeRouteHandler来解决这个问题。

我的解决方案是实现 IRouteHandler 并从 Umbraco.Web 获取一些代码：

public class XmlSitemapRouteHandler : IRouteHandler
{
    public IHttpHandler GetHttpHandler(RequestContext requestContext)
    {
       UmbracoContext current = UmbracoContext.Current;

        if (current == null)
        {
            var httpBase = new System.Web.HttpContextWrapper(System.Web.HttpContext.Current);
            current = UmbracoContext.EnsureContext(
            httpBase,
            ApplicationContext.Current,
            new WebSecurity(httpBase, ApplicationContext.Current),
            UmbracoConfig.For.UmbracoSettings(),
            UrlProviderResolver.Current.Providers,
            false);
        }

        IPublishedContent publishedContent = this.FindContent(requestContext, current);
        if (publishedContent == null)
        {
            return new NotFoundHandler();
        }


        Uri originalRequestUrl = requestContext.HttpContext.Request.Url;

        Uri cleanedUmbracoUrl = UriUtility.UriToUmbraco(originalRequestUrl);
        current.PublishedContentRequest = new PublishedContentRequest(cleanedUmbracoUrl, current.RoutingContext, UmbracoConfig.For.UmbracoSettings().WebRouting, (string s) => Roles.Provider.GetRolesForUser(s))
        {
            PublishedContent = publishedContent
        };
        this.PreparePublishedContentRequest(current.PublishedContentRequest);
        RenderModel value = new RenderModel(current.PublishedContentRequest.PublishedContent, current.PublishedContentRequest.Culture);
        requestContext.RouteData.DataTokens.Add("umbraco", value);
        requestContext.RouteData.DataTokens.Add("umbraco-doc-request", current.PublishedContentRequest);
        requestContext.RouteData.DataTokens.Add("umbraco-context", current);
        requestContext.RouteData.DataTokens.Add("umbraco-custom-route", true);

        return new MvcHandler(requestContext);
    }

    protected IPublishedContent FindContent(RequestContext requestContext, UmbracoContext umbracoContext)
    {
        var umbracoHelper = new UmbracoHelper(umbracoContext);
        return umbracoHelper.TypedContent(_sitemapNodeId);
    }
    protected virtual void PreparePublishedContentRequest(PublishedContentRequest publishedContentRequest)
    {
        publishedContentRequest.Prepare();
    }

}

您还需要一个自定义路由扩展：

    public static Route MapXmlSitemapRoute(this RouteCollection routes, string name, string url, object defaults, XmlSitemapRouteHandler virtualNodeHandler, object constraints = null, string[] namespaces = null)
    {
        Route route = routes.MapRoute(name, url, defaults, constraints, namespaces);
        route.RouteHandler = virtualNodeHandler;
        return route;
    }

您现在可以在IApplicationEventHandler 的实现中创建这样的路由：

RouteTable.Routes.MapXmlSitemapRoute(
            "sitemap",
            "sitemap.xml",
            new
            {
                controller = "XMLSitemap",
                action = "index"
            },
            new XmlSitemapRouteHandler());

Answer 2

我想添加评论，但我没有足够的声誉。

我的建议是退后一步，尝试让基本的自定义路线发挥作用。然后你可以从那里开始工作。 我刚刚写了一篇关于 Umbraco 中自定义路由的博文，它可能会对你有所帮助。 你可以在这里找到它：https://blog.sandervanlooveren.be/posts/custom-routes-in-umbraco-for-better-seo/