Feb 8 2006

URL Mapper in ASP.NET 2.0

Category:Bil@l @ 07:54

Url Rewriting with Regex for ASP.NET 2.0

A new feature in ASP.NET 2.0 is it's built-in url rewriting support. When i looked into this new feature i found out it lacked regular expressions support, wich is really the point of an Url Mapper. ScottGlu at his blog, explains the reason why the ASP.NET team didn't implemented this feature. Basically they realized that a full featured version would want to take advantage of the next IIS 7.0 new features, specially the support for all content-types (images and directories).

Anyway, it's really simple to implement a Url Rewriting Module with Regex support in ASP.NET. I wrote a quick and simple HttpModule for this. The whole magic is done within a few lines within the HttpModule:

 1 public void Rewrite_BeginRequest(object sender, System.EventArgs args) { 
 2      string strPath = HttpContext.Current.Request.Url.AbsolutePath; 
 3      UrlRedirection oPR = new UrlRedirection(); 
 4      string strURL = strPath; 
 5      string strRewrite = oPR.GetMatchingRewrite(strPath);
 6       if (!String.IsNullOrEmpty(strRewrite)) { 
 7           strURL = strRewrite; 
 8      } else { 
 9           strURL = strPath; 
10      } 
11      HttpContext.Current.RewritePath("~" + strURL);
12 }

The code is self explanatory. When a request that is processed by the ASP.NET engine, the module checks an XML for a regex match. I've seen many Url Rewriting engines that uses Web.config to store the matching rules but i prefer using an additional XML file. The rewriting rules file look like the following:

 1 <?xml version="1.0" encoding="utf-8" standalone="yes"?>
 2 <urlrewrites>
 3      <rule name="Category Page">
 4           <url>/([a-zA-Z][\w-]{1,149})\.aspx</url>
 5           <rewrite>/Default.aspx?Category=$1</rewrite>
 6      </rule>
 7      <rule name="Item Page">
 8           <url>/([a-zA-Z][\w-]{1,149})/([a-zA-Z][\w-]{1,149})\.aspx</url>
 9           <rewrite>/Default.aspx?Category=$1&amp;Item=$2</rewrite>
10      </rule>
11 </urlrewrites>

The rule matching routine, wich is implemented in the GetMatchingRewrite() method is quite simple and lightweighted:

 1 public string GetMatchingRewrite(string URL)  {
 2      string strRtrn = "";
 4      System.Text.RegularExpressions.Regex oReg;
 6      foreach (RedirectRule oRule in Rules) {
 8           Reg = new Regex(oRule.URL);
 9           Match oMatch = oReg.Match(URL);
11           if (oMatch.Success)  {
12                strRtrn = oReg.Replace(URL, oRule.Rewrite);
13           }
15      }
16      return strRtrn;
17 }

I have uploaded a sample project that uses this rewriting engine. The HttpModule and it's helper classes are inside the App_Code folder. I hope you find this code useful, if you have any questions just leave a comment in this entry. Happy coding!


Comments are closed