Introduction
Like generics, delegates are one of those features that developers use without really understanding. Initially this wasn’t really a problem since delegates were reserved for fairly specific purposes: implementing callbacks and as the building-block for events (amongst a few other edge cases). However, each version of .NET has seen delegates evolve, first with the introduction of anonymous methods in 2.0 and now with lambda expressions in C# 3.0. With each evolution, delegates have become less of an specific pattern and more of a general purpose tool. In fact, most libraries written specifically for .NET 3.5 are likely to make heavy use of lambda expressions. As always, our concern isn’t just about understanding the code that we use, but also about enriching our own toolset. Seven years ago it wouldn’t have been abnormal to see even a complex system make little (or no) us of delegates (except for using the events of built-in controls). Today, however, even the simplest systems heavily relies on them.
Delegates
The best way to learn about all three framework/language feature is to start from the original and build our way up, seeing what each evolution adds. Delegates have always been pretty simple to understand, but without any good reason to use them, people never really latched on to the concept. It’s always easier to understand something when you can see what problem it solves and how it’s used – and examples of delegates always seem contrived.
Delegates are .NETs version of function pointers – with added type safety. If you aren’t familiar with C or C++ (or another lower level languages) that might not be very helpful. Essentially they let you pass a method into another method as an argument. Although many developers understand the concept in languages such as JavaScript, the strictness of C#/VB.NET makes it a little more confusion. For example, the following JavaScript code is completely valid (and even common):
function executor(functionToExecute)
{
functionToExecute(9000);
}
var doSomething = function(count){alert(“It’s Over ” + count);}
executor(doSomething);
Although simplistic, the above code shows how a function can be assigned to a variable (not the return value mind you, the actual function body) and then passed around as a parameter into a function. This parameter can then be executed as you would any other function.
The only difference in .NET is that you can’t just assign any function to any variable and pass it into any method. Instead everything has to be properly typed. That’s where delegates come in, they let you define the signature for a method – its parameters and return type. So, to build the above code in C#, we use the following:
public delegate void NotifyDelegate(int count);
public class Executor
{
public static void Execute(NotifyDelegate notifier)
{
notifier(9000);
}
}
public class Program
{
public static void Main(string[] args)
{
NotifyDelegate notifier = Alert;
Executor.Execute(notifier);
}
public static void Alert(int count)
{
Console.WriteLine(“It’s over {0}”, count);
}
}
It seems like a lot more code, but a good chunk of it is simply the requirement for everything in .NET to be in a class. The first, and most important, line is the definition for the delegate itself. Delegates are much like classes, interfaces, structures or enums – they define a type. Here we’ve defined a type named
NotifyDelegate. Any method can be assigned to a variable of type NotifyDelegate provided that method has the same signature: it must return void and take a single parameter of type int. In the above code I explicitly assigned the Alert method to a variable named notifier for demonstration purposes only, the following would have been just as acceptable:Executor.Execute(Alert);
The point is that a delegate can be used like any other type, the difference is simply that its assigned to a method. The other point to keep in mind is that my example used a static method (
Alert). You can use either a static or an instance method – again, the only requirement is that it meets the defined method signature. Within an instance method you have access to all instance members just like any normal method (because it is a normal method).Let’s Get More Practical
So we have an idea of what delegates are, but when would we use them? As I mentioned earlier, in their normal form, their usage is fairly reserved for specific cases, most notably callbacks (if you’ve ever used an asynchronous method you likely had to supply a delegate to be called when the async call completed). However, lets look at a real example in which you might use a delegate. Initially this is going to be a little contrived, but as we move the example to anonymous methods and then lambda expressions, the example will feel more natural. This is a real example I use in my code.
Within our data layer we have a method that expects an array of objects and saves them all within a transaction. The method looks something like this (we use NHibernate, but the implementation details don’t matter):
public class GenericStore<T>
{
public void Save(params T[] entities)
{
using (var transaction = BeginTransaction())
{
try
{
foreach(T entity in entities)
{
Save(entity);
}
transaction.Commit();
}
catch(Exception)
{
transaction.Rollback();
}
}
}
}
We use this method, for example, when we want to switch the default group, something like:
public void SwitchDefault(Group newDefault)
{
var oldDefault = GetDefaultGroup(); //implementation isn’t important
oldDefault.Default = false;
newDefault.Default = true;
DataFactory.For<Group>().Save(oldDefault, newDefault);
}
Of course, if our
Save method throws an exception, we need to undo our code (rolling back the transaction undoes the database commit, but not the actual in-memory change we made). Here’s one way to do that:public void SwitchDefault(Group newDefault)
{
var oldDefault = GetDefaultGroup(); //implementation isn’t important
oldDefault.Default = false;
newDefault.Default = true;
try
{
DataFactory.For<Group>().Save(oldDefault, newDefault);
}
catch
{
oldDefault.Default = true;
newDefault.Default = false;
}
}
This works fine, except we end up with a lot of try/catches all over the place. Instead we use a delegate (again, this is actually more code, but it’s just a foundation to progress to anonymous methods). Here’s our improved
Save method:public class GenericStore<T>
{
public delegate void RollbackDelegate(T entities);
public void Save(params T[] entities)
{
Save(null, entities);
}
public void Save(RollbackDelegate rollback, params T[] entities)
{
using (var transaction = BeginTransaction())
{
try
{
foreach(T entity in entities)
{
Save(entity);
}
transaction.Commit();
}
catch(Exception)
{
transaction.Rollback();
if (rollback != null)
{
rollback(entities);
}
}
}
}
}
The overloaded
Save method is provided so that calling code can provide a delegate or not. We can use this code simply by doing:public void SwitchDefault(Group newDefault)
{
var oldDefault = GetDefaultGroup(); //implementation isn’t important
oldDefault.Default = false;
newDefault.Default = true;
DataFactory.For<Group>().Save(SwitchDefaultRollback, oldDefault, newDefault);
}
public void SwitchDefaultRollback(Group[] groups)
{
groups[0].Default = false;
groups[1].Default = true;
}
Whether or not you consider this an improvement over the try/catch solution is largely a matter of taste. I find neither particularly elegant. The problem with the delegate solution is the need for the extra method, and the awkward use of array indexes (we’re relying on the
Save method to pass the items back in the same order they were passed in).Anonymous Methods
.NET 2.0 added a fairly significant improvement to delegates: anonymous methods. Delegates still exist and are still the ideal solution for a number of cases. However, for situations such as the one we’re developing, they are far from perfect. What we want is a more concise way to create our callback as well as something that’ll help us avoid the weird array indexing. Anonymous methods solve both those problem. We’ll address each point separately.
Probably the most intimidating aspect of anonymous method is the way they are declared. Unlike normal methods, anonymous methods are declared within another method, using the
delegate keyword:public void SwitchDefault(Group newDefault)
{
GenericStore<Group>.RollbackDelegate rollback = delegate(Group[] entities)
{
groups[0].Default = false;
groups[1].Default = true;
};
var oldDefault = GetDefaultGroup(); //implementation isn’t important
oldDefault.Default = false;
newDefault.Default = true;
DataFactory.For<Group>().Save(rollback, oldDefault, newDefault);
}
Like any nested-type, we access our delegate via its full name (
GenericStore<Group>.RollbackDelegate). The delegatekeyword creates an anonymous method – which behaves like any other method, except it isn’t named and exists within a limited scope. Again, I assigned the anonymous method to a variable for demonstrative purposes, in real life you’re more likely do to:public void SwitchDefault(Group newDefault)
{
var oldDefault = GetDefaultGroup(); //implementation isn’t important
oldDefault.Default = false;
newDefault.Default = true;
DataFactory.For<Group>().Save(delegate(Group[] entities)
{
groups[0].Default = false;
groups[1].Default = true;
}, oldDefault, newDefault);
}
The syntax is more confusing. If you look at it, you’ll notice that we’re really just passing 3 parameters to our
Savemethod – our anonymous method, oldDefault and newDefault. The syntax will improve considerably when we look at the next evolution. For now, it’s important that you understand the concept behind creating an anonymous method.
While the syntax might be the most confusing, the most important aspect of anonymous methods is their scope. Anonymous methods behave like any other code-block. In our above code that means that our anonymous method has access to
oldDefault, newDefault and all the other instance members which might be defined (like the GetDefaultGroupmethod we’re calling). That means that we can really simplify our code. First, we’ll change our delegate so that it no longer passes back our array of entities:public delegate void RollbackDelegate();
Along with the corresponding part of our
Save method:transaction.Rollback();
if (rollback != null)
{
rollback();
}
Our calling code now looks like:
public void SwitchDefault(Group newDefault)
{
var oldDefault = GetDefaultGroup(); //implementation isn’t important
oldDefault.Default = false;
newDefault.Default = true;
DataFactory.For<Group>().Save(delegate()
{
newDefault.Default = false;
oldDefault.Default = true;
}, oldDefault, newDefault);
}
I consider this much cleaner, not only because there’s less chance of bugs, but also because the code is far more readable. All ambiguity around what
groups[0] and groups[1] referred to has been removed.
Our solution still isn’t perfect (the syntax around anonymous delegates is a little messy), but to me it’s definitely a step in the right direction. We no longer have to create a full-blown method for each delegate, and having our scoped within the method gives us direct access to variables we’ll likley need.
Lambda Expressions
While anonymous methods provide a new feature, lambda expressions merely provide an improved syntax. The improvement is rather significant though, which has made anonymous methods even more popular. At one point our delegate was passing along an array as a parameter:
public delegate void RollbackDelegate(T entities);
And, to be valid, our anonymous method had to be defined with the same signature:
delegate(Group[] entities){ … }
Although we’ve moved beyond the need to pass-back the array, I want to look at lambdas from this point on, as it’ll help make things clearer (and often times you’ll have delegates with parameters). The lambda version of our above code is:
entities => {….}
Essentially, the
=> operator (some people call it the wang operator) replaces the need for both the delegate keyword as well as the parameter types. Additionally, if your delegate is a single statement, you can drop the brackets { }. If you have multiple parameters, you wrap them in parenthesis:(entities, transaction) => {…}
If you don’t have any parameters, like in our example, you use empty paranthesis:
() => {…}
It’s easy to get mixed up with the syntax, but if you walk backwards through the code, hopefully everything makes sense. Here’s what our implementation now looks like:
public void SwitchDefault(Group newDefault)
{
var oldDefault = GetDefaultGroup(); //implementation isn’t important
oldDefault.Default = false;
newDefault.Default = true;
DataFactory.For<Group>().Save(() =>{newDefault.Default = false; oldDefault.Default = true;}, oldDefault, newDefault);
}
Some More Examples
To get a good feel for the syntax, let’s look at some other, common, examples. We’ll stick to the
List<T> class, which exposes a number of methods which expect delegates.
To get the sum of all integers within a list using an anonymous method:
var ids = new List<int>{1,2,3,4,5};
var sum = 0;
ids.ForEach(delegate(int i){ sum += i;});
Using a lambda expression:
var ids = new List<int>{1,2,3,4,5};
var sum = 0;
ids.ForEach(i => sum += i);
To find a specific group by its id:
public Group FindGroup(int id)
{
var groups = GetAllGroups(); //there might be a more efficient way!
return groups.Find(delegate(Group g){return g.Id == id;});
}
Using a lambda expression:
public Group FindGroup(int id)
{
var groups = GetAllGroups(); //there might be a more efficient way!
return = groups.Find(g => g.Id == id);
}
Notice that using a lambda we don’t even have to return true or false if a match is found. Lambdas explicitly returns the value.
Delegates and Generics
The last thing we’ll cover is the synergy between delegates and generics. This is something I’ve covered in depth before, so we’ll only briefly discuss it here. The .NET framework comes with a number of built-in delegates (for example, we might not need to define our own
RollbackDelegate type as the .NET framework might already have one for the same method signature). It turns out that if you sprinkle some generic goodness of top of delegates, you can easily create a delegate for almost any situation. There are three core generic delegates within the .NET framework:Predicate, Func and Action. Each comes with a number of overloads to cover the most common cases:delegate bool Predicate(); delegate bool Predicate<T1>(T1 parameter1); delegate bool Predicate<T1, T2>(T1 parameter1, T2 paremter2); delegate bool Predicate<T1, T2, T3>(T2 parameter1, T2 paremter2, T3 parameter3);delegate T Func<T>(T returnType); delegate T Func<T, T1>(T returnType, T1 parameter1); delegate T Func<T, T1, T2>(T returnType, T1 parameter1, T2 paremter2); delegate T Func<T T1, T2, T3>(T returnType, T1 parameter1, T2 paremter2, T3 parameter3);delegate void Action(); delegate void Action<T1>(T1 parameter1); delegate void Action<T1, T2>(T1 parameter1, T2 paremter2); delegate void Action<T1, T2, T3>(T1 parameter1, T2 paremter2, T3 parameter3);
The difference between the three is the type of the return (
Predicate always returns bool, Func returns T and Actionreturns void). The overloads just let us support multiple parameters.
Instead of using this delegate:
public delegate void RollbackDelegate(T entities);
…
public void Save(RollbackDelegate rollback, params T[] entities){…}
We could have simply used:
public void Save(Action<T[]> rollback, params T[] entities){…}
And instead of:
public delegate void RollbackDelegate();
…
public void Save(RollbackDelegate rollback, params T[] entities){…}
We could have simply used:
public void Save(Action rollback, params T[] entities){…}
Anonymous Methods (C# Programming Guide)
In versions of C# previous to 2.0, the only way to declare a delegate was to use named methods. C# 2.0 introduces anonymous methods.
Creating anonymous methods is essentially a way to pass a code block as a delegate parameter. For example:
// Create a handler for a click event button1.Click += delegate(System.Object o, System.EventArgs e) { System.Windows.Forms.MessageBox.Show("Click!"); };
or
// Create a delegate instance delegate void Del(int x); // Instantiate the delegate using an anonymous method Del d = delegate(int k) { /* ... */ };
By using anonymous methods, you reduce the coding overhead in instantiating delegates by eliminating the need to create a separate method.
For example, specifying a code block in the place of a delegate can be useful in a situation when having to create a method might seem an unnecessary overhead. A good example would be when launching a new thread. This class creates a thread and also contains the code that the thread executes, without the need for creating an additional method for the delegate.
void StartThread() { System.Threading.Thread t1 = new System.Threading.Thread (delegate() { System.Console.Write("Hello, "); System.Console.WriteLine("World!"); }); t1.Start(); }
The scope of the parameters of an anonymous method is the anonymous-method-block.
It is an error to have a jump statement, such as goto, break, or continue, inside the anonymous method block whose target is outside the block. It is also an error to have a jump statement, such as goto, break, or continue, outside the anonymous method block whose target is inside the block.
The local variables and parameters whose scope contain an anonymous method declaration are called outer or captured variables of the anonymous method. For example, in the following code segment,
n is an outer variable:int n = 0; Del d = delegate() { System.Console.WriteLine("Copy #:{0}", ++n); };
Unlike local variables, the lifetime of the outer variable extends until the delegates that reference the anonymous methods are eligible for garbage collection. A reference to
n is captured at the time the delegate is created.
No unsafe code can be accessed within the anonymous-method-block.
The following example demonstrates the two ways of instantiating a delegate:
- Associating the delegate with an anonymous method.
- Associating the delegate with a named method (
DoWork).
In each case, a message is displayed when the delegate is invoked.
// Declare a delegate delegate void Printer(string s); class TestClass { static void Main() { // Instatiate the delegate type using an anonymous method: Printer p = delegate(string j) { System.Console.WriteLine(j); }; // Results from the anonymous delegate call: p("The delegate using the anonymous method is called."); // The delegate instantiation using a named method "DoWork": p = new Printer(TestClass.DoWork); // Results from the old style delegate call: p("The delegate using the named method is called."); } // The method associated with the named delegate: static void DoWork(string k) { System.Console.WriteLine(k); } }
Conclusion
Hopefully this helped clarify delegates, anonymous methods and lambdas, both in terms of their crazy syntax as well as how you can use them within your own code. When you combine this with a solid understanding of generics you end up with some powerful and concise code. You also end up with new ways to solve existing problems, which could otherwise be problematic and ugly. Don’t be afraid to try using some of these solutions within your code. The best way to learn how pieces fit together and to actually try to make something work
No comments:
Post a Comment