Extend UniqueSeoGenerator to replace SEO URL generation in EPiServer Commerce 8.9

In EPiServer Commerce 7.5, we had Magnus Rahl's post about replacing SEO URL generation. And one more time from EPiServer Commerce 8.0 and above still support two different approaches for routing to catalog content. However, there are some improvements to make creating custom SEO easier, more flexible and increase performance.

By default the SEO URL is generated from content name, language branch name and “file extension” .aspx appended. SEO uri is look like “Tops-Tunics-LongSleeve-en.aspx” and with hierarchical route using the Name in URL property, it become /catalog/category/subcategory/ and URL segment.

And now, we can customize SEO URL by extending Mediachase.Commerce.Catalog.Data.UniqueSeoGenerator

Generating your own SEO URLs

The SEO URL generation is handled by the Mediachase.Commerce.Catalog.Data.UniqueSeoGenerator class. We can override the generating method:

Sample extend class:

public class ExtendUniqueSeoGenerator : UniqueSeoGenerator
{
	protected override string UriExtension
	{
		get
		{
			// Default value is ".aspx"
			return ".html";
		}
	}

	public override string GenerateSeoUri(string name, string languageCode, bool includeRandomToken)
	{      
		// When extend UniqueSeoGenerator, Uri will become: tops_tunics_longsleeve_en.aspx or tops_tunics_longsleeve_en_asdfghjk.aspx
		return includeRandomToken
			? String.Format("{0}_{1}_{2}{3}", CommerceHelper.CleanUrlField(name), languageCode, GetRandomToken(), UriExtension)
			: String.Format("{0}_{1}{2}", CommerceHelper.CleanUrlField(name), languageCode, UriExtension);
	}

	public override string GenerateUriSegment(string name, bool includeRandomToken)
	{ 
		// When extend UniqueSeoGenerator, UriSegment will become: tops_tunics_longsleeve or tops_tunics_longsleeve_asdfghjk
		return includeRandomToken
			? String.Format("{0}_{1}", UrlSegment.GetUrlFriendlySegment(name), GetRandomToken())
			: UrlSegment.GetUrlFriendlySegment(name);
	}

	protected override string GetRandomToken()
	{
		var chars = "abcdefghijklmnopqrstuvwzyz1234567890";
		var random = new Random();
		var result = new string(
			Enumerable.Repeat(chars, 8)
					  .Select(s => s[random.Next(s.Length)])
					  .ToArray());
		return result;
	}
}

GenerateUri and GenerateUriSegment method will be called when data has the same Uri (or UriSegment) that is existed.To make use of your implementation you need an initialization module to replace the configuration in the container:

using EPiServer.Framework;
using EPiServer.Framework.Initialization;
using EPiServer.ServiceLocation;
using EPiServer.Commerce.SampleMvc.Business;
using Mediachase.Commerce.Catalog.Data;
 
namespace EPiServer.Commerce.SampleMvc
{
    [ModuleDependency(typeof(EPiServer.Commerce.Initialization.InitializationModule))]
    public class Initialization : IConfigurableModule
    {
        public void Initialize(InitializationEngine context)
        {
        }
 
        public void Preload(string[] parameters)
        {
        }
 
        public void Uninitialize(InitializationEngine context)
        {
        }
 
        public void ConfigureContainer(ServiceConfigurationContext context)
        {
            context.Container.Configure(c => c.For< UniqueSeoGenerator>().Use<ExtendUniqueSeoGenerator>());
        }
    }
}