Skip to main content
 首页 » 编程设计

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

2024年01月31日33lyj

我构建了一个 Umbraco 7 站点并创建了一个 Sitemap 文档类型,该文档类型在其 Razor View 中呈现 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); 
} 

现在我有一个非常简单的关联 Controller :

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

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

Value cannot be null. Parameter name: umbracoContext

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

似乎没有创建 UmbracoContext。我的应用程序使用依赖注入(inject) (StructureMap) 并为 UmbracoContext 指定绑定(bind):

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

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

The RouteData must contain an item named 'action' with a non-empty string value.

我确实找到了一些建议 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 是一个有效的引用。但是,这次我仍然遇到异常:

Object reference not set to an instance of an object.

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

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

请您参考如下方法:

遇到了同样的问题,并进一步研究了这一点。问题出现在 UmbracoVirtualNodeRouteHandler.GetHttpHandler(RequestContext requestContext) 中,因为 UmbracoContext.Current 为 null 但需要创建 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());