A useful UrlBuilder class

• Download source file - 1.02 Kb

Introduction

Building URLs is something one does all the time as an ASP.NET developer. The .NET Framework has generously provided many classes to help us simplify the problem, but after all my searching, the one thing I found missing from the framework was a way to easily work with QueryString parameters. I did a little looking around and found a few solutions to the problem written by various people but none of them built on anything already in the framework. The framework provides the very useful System.UriBuilder class but it has no in-built way to deal with QueryString parameters apart from being able to get back a string containing the Query portion of the URI. While this is not all that useful in itself, it does help us create a derived class which extends the functionality in UriBuilder. Enter UrlBuilder. While UriBuilder is a more accurate name given modern naming conventions, UrlBuilder is semantically equivalent and more importantly, not a duplicate name of anything already in the framework.

If the reader wishes to get elbow deep in the code to discover its inner workings, it is provided in the download for your perusal and should be immediately obvious how it all hangs together. All I shall attempt to do here is give a brief explanation of how to use the UrlBuilder class by means of some sample code which will hopefully outline and highlight the salient features of this class. So then, without further delay, let's delve in.

The UrlBuilder class can be instantiated in several ways, but for simplicity, let's assume the user wishes to use a string as the initialiser of this UrlBuilder instance.

UrlBuilder builder = new 
    UrlBuilder("http://www.codeproject.com/index.asp?cat=4");

The rest of the constructor overloads provided in the class are exactly the same as those of the base UriBuilder class with the exception of one additional which takes a System.Web.UI.Page object. This is useful when one wishes to merely redirect to the same page with different QueryString parameters. The object can also be initialised using a System.Uri object. Once instantiated, we can manipulate any part of the URI (see the System.Uri documentation).

builder.Host = "www.gibbons.co.za";
builder.Path = "archive/2005";

It is interesting to note that a forward slash “/” is optional at the start of the Path string. Either way, the UriBuilder class will return a correctly formed URI. The UriBuilder class provides no way to set only the page name portion of the URI, so I added a new property called PageName which allows you to set only the name of the required page.

builder.PageName = "06.aspx";

So far, apart from the PageName property, this is nothing new; all this can already be done with the UriBuilder class. The real usefulness of the UrlBuilder class becomes apparent when we try to manipulate the QueryString parameters, as follows:

builder.QueryString["cat"] = 12345;
builder.QueryString["a"] = "A";
builder.QueryString["b"] = "B"; 

If the QueryString already contains a parameter contained in the URI passed to the constructor (in this case “cat”), the value of the parameter will be overwritten with the new value. If the parameter doesn’t already exist, it is appended to the QueryString generated. In addition, all the properties and methods of the internal StringDictionary object used to store the QueryString pairs are made available to the user. You could, for example, remove one of the parameters:

builder.QueryString.Remove("cat"); 

Or check if the collection contains a given key or value:

builder.QueryString.ContainsKey("cat");
builder.QueryString.ContainsValue("12345");

Lastly, there are two ways in which the URI may be consumed. Firstly, by calling:

string uri = builder.ToString(); 

Or simply by calling:

builder.Navigate(); 

which will perform a redirect to the URI currently contained in the object.

Happy coding.