Building sitemap.xml for SEO ASP.NET MVC

Ian Mercer — Tue, 09 Feb 2010 23:30:58 +0000

Creating a sitemap.xml file for Google and other search engines can be accomplished in MVC using a simple ActionResult that returns the appropriate XML blog. The problem however is in generating the list of URLs to go into that sitemap.xml file.

In ASP.NET MVC there is no distinction between an action method that is a page and one that is a service call. To remedy that let’s create an ActionFilterAttribute that can be applied to any method to mark it as a page and to record the URL that we want that page to show up as in our sitemap:

/// 
/// This attribute indicates that a method is an actual page and gives the data for it
/// 
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, Inherited = true, AllowMultiple = false)]
public class MVCUrlAttribute : ActionFilterAttribute
{
public string Url { get; private set; }
 8
public MVCUrlAttribute(string url)
{
this.Url = url;
}
 13
public override void OnResultExecuting(ResultExecutingContext filterContext)
{
string fullyQualifiedUrl = filterContext.HttpContext.Request.Url.GetLeftPart(UriPartial.Authority) + this.Url;
// We build HTML here because we want the View to be easily able to include it without any conditionals
// and because the ASP.NET WebForms view engine sometimes doesn’t subsitute <% in certain head items
filterContext.Controller.ViewData["CanonicalUrl"] = @” + fullyQualifiedUrl + ” />”;
base.OnResultExecuting(filterContext);
}
}

You may wonder at this point why we can’t just use the Routing table to figure this out. The issue is that multiple routes may map onto one page but we still want it to show up just once in the sitemap otherwise we will get slammed for duplicate content. We also want to be able to mark each page with its canonical URL.

Now we can use reflection to find all of the ‘pages’ in our ASP.NET MVC Application and then build a sitemap.xml file from them.

List<string> allPageUrls = new List<string>();
 2
// Find all the MVC Routes
Log.Debug(“*** FINDING ALL MVC ROUTES MARKED FOR INCLUSION IN SITEMAP”);
var allControllers = Assembly.GetExecutingAssembly().GetTypes().Where(t => t.IsSubclassOf(typeof(Controller)));
Log.DebugFormat(“Found {0} controllers”, allControllers.Count());
 7
foreach (var controllerType in allControllers)
{
var allPublicMethodsOnController = controllerType.GetMethods(BindingFlags.Public | BindingFlags.Instance);
Log.DebugFormat(“Found {0} public methods on {1}”, allPublicMethodsOnController.Count(), controllerType.Name);
 12
foreach (var publicMethod in allPublicMethodsOnController)
{
var mvcurlattr = publicMethod.GetCustomAttributes(true).OfType<MVCUrlAttribute>().FirstOrDefault();
if (mvcurlattr != null)
{
string url = mvcurlattr.Url;
Log.Debug(“Found “ + controllerType.Name + “.” + publicMethod.Name + ” <– “ + url);
allPageUrls.Add(url);
}
}
}

Ian Mercer » sitemap

Building sitemap.xml for SEO ASP.NET MVC