http://www.gutgames.com/ en-us Copyright 2021 D05, 05 May 2021 12:47:21 noGut Instincthttp://blogs.law.harvard.edu/tech/rss 5 http://www.gutgames.com/post/Craigrsquo3bs-Utility-Library-32-Released.aspx James Craig Mon, 03 Sep 2012 16:20:59 GMT

2: {


3: [IntGenerator]


4: public int A { get; set; }


5:


6: [LoremIpsumGenerator]


7: public string B { get; set; }


8:


9: [FloatGenerator]


10: public float C { get; set; }


11:


12: [IntGenerator(1, 100)]


13: public int D { get; set; }


14: }





And call NextClass and have a newly generated RandomTestClass object given to you.

Past the new randomization classes/extension methods, a number of updates, speed increases, and fixes were implemented on the SQLHelper, MicroORM, and ORM classes. For example, you can now add parameters in batch to the SQLHelper class by simply calling the AddParameter function. (For example if you have andquot;SELECT * FROM Table WHERE ID=@0 and Value=@1andquot; and you used AddParameter(10, andquot;This is a stringandquot;) then it would put the value 10 in for @0 and andquot;This is a stringandquot; for @1 (note that it would do that as a parameter, it doesn't do string concat).

On top of that a number of extensions to make life easier were added, such as Times which will run a function/action the specified number of times, so 100.Times(x=andgt;x) creates a list of integers going from 1 to 100. On top of that, I ‘ve added:


A RingBuffer class

Google API class for pulling static maps

LevenshteinDistance extension for strings

extension method to convert Dictionary and NameValueCollections classes to query strings

UserIPAddress and IfModifiedSince extension methods for HttpRequest

RelativeTime extension which expresses the difference between a DateTime and some Epoch as a string

updated the BlogML code to allow exporting

added ReadAll and ReadAllBinary extensions for Stream objects

and a number of other items.


Future of the Library

I’ve recently had a number of requests for additions as well as a couple other questions regarding 3rd party libraries. With regard to 3rd party libraries, I'm at a bit of a cross roads at the moment. When I started the library I wanted to make it so that it only relied on .Net and maybe a couple Win32/COM APIs. There were a couple of reasons for not using 3rd party libraries. I mean part of the issue was the fact this library is sort of a learning experience for me. When I want to try out a concept, I usually do it here. Hence I have no desire to use something like AForge for simple image manipulation. I want to build that myself to learn about the subject. But the main reason for not using 3rd party libraries was that at the time, it was a pain.

Keeping libraries updated and working between updates took a lot of work, requiring users to pin to a specific version of a library was difficult, putting out updates of your product became a pain, etc. Now we have NuGet. NuGet makes all of those issues simple to handle (and I don't think I would lose any users as I actually get more downloads from there than Codeplex at this point). On top of that we're now in a weird bizarro world where the .Net guys (well the web portion anyway) are now using open source libraries...

So let's assume I say OK to the 3rd party libraries, what libraries? Because not only is Json.Net a possibility (and it's MIT license, so that works), but ServiceStack has some advantages. Then you have other libraries that are getting added into the andquot;blessedandquot; mix (DotNetOpenAuth, etc), which is probably only going to expand in the future... But then does it even matter if something gets the nod from Microsoft? Personally I say no. I tend to remove all of their prepackaged libraries and start from scratch anyway. That being said, I actually do use Json.Net, but I can’t guarantee that I will continue to do so in the future. In fact I tend to swap out libraries without giving it a second thought…

Anyway, long story short, I’m not going to be adding 3rd party libraries directly into the library. However I am looking at ways to allow people to attach 3rd party libraries to the system. It will probably be some combination of MEF, IoC, and extension points. I’m still working on the design though. As far as requests for additions, I welcome people to fork the library and make additions. However most changes that I make are due to my day to day work so if it’s in line with what I’m already doing, I’ll probably add it. If it’s not, it might take a while for me to add it. But if you fork the project and make additions, I’ll most likely accept them.]]> Craigandrsquo;s Utility Library 3.2 Released

2: {


3: [IntGenerator]


4: public int A { get; set; }


5:


6: [LoremIpsumGenerator]


7: public string B { get; set; }


8:


9: [FloatGenerator]


10: public float C { get; set; }


11:


12: [IntGenerator(1, 100)]


13: public int D { get; set; }


14: }





And call NextClass and have a newly generated RandomTestClass object given to you.

Past the new randomization classes/extension methods, a number of updates, speed increases, and fixes were implemented on the SQLHelper, MicroORM, and ORM classes. For example, you can now add parameters in batch to the SQLHelper class by simply calling the AddParameter function. (For example if you have andquot;SELECT * FROM Table WHERE ID=@0 and Value=@1andquot; and you used AddParameter(10, andquot;This is a stringandquot;) then it would put the value 10 in for @0 and andquot;This is a stringandquot; for @1 (note that it would do that as a parameter, it doesn't do string concat).

On top of that a number of extensions to make life easier were added, such as Times which will run a function/action the specified number of times, so 100.Times(x=andgt;x) creates a list of integers going from 1 to 100. On top of that, I ‘ve added:


A RingBuffer class

Google API class for pulling static maps

LevenshteinDistance extension for strings

extension method to convert Dictionary and NameValueCollections classes to query strings

UserIPAddress and IfModifiedSince extension methods for HttpRequest

RelativeTime extension which expresses the difference between a DateTime and some Epoch as a string

updated the BlogML code to allow exporting

added ReadAll and ReadAllBinary extensions for Stream objects

and a number of other items.


Future of the Library

I’ve recently had a number of requests for additions as well as a couple other questions regarding 3rd party libraries. With regard to 3rd party libraries, I'm at a bit of a cross roads at the moment. When I started the library I wanted to make it so that it only relied on .Net and maybe a couple Win32/COM APIs. There were a couple of reasons for not using 3rd party libraries. I mean part of the issue was the fact this library is sort of a learning experience for me. When I want to try out a concept, I usually do it here. Hence I have no desire to use something like AForge for simple image manipulation. I want to build that myself to learn about the subject. But the main reason for not using 3rd party libraries was that at the time, it was a pain.

Keeping libraries updated and working between updates took a lot of work, requiring users to pin to a specific version of a library was difficult, putting out updates of your product became a pain, etc. Now we have NuGet. NuGet makes all of those issues simple to handle (and I don't think I would lose any users as I actually get more downloads from there than Codeplex at this point). On top of that we're now in a weird bizarro world where the .Net guys (well the web portion anyway) are now using open source libraries...

So let's assume I say OK to the 3rd party libraries, what libraries? Because not only is Json.Net a possibility (and it's MIT license, so that works), but ServiceStack has some advantages. Then you have other libraries that are getting added into the andquot;blessedandquot; mix (DotNetOpenAuth, etc), which is probably only going to expand in the future... But then does it even matter if something gets the nod from Microsoft? Personally I say no. I tend to remove all of their prepackaged libraries and start from scratch anyway. That being said, I actually do use Json.Net, but I can’t guarantee that I will continue to do so in the future. In fact I tend to swap out libraries without giving it a second thought…

Anyway, long story short, I’m not going to be adding 3rd party libraries directly into the library. However I am looking at ways to allow people to attach 3rd party libraries to the system. It will probably be some combination of MEF, IoC, and extension points. I’m still working on the design though. As far as requests for additions, I welcome people to fork the library and make additions. However most changes that I make are due to my day to day work so if it’s in line with what I’m already doing, I’ll probably add it. If it’s not, it might take a while for me to add it. But if you fork the project and make additions, I’ll most likely accept them.]]> http://www.gutgames.com/post/Craigrsquo3bs-Framework.aspx James Craig Sun, 20 May 2012 15:38:54 GMT

2: /// Sets the content type


3: /// andlt;/summaryandgt;


4: [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false)]


5: public class ContentType : ActionFilterAttribute


6: {


7: #region Properties


8:


9: /// andlt;summaryandgt;


10: /// Content type to set for this item


11: /// andlt;/summaryandgt;


12: public virtual string Type { get; set; }


13:


14: #endregion


15:


16: #region Functions


17:


18: /// andlt;summaryandgt;


19: /// OnActionExecuted


20: /// andlt;/summaryandgt;


21: /// andlt;param name=andquot;filterContextandquot;andgt;filter contextandlt;/paramandgt;


22: public override void OnActionExecuted(ActionExecutedContext filterContext)


23: {


24: filterContext.HttpContext.Response.ContentType = Type;


25: base.OnActionExecuted(filterContext);


26: }


27:


28:


29: #endregion


30: }



Many of the classes in the framework are simply helper classes, like the one above. So, for instance, above is an ActionFilter that simply lets me place an attribute on a class so I can set the ContentType that will be returned. I have others that force all requests be forced over to SSL, one that adds a variable to a controller saying what the HTTP verb is, one that tells the client to cache the content that it receives, etc. These sorts of classes probably comprise about 50% of what’s in there at present. The other half is base classes. For instance, I have two base classes for controllers. The first is aimed at APIs and controllers that will mostly be dealing with JSON:



1: /// andlt;summaryandgt;


2: /// API Controller base class


3: /// andlt;/summaryandgt;


4: [ContentType(Type = andquot;application/jsonandquot;)]


5: public class APIControllerBase : System.Web.Mvc.Controller


6: {


7: /// andlt;summaryandgt;


8: /// Encoding used for the controller (defaults to UTF8)


9: /// andlt;/summaryandgt;


10: public virtual Encoding Encoding { get; set; }


11:


12: /// andlt;summaryandgt;


13: /// Initializes the controller


14: /// andlt;/summaryandgt;


15: /// andlt;param name=andquot;requestContextandquot;andgt;Request contextandlt;/paramandgt;


16: protected override void Initialize(System.Web.Routing.RequestContext requestContext)


17: {


18: requestContext.HttpContext.HTTPCompress();


19: requestContext.HttpContext.Response.ContentEncoding = Encoding.NullCheck(new UTF8Encoding());


20: base.Initialize(requestContext);


21: }


22:


23: /// andlt;summaryandgt;


24: /// Returns Json encoded object


25: /// andlt;/summaryandgt;


26: /// andlt;param name=andquot;Objectandquot;andgt;Object to encodeandlt;/paramandgt;


27: /// andlt;returnsandgt;The object as a Json.Net resultandlt;/returnsandgt;


28: protected virtual JsonNetResult JsonNet(object Object)


29: {


30: JsonNetResult Result = null;


31: JsonSerializerSettings Settings = new JsonSerializerSettings();


32: IsoDateTimeConverter Converter = new IsoDateTimeConverter();


33: Settings.Converters.Add(Converter);


34: Result = new JsonNetResult(Object, Settings, Formatting.None);


35: return Result;


36: }


37:


38: /// andlt;summaryandgt;


39: /// On Action Executed


40: /// andlt;/summaryandgt;


41: /// andlt;param name=andquot;filterContextandquot;andgt;filter contextandlt;/paramandgt;


42: protected override void OnActionExecuted(System.Web.Mvc.ActionExecutedContext filterContext)


43: {


44: base.OnActionExecuted(filterContext);


45: }


46: }





I’m still adding to it, but at present it compresses the data sent back (using GZip by default), sets the encoding, sets the content type to ‘application/json’ and adds a function JsonNet that serializes an object to JSON (using Json.Net) and returns it as a result. The other controller base class deals primarily with controllers that deal primarily with HTML:



1: /// andlt;summaryandgt;


2: /// Base class for controllers


3: /// andlt;/summaryandgt;


4: [CSRF]


5: public class ControllerBase : System.Web.Mvc.Controller


6: {


7: /// andlt;summaryandgt;


8: /// Encoding used for the controller (defaults to UTF8)


9: /// andlt;/summaryandgt;


10: public virtual Encoding Encoding { get; set; }


11:


12: /// andlt;summaryandgt;


13: /// Initializes the controller


14: /// andlt;/summaryandgt;


15: /// andlt;param name=andquot;requestContextandquot;andgt;Request contextandlt;/paramandgt;


16: protected override void Initialize(System.Web.Routing.RequestContext requestContext)


17: {


18: requestContext.HttpContext.HTTPCompress(true);


19: requestContext.HttpContext.Response.ContentEncoding = Encoding.NullCheck(new UTF8Encoding());


20: base.Initialize(requestContext);


21: }


22:


23: /// andlt;summaryandgt;


24: /// On Action Executed


25: /// andlt;/summaryandgt;


26: /// andlt;param name=andquot;filterContextandquot;andgt;filter contextandlt;/paramandgt;


27: protected override void OnActionExecuted(System.Web.Mvc.ActionExecutedContext filterContext)


28: {


29: base.OnActionExecuted(filterContext);


30: }


31: }




This one, using a couple of functions from my utility library, compresses the data sent back and removes white space (basically removes “pretty printing”), sets the encoding, and adds a cross site request forgery token on any form (that’s the CSRF attribute on the class). Past that, there are classes that help add themes to MVC, automatically compress CSS and Javascript files, classes that will help with plugins, etc. In fact, my ultimate goal with this framework is to make it so that once I drop it in place, all I have to do is define my models and it will set up my REST API and services for me so all I need to do is the HTML, CSS, Javascript, etc. basically the front end stuff (minus the one off items). Anyway, I’m hoping to have this done soon so I can put it up on CodePlex/Github with an initial release and then start on the main project. So I’ll keep people posted and happy coding.]]> Craigandrsquo;s Framework

2: /// Sets the content type


3: /// andlt;/summaryandgt;


4: [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false)]


5: public class ContentType : ActionFilterAttribute


6: {


7: #region Properties


8:


9: /// andlt;summaryandgt;


10: /// Content type to set for this item


11: /// andlt;/summaryandgt;


12: public virtual string Type { get; set; }


13:


14: #endregion


15:


16: #region Functions


17:


18: /// andlt;summaryandgt;


19: /// OnActionExecuted


20: /// andlt;/summaryandgt;


21: /// andlt;param name=andquot;filterContextandquot;andgt;filter contextandlt;/paramandgt;


22: public override void OnActionExecuted(ActionExecutedContext filterContext)


23: {


24: filterContext.HttpContext.Response.ContentType = Type;


25: base.OnActionExecuted(filterContext);


26: }


27:


28:


29: #endregion


30: }



Many of the classes in the framework are simply helper classes, like the one above. So, for instance, above is an ActionFilter that simply lets me place an attribute on a class so I can set the ContentType that will be returned. I have others that force all requests be forced over to SSL, one that adds a variable to a controller saying what the HTTP verb is, one that tells the client to cache the content that it receives, etc. These sorts of classes probably comprise about 50% of what’s in there at present. The other half is base classes. For instance, I have two base classes for controllers. The first is aimed at APIs and controllers that will mostly be dealing with JSON:



1: /// andlt;summaryandgt;


2: /// API Controller base class


3: /// andlt;/summaryandgt;


4: [ContentType(Type = andquot;application/jsonandquot;)]


5: public class APIControllerBase : System.Web.Mvc.Controller


6: {


7: /// andlt;summaryandgt;


8: /// Encoding used for the controller (defaults to UTF8)


9: /// andlt;/summaryandgt;


10: public virtual Encoding Encoding { get; set; }


11:


12: /// andlt;summaryandgt;


13: /// Initializes the controller


14: /// andlt;/summaryandgt;


15: /// andlt;param name=andquot;requestContextandquot;andgt;Request contextandlt;/paramandgt;


16: protected override void Initialize(System.Web.Routing.RequestContext requestContext)


17: {


18: requestContext.HttpContext.HTTPCompress();


19: requestContext.HttpContext.Response.ContentEncoding = Encoding.NullCheck(new UTF8Encoding());


20: base.Initialize(requestContext);


21: }


22:


23: /// andlt;summaryandgt;


24: /// Returns Json encoded object


25: /// andlt;/summaryandgt;


26: /// andlt;param name=andquot;Objectandquot;andgt;Object to encodeandlt;/paramandgt;


27: /// andlt;returnsandgt;The object as a Json.Net resultandlt;/returnsandgt;


28: protected virtual JsonNetResult JsonNet(object Object)


29: {


30: JsonNetResult Result = null;


31: JsonSerializerSettings Settings = new JsonSerializerSettings();


32: IsoDateTimeConverter Converter = new IsoDateTimeConverter();


33: Settings.Converters.Add(Converter);


34: Result = new JsonNetResult(Object, Settings, Formatting.None);


35: return Result;


36: }


37:


38: /// andlt;summaryandgt;


39: /// On Action Executed


40: /// andlt;/summaryandgt;


41: /// andlt;param name=andquot;filterContextandquot;andgt;filter contextandlt;/paramandgt;


42: protected override void OnActionExecuted(System.Web.Mvc.ActionExecutedContext filterContext)


43: {


44: base.OnActionExecuted(filterContext);


45: }


46: }





I’m still adding to it, but at present it compresses the data sent back (using GZip by default), sets the encoding, sets the content type to ‘application/json’ and adds a function JsonNet that serializes an object to JSON (using Json.Net) and returns it as a result. The other controller base class deals primarily with controllers that deal primarily with HTML:



1: /// andlt;summaryandgt;


2: /// Base class for controllers


3: /// andlt;/summaryandgt;


4: [CSRF]


5: public class ControllerBase : System.Web.Mvc.Controller


6: {


7: /// andlt;summaryandgt;


8: /// Encoding used for the controller (defaults to UTF8)


9: /// andlt;/summaryandgt;


10: public virtual Encoding Encoding { get; set; }


11:


12: /// andlt;summaryandgt;


13: /// Initializes the controller


14: /// andlt;/summaryandgt;


15: /// andlt;param name=andquot;requestContextandquot;andgt;Request contextandlt;/paramandgt;


16: protected override void Initialize(System.Web.Routing.RequestContext requestContext)


17: {


18: requestContext.HttpContext.HTTPCompress(true);


19: requestContext.HttpContext.Response.ContentEncoding = Encoding.NullCheck(new UTF8Encoding());


20: base.Initialize(requestContext);


21: }


22:


23: /// andlt;summaryandgt;


24: /// On Action Executed


25: /// andlt;/summaryandgt;


26: /// andlt;param name=andquot;filterContextandquot;andgt;filter contextandlt;/paramandgt;


27: protected override void OnActionExecuted(System.Web.Mvc.ActionExecutedContext filterContext)


28: {


29: base.OnActionExecuted(filterContext);


30: }


31: }




This one, using a couple of functions from my utility library, compresses the data sent back and removes white space (basically removes “pretty printing”), sets the encoding, and adds a cross site request forgery token on any form (that’s the CSRF attribute on the class). Past that, there are classes that help add themes to MVC, automatically compress CSS and Javascript files, classes that will help with plugins, etc. In fact, my ultimate goal with this framework is to make it so that once I drop it in place, all I have to do is define my models and it will set up my REST API and services for me so all I need to do is the HTML, CSS, Javascript, etc. basically the front end stuff (minus the one off items). Anyway, I’m hoping to have this done soon so I can put it up on CodePlex/Github with an initial release and then start on the main project. So I’ll keep people posted and happy coding.]]> http://www.gutgames.com/post/Personal-Data-Management.aspx James Craig Sun, 06 May 2012 21:06:16 GMT Personal Data Management http://www.gutgames.com/post/Craigrsquo3bs-Utility-Library-31-Released.aspx James Craig Sun, 25 Mar 2012 14:05:53 GMT Craigandrsquo;s Utility Library 3.1 Released http://www.gutgames.com/post/Small-Changes2c-Big-Speed-Ups.aspx James Craig Sun, 04 Mar 2012 13:11:30 GMT

2: {


3: DoSomething();


4: }



and convert it to being multithreading by just doing the following:



1: Parallel.For(0,10,x=andgt;{


2: DoSomething();


3: });



Basically we just send it the start and stop values, give it an Action, and we're done as the TPL takes care of the rest. This can be done with most of your for and foreach loops but there are some things to keep in mind. First, it doesn't seem to lock data from outside the Action from what I can tell. So if you try to manipulate the exact same location in an array from two of the threads that it spawns at the same time, you're going to get some bugs. On top of that not everything in the .Net world is thread safe (for instance trying to generate a random number using the Random class is a huge problem). But keeping that sort of stuff in mind, it's still pretty easy to use and works quite well.

In the case of my Bitmap extensions, I found that generally speaking I was reading from a number of pixels in one image (that wasn't changing) and modifying one pixel in the destination image (and only setting it once). As such my, for the most part, wasn't going to be effected too much by the potential pitfalls (although the random number generation did pop up). So for instance the Negative function used to be:



1: public static Bitmap Negative(this Bitmap OriginalImage, string FileName = andquot;andquot;)


2: {


3: if (OriginalImage == null)


4: throw new ArgumentNullException(andquot;OriginalImageandquot;);


5: ImageFormat FormatUsing = FileName.GetImageFormat();


6: Bitmap NewBitmap = new Bitmap(OriginalImage.Width, OriginalImage.Height);


7: BitmapData NewData = NewBitmap.LockImage();


8: BitmapData OldData = OriginalImage.LockImage();


9: int NewPixelSize = NewData.GetPixelSize();


10: int OldPixelSize = OldData.GetPixelSize();


11: for (int x = 0; x andlt; NewBitmap.Width; ++x)


12: {


13: for (int y = 0; y andlt; NewBitmap.Height; ++y)


14: {


15: Color CurrentPixel = OldData.GetPixel(x, y, OldPixelSize);


16: Color TempValue = Color.FromArgb(255 - CurrentPixel.R, 255 - CurrentPixel.G, 255 - CurrentPixel.B);


17: NewData.SetPixel(x, y, TempValue, NewPixelSize);


18: }


19: }


20: NewBitmap.UnlockImage(NewData);


21: OriginalImage.UnlockImage(OldData);


22: if (!string.IsNullOrEmpty(FileName))


23: NewBitmap.Save(FileName, FormatUsing);


24: return NewBitmap;


25: }



But by changing it to this:



1: public static Bitmap Negative(this Bitmap OriginalImage, string FileName = andquot;andquot;)


2: {


3: OriginalImage.ThrowIfNull(andquot;OriginalImageandquot;);


4: ImageFormat FormatUsing = FileName.GetImageFormat();


5: Bitmap NewBitmap = new Bitmap(OriginalImage.Width, OriginalImage.Height);


6: BitmapData NewData = NewBitmap.LockImage();


7: BitmapData OldData = OriginalImage.LockImage();


8: int NewPixelSize = NewData.GetPixelSize();


9: int OldPixelSize = OldData.GetPixelSize();


10: int Width = NewBitmap.Width;


11: int Height = NewBitmap.Height;


12: Parallel.For(0, Width, x =andgt;


13: {


14: for (int y = 0; y andlt; Height; ++y)


15: {


16: Color CurrentPixel = OldData.GetPixel(x, y, OldPixelSize);


17: Color TempValue = Color.FromArgb(255 - CurrentPixel.R, 255 - CurrentPixel.G, 255 - CurrentPixel.B);


18: NewData.SetPixel(x, y, TempValue, NewPixelSize);


19: }


20: });


21: NewBitmap.UnlockImage(NewData);


22: OriginalImage.UnlockImage(OldData);


23: if (!string.IsNullOrEmpty(FileName))


24: NewBitmap.Save(FileName, FormatUsing);


25: return NewBitmap;


26: }



I get the image being worked on by multiple processors, speeding up the code by about 400% (the original took about 40ms to run on my test image and about 10ms after the change, but it would depend on how many cores you have on your system, etc. as to how much of a speed up you'll see). But all I really had to do was change the outer loop and I got an instant speed boost. The next item I was going to look at was my ORM and MicroORM and this is where I ran into my little surprise...

So one of the things that I do in these cases is I set up a small app to run a number of times (usually something like 10000 times) to get my base, I go and make my modifications and go back and test to see if it made an improvement to the run time. I use my Profiler code for this. In this instance I was just curious how the SQLHelper, ORM, and MicroORM code stacked up because each one is built on top of the other (SQLHelper-andgt;MicroORM-andgt;ORM). And here is where I was surprised. I did a couple tests, inserting a single entry, updating it, selecting one entry, selecting all entries from a table, etc. I was expecting the SQLHelper to be the fastest, the MicroORM next, and ORM the slowest. And I was correct in that assessment, however it wasn't the large spread that I was expecting. For the average insert the times were 4.92ms, 4.97ms, and 5.09ms (I have an SSD, database was local, my processor is pretty freakin good, etc. plus the data was small, only a couple of strings, float, decimal, int, DateTime, long, and bool. I didn't send it anything complex), That's a .17ms difference. The select, 4.53ms, 4.60ms, 4.69ms. That's .16ms... They're all like that. As far as I can tell I've inadvertantly built an ORM that does lazy loading, deals with multiple databases, etc. that's about as fast as straight SQL. Well, almost anyway. Because there are a number of tricks you can do to speed up things when you're dealing with straight SQL.

For instance inserting those 10,000 rows took a total of 49 seconds when doing each one individually. However we can simply use the SQLBulkCopy class and have that insert the 10,000 rows in a total of 525ms... By the way, the SQLBulkCopy class is now being used by SQLHelper (the ExecuteBulkCopy function). We can also update multiple rows at once when using SQLHelper (which the ORM and MicroORM doesn't quite do yet). But there are things that I could do at the MicroORM and ORM levels to give them an advantage (caching being a big one, which I don't do yet). There are a couple of other things also, but other than that it's not a bad surprise. Anyway, take a look, leave feedback, and happy coding.]]> Small Changes, Big Speed Ups

2: {


3: DoSomething();


4: }



and convert it to being multithreading by just doing the following:



1: Parallel.For(0,10,x=andgt;{


2: DoSomething();


3: });



Basically we just send it the start and stop values, give it an Action, and we're done as the TPL takes care of the rest. This can be done with most of your for and foreach loops but there are some things to keep in mind. First, it doesn't seem to lock data from outside the Action from what I can tell. So if you try to manipulate the exact same location in an array from two of the threads that it spawns at the same time, you're going to get some bugs. On top of that not everything in the .Net world is thread safe (for instance trying to generate a random number using the Random class is a huge problem). But keeping that sort of stuff in mind, it's still pretty easy to use and works quite well.

In the case of my Bitmap extensions, I found that generally speaking I was reading from a number of pixels in one image (that wasn't changing) and modifying one pixel in the destination image (and only setting it once). As such my, for the most part, wasn't going to be effected too much by the potential pitfalls (although the random number generation did pop up). So for instance the Negative function used to be:



1: public static Bitmap Negative(this Bitmap OriginalImage, string FileName = andquot;andquot;)


2: {


3: if (OriginalImage == null)


4: throw new ArgumentNullException(andquot;OriginalImageandquot;);


5: ImageFormat FormatUsing = FileName.GetImageFormat();


6: Bitmap NewBitmap = new Bitmap(OriginalImage.Width, OriginalImage.Height);


7: BitmapData NewData = NewBitmap.LockImage();


8: BitmapData OldData = OriginalImage.LockImage();


9: int NewPixelSize = NewData.GetPixelSize();


10: int OldPixelSize = OldData.GetPixelSize();


11: for (int x = 0; x andlt; NewBitmap.Width; ++x)


12: {


13: for (int y = 0; y andlt; NewBitmap.Height; ++y)


14: {


15: Color CurrentPixel = OldData.GetPixel(x, y, OldPixelSize);


16: Color TempValue = Color.FromArgb(255 - CurrentPixel.R, 255 - CurrentPixel.G, 255 - CurrentPixel.B);


17: NewData.SetPixel(x, y, TempValue, NewPixelSize);


18: }


19: }


20: NewBitmap.UnlockImage(NewData);


21: OriginalImage.UnlockImage(OldData);


22: if (!string.IsNullOrEmpty(FileName))


23: NewBitmap.Save(FileName, FormatUsing);


24: return NewBitmap;


25: }



But by changing it to this:



1: public static Bitmap Negative(this Bitmap OriginalImage, string FileName = andquot;andquot;)


2: {


3: OriginalImage.ThrowIfNull(andquot;OriginalImageandquot;);


4: ImageFormat FormatUsing = FileName.GetImageFormat();


5: Bitmap NewBitmap = new Bitmap(OriginalImage.Width, OriginalImage.Height);


6: BitmapData NewData = NewBitmap.LockImage();


7: BitmapData OldData = OriginalImage.LockImage();


8: int NewPixelSize = NewData.GetPixelSize();


9: int OldPixelSize = OldData.GetPixelSize();


10: int Width = NewBitmap.Width;


11: int Height = NewBitmap.Height;


12: Parallel.For(0, Width, x =andgt;


13: {


14: for (int y = 0; y andlt; Height; ++y)


15: {


16: Color CurrentPixel = OldData.GetPixel(x, y, OldPixelSize);


17: Color TempValue = Color.FromArgb(255 - CurrentPixel.R, 255 - CurrentPixel.G, 255 - CurrentPixel.B);


18: NewData.SetPixel(x, y, TempValue, NewPixelSize);


19: }


20: });


21: NewBitmap.UnlockImage(NewData);


22: OriginalImage.UnlockImage(OldData);


23: if (!string.IsNullOrEmpty(FileName))


24: NewBitmap.Save(FileName, FormatUsing);


25: return NewBitmap;


26: }



I get the image being worked on by multiple processors, speeding up the code by about 400% (the original took about 40ms to run on my test image and about 10ms after the change, but it would depend on how many cores you have on your system, etc. as to how much of a speed up you'll see). But all I really had to do was change the outer loop and I got an instant speed boost. The next item I was going to look at was my ORM and MicroORM and this is where I ran into my little surprise...

So one of the things that I do in these cases is I set up a small app to run a number of times (usually something like 10000 times) to get my base, I go and make my modifications and go back and test to see if it made an improvement to the run time. I use my Profiler code for this. In this instance I was just curious how the SQLHelper, ORM, and MicroORM code stacked up because each one is built on top of the other (SQLHelper-andgt;MicroORM-andgt;ORM). And here is where I was surprised. I did a couple tests, inserting a single entry, updating it, selecting one entry, selecting all entries from a table, etc. I was expecting the SQLHelper to be the fastest, the MicroORM next, and ORM the slowest. And I was correct in that assessment, however it wasn't the large spread that I was expecting. For the average insert the times were 4.92ms, 4.97ms, and 5.09ms (I have an SSD, database was local, my processor is pretty freakin good, etc. plus the data was small, only a couple of strings, float, decimal, int, DateTime, long, and bool. I didn't send it anything complex), That's a .17ms difference. The select, 4.53ms, 4.60ms, 4.69ms. That's .16ms... They're all like that. As far as I can tell I've inadvertantly built an ORM that does lazy loading, deals with multiple databases, etc. that's about as fast as straight SQL. Well, almost anyway. Because there are a number of tricks you can do to speed up things when you're dealing with straight SQL.

For instance inserting those 10,000 rows took a total of 49 seconds when doing each one individually. However we can simply use the SQLBulkCopy class and have that insert the 10,000 rows in a total of 525ms... By the way, the SQLBulkCopy class is now being used by SQLHelper (the ExecuteBulkCopy function). We can also update multiple rows at once when using SQLHelper (which the ORM and MicroORM doesn't quite do yet). But there are things that I could do at the MicroORM and ORM levels to give them an advantage (caching being a big one, which I don't do yet). There are a couple of other things also, but other than that it's not a bad surprise. Anyway, take a look, leave feedback, and happy coding.]]> http://www.gutgames.com/post/Craigrsquo3bs-Utility-Library-30-Released.aspx James Craig Tue, 20 Dec 2011 21:37:44 GMT Craigandrsquo;s Utility Library 3.0 Released http://www.gutgames.com/post/Building-an-DI-Container.aspx James Craig Sun, 13 Nov 2011 16:51:57 GMT

2: Copyright (c) 2011 andlt;a href=andquot;http://www.gutgames.comandquot;andgt;James Craigandlt;/aandgt;


3:


4: Permission is hereby granted, free of charge, to any person obtaining a copy


5: of this software and associated documentation files (the andquot;Softwareandquot;), to deal


6: in the Software without restriction, including without limitation the rights


7: to use, copy, modify, merge, publish, distribute, sublicense, and/or sell


8: copies of the Software, and to permit persons to whom the Software is


9: furnished to do so, subject to the following conditions:


10:


11: The above copyright notice and this permission notice shall be included in


12: all copies or substantial portions of the Software.


13:


14: THE SOFTWARE IS PROVIDED andquot;AS ISandquot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR


15: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,


16: FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE


17: AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER


18: LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,


19: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN


20: THE SOFTWARE.*/


21:


22: #region Usings


23: using System;


24: using System.Collections.Generic;


25: using System.Linq;


26: using System.Text;


27: using Utilities.IoC.Providers;


28: using Utilities.IoC.Mappings;


29: using Utilities.IoC.Mappings.Interfaces;


30: using System.Reflection;


31: using System.IO;


32: using Utilities.IO.ExtensionMethods;


33: using Utilities.Reflection.ExtensionMethods;


34: using Utilities.DataTypes.ExtensionMethods;


35: #endregion


36:


37: namespace Utilities.IoC


38: {


39: /// andlt;summaryandgt;


40: /// Manager class


41: /// andlt;/summaryandgt;


42: public class Manager


43: {


44: #region Constructor


45:


46: /// andlt;summaryandgt;


47: /// Constructor


48: /// andlt;/summaryandgt;


49: public Manager()


50: {


51: if (ProviderManager.IsNull())


52: ProviderManager = new ProviderManager();


53: if (MappingManager.IsNull())


54: MappingManager = new MappingManager(ProviderManager);


55: }


56:


57: #endregion


58:


59: #region Functions


60:


61: /// andlt;summaryandgt;


62: /// Loads all mapping modules found within the assembly


63: /// andlt;/summaryandgt;


64: /// andlt;param name=andquot;ModuleAssemblyandquot;andgt;Module assemblyandlt;/paramandgt;


65: public void Setup(Assembly ModuleAssembly)


66: {


67: ProviderManager.Setup(ModuleAssembly);


68: MappingManager.Setup(ModuleAssembly);


69: }


70:


71: /// andlt;summaryandgt;


72: /// Loads all mapping modules found within the assemblies


73: /// andlt;/summaryandgt;


74: /// andlt;param name=andquot;ModuleAssembliesandquot;andgt;Module assembliesandlt;/paramandgt;


75: public void Setup(IEnumerableandlt;Assemblyandgt; ModuleAssemblies)


76: {


77: ModuleAssemblies.ForEach(x =andgt; Setup(x));


78: }


79:


80: /// andlt;summaryandgt;


81: /// Loads all mapping modules found within a specific directory


82: /// andlt;/summaryandgt;


83: /// andlt;param name=andquot;Directoryandquot;andgt;Directory to scan for modulesandlt;/paramandgt;


84: /// andlt;param name=andquot;RecursiveScanandquot;andgt;Determines if sub directories should be scannedandlt;/paramandgt;


85: public void Setup(string Directory, bool ScanSubDirectories = true)


86: {


87: Setup(new DirectoryInfo(Directory).LoadAssemblies(ScanSubDirectories));


88: }


89:


90: /// andlt;summaryandgt;


91: /// Creates an object of the specified type


92: /// andlt;/summaryandgt;


93: /// andlt;typeparam name=andquot;ServiceTypeandquot;andgt;Service typeandlt;/typeparamandgt;


94: /// andlt;returnsandgt;An object of the specified typeandlt;/returnsandgt;


95: public ServiceType Getandlt;ServiceTypeandgt;()


96: {


97: return (ServiceType)Get(typeof(ServiceType));


98: }


99:


100: /// andlt;summaryandgt;


101: /// Creates an object of the specified type associated with the attribute type


102: /// andlt;/summaryandgt;


103: /// andlt;typeparam name=andquot;ServiceTypeandquot;andgt;Service typeandlt;/typeparamandgt;


104: /// andlt;typeparam name=andquot;AttributeTypeandquot;andgt;Attribute typeandlt;/typeparamandgt;


105: /// andlt;returnsandgt;An object of the specified typeandlt;/returnsandgt;


106: public ServiceType Getandlt;ServiceType, AttributeTypeandgt;()


107: {


108: return (ServiceType)Get(typeof(ServiceType), typeof(AttributeType));


109: }


110:


111: /// andlt;summaryandgt;


112: /// Creates an object of the specified type


113: /// andlt;/summaryandgt;


114: /// andlt;param name=andquot;ServiceTypeandquot;andgt;Service typeandlt;/paramandgt;


115: /// andlt;returnsandgt;An object of the specified typeandlt;/returnsandgt;


116: public object Get(Type ServiceType)


117: {


118: IMapping Mapping = MappingManager.GetMapping(ServiceType);


119: if (Mapping.IsNull())


120: throw new ArgumentException(andquot;ServiceType not found in mappingsandquot;);


121: return Mapping.Implementation.Create();


122: }


123:


124: /// andlt;summaryandgt;


125: /// Creates an object of the specified type associated with the attribute type


126: /// andlt;/summaryandgt;


127: /// andlt;param name=andquot;ServiceTypeandquot;andgt;Service typeandlt;/paramandgt;


128: /// andlt;param name=andquot;AttributeTypeandquot;andgt;Attribute typeandlt;/paramandgt;


129: /// andlt;returnsandgt;An object of the specified typeandlt;/returnsandgt;


130: public object Get(Type ServiceType, Type AttributeType)


131: {


132: IMapping Mapping = MappingManager.GetMapping(ServiceType, AttributeType);


133: if (Mapping.IsNull())


134: throw new ArgumentException(andquot;ServiceType not found in mappingsandquot;);


135: return Mapping.Implementation.Create();


136: }


137:


138: #endregion


139:


140: #region Properties


141:


142: protected static ProviderManager ProviderManager { get; set; }


143: protected static MappingManager MappingManager { get; set; }


144:


145: #endregion


146: }


147: }



This is our main point of code that we are going to use to get our objects. We set it up, call Get, and it will return to us our object (with the appropriate items injected). One thing that you’ll notice is that there are a couple nonstandard C# calls in there (specifically the ForEach on the IEnumerable, IsNull, etc). These are all functions from the new utility library that I’m working on. I’ve been adding quite a bit to it, tons of extension methods, etc. So go and check out the repository as all of my code on here uses it (or at least the code on here uses a version of it). Plus any updates to the code can be found there also as I tend to forget the pages on this site. Anyway another thing you may notice is there isn’t much code here. Most of the actual work is going to be done in the ProviderManager and MappingManager.



1: /*


2: Copyright (c) 2011 andlt;a href=andquot;http://www.gutgames.comandquot;andgt;James Craigandlt;/aandgt;


3:


4: Permission is hereby granted, free of charge, to any person obtaining a copy


5: of this software and associated documentation files (the andquot;Softwareandquot;), to deal


6: in the Software without restriction, including without limitation the rights


7: to use, copy, modify, merge, publish, distribute, sublicense, and/or sell


8: copies of the Software, and to permit persons to whom the Software is


9: furnished to do so, subject to the following conditions:


10:


11: The above copyright notice and this permission notice shall be included in


12: all copies or substantial portions of the Software.


13:


14: THE SOFTWARE IS PROVIDED andquot;AS ISandquot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR


15: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,


16: FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE


17: AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER


18: LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,


19: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN


20: THE SOFTWARE.*/


21:


22: #region Usings


23: using System;


24: using System.Collections.Generic;


25: using System.Linq;


26: using System.Text;


27: using Utilities.IoC.Providers.Interfaces;


28: using Utilities.IoC.Providers.Scope;


29: using Utilities.Reflection;


30: using Utilities.Reflection.ExtensionMethods;


31: using Utilities.DataTypes.ExtensionMethods;


32: using System.Reflection;


33: #endregion


34:


35: namespace Utilities.IoC.Providers


36: {


37: /// andlt;summaryandgt;


38: /// Provider manager


39: /// andlt;/summaryandgt;


40: public class ProviderManager


41: {


42: #region Constructor


43:


44: /// andlt;summaryandgt;


45: /// Constructor


46: /// andlt;/summaryandgt;


47: public ProviderManager()


48: {


49: Providers = new Listandlt;IProviderandgt;();


50: Providers.AddRange(typeof(ProviderManager).Assembly.GetObjectsandlt;IProviderandgt;());


51: }


52:


53: #endregion


54:


55: #region Functions


56:


57: /// andlt;summaryandgt;


58: /// Sets up all providers found within the assembly specified


59: /// andlt;/summaryandgt;


60: /// andlt;param name=andquot;Assemblyandquot;andgt;Assembly to scanandlt;/paramandgt;


61: public void Setup(Assembly Assembly)


62: {


63: Providers.AddRange(Assembly.GetObjectsandlt;IProviderandgt;());


64: }


65:


66: /// andlt;summaryandgt;


67: /// Gets the specified provider based on the scope specified


68: /// andlt;/summaryandgt;


69: /// andlt;param name=andquot;Scopeandquot;andgt;Scopeandlt;/paramandgt;


70: /// andlt;returnsandgt;The specified providerandlt;/returnsandgt;


71: public IProvider GetProvider(BaseScope Scope)


72: {


73: return Providers.FirstOrDefault(x =andgt; x.ProviderScope.Equals(Scope));


74: }


75:


76: #endregion


77:


78: #region Properties


79:


80: protected virtual Listandlt;IProviderandgt; Providers { get; set; }


81:


82: #endregion


83: }


84: }



The ProviderManager above holds a list of providers. These providers determine how to handle an implementation when you provide the system with one. The implementations actually determine how something is created. For instance, the code base only has one provider at present called Standard.



1: /*


2: Copyright (c) 2011 andlt;a href=andquot;http://www.gutgames.comandquot;andgt;James Craigandlt;/aandgt;


3:


4: Permission is hereby granted, free of charge, to any person obtaining a copy


5: of this software and associated documentation files (the andquot;Softwareandquot;), to deal


6: in the Software without restriction, including without limitation the rights


7: to use, copy, modify, merge, publish, distribute, sublicense, and/or sell


8: copies of the Software, and to permit persons to whom the Software is


9: furnished to do so, subject to the following conditions:


10:


11: The above copyright notice and this permission notice shall be included in


12: all copies or substantial portions of the Software.


13:


14: THE SOFTWARE IS PROVIDED andquot;AS ISandquot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR


15: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,


16: FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE


17: AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER


18: LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,


19: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN


20: THE SOFTWARE.*/


21:


22: #region Usings


23: using System;


24: using System.Collections.Generic;


25: using System.Linq;


26: using System.Text;


27: using Utilities.IoC.Providers.Scope;


28: using Utilities.IoC.Providers.Interfaces;


29: using Utilities.IoC.Mappings;


30: using Utilities.IoC.Providers.Implementations;


31: #endregion


32:


33: namespace Utilities.IoC.Providers.DefaultProviders


34: {


35: /// andlt;summaryandgt;


36: /// Standard provider


37: /// andlt;/summaryandgt;


38: public class Standard : IProvider


39: {


40: public IImplementation CreateImplementation(Type ImplementationType, MappingManager MappingManager)


41: {


42: return new Implementations.Standard(ImplementationType, MappingManager);


43: }


44:


45:


46: public BaseScope ProviderScope


47: {


48: get { return new StandardScope(); }


49: }


50:


51: public IImplementation CreateImplementation(IImplementation Implementation, MappingManager MappingManager)


52: {


53: return CreateImplementation(Implementation.ReturnType, MappingManager);


54: }


55:


56: public IImplementation CreateImplementationandlt;ImplementationTypeandgt;(Funcandlt;ImplementationTypeandgt; Implementation)


57: {


58: return new Delegateandlt;ImplementationTypeandgt;(Implementation);


59: }


60: }


61: }



This provider just creates a new implementation object (either a Delegate or Standard implementation depending) each time it’s fed anything. However we could have a provider called Singleton or something and have it return its own implementation types. We determine which provider to use in the ProviderManager based on something called Scopes:



1: /*


2: Copyright (c) 2011 andlt;a href=andquot;http://www.gutgames.comandquot;andgt;James Craigandlt;/aandgt;


3:


4: Permission is hereby granted, free of charge, to any person obtaining a copy


5: of this software and associated documentation files (the andquot;Softwareandquot;), to deal


6: in the Software without restriction, including without limitation the rights


7: to use, copy, modify, merge, publish, distribute, sublicense, and/or sell


8: copies of the Software, and to permit persons to whom the Software is


9: furnished to do so, subject to the following conditions:


10:


11: The above copyright notice and this permission notice shall be included in


12: all copies or substantial portions of the Software.


13:


14: THE SOFTWARE IS PROVIDED andquot;AS ISandquot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR


15: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,


16: FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE


17: AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER


18: LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,


19: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN


20: THE SOFTWARE.*/


21:


22: #region Usings


23: using System;


24: using System.Collections.Generic;


25: using System.Linq;


26: using System.Text;


27: #endregion


28:


29: namespace Utilities.IoC.Providers.Scope


30: {


31: /// andlt;summaryandgt;


32: /// Standard scope


33: /// andlt;/summaryandgt;


34: public class StandardScope : BaseScope


35: {


36: #region Constructor


37:


38: public StandardScope()


39: : base()


40: {


41: }


42:


43: #endregion


44:


45: #region Properties


46:


47: public override string Name { get { return andquot;Standardandquot;; } }


48:


49: #endregion


50: }


51: }



As you can see, it’s just a holder of info. So for our Singleton provider example, we would need to create a Singleton scope and have it return that value so we know which to use. Anyway, the next bit is the actual implementations:



1: /*


2: Copyright (c) 2011 andlt;a href=andquot;http://www.gutgames.comandquot;andgt;James Craigandlt;/aandgt;


3:


4: Permission is hereby granted, free of charge, to any person obtaining a copy


5: of this software and associated documentation files (the andquot;Softwareandquot;), to deal


6: in the Software without restriction, including without limitation the rights


7: to use, copy, modify, merge, publish, distribute, sublicense, and/or sell


8: copies of the Software, and to permit persons to whom the Software is


9: furnished to do so, subject to the following conditions:


10:


11: The above copyright notice and this permission notice shall be included in


12: all copies or substantial portions of the Software.


13:


14: THE SOFTWARE IS PROVIDED andquot;AS ISandquot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR


15: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,


16: FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE


17: AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER


18: LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,


19: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN


20: THE SOFTWARE.*/


21:


22: #region Usings


23: using System;


24: using System.Collections.Generic;


25: using System.Linq;


26: using System.Text;


27: using Utilities.IoC.Mappings;


28: using Utilities.IoC.Mappings.Interfaces;


29: using System.Reflection;


30: using Utilities.IoC.Mappings.Attributes;


31: using Utilities.IoC.Providers.BaseClasses;


32: using Utilities.DataTypes.ExtensionMethods;


33: using Utilities.Reflection.ExtensionMethods;


34: #endregion


35:


36: namespace Utilities.IoC.Providers.Implementations


37: {


38: /// andlt;summaryandgt;


39: /// Standard implementation class


40: /// andlt;/summaryandgt;


41: public class Standard : BaseImplementation


42: {


43: #region Constructor


44:


45: /// andlt;summaryandgt;


46: /// Constructor


47: /// andlt;/summaryandgt;


48: /// andlt;param name=andquot;ImplementationTypeandquot;andgt;Implementation typeandlt;/paramandgt;


49: /// andlt;param name=andquot;MappingManagerandquot;andgt;Mapping managerandlt;/paramandgt;


50: public Standard(Type ImplementationType, MappingManager MappingManager)


51: {


52: this.ReturnType = ImplementationType;


53: this.MappingManager = MappingManager;


54: }


55:


56: #endregion


57:


58: #region Functions


59:


60: #region Create


61:


62: public override object Create()


63: {


64: ConstructorInfo Constructor = Utils.ConstructorList.ChooseConstructor(ReturnType, MappingManager);


65: object Instance = CreateInstance(Constructor);


66: SetupProperties(Instance);


67: SetupMethods(Instance);


68: return Instance;


69: }


70:


71: #endregion


72:


73: #region SetupMethods


74:


75: private void SetupMethods(object Instance)


76: {


77: if (Instance.IsNull())


78: return;


79: foreach (MethodInfo Method in Instance.GetType().GetMethods().Where(x =andgt; IsInjectable(x)))


80: Method.Invoke(Instance, Method.GetParameters().ForEach(x =andgt; CreateInstance(x)).ToArray());


81: }


82:


83: #endregion


84:


85: #region SetupProperties


86:


87: private void SetupProperties(object Instance)


88: {


89: if (Instance.IsNull())


90: return;


91: Instance.GetType()


92: .GetProperties()


93: .Where(x =andgt; IsInjectable(x))


94: .ForEachandlt;PropertyInfoandgt;(x =andgt; Instance.SetProperty(x, CreateInstance(x)));


95: }


96:


97: #endregion


98:


99: #region IsInjectable


100:


101: private bool IsInjectable(MethodInfo Method)


102: {


103: return IsInjectable(Method.GetCustomAttributes(false));


104: }


105:


106: private bool IsInjectable(PropertyInfo Property)


107: {


108: return IsInjectable(Property.GetCustomAttributes(false));


109: }


110:


111: private bool IsInjectable(object[] Attributes)


112: {


113: return Attributes.OfTypeandlt;Injectandgt;().Count() andgt; 0;


114: }


115:


116: #endregion


117:


118: #region CreateInstance


119:


120: private object CreateInstance(ConstructorInfo Constructor)


121: {


122: if (Constructor.IsNull() || MappingManager.IsNull())


123: return null;


124: Listandlt;objectandgt; ParameterValues = new Listandlt;objectandgt;();


125: Constructor.GetParameters().ForEachandlt;ParameterInfoandgt;(x =andgt; ParameterValues.Add(CreateInstance(x)));


126: return Constructor.Invoke(ParameterValues.ToArray());


127: }


128:


129: private object CreateInstance(ParameterInfo Parameter)


130: {


131: return CreateInstance(Parameter.GetCustomAttributes(false), Parameter.ParameterType);


132: }


133:


134: private object CreateInstance(PropertyInfo Property)


135: {


136: return CreateInstance(Property.GetCustomAttributes(false), Property.PropertyType);


137: }


138:


139: private object CreateInstance(object[] Attributes, Type Type)


140: {


141: if (Attributes.Length andgt; 0)


142: {


143: foreach (Attribute Attribute in Attributes)


144: {


145: object TempObject = GetObject(Type, Attribute.GetType());


146: if (!TempObject.IsNull())


147: return TempObject;


148: }


149: }


150: return GetObject(Type);


151: }


152:


153: #endregion


154:


155: #region GetObject


156:


157: private object GetObject(Type Type)


158: {


159: IMapping Mapping = MappingManager.GetMapping(Type);


160: return Mapping.IsNull() ? null : Mapping.Implementation.Create();


161: }


162:


163: private object GetObject(Type Type, Type AttributeType)


164: {


165: IMapping Mapping = MappingManager.GetMapping(Type, AttributeType);


166: return Mapping.IsNull() ? null : Mapping.Implementation.Create();


167: }


168:


169: #endregion


170:


171: #endregion


172:


173: #region Properties


174:


175: /// andlt;summaryandgt;


176: /// Mapping manager


177: /// andlt;/summaryandgt;


178: protected virtual MappingManager MappingManager { get; set; }


179:


180: #endregion


181: }


182: }





1: /*


2: Copyright (c) 2011 andlt;a href=andquot;http://www.gutgames.comandquot;andgt;James Craigandlt;/aandgt;


3:


4: Permission is hereby granted, free of charge, to any person obtaining a copy


5: of this software and associated documentation files (the andquot;Softwareandquot;), to deal


6: in the Software without restriction, including without limitation the rights


7: to use, copy, modify, merge, publish, distribute, sublicense, and/or sell


8: copies of the Software, and to permit persons to whom the Software is


9: furnished to do so, subject to the following conditions:


10:


11: The above copyright notice and this permission notice shall be included in


12: all copies or substantial portions of the Software.


13:


14: THE SOFTWARE IS PROVIDED andquot;AS ISandquot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR


15: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,


16: FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE


17: AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER


18: LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,


19: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN


20: THE SOFTWARE.*/


21:


22: #region Usings


23: using System;


24: using System.Collections.Generic;


25: using System.Linq;


26: using System.Text;


27: using Utilities.IoC.Providers.BaseClasses;


28: #endregion


29:


30: namespace Utilities.IoC.Providers.Implementations


31: {


32: /// andlt;summaryandgt;


33: /// Delegate implementation


34: /// andlt;/summaryandgt;


35: /// andlt;typeparam name=andquot;Tandquot;andgt;Return type of the delegateandlt;/typeparamandgt;


36: public class Delegateandlt;Tandgt; : BaseImplementation


37: {


38: #region Constructor


39:


40: /// andlt;summaryandgt;


41: /// Constructor


42: /// andlt;/summaryandgt;


43: /// andlt;param name=andquot;Implementationandquot;andgt;Implementation delegateandlt;/paramandgt;


44: public Delegate(Funcandlt;Tandgt; Implementation)


45: {


46: this.Implementation = Implementation;


47: ReturnType = typeof(T);


48: }


49:


50: #endregion


51:


52: #region Functions


53:


54: /// andlt;summaryandgt;


55: /// Creates an object based on a delegate


56: /// andlt;/summaryandgt;


57: /// andlt;returnsandgt;An objectandlt;/returnsandgt;


58: public override object Create()


59: {


60: return Implementation();


61: }


62:


63: #endregion


64:


65: #region Properties


66:


67: /// andlt;summaryandgt;


68: /// Delegate used to create objects


69: /// andlt;/summaryandgt;


70: protected virtual Funcandlt;Tandgt; Implementation { get; set; }


71:


72: #endregion


73: }


74: }



You’ll notice that the Delegate implementation is a bit simpler. In this case you provide a Func and we just assume you know how you want an item created so we just return it. The standard implementation though is a bit more complicated.

When we call the standard implementation’s Create function, it calls this little utility to determine which constructor to use:



1: /*


2: Copyright (c) 2011 andlt;a href=andquot;http://www.gutgames.comandquot;andgt;James Craigandlt;/aandgt;


3:


4: Permission is hereby granted, free of charge, to any person obtaining a copy


5: of this software and associated documentation files (the andquot;Softwareandquot;), to deal


6: in the Software without restriction, including without limitation the rights


7: to use, copy, modify, merge, publish, distribute, sublicense, and/or sell


8: copies of the Software, and to permit persons to whom the Software is


9: furnished to do so, subject to the following conditions:


10:


11: The above copyright notice and this permission notice shall be included in


12: all copies or substantial portions of the Software.


13:


14: THE SOFTWARE IS PROVIDED andquot;AS ISandquot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR


15: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,


16: FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE


17: AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER


18: LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,


19: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN


20: THE SOFTWARE.*/


21:


22: #region Usings


23: using System;


24: using System.Collections.Generic;


25: using System.Linq;


26: using System.Text;


27: using System.Reflection;


28: using Utilities.IoC.Mappings;


29: #endregion


30:


31: namespace Utilities.IoC.Utils


32: {


33: public static class ConstructorList


34: {


35: public static ConstructorInfo ChooseConstructor(Type ImplementationType, MappingManager MappingManager)


36: {


37: ConstructorInfo[] Constructors = ImplementationType.GetConstructors();


38: int MaxValue = int.MinValue;


39: ConstructorInfo CurrentConstructor = null;


40: foreach (ConstructorInfo Constructor in Constructors)


41: {


42: int Count = GetParameterCount(Constructor, MappingManager);


43: if (Count andgt; MaxValue)


44: {


45: CurrentConstructor = Constructor;


46: MaxValue = Count;


47: }


48: }


49: return CurrentConstructor;


50: }


51:


52: private static int GetParameterCount(ConstructorInfo Constructor, MappingManager MappingManager)


53: {


54: int Count = 0;


55: ParameterInfo[] Parameters = Constructor.GetParameters();


56: foreach (ParameterInfo Parameter in Parameters)


57: {


58: bool Inject = true;


59: object[] Attributes = Parameter.GetCustomAttributes(false);


60: if (Attributes.Length andgt; 0)


61: {


62: foreach (Attribute Attribute in Attributes)


63: {


64: if (MappingManager.GetMapping(Parameter.ParameterType, Attribute.GetType()) != null)


65: {


66: ++Count;


67: Inject = false;


68: break;


69: }


70: }


71: }


72: if (Inject)


73: {


74: if (MappingManager.GetMapping(Parameter.ParameterType) != null)


75: ++Count;


76: }


77: }


78: if (Count == Parameters.Length)


79: return Count;


80: return int.MinValue;


81: }


82: }


83: }



This bit of code simply determines which constructor has the most items that we know how to create and returns it. The Standard.Create function then takes that constructor and calls CreateInstance. This call determines the parameters of the constructor, and creates each one in turn using the MappingManager (we’ll get to that later). It then feeds the newly created items into the constructor and creates the object. After that it searches each method and each property to determine if they have been marked for injection also (note that this is done using an attribute called Inject). If it finds anything, it creates more objects in the same manner as the parameters for the constructor. Once it’s done with that, it returns the newly created object.

So at this point we have our code to actually create our objects but we have nothing mapping it to anything. We can create but we don’t know when and we don’t know why. That’s where the MappingManager comes in.



1: /*


2: Copyright (c) 2011 andlt;a href=andquot;http://www.gutgames.comandquot;andgt;James Craigandlt;/aandgt;


3:


4: Permission is hereby granted, free of charge, to any person obtaining a copy


5: of this software and associated documentation files (the andquot;Softwareandquot;), to deal


6: in the Software without restriction, including without limitation the rights


7: to use, copy, modify, merge, publish, distribute, sublicense, and/or sell


8: copies of the Software, and to permit persons to whom the Software is


9: furnished to do so, subject to the following conditions:


10:


11: The above copyright notice and this permission notice shall be included in


12: all copies or substantial portions of the Software.


13:


14: THE SOFTWARE IS PROVIDED andquot;AS ISandquot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR


15: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,


16: FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE


17: AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER


18: LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,


19: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN


20: THE SOFTWARE.*/


21:


22: #region Usings


23: using System;


24: using System.Collections.Generic;


25: using System.Linq;


26: using System.Text;


27: using Utilities.IoC.Mappings.Interfaces;


28: using System.Reflection;


29: using Utilities.IoC.Providers;


30: using Utilities.Reflection.ExtensionMethods;


31: using Utilities.IoC.Mappings.Internal_Classes;


32: using Utilities.IoC.Mappings.BaseClasses;


33: #endregion


34:


35: namespace Utilities.IoC.Mappings


36: {


37: /// andlt;summaryandgt;


38: /// Mapping manager


39: /// andlt;/summaryandgt;


40: public class MappingManager


41: {


42: #region Constructor


43:


44: /// andlt;summaryandgt;


45: /// Constructor


46: /// andlt;/summaryandgt;


47: public MappingManager(ProviderManager ProviderManager)


48: {


49: Modules = new Listandlt;IModuleandgt;();


50: Mappings = new Listandlt;IMappingandgt;();


51: this.ProviderManager = ProviderManager;


52: }


53:


54: #endregion


55:


56: #region Functions


57:


58: /// andlt;summaryandgt;


59: /// Scans the assembly for mapping modules and creates them


60: /// andlt;/summaryandgt;


61: /// andlt;param name=andquot;ModuleAssemblyandquot;andgt;andlt;/paramandgt;


62: public void Setup(Assembly ModuleAssembly)


63: {


64: IEnumerableandlt;Typeandgt; Modules = ModuleAssembly.GetTypes(typeof(IModule));


65: Listandlt;IModuleandgt; TempModules = new Listandlt;IModuleandgt;();


66: foreach (Type Module in Modules)


67: {


68: if (!Module.IsInterface andamp;andamp; !Module.IsAbstract)


69: TempModules.Add((IModule)Module.Assembly.CreateInstance(Module.FullName));


70: }


71: foreach (IModule Module in TempModules)


72: {


73: Module.Manager = this;


74: Module.Setup();


75: }


76: this.Modules.AddRange(TempModules);


77: }


78:


79: /// andlt;summaryandgt;


80: /// Creates a mapping object


81: /// andlt;/summaryandgt;


82: /// andlt;param name=andquot;ServiceTypeandquot;andgt;Service typeandlt;/paramandgt;


83: /// andlt;returnsandgt;a mapping objectandlt;/returnsandgt;


84: public IMapping CreateMapping(Type ServiceType)


85: {


86: IMapping Mapping = new Mapping(ServiceType, ProviderManager, this);


87: Mappings.Add(Mapping);


88: return Mapping;


89: }


90:


91: /// andlt;summaryandgt;


92: /// Creates a mapping object


93: /// andlt;/summaryandgt;


94: /// andlt;param name=andquot;ServiceTypeandquot;andgt;Service typeandlt;/paramandgt;


95: /// andlt;param name=andquot;AttributeTypeandquot;andgt;Attribute typeandlt;/paramandgt;


96: /// andlt;returnsandgt;A mapping objectandlt;/returnsandgt;


97: public IMapping CreateMapping(Type ServiceType, Type AttributeType)


98: {


99: IMapping Mapping = new Mapping(ServiceType, AttributeType, ProviderManager, this);


100: Mappings.Add(Mapping);


101: return Mapping;


102: }


103:


104: /// andlt;summaryandgt;


105: /// Gets the mapping that matches this service type


106: /// andlt;/summaryandgt;


107: /// andlt;param name=andquot;ServiceTypeandquot;andgt;Service typeandlt;/paramandgt;


108: /// andlt;returnsandgt;The mapping associated with this service typeandlt;/returnsandgt;


109: public IMapping GetMapping(Type ServiceType)


110: {


111: MappingKey Key = new MappingKey(ServiceType, null, ProviderManager, this);


112: return Mappings.Find(x =andgt; x.Equals(Key));


113: }


114:


115: /// andlt;summaryandgt;


116: /// Gets the mapping that matches this service type and attribute type


117: /// andlt;/summaryandgt;


118: /// andlt;param name=andquot;ServiceTypeandquot;andgt;Service typeandlt;/paramandgt;


119: /// andlt;param name=andquot;AttributeTypeandquot;andgt;Attribute typeandlt;/paramandgt;


120: /// andlt;returnsandgt;The mapping associated with this service type and attribute typeandlt;/returnsandgt;


121: public IMapping GetMapping(Type ServiceType, Type AttributeType)


122: {


123: MappingKey Key = new MappingKey(ServiceType, AttributeType, ProviderManager, this);


124: return Mappings.Find(x =andgt; x.Equals(Key));


125: }


126:


127: #endregion


128:


129: #region Properties


130:


131: /// andlt;summaryandgt;


132: /// Modules listing


133: /// andlt;/summaryandgt;


134: protected virtual Listandlt;IModuleandgt; Modules { get; set; }


135:


136: /// andlt;summaryandgt;


137: /// Mapping listing


138: /// andlt;/summaryandgt;


139: protected virtual Listandlt;IMappingandgt; Mappings { get; set; }


140:


141: /// andlt;summaryandgt;


142: /// Provider manager


143: /// andlt;/summaryandgt;


144: protected virtual ProviderManager ProviderManager { get; set; }


145:


146: #endregion


147: }


148: }



The MappingManager is also a bit bare on implementation. All it does is holds a series of mappings and modules and creates them/returns them as necessary. A module is actually not defined inside the system itself. It’s what the end user would use to let the system know what mappings to use. It uses the following interface and base class:



1: /*


2: Copyright (c) 2011 andlt;a href=andquot;http://www.gutgames.comandquot;andgt;James Craigandlt;/aandgt;


3:


4: Permission is hereby granted, free of charge, to any person obtaining a copy


5: of this software and associated documentation files (the andquot;Softwareandquot;), to deal


6: in the Software without restriction, including without limitation the rights


7: to use, copy, modify, merge, publish, distribute, sublicense, and/or sell


8: copies of the Software, and to permit persons to whom the Software is


9: furnished to do so, subject to the following conditions:


10:


11: The above copyright notice and this permission notice shall be included in


12: all copies or substantial portions of the Software.


13:


14: THE SOFTWARE IS PROVIDED andquot;AS ISandquot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR


15: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,


16: FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE


17: AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER


18: LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,


19: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN


20: THE SOFTWARE.*/


21:


22: #region Usings


23: using System;


24: using System.Collections.Generic;


25: using System.Linq;


26: using System.Text;


27: #endregion


28:


29: namespace Utilities.IoC.Mappings.Interfaces


30: {


31: /// andlt;summaryandgt;


32: /// Mapping module interface


33: /// andlt;/summaryandgt;


34: public interface IModule


35: {


36: #region Functions


37:


38: /// andlt;summaryandgt;


39: /// Called to setup the module (actual mapping occurs here)


40: /// andlt;/summaryandgt;


41: void Setup();


42:


43: #endregion


44:


45: #region Properties


46:


47: MappingManager Manager { get; set; }


48:


49: #endregion


50: }


51: }





1: /*


2: Copyright (c) 2011 andlt;a href=andquot;http://www.gutgames.comandquot;andgt;James Craigandlt;/aandgt;


3:


4: Permission is hereby granted, free of charge, to any person obtaining a copy


5: of this software and associated documentation files (the andquot;Softwareandquot;), to deal


6: in the Software without restriction, including without limitation the rights


7: to use, copy, modify, merge, publish, distribute, sublicense, and/or sell


8: copies of the Software, and to permit persons to whom the Software is


9: furnished to do so, subject to the following conditions:


10:


11: The above copyright notice and this permission notice shall be included in


12: all copies or substantial portions of the Software.


13:


14: THE SOFTWARE IS PROVIDED andquot;AS ISandquot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR


15: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,


16: FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE


17: AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER


18: LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,


19: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN


20: THE SOFTWARE.*/


21:


22: #region Usings


23: using System;


24: using System.Collections.Generic;


25: using System.Linq;


26: using System.Text;


27: using Utilities.IoC.Mappings.Interfaces;


28: #endregion


29:


30: namespace Utilities.IoC.Mappings.BaseClasses


31: {


32: /// andlt;summaryandgt;


33: /// Base module class


34: /// andlt;/summaryandgt;


35: public abstract class BaseModule : IModule


36: {


37: #region Functions


38:


39: public abstract void Setup();


40:


41: /// andlt;summaryandgt;


42: /// Creates a mapping using a specific service type


43: /// andlt;/summaryandgt;


44: /// andlt;typeparam name=andquot;ServiceTypeandquot;andgt;Service typeandlt;/typeparamandgt;


45: /// andlt;returnsandgt;A mapping objectandlt;/returnsandgt;


46: public virtual IMapping Mapandlt;ServiceTypeandgt;()


47: {


48: return Map(typeof(ServiceType));


49: }


50:


51: /// andlt;summaryandgt;


52: /// Creates a mapping using a specific service type and attribute type


53: /// andlt;/summaryandgt;


54: /// andlt;typeparam name=andquot;ServiceTypeandquot;andgt;Service typeandlt;/typeparamandgt;


55: /// andlt;typeparam name=andquot;AttributeTypeandquot;andgt;Attribute typeandlt;/typeparamandgt;


56: /// andlt;returnsandgt;A mapping objectandlt;/returnsandgt;


57: public virtual IMapping Mapandlt;ServiceType, AttributeTypeandgt;()


58: {


59: return Map(typeof(ServiceType), typeof(AttributeType));


60: }


61:


62: /// andlt;summaryandgt;


63: /// Creates a mapping using a specific service type


64: /// andlt;/summaryandgt;


65: /// andlt;param name=andquot;ServiceTypeandquot;andgt;Service typeandlt;/paramandgt;


66: /// andlt;param name=andquot;AttributeTypeandquot;andgt;Attribute typeandlt;/paramandgt;


67: /// andlt;returnsandgt;A mapping objectandlt;/returnsandgt;


68: public virtual IMapping Map(Type ServiceType, Type AttributeType = null)


69: {


70: return Manager.CreateMapping(ServiceType, AttributeType);


71: }


72:


73: #endregion


74:


75: #region Properties


76:


77: public virtual MappingManager Manager { get; set; }


78:


79: #endregion


80: }


81: }



For example, in your code, you would define a module like this:



1: public class Module : BaseModule


2: {


3: public override void Setup()


4: {


5: Mapandlt;ITestInterfaceandgt;().Toandlt;TestClass1andgt;().SetScope(new StandardScope());


6: Mapandlt;TestClass1andgt;().Toandlt;TestClass1andgt;(() =andgt; new TestClass1());


7: Mapandlt;ITestInterface, MyAttributeandgt;().To(new TestImplementation());


8: Mapandlt;TestClass2andgt;().Toandlt;TestClass2andgt;();


9: }


10: }



This module defines four mappings that the system can use. A mapping is, as the name suggests, a mapping between a key type and what should be created when it encounters that type. For instance whenever I hit the interface ITestInterface, we return a TestClass1 object. The module can also define the scope for the object and sets the implementation used. In the example above the first item maps ITestInterface to TestClass1 and sets the scope to StandardScope. The third item maps ITestInterface items that have the MyAttribute attribute to the TestImplementation implementation. Whenever you call Map in a module, it creates and returns a Mapping class:



1: /*


2: Copyright (c) 2011 andlt;a href=andquot;http://www.gutgames.comandquot;andgt;James Craigandlt;/aandgt;


3:


4: Permission is hereby granted, free of charge, to any person obtaining a copy


5: of this software and associated documentation files (the andquot;Softwareandquot;), to deal


6: in the Software without restriction, including without limitation the rights


7: to use, copy, modify, merge, publish, distribute, sublicense, and/or sell


8: copies of the Software, and to permit persons to whom the Software is


9: furnished to do so, subject to the following conditions:


10:


11: The above copyright notice and this permission notice shall be included in


12: all copies or substantial portions of the Software.


13:


14: THE SOFTWARE IS PROVIDED andquot;AS ISandquot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR


15: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,


16: FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE


17: AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER


18: LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,


19: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN


20: THE SOFTWARE.*/


21:


22: #region Usings


23: using System;


24: using System.Collections.Generic;


25: using System.Linq;


26: using System.Text;


27: using Utilities.IoC.Mappings.BaseClasses;


28: using Utilities.IoC.Providers;


29: #endregion


30:


31: namespace Utilities.IoC.Mappings.Internal_Classes


32: {


33: /// andlt;summaryandgt;


34: /// Mapping class


35: /// andlt;/summaryandgt;


36: public class Mapping : MappingKey


37: {


38: #region Constructors


39:


40: /// andlt;summaryandgt;


41: /// Constructor


42: /// andlt;/summaryandgt;


43: /// andlt;param name=andquot;ServiceTypeandquot;andgt;Service typeandlt;/paramandgt;


44: public Mapping(Type ServiceType, ProviderManager ProviderManager, MappingManager MappingManager)


45: : base(ServiceType, null, ProviderManager, MappingManager)


46: {


47: }


48:


49: /// andlt;summaryandgt;


50: /// Constructor


51: /// andlt;/summaryandgt;


52: /// andlt;param name=andquot;ServiceTypeandquot;andgt;Service typeandlt;/paramandgt;


53: /// andlt;param name=andquot;AttributeTypeandquot;andgt;Attribute typeandlt;/paramandgt;


54: public Mapping(Type ServiceType, Type AttributeType, ProviderManager ProviderManager, MappingManager MappingManager)


55: : base(ServiceType, AttributeType, ProviderManager, MappingManager)


56: {


57: }


58:


59: #endregion


60: }


61: }





1: /*


2: Copyright (c) 2011 andlt;a href=andquot;http://www.gutgames.comandquot;andgt;James Craigandlt;/aandgt;


3:


4: Permission is hereby granted, free of charge, to any person obtaining a copy


5: of this software and associated documentation files (the andquot;Softwareandquot;), to deal


6: in the Software without restriction, including without limitation the rights


7: to use, copy, modify, merge, publish, distribute, sublicense, and/or sell


8: copies of the Software, and to permit persons to whom the Software is


9: furnished to do so, subject to the following conditions:


10:


11: The above copyright notice and this permission notice shall be included in


12: all copies or substantial portions of the Software.


13:


14: THE SOFTWARE IS PROVIDED andquot;AS ISandquot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR


15: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,


16: FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE


17: AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER


18: LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,


19: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN


20: THE SOFTWARE.*/


21:


22: #region Usings


23: using System;


24: using System.Collections.Generic;


25: using System.Linq;


26: using System.Text;


27: using Utilities.IoC.Mappings.Interfaces;


28: using Utilities.IoC.Providers;


29: #endregion


30:


31: namespace Utilities.IoC.Mappings.BaseClasses


32: {


33: /// andlt;summaryandgt;


34: /// Mapping key


35: /// andlt;/summaryandgt;


36: public class MappingKey : BaseMapping


37: {


38: #region Constructor


39:


40: public MappingKey(Type ServiceType, Type AttributeType, ProviderManager ProviderManager, MappingManager MappingManager)


41: : base(ServiceType, AttributeType, ProviderManager, MappingManager)


42: {


43: }


44:


45: #endregion


46:


47: #region Functions


48:


49: public override bool Equals(object obj)


50: {


51: if (!(obj is IMapping))


52: return false;


53: IMapping ObjectMapping = (IMapping)obj;


54: return ObjectMapping.AttributeType == AttributeType


55: andamp;andamp; ObjectMapping.ServiceType == ServiceType;


56: }


57:


58: public override int GetHashCode()


59: {


60: int AttributeHash = AttributeType == null ? 1 : AttributeType.GetHashCode();


61: int ServiceHash = ServiceType == null ? 1 : ServiceType.GetHashCode();


62: return ServiceHash * AttributeHash;


63: }


64:


65: #endregion


66: }


67: }





1: /*


2: Copyright (c) 2011 andlt;a href=andquot;http://www.gutgames.comandquot;andgt;James Craigandlt;/aandgt;


3:


4: Permission is hereby granted, free of charge, to any person obtaining a copy


5: of this software and associated documentation files (the andquot;Softwareandquot;), to deal


6: in the Software without restriction, including without limitation the rights


7: to use, copy, modify, merge, publish, distribute, sublicense, and/or sell


8: copies of the Software, and to permit persons to whom the Software is


9: furnished to do so, subject to the following conditions:


10:


11: The above copyright notice and this permission notice shall be included in


12: all copies or substantial portions of the Software.


13:


14: THE SOFTWARE IS PROVIDED andquot;AS ISandquot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR


15: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,


16: FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE


17: AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER


18: LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,


19: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN


20: THE SOFTWARE.*/


21:


22: #region Usings


23: using System;


24: using System.Collections.Generic;


25: using System.Linq;


26: using System.Text;


27: using Utilities.IoC.Mappings.Interfaces;


28: using Utilities.IoC.Providers;


29: using Utilities.IoC.Providers.Scope;


30: using Utilities.IoC.Providers.Interfaces;


31: #endregion


32:


33: namespace Utilities.IoC.Mappings.BaseClasses


34: {


35: /// andlt;summaryandgt;


36: /// Base mapping


37: /// andlt;/summaryandgt;


38: public class BaseMapping : IMapping


39: {


40: #region Constructor


41:


42: /// andlt;summaryandgt;


43: /// Constructor


44: /// andlt;/summaryandgt;


45: /// andlt;param name=andquot;ServiceTypeandquot;andgt;Service typeandlt;/paramandgt;


46: /// andlt;param name=andquot;AttributeTypeandquot;andgt;Attribute typeandlt;/paramandgt;


47: public BaseMapping(Type ServiceType, Type AttributeType, ProviderManager ProviderManager, MappingManager MappingManager)


48: {


49: this.ServiceType = ServiceType;


50: this.AttributeType = AttributeType;


51: this.ProviderManager = ProviderManager;


52: this.MappingManager = MappingManager;


53: this.Scope = new StandardScope();


54: }


55:


56: #endregion


57:


58: #region Functions


59:


60: public virtual IMapping Toandlt;ImplementationTypeandgt;()


61: {


62: return To(typeof(ImplementationType));


63: }


64:


65: public virtual IMapping To(Type ImplementationType)


66: {


67: Implementation = ProviderManager.GetProvider(Scope).CreateImplementation(ImplementationType, MappingManager);


68: return this;


69: }


70:


71: public virtual IMapping Toandlt;ImplementationTypeandgt;(Funcandlt;ImplementationTypeandgt; Implementation)


72: {


73: this.Implementation = ProviderManager.GetProvider(Scope).CreateImplementation(Implementation);


74: return this;


75: }


76:


77: public virtual IMapping To(Providers.Interfaces.IImplementation Implementation)


78: {


79: this.Implementation = Implementation;


80: return this;


81: }


82:


83: public virtual IMapping SetScope(BaseScope Scope)


84: {


85: this.Scope = Scope;


86: Implementation = ProviderManager.GetProvider(Scope).CreateImplementation(Implementation, MappingManager);


87: return this;


88: }


89:


90: #endregion


91:


92: #region Properties


93:


94: public virtual Type ServiceType { get; protected set; }


95: public virtual Type AttributeType { get; protected set; }


96: public virtual BaseScope Scope { get; protected set; }


97: public virtual IImplementation Implementation { get; protected set; }


98: protected virtual ProviderManager ProviderManager { get; set; }


99: protected virtual MappingManager MappingManager { get; set; }


100:


101: #endregion


102: }


103: }



The Mapping class is rather empty, the MappingKey actually defines the functions needed to determine which mapping is which. And the BaseMapping class holds the functions that set the scope, set the implementation, etc. And with that we’re done.

We create our modules, which sets our mappings, which the system holds for us until we tell the manager to get us a specific object type. Once we do that, it assembles our object for us. It’s not that complicated really and not that much code either (the largest file tops out at 189 lines of code including comments). And with that we have ourselves a simple DI container.

If you want updates, or find bugs, etc. check out the repository for the utility library (this is currently under the Utilities.IoC namespace). I’m terrible about updating my site but I update the code there whenever a bug is found. And hopefully I’ll finish my huge update to that library before too long (and it is going to contain a number of changes and additions). Anyway, take a look at the code and happy coding.]]> Building an DI Container

2: Copyright (c) 2011 andlt;a href=andquot;http://www.gutgames.comandquot;andgt;James Craigandlt;/aandgt;


3:


4: Permission is hereby granted, free of charge, to any person obtaining a copy


5: of this software and associated documentation files (the andquot;Softwareandquot;), to deal


6: in the Software without restriction, including without limitation the rights


7: to use, copy, modify, merge, publish, distribute, sublicense, and/or sell


8: copies of the Software, and to permit persons to whom the Software is


9: furnished to do so, subject to the following conditions:


10:


11: The above copyright notice and this permission notice shall be included in


12: all copies or substantial portions of the Software.


13:


14: THE SOFTWARE IS PROVIDED andquot;AS ISandquot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR


15: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,


16: FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE


17: AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER


18: LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,


19: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN


20: THE SOFTWARE.*/


21:


22: #region Usings


23: using System;


24: using System.Collections.Generic;


25: using System.Linq;


26: using System.Text;


27: using Utilities.IoC.Providers;


28: using Utilities.IoC.Mappings;


29: using Utilities.IoC.Mappings.Interfaces;


30: using System.Reflection;


31: using System.IO;


32: using Utilities.IO.ExtensionMethods;


33: using Utilities.Reflection.ExtensionMethods;


34: using Utilities.DataTypes.ExtensionMethods;


35: #endregion


36:


37: namespace Utilities.IoC


38: {


39: /// andlt;summaryandgt;


40: /// Manager class


41: /// andlt;/summaryandgt;


42: public class Manager


43: {


44: #region Constructor


45:


46: /// andlt;summaryandgt;


47: /// Constructor


48: /// andlt;/summaryandgt;


49: public Manager()


50: {


51: if (ProviderManager.IsNull())


52: ProviderManager = new ProviderManager();


53: if (MappingManager.IsNull())


54: MappingManager = new MappingManager(ProviderManager);


55: }


56:


57: #endregion


58:


59: #region Functions


60:


61: /// andlt;summaryandgt;


62: /// Loads all mapping modules found within the assembly


63: /// andlt;/summaryandgt;


64: /// andlt;param name=andquot;ModuleAssemblyandquot;andgt;Module assemblyandlt;/paramandgt;


65: public void Setup(Assembly ModuleAssembly)


66: {


67: ProviderManager.Setup(ModuleAssembly);


68: MappingManager.Setup(ModuleAssembly);


69: }


70:


71: /// andlt;summaryandgt;


72: /// Loads all mapping modules found within the assemblies


73: /// andlt;/summaryandgt;


74: /// andlt;param name=andquot;ModuleAssembliesandquot;andgt;Module assembliesandlt;/paramandgt;


75: public void Setup(IEnumerableandlt;Assemblyandgt; ModuleAssemblies)


76: {


77: ModuleAssemblies.ForEach(x =andgt; Setup(x));


78: }


79:


80: /// andlt;summaryandgt;


81: /// Loads all mapping modules found within a specific directory


82: /// andlt;/summaryandgt;


83: /// andlt;param name=andquot;Directoryandquot;andgt;Directory to scan for modulesandlt;/paramandgt;


84: /// andlt;param name=andquot;RecursiveScanandquot;andgt;Determines if sub directories should be scannedandlt;/paramandgt;


85: public void Setup(string Directory, bool ScanSubDirectories = true)


86: {


87: Setup(new DirectoryInfo(Directory).LoadAssemblies(ScanSubDirectories));


88: }


89:


90: /// andlt;summaryandgt;


91: /// Creates an object of the specified type


92: /// andlt;/summaryandgt;


93: /// andlt;typeparam name=andquot;ServiceTypeandquot;andgt;Service typeandlt;/typeparamandgt;


94: /// andlt;returnsandgt;An object of the specified typeandlt;/returnsandgt;


95: public ServiceType Getandlt;ServiceTypeandgt;()


96: {


97: return (ServiceType)Get(typeof(ServiceType));


98: }


99:


100: /// andlt;summaryandgt;


101: /// Creates an object of the specified type associated with the attribute type


102: /// andlt;/summaryandgt;


103: /// andlt;typeparam name=andquot;ServiceTypeandquot;andgt;Service typeandlt;/typeparamandgt;


104: /// andlt;typeparam name=andquot;AttributeTypeandquot;andgt;Attribute typeandlt;/typeparamandgt;


105: /// andlt;returnsandgt;An object of the specified typeandlt;/returnsandgt;


106: public ServiceType Getandlt;ServiceType, AttributeTypeandgt;()


107: {


108: return (ServiceType)Get(typeof(ServiceType), typeof(AttributeType));


109: }


110:


111: /// andlt;summaryandgt;


112: /// Creates an object of the specified type


113: /// andlt;/summaryandgt;


114: /// andlt;param name=andquot;ServiceTypeandquot;andgt;Service typeandlt;/paramandgt;


115: /// andlt;returnsandgt;An object of the specified typeandlt;/returnsandgt;


116: public object Get(Type ServiceType)


117: {


118: IMapping Mapping = MappingManager.GetMapping(ServiceType);


119: if (Mapping.IsNull())


120: throw new ArgumentException(andquot;ServiceType not found in mappingsandquot;);


121: return Mapping.Implementation.Create();


122: }


123:


124: /// andlt;summaryandgt;


125: /// Creates an object of the specified type associated with the attribute type


126: /// andlt;/summaryandgt;


127: /// andlt;param name=andquot;ServiceTypeandquot;andgt;Service typeandlt;/paramandgt;


128: /// andlt;param name=andquot;AttributeTypeandquot;andgt;Attribute typeandlt;/paramandgt;


129: /// andlt;returnsandgt;An object of the specified typeandlt;/returnsandgt;


130: public object Get(Type ServiceType, Type AttributeType)


131: {


132: IMapping Mapping = MappingManager.GetMapping(ServiceType, AttributeType);


133: if (Mapping.IsNull())


134: throw new ArgumentException(andquot;ServiceType not found in mappingsandquot;);


135: return Mapping.Implementation.Create();


136: }


137:


138: #endregion


139:


140: #region Properties


141:


142: protected static ProviderManager ProviderManager { get; set; }


143: protected static MappingManager MappingManager { get; set; }


144:


145: #endregion


146: }


147: }



This is our main point of code that we are going to use to get our objects. We set it up, call Get, and it will return to us our object (with the appropriate items injected). One thing that you’ll notice is that there are a couple nonstandard C# calls in there (specifically the ForEach on the IEnumerable, IsNull, etc). These are all functions from the new utility library that I’m working on. I’ve been adding quite a bit to it, tons of extension methods, etc. So go and check out the repository as all of my code on here uses it (or at least the code on here uses a version of it). Plus any updates to the code can be found there also as I tend to forget the pages on this site. Anyway another thing you may notice is there isn’t much code here. Most of the actual work is going to be done in the ProviderManager and MappingManager.



1: /*


2: Copyright (c) 2011 andlt;a href=andquot;http://www.gutgames.comandquot;andgt;James Craigandlt;/aandgt;


3:


4: Permission is hereby granted, free of charge, to any person obtaining a copy


5: of this software and associated documentation files (the andquot;Softwareandquot;), to deal


6: in the Software without restriction, including without limitation the rights


7: to use, copy, modify, merge, publish, distribute, sublicense, and/or sell


8: copies of the Software, and to permit persons to whom the Software is


9: furnished to do so, subject to the following conditions:


10:


11: The above copyright notice and this permission notice shall be included in


12: all copies or substantial portions of the Software.


13:


14: THE SOFTWARE IS PROVIDED andquot;AS ISandquot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR


15: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,


16: FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE


17: AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER


18: LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,


19: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN


20: THE SOFTWARE.*/


21:


22: #region Usings


23: using System;


24: using System.Collections.Generic;


25: using System.Linq;


26: using System.Text;


27: using Utilities.IoC.Providers.Interfaces;


28: using Utilities.IoC.Providers.Scope;


29: using Utilities.Reflection;


30: using Utilities.Reflection.ExtensionMethods;


31: using Utilities.DataTypes.ExtensionMethods;


32: using System.Reflection;


33: #endregion


34:


35: namespace Utilities.IoC.Providers


36: {


37: /// andlt;summaryandgt;


38: /// Provider manager


39: /// andlt;/summaryandgt;


40: public class ProviderManager


41: {


42: #region Constructor


43:


44: /// andlt;summaryandgt;


45: /// Constructor


46: /// andlt;/summaryandgt;


47: public ProviderManager()


48: {


49: Providers = new Listandlt;IProviderandgt;();


50: Providers.AddRange(typeof(ProviderManager).Assembly.GetObjectsandlt;IProviderandgt;());


51: }


52:


53: #endregion


54:


55: #region Functions


56:


57: /// andlt;summaryandgt;


58: /// Sets up all providers found within the assembly specified


59: /// andlt;/summaryandgt;


60: /// andlt;param name=andquot;Assemblyandquot;andgt;Assembly to scanandlt;/paramandgt;


61: public void Setup(Assembly Assembly)


62: {


63: Providers.AddRange(Assembly.GetObjectsandlt;IProviderandgt;());


64: }


65:


66: /// andlt;summaryandgt;


67: /// Gets the specified provider based on the scope specified


68: /// andlt;/summaryandgt;


69: /// andlt;param name=andquot;Scopeandquot;andgt;Scopeandlt;/paramandgt;


70: /// andlt;returnsandgt;The specified providerandlt;/returnsandgt;


71: public IProvider GetProvider(BaseScope Scope)


72: {


73: return Providers.FirstOrDefault(x =andgt; x.ProviderScope.Equals(Scope));


74: }


75:


76: #endregion


77:


78: #region Properties


79:


80: protected virtual Listandlt;IProviderandgt; Providers { get; set; }


81:


82: #endregion


83: }


84: }



The ProviderManager above holds a list of providers. These providers determine how to handle an implementation when you provide the system with one. The implementations actually determine how something is created. For instance, the code base only has one provider at present called Standard.



1: /*


2: Copyright (c) 2011 andlt;a href=andquot;http://www.gutgames.comandquot;andgt;James Craigandlt;/aandgt;


3:


4: Permission is hereby granted, free of charge, to any person obtaining a copy


5: of this software and associated documentation files (the andquot;Softwareandquot;), to deal


6: in the Software without restriction, including without limitation the rights


7: to use, copy, modify, merge, publish, distribute, sublicense, and/or sell


8: copies of the Software, and to permit persons to whom the Software is


9: furnished to do so, subject to the following conditions:


10:


11: The above copyright notice and this permission notice shall be included in


12: all copies or substantial portions of the Software.


13:


14: THE SOFTWARE IS PROVIDED andquot;AS ISandquot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR


15: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,


16: FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE


17: AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER


18: LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,


19: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN


20: THE SOFTWARE.*/


21:


22: #region Usings


23: using System;


24: using System.Collections.Generic;


25: using System.Linq;


26: using System.Text;


27: using Utilities.IoC.Providers.Scope;


28: using Utilities.IoC.Providers.Interfaces;


29: using Utilities.IoC.Mappings;


30: using Utilities.IoC.Providers.Implementations;


31: #endregion


32:


33: namespace Utilities.IoC.Providers.DefaultProviders


34: {


35: /// andlt;summaryandgt;


36: /// Standard provider


37: /// andlt;/summaryandgt;


38: public class Standard : IProvider


39: {


40: public IImplementation CreateImplementation(Type ImplementationType, MappingManager MappingManager)


41: {


42: return new Implementations.Standard(ImplementationType, MappingManager);


43: }


44:


45:


46: public BaseScope ProviderScope


47: {


48: get { return new StandardScope(); }


49: }


50:


51: public IImplementation CreateImplementation(IImplementation Implementation, MappingManager MappingManager)


52: {


53: return CreateImplementation(Implementation.ReturnType, MappingManager);


54: }


55:


56: public IImplementation CreateImplementationandlt;ImplementationTypeandgt;(Funcandlt;ImplementationTypeandgt; Implementation)


57: {


58: return new Delegateandlt;ImplementationTypeandgt;(Implementation);


59: }


60: }


61: }



This provider just creates a new implementation object (either a Delegate or Standard implementation depending) each time it’s fed anything. However we could have a provider called Singleton or something and have it return its own implementation types. We determine which provider to use in the ProviderManager based on something called Scopes:



1: /*


2: Copyright (c) 2011 andlt;a href=andquot;http://www.gutgames.comandquot;andgt;James Craigandlt;/aandgt;


3:


4: Permission is hereby granted, free of charge, to any person obtaining a copy


5: of this software and associated documentation files (the andquot;Softwareandquot;), to deal


6: in the Software without restriction, including without limitation the rights


7: to use, copy, modify, merge, publish, distribute, sublicense, and/or sell


8: copies of the Software, and to permit persons to whom the Software is


9: furnished to do so, subject to the following conditions:


10:


11: The above copyright notice and this permission notice shall be included in


12: all copies or substantial portions of the Software.


13:


14: THE SOFTWARE IS PROVIDED andquot;AS ISandquot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR


15: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,


16: FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE


17: AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER


18: LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,


19: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN


20: THE SOFTWARE.*/


21:


22: #region Usings


23: using System;


24: using System.Collections.Generic;


25: using System.Linq;


26: using System.Text;


27: #endregion


28:


29: namespace Utilities.IoC.Providers.Scope


30: {


31: /// andlt;summaryandgt;


32: /// Standard scope


33: /// andlt;/summaryandgt;


34: public class StandardScope : BaseScope


35: {


36: #region Constructor


37:


38: public StandardScope()


39: : base()


40: {


41: }


42:


43: #endregion


44:


45: #region Properties


46:


47: public override string Name { get { return andquot;Standardandquot;; } }


48:


49: #endregion


50: }


51: }



As you can see, it’s just a holder of info. So for our Singleton provider example, we would need to create a Singleton scope and have it return that value so we know which to use. Anyway, the next bit is the actual implementations:



1: /*


2: Copyright (c) 2011 andlt;a href=andquot;http://www.gutgames.comandquot;andgt;James Craigandlt;/aandgt;


3:


4: Permission is hereby granted, free of charge, to any person obtaining a copy


5: of this software and associated documentation files (the andquot;Softwareandquot;), to deal


6: in the Software without restriction, including without limitation the rights


7: to use, copy, modify, merge, publish, distribute, sublicense, and/or sell


8: copies of the Software, and to permit persons to whom the Software is


9: furnished to do so, subject to the following conditions:


10:


11: The above copyright notice and this permission notice shall be included in


12: all copies or substantial portions of the Software.


13:


14: THE SOFTWARE IS PROVIDED andquot;AS ISandquot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR


15: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,


16: FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE


17: AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER


18: LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,


19: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN


20: THE SOFTWARE.*/


21:


22: #region Usings


23: using System;


24: using System.Collections.Generic;


25: using System.Linq;


26: using System.Text;


27: using Utilities.IoC.Mappings;


28: using Utilities.IoC.Mappings.Interfaces;


29: using System.Reflection;


30: using Utilities.IoC.Mappings.Attributes;


31: using Utilities.IoC.Providers.BaseClasses;


32: using Utilities.DataTypes.ExtensionMethods;


33: using Utilities.Reflection.ExtensionMethods;


34: #endregion


35:


36: namespace Utilities.IoC.Providers.Implementations


37: {


38: /// andlt;summaryandgt;


39: /// Standard implementation class


40: /// andlt;/summaryandgt;


41: public class Standard : BaseImplementation


42: {


43: #region Constructor


44:


45: /// andlt;summaryandgt;


46: /// Constructor


47: /// andlt;/summaryandgt;


48: /// andlt;param name=andquot;ImplementationTypeandquot;andgt;Implementation typeandlt;/paramandgt;


49: /// andlt;param name=andquot;MappingManagerandquot;andgt;Mapping managerandlt;/paramandgt;


50: public Standard(Type ImplementationType, MappingManager MappingManager)


51: {


52: this.ReturnType = ImplementationType;


53: this.MappingManager = MappingManager;


54: }


55:


56: #endregion


57:


58: #region Functions


59:


60: #region Create


61:


62: public override object Create()


63: {


64: ConstructorInfo Constructor = Utils.ConstructorList.ChooseConstructor(ReturnType, MappingManager);


65: object Instance = CreateInstance(Constructor);


66: SetupProperties(Instance);


67: SetupMethods(Instance);


68: return Instance;


69: }


70:


71: #endregion


72:


73: #region SetupMethods


74:


75: private void SetupMethods(object Instance)


76: {


77: if (Instance.IsNull())


78: return;


79: foreach (MethodInfo Method in Instance.GetType().GetMethods().Where(x =andgt; IsInjectable(x)))


80: Method.Invoke(Instance, Method.GetParameters().ForEach(x =andgt; CreateInstance(x)).ToArray());


81: }


82:


83: #endregion


84:


85: #region SetupProperties


86:


87: private void SetupProperties(object Instance)


88: {


89: if (Instance.IsNull())


90: return;


91: Instance.GetType()


92: .GetProperties()


93: .Where(x =andgt; IsInjectable(x))


94: .ForEachandlt;PropertyInfoandgt;(x =andgt; Instance.SetProperty(x, CreateInstance(x)));


95: }


96:


97: #endregion


98:


99: #region IsInjectable


100:


101: private bool IsInjectable(MethodInfo Method)


102: {


103: return IsInjectable(Method.GetCustomAttributes(false));


104: }


105:


106: private bool IsInjectable(PropertyInfo Property)


107: {


108: return IsInjectable(Property.GetCustomAttributes(false));


109: }


110:


111: private bool IsInjectable(object[] Attributes)


112: {


113: return Attributes.OfTypeandlt;Injectandgt;().Count() andgt; 0;


114: }


115:


116: #endregion


117:


118: #region CreateInstance


119:


120: private object CreateInstance(ConstructorInfo Constructor)


121: {


122: if (Constructor.IsNull() || MappingManager.IsNull())


123: return null;


124: Listandlt;objectandgt; ParameterValues = new Listandlt;objectandgt;();


125: Constructor.GetParameters().ForEachandlt;ParameterInfoandgt;(x =andgt; ParameterValues.Add(CreateInstance(x)));


126: return Constructor.Invoke(ParameterValues.ToArray());


127: }


128:


129: private object CreateInstance(ParameterInfo Parameter)


130: {


131: return CreateInstance(Parameter.GetCustomAttributes(false), Parameter.ParameterType);


132: }


133:


134: private object CreateInstance(PropertyInfo Property)


135: {


136: return CreateInstance(Property.GetCustomAttributes(false), Property.PropertyType);


137: }


138:


139: private object CreateInstance(object[] Attributes, Type Type)


140: {


141: if (Attributes.Length andgt; 0)


142: {


143: foreach (Attribute Attribute in Attributes)


144: {


145: object TempObject = GetObject(Type, Attribute.GetType());


146: if (!TempObject.IsNull())


147: return TempObject;


148: }


149: }


150: return GetObject(Type);


151: }


152:


153: #endregion


154:


155: #region GetObject


156:


157: private object GetObject(Type Type)


158: {


159: IMapping Mapping = MappingManager.GetMapping(Type);


160: return Mapping.IsNull() ? null : Mapping.Implementation.Create();


161: }


162:


163: private object GetObject(Type Type, Type AttributeType)


164: {


165: IMapping Mapping = MappingManager.GetMapping(Type, AttributeType);


166: return Mapping.IsNull() ? null : Mapping.Implementation.Create();


167: }


168:


169: #endregion


170:


171: #endregion


172:


173: #region Properties


174:


175: /// andlt;summaryandgt;


176: /// Mapping manager


177: /// andlt;/summaryandgt;


178: protected virtual MappingManager MappingManager { get; set; }


179:


180: #endregion


181: }


182: }





1: /*


2: Copyright (c) 2011 andlt;a href=andquot;http://www.gutgames.comandquot;andgt;James Craigandlt;/aandgt;


3:


4: Permission is hereby granted, free of charge, to any person obtaining a copy


5: of this software and associated documentation files (the andquot;Softwareandquot;), to deal


6: in the Software without restriction, including without limitation the rights


7: to use, copy, modify, merge, publish, distribute, sublicense, and/or sell


8: copies of the Software, and to permit persons to whom the Software is


9: furnished to do so, subject to the following conditions:


10:


11: The above copyright notice and this permission notice shall be included in


12: all copies or substantial portions of the Software.


13:


14: THE SOFTWARE IS PROVIDED andquot;AS ISandquot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR


15: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,


16: FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE


17: AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER


18: LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,


19: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN


20: THE SOFTWARE.*/


21:


22: #region Usings


23: using System;


24: using System.Collections.Generic;


25: using System.Linq;


26: using System.Text;


27: using Utilities.IoC.Providers.BaseClasses;


28: #endregion


29:


30: namespace Utilities.IoC.Providers.Implementations


31: {


32: /// andlt;summaryandgt;


33: /// Delegate implementation


34: /// andlt;/summaryandgt;


35: /// andlt;typeparam name=andquot;Tandquot;andgt;Return type of the delegateandlt;/typeparamandgt;


36: public class Delegateandlt;Tandgt; : BaseImplementation


37: {


38: #region Constructor


39:


40: /// andlt;summaryandgt;


41: /// Constructor


42: /// andlt;/summaryandgt;


43: /// andlt;param name=andquot;Implementationandquot;andgt;Implementation delegateandlt;/paramandgt;


44: public Delegate(Funcandlt;Tandgt; Implementation)


45: {


46: this.Implementation = Implementation;


47: ReturnType = typeof(T);


48: }


49:


50: #endregion


51:


52: #region Functions


53:


54: /// andlt;summaryandgt;


55: /// Creates an object based on a delegate


56: /// andlt;/summaryandgt;


57: /// andlt;returnsandgt;An objectandlt;/returnsandgt;


58: public override object Create()


59: {


60: return Implementation();


61: }


62:


63: #endregion


64:


65: #region Properties


66:


67: /// andlt;summaryandgt;


68: /// Delegate used to create objects


69: /// andlt;/summaryandgt;


70: protected virtual Funcandlt;Tandgt; Implementation { get; set; }


71:


72: #endregion


73: }


74: }



You’ll notice that the Delegate implementation is a bit simpler. In this case you provide a Func and we just assume you know how you want an item created so we just return it. The standard implementation though is a bit more complicated.

When we call the standard implementation’s Create function, it calls this little utility to determine which constructor to use:



1: /*


2: Copyright (c) 2011 andlt;a href=andquot;http://www.gutgames.comandquot;andgt;James Craigandlt;/aandgt;


3:


4: Permission is hereby granted, free of charge, to any person obtaining a copy


5: of this software and associated documentation files (the andquot;Softwareandquot;), to deal


6: in the Software without restriction, including without limitation the rights


7: to use, copy, modify, merge, publish, distribute, sublicense, and/or sell


8: copies of the Software, and to permit persons to whom the Software is


9: furnished to do so, subject to the following conditions:


10:


11: The above copyright notice and this permission notice shall be included in


12: all copies or substantial portions of the Software.


13:


14: THE SOFTWARE IS PROVIDED andquot;AS ISandquot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR


15: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,


16: FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE


17: AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER


18: LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,


19: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN


20: THE SOFTWARE.*/


21:


22: #region Usings


23: using System;


24: using System.Collections.Generic;


25: using System.Linq;


26: using System.Text;


27: using System.Reflection;


28: using Utilities.IoC.Mappings;


29: #endregion


30:


31: namespace Utilities.IoC.Utils


32: {


33: public static class ConstructorList


34: {


35: public static ConstructorInfo ChooseConstructor(Type ImplementationType, MappingManager MappingManager)


36: {


37: ConstructorInfo[] Constructors = ImplementationType.GetConstructors();


38: int MaxValue = int.MinValue;


39: ConstructorInfo CurrentConstructor = null;


40: foreach (ConstructorInfo Constructor in Constructors)


41: {


42: int Count = GetParameterCount(Constructor, MappingManager);


43: if (Count andgt; MaxValue)


44: {


45: CurrentConstructor = Constructor;


46: MaxValue = Count;


47: }


48: }


49: return CurrentConstructor;


50: }


51:


52: private static int GetParameterCount(ConstructorInfo Constructor, MappingManager MappingManager)


53: {


54: int Count = 0;


55: ParameterInfo[] Parameters = Constructor.GetParameters();


56: foreach (ParameterInfo Parameter in Parameters)


57: {


58: bool Inject = true;


59: object[] Attributes = Parameter.GetCustomAttributes(false);


60: if (Attributes.Length andgt; 0)


61: {


62: foreach (Attribute Attribute in Attributes)


63: {


64: if (MappingManager.GetMapping(Parameter.ParameterType, Attribute.GetType()) != null)


65: {


66: ++Count;


67: Inject = false;


68: break;


69: }


70: }


71: }


72: if (Inject)


73: {


74: if (MappingManager.GetMapping(Parameter.ParameterType) != null)


75: ++Count;


76: }


77: }


78: if (Count == Parameters.Length)


79: return Count;


80: return int.MinValue;


81: }


82: }


83: }



This bit of code simply determines which constructor has the most items that we know how to create and returns it. The Standard.Create function then takes that constructor and calls CreateInstance. This call determines the parameters of the constructor, and creates each one in turn using the MappingManager (we’ll get to that later). It then feeds the newly created items into the constructor and creates the object. After that it searches each method and each property to determine if they have been marked for injection also (note that this is done using an attribute called Inject). If it finds anything, it creates more objects in the same manner as the parameters for the constructor. Once it’s done with that, it returns the newly created object.

So at this point we have our code to actually create our objects but we have nothing mapping it to anything. We can create but we don’t know when and we don’t know why. That’s where the MappingManager comes in.



1: /*


2: Copyright (c) 2011 andlt;a href=andquot;http://www.gutgames.comandquot;andgt;James Craigandlt;/aandgt;


3:


4: Permission is hereby granted, free of charge, to any person obtaining a copy


5: of this software and associated documentation files (the andquot;Softwareandquot;), to deal


6: in the Software without restriction, including without limitation the rights


7: to use, copy, modify, merge, publish, distribute, sublicense, and/or sell


8: copies of the Software, and to permit persons to whom the Software is


9: furnished to do so, subject to the following conditions:


10:


11: The above copyright notice and this permission notice shall be included in


12: all copies or substantial portions of the Software.


13:


14: THE SOFTWARE IS PROVIDED andquot;AS ISandquot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR


15: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,


16: FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE


17: AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER


18: LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,


19: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN


20: THE SOFTWARE.*/


21:


22: #region Usings


23: using System;


24: using System.Collections.Generic;


25: using System.Linq;


26: using System.Text;


27: using Utilities.IoC.Mappings.Interfaces;


28: using System.Reflection;


29: using Utilities.IoC.Providers;


30: using Utilities.Reflection.ExtensionMethods;


31: using Utilities.IoC.Mappings.Internal_Classes;


32: using Utilities.IoC.Mappings.BaseClasses;


33: #endregion


34:


35: namespace Utilities.IoC.Mappings


36: {


37: /// andlt;summaryandgt;


38: /// Mapping manager


39: /// andlt;/summaryandgt;


40: public class MappingManager


41: {


42: #region Constructor


43:


44: /// andlt;summaryandgt;


45: /// Constructor


46: /// andlt;/summaryandgt;


47: public MappingManager(ProviderManager ProviderManager)


48: {


49: Modules = new Listandlt;IModuleandgt;();


50: Mappings = new Listandlt;IMappingandgt;();


51: this.ProviderManager = ProviderManager;


52: }


53:


54: #endregion


55:


56: #region Functions


57:


58: /// andlt;summaryandgt;


59: /// Scans the assembly for mapping modules and creates them


60: /// andlt;/summaryandgt;


61: /// andlt;param name=andquot;ModuleAssemblyandquot;andgt;andlt;/paramandgt;


62: public void Setup(Assembly ModuleAssembly)


63: {


64: IEnumerableandlt;Typeandgt; Modules = ModuleAssembly.GetTypes(typeof(IModule));


65: Listandlt;IModuleandgt; TempModules = new Listandlt;IModuleandgt;();


66: foreach (Type Module in Modules)


67: {


68: if (!Module.IsInterface andamp;andamp; !Module.IsAbstract)


69: TempModules.Add((IModule)Module.Assembly.CreateInstance(Module.FullName));


70: }


71: foreach (IModule Module in TempModules)


72: {


73: Module.Manager = this;


74: Module.Setup();


75: }


76: this.Modules.AddRange(TempModules);


77: }


78:


79: /// andlt;summaryandgt;


80: /// Creates a mapping object


81: /// andlt;/summaryandgt;


82: /// andlt;param name=andquot;ServiceTypeandquot;andgt;Service typeandlt;/paramandgt;


83: /// andlt;returnsandgt;a mapping objectandlt;/returnsandgt;


84: public IMapping CreateMapping(Type ServiceType)


85: {


86: IMapping Mapping = new Mapping(ServiceType, ProviderManager, this);


87: Mappings.Add(Mapping);


88: return Mapping;


89: }


90:


91: /// andlt;summaryandgt;


92: /// Creates a mapping object


93: /// andlt;/summaryandgt;


94: /// andlt;param name=andquot;ServiceTypeandquot;andgt;Service typeandlt;/paramandgt;


95: /// andlt;param name=andquot;AttributeTypeandquot;andgt;Attribute typeandlt;/paramandgt;


96: /// andlt;returnsandgt;A mapping objectandlt;/returnsandgt;


97: public IMapping CreateMapping(Type ServiceType, Type AttributeType)


98: {


99: IMapping Mapping = new Mapping(ServiceType, AttributeType, ProviderManager, this);


100: Mappings.Add(Mapping);


101: return Mapping;


102: }


103:


104: /// andlt;summaryandgt;


105: /// Gets the mapping that matches this service type


106: /// andlt;/summaryandgt;


107: /// andlt;param name=andquot;ServiceTypeandquot;andgt;Service typeandlt;/paramandgt;


108: /// andlt;returnsandgt;The mapping associated with this service typeandlt;/returnsandgt;


109: public IMapping GetMapping(Type ServiceType)


110: {


111: MappingKey Key = new MappingKey(ServiceType, null, ProviderManager, this);


112: return Mappings.Find(x =andgt; x.Equals(Key));


113: }


114:


115: /// andlt;summaryandgt;


116: /// Gets the mapping that matches this service type and attribute type


117: /// andlt;/summaryandgt;


118: /// andlt;param name=andquot;ServiceTypeandquot;andgt;Service typeandlt;/paramandgt;


119: /// andlt;param name=andquot;AttributeTypeandquot;andgt;Attribute typeandlt;/paramandgt;


120: /// andlt;returnsandgt;The mapping associated with this service type and attribute typeandlt;/returnsandgt;


121: public IMapping GetMapping(Type ServiceType, Type AttributeType)


122: {


123: MappingKey Key = new MappingKey(ServiceType, AttributeType, ProviderManager, this);


124: return Mappings.Find(x =andgt; x.Equals(Key));


125: }


126:


127: #endregion


128:


129: #region Properties


130:


131: /// andlt;summaryandgt;


132: /// Modules listing


133: /// andlt;/summaryandgt;


134: protected virtual Listandlt;IModuleandgt; Modules { get; set; }


135:


136: /// andlt;summaryandgt;


137: /// Mapping listing


138: /// andlt;/summaryandgt;


139: protected virtual Listandlt;IMappingandgt; Mappings { get; set; }


140:


141: /// andlt;summaryandgt;


142: /// Provider manager


143: /// andlt;/summaryandgt;


144: protected virtual ProviderManager ProviderManager { get; set; }


145:


146: #endregion


147: }


148: }



The MappingManager is also a bit bare on implementation. All it does is holds a series of mappings and modules and creates them/returns them as necessary. A module is actually not defined inside the system itself. It’s what the end user would use to let the system know what mappings to use. It uses the following interface and base class:



1: /*


2: Copyright (c) 2011 andlt;a href=andquot;http://www.gutgames.comandquot;andgt;James Craigandlt;/aandgt;


3:


4: Permission is hereby granted, free of charge, to any person obtaining a copy


5: of this software and associated documentation files (the andquot;Softwareandquot;), to deal


6: in the Software without restriction, including without limitation the rights


7: to use, copy, modify, merge, publish, distribute, sublicense, and/or sell


8: copies of the Software, and to permit persons to whom the Software is


9: furnished to do so, subject to the following conditions:


10:


11: The above copyright notice and this permission notice shall be included in


12: all copies or substantial portions of the Software.


13:


14: THE SOFTWARE IS PROVIDED andquot;AS ISandquot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR


15: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,


16: FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE


17: AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER


18: LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,


19: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN


20: THE SOFTWARE.*/


21:


22: #region Usings


23: using System;


24: using System.Collections.Generic;


25: using System.Linq;


26: using System.Text;


27: #endregion


28:


29: namespace Utilities.IoC.Mappings.Interfaces


30: {


31: /// andlt;summaryandgt;


32: /// Mapping module interface


33: /// andlt;/summaryandgt;


34: public interface IModule


35: {


36: #region Functions


37:


38: /// andlt;summaryandgt;


39: /// Called to setup the module (actual mapping occurs here)


40: /// andlt;/summaryandgt;


41: void Setup();


42:


43: #endregion


44:


45: #region Properties


46:


47: MappingManager Manager { get; set; }


48:


49: #endregion


50: }


51: }





1: /*


2: Copyright (c) 2011 andlt;a href=andquot;http://www.gutgames.comandquot;andgt;James Craigandlt;/aandgt;


3:


4: Permission is hereby granted, free of charge, to any person obtaining a copy


5: of this software and associated documentation files (the andquot;Softwareandquot;), to deal


6: in the Software without restriction, including without limitation the rights


7: to use, copy, modify, merge, publish, distribute, sublicense, and/or sell


8: copies of the Software, and to permit persons to whom the Software is


9: furnished to do so, subject to the following conditions:


10:


11: The above copyright notice and this permission notice shall be included in


12: all copies or substantial portions of the Software.


13:


14: THE SOFTWARE IS PROVIDED andquot;AS ISandquot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR


15: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,


16: FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE


17: AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER


18: LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,


19: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN


20: THE SOFTWARE.*/


21:


22: #region Usings


23: using System;


24: using System.Collections.Generic;


25: using System.Linq;


26: using System.Text;


27: using Utilities.IoC.Mappings.Interfaces;


28: #endregion


29:


30: namespace Utilities.IoC.Mappings.BaseClasses


31: {


32: /// andlt;summaryandgt;


33: /// Base module class


34: /// andlt;/summaryandgt;


35: public abstract class BaseModule : IModule


36: {


37: #region Functions


38:


39: public abstract void Setup();


40:


41: /// andlt;summaryandgt;


42: /// Creates a mapping using a specific service type


43: /// andlt;/summaryandgt;


44: /// andlt;typeparam name=andquot;ServiceTypeandquot;andgt;Service typeandlt;/typeparamandgt;


45: /// andlt;returnsandgt;A mapping objectandlt;/returnsandgt;


46: public virtual IMapping Mapandlt;ServiceTypeandgt;()


47: {


48: return Map(typeof(ServiceType));


49: }


50:


51: /// andlt;summaryandgt;


52: /// Creates a mapping using a specific service type and attribute type


53: /// andlt;/summaryandgt;


54: /// andlt;typeparam name=andquot;ServiceTypeandquot;andgt;Service typeandlt;/typeparamandgt;


55: /// andlt;typeparam name=andquot;AttributeTypeandquot;andgt;Attribute typeandlt;/typeparamandgt;


56: /// andlt;returnsandgt;A mapping objectandlt;/returnsandgt;


57: public virtual IMapping Mapandlt;ServiceType, AttributeTypeandgt;()


58: {


59: return Map(typeof(ServiceType), typeof(AttributeType));


60: }


61:


62: /// andlt;summaryandgt;


63: /// Creates a mapping using a specific service type


64: /// andlt;/summaryandgt;


65: /// andlt;param name=andquot;ServiceTypeandquot;andgt;Service typeandlt;/paramandgt;


66: /// andlt;param name=andquot;AttributeTypeandquot;andgt;Attribute typeandlt;/paramandgt;


67: /// andlt;returnsandgt;A mapping objectandlt;/returnsandgt;


68: public virtual IMapping Map(Type ServiceType, Type AttributeType = null)


69: {


70: return Manager.CreateMapping(ServiceType, AttributeType);


71: }


72:


73: #endregion


74:


75: #region Properties


76:


77: public virtual MappingManager Manager { get; set; }


78:


79: #endregion


80: }


81: }



For example, in your code, you would define a module like this:



1: public class Module : BaseModule


2: {


3: public override void Setup()


4: {


5: Mapandlt;ITestInterfaceandgt;().Toandlt;TestClass1andgt;().SetScope(new StandardScope());


6: Mapandlt;TestClass1andgt;().Toandlt;TestClass1andgt;(() =andgt; new TestClass1());


7: Mapandlt;ITestInterface, MyAttributeandgt;().To(new TestImplementation());


8: Mapandlt;TestClass2andgt;().Toandlt;TestClass2andgt;();


9: }


10: }



This module defines four mappings that the system can use. A mapping is, as the name suggests, a mapping between a key type and what should be created when it encounters that type. For instance whenever I hit the interface ITestInterface, we return a TestClass1 object. The module can also define the scope for the object and sets the implementation used. In the example above the first item maps ITestInterface to TestClass1 and sets the scope to StandardScope. The third item maps ITestInterface items that have the MyAttribute attribute to the TestImplementation implementation. Whenever you call Map in a module, it creates and returns a Mapping class:



1: /*


2: Copyright (c) 2011 andlt;a href=andquot;http://www.gutgames.comandquot;andgt;James Craigandlt;/aandgt;


3:


4: Permission is hereby granted, free of charge, to any person obtaining a copy


5: of this software and associated documentation files (the andquot;Softwareandquot;), to deal


6: in the Software without restriction, including without limitation the rights


7: to use, copy, modify, merge, publish, distribute, sublicense, and/or sell


8: copies of the Software, and to permit persons to whom the Software is


9: furnished to do so, subject to the following conditions:


10:


11: The above copyright notice and this permission notice shall be included in


12: all copies or substantial portions of the Software.


13:


14: THE SOFTWARE IS PROVIDED andquot;AS ISandquot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR


15: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,


16: FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE


17: AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER


18: LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,


19: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN


20: THE SOFTWARE.*/


21:


22: #region Usings


23: using System;


24: using System.Collections.Generic;


25: using System.Linq;


26: using System.Text;


27: using Utilities.IoC.Mappings.BaseClasses;


28: using Utilities.IoC.Providers;


29: #endregion


30:


31: namespace Utilities.IoC.Mappings.Internal_Classes


32: {


33: /// andlt;summaryandgt;


34: /// Mapping class


35: /// andlt;/summaryandgt;


36: public class Mapping : MappingKey


37: {


38: #region Constructors


39:


40: /// andlt;summaryandgt;


41: /// Constructor


42: /// andlt;/summaryandgt;


43: /// andlt;param name=andquot;ServiceTypeandquot;andgt;Service typeandlt;/paramandgt;


44: public Mapping(Type ServiceType, ProviderManager ProviderManager, MappingManager MappingManager)


45: : base(ServiceType, null, ProviderManager, MappingManager)


46: {


47: }


48:


49: /// andlt;summaryandgt;


50: /// Constructor


51: /// andlt;/summaryandgt;


52: /// andlt;param name=andquot;ServiceTypeandquot;andgt;Service typeandlt;/paramandgt;


53: /// andlt;param name=andquot;AttributeTypeandquot;andgt;Attribute typeandlt;/paramandgt;


54: public Mapping(Type ServiceType, Type AttributeType, ProviderManager ProviderManager, MappingManager MappingManager)


55: : base(ServiceType, AttributeType, ProviderManager, MappingManager)


56: {


57: }


58:


59: #endregion


60: }


61: }





1: /*


2: Copyright (c) 2011 andlt;a href=andquot;http://www.gutgames.comandquot;andgt;James Craigandlt;/aandgt;


3:


4: Permission is hereby granted, free of charge, to any person obtaining a copy


5: of this software and associated documentation files (the andquot;Softwareandquot;), to deal


6: in the Software without restriction, including without limitation the rights


7: to use, copy, modify, merge, publish, distribute, sublicense, and/or sell


8: copies of the Software, and to permit persons to whom the Software is


9: furnished to do so, subject to the following conditions:


10:


11: The above copyright notice and this permission notice shall be included in


12: all copies or substantial portions of the Software.


13:


14: THE SOFTWARE IS PROVIDED andquot;AS ISandquot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR


15: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,


16: FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE


17: AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER


18: LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,


19: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN


20: THE SOFTWARE.*/


21:


22: #region Usings


23: using System;


24: using System.Collections.Generic;


25: using System.Linq;


26: using System.Text;


27: using Utilities.IoC.Mappings.Interfaces;


28: using Utilities.IoC.Providers;


29: #endregion


30:


31: namespace Utilities.IoC.Mappings.BaseClasses


32: {


33: /// andlt;summaryandgt;


34: /// Mapping key


35: /// andlt;/summaryandgt;


36: public class MappingKey : BaseMapping


37: {


38: #region Constructor


39:


40: public MappingKey(Type ServiceType, Type AttributeType, ProviderManager ProviderManager, MappingManager MappingManager)


41: : base(ServiceType, AttributeType, ProviderManager, MappingManager)


42: {


43: }


44:


45: #endregion


46:


47: #region Functions


48:


49: public override bool Equals(object obj)


50: {


51: if (!(obj is IMapping))


52: return false;


53: IMapping ObjectMapping = (IMapping)obj;


54: return ObjectMapping.AttributeType == AttributeType


55: andamp;andamp; ObjectMapping.ServiceType == ServiceType;


56: }


57:


58: public override int GetHashCode()


59: {


60: int AttributeHash = AttributeType == null ? 1 : AttributeType.GetHashCode();


61: int ServiceHash = ServiceType == null ? 1 : ServiceType.GetHashCode();


62: return ServiceHash * AttributeHash;


63: }


64:


65: #endregion


66: }


67: }





1: /*


2: Copyright (c) 2011 andlt;a href=andquot;http://www.gutgames.comandquot;andgt;James Craigandlt;/aandgt;


3:


4: Permission is hereby granted, free of charge, to any person obtaining a copy


5: of this software and associated documentation files (the andquot;Softwareandquot;), to deal


6: in the Software without restriction, including without limitation the rights


7: to use, copy, modify, merge, publish, distribute, sublicense, and/or sell


8: copies of the Software, and to permit persons to whom the Software is


9: furnished to do so, subject to the following conditions:


10:


11: The above copyright notice and this permission notice shall be included in


12: all copies or substantial portions of the Software.


13:


14: THE SOFTWARE IS PROVIDED andquot;AS ISandquot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR


15: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,


16: FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE


17: AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER


18: LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,


19: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN


20: THE SOFTWARE.*/


21:


22: #region Usings


23: using System;


24: using System.Collections.Generic;


25: using System.Linq;


26: using System.Text;


27: using Utilities.IoC.Mappings.Interfaces;


28: using Utilities.IoC.Providers;


29: using Utilities.IoC.Providers.Scope;


30: using Utilities.IoC.Providers.Interfaces;


31: #endregion


32:


33: namespace Utilities.IoC.Mappings.BaseClasses


34: {


35: /// andlt;summaryandgt;


36: /// Base mapping


37: /// andlt;/summaryandgt;


38: public class BaseMapping : IMapping


39: {


40: #region Constructor


41:


42: /// andlt;summaryandgt;


43: /// Constructor


44: /// andlt;/summaryandgt;


45: /// andlt;param name=andquot;ServiceTypeandquot;andgt;Service typeandlt;/paramandgt;


46: /// andlt;param name=andquot;AttributeTypeandquot;andgt;Attribute typeandlt;/paramandgt;


47: public BaseMapping(Type ServiceType, Type AttributeType, ProviderManager ProviderManager, MappingManager MappingManager)


48: {


49: this.ServiceType = ServiceType;


50: this.AttributeType = AttributeType;


51: this.ProviderManager = ProviderManager;


52: this.MappingManager = MappingManager;


53: this.Scope = new StandardScope();


54: }


55:


56: #endregion


57:


58: #region Functions


59:


60: public virtual IMapping Toandlt;ImplementationTypeandgt;()


61: {


62: return To(typeof(ImplementationType));


63: }


64:


65: public virtual IMapping To(Type ImplementationType)


66: {


67: Implementation = ProviderManager.GetProvider(Scope).CreateImplementation(ImplementationType, MappingManager);


68: return this;


69: }


70:


71: public virtual IMapping Toandlt;ImplementationTypeandgt;(Funcandlt;ImplementationTypeandgt; Implementation)


72: {


73: this.Implementation = ProviderManager.GetProvider(Scope).CreateImplementation(Implementation);


74: return this;


75: }


76:


77: public virtual IMapping To(Providers.Interfaces.IImplementation Implementation)


78: {


79: this.Implementation = Implementation;


80: return this;


81: }


82:


83: public virtual IMapping SetScope(BaseScope Scope)


84: {


85: this.Scope = Scope;


86: Implementation = ProviderManager.GetProvider(Scope).CreateImplementation(Implementation, MappingManager);


87: return this;


88: }


89:


90: #endregion


91:


92: #region Properties


93:


94: public virtual Type ServiceType { get; protected set; }


95: public virtual Type AttributeType { get; protected set; }


96: public virtual BaseScope Scope { get; protected set; }


97: public virtual IImplementation Implementation { get; protected set; }


98: protected virtual ProviderManager ProviderManager { get; set; }


99: protected virtual MappingManager MappingManager { get; set; }


100:


101: #endregion


102: }


103: }



The Mapping class is rather empty, the MappingKey actually defines the functions needed to determine which mapping is which. And the BaseMapping class holds the functions that set the scope, set the implementation, etc. And with that we’re done.

We create our modules, which sets our mappings, which the system holds for us until we tell the manager to get us a specific object type. Once we do that, it assembles our object for us. It’s not that complicated really and not that much code either (the largest file tops out at 189 lines of code including comments). And with that we have ourselves a simple DI container.

If you want updates, or find bugs, etc. check out the repository for the utility library (this is currently under the Utilities.IoC namespace). I’m terrible about updating my site but I update the code there whenever a bug is found. And hopefully I’ll finish my huge update to that library before too long (and it is going to contain a number of changes and additions). Anyway, take a look at the code and happy coding.]]> http://www.gutgames.com/post/Utility-Library-Progress.aspx James Craig Thu, 08 Sep 2011 21:38:08 GMT

2: /// Encrypts a string


3: /// andlt;/summaryandgt;


4: /// andlt;param name=andquot;PlainTextandquot;andgt;Text to be encryptedandlt;/paramandgt;


5: /// andlt;param name=andquot;Passwordandquot;andgt;Password to encrypt withandlt;/paramandgt;


6: /// andlt;param name=andquot;Saltandquot;andgt;Salt to encrypt withandlt;/paramandgt;


7: /// andlt;param name=andquot;HashAlgorithmandquot;andgt;Can be either SHA1 or MD5andlt;/paramandgt;


8: /// andlt;param name=andquot;PasswordIterationsandquot;andgt;Number of iterations to doandlt;/paramandgt;


9: /// andlt;param name=andquot;InitialVectorandquot;andgt;Needs to be 16 ASCII characters longandlt;/paramandgt;


10: /// andlt;param name=andquot;KeySizeandquot;andgt;Can be 128, 192, or 256andlt;/paramandgt;


11: /// andlt;returnsandgt;An encrypted stringandlt;/returnsandgt;


12: public static string Encrypt(string PlainText, string Password,


13: string Salt = andquot;Kosherandquot;, string HashAlgorithm = andquot;SHA1andquot;,


14: int PasswordIterations = 2, string InitialVector = andquot;OFRna73m*aze01xYandquot;,


15: int KeySize = 256)


16: {


17: if (string.IsNullOrEmpty(PlainText))


18: return andquot;andquot;;


19: if (string.IsNullOrEmpty(Password))


20: throw new ArgumentNullException(andquot;Passwordandquot;);


21: if(string.IsNullOrEmpty(Salt))


22: throw new ArgumentNullException(andquot;Saltandquot;);


23: if(string.IsNullOrEmpty(HashAlgorithm))


24: throw new ArgumentNullException(andquot;HashAlgorithmandquot;);


25: if (string.IsNullOrEmpty(InitialVector))


26: throw new ArgumentNullException(andquot;InitialVectorandquot;);


27: byte[] InitialVectorBytes = Encoding.ASCII.GetBytes(InitialVector);


28: byte[] SaltValueBytes = Encoding.ASCII.GetBytes(Salt);


29: byte[] PlainTextBytes = Encoding.UTF8.GetBytes(PlainText);


30: PasswordDeriveBytes DerivedPassword = new PasswordDeriveBytes(Password, SaltValueBytes, HashAlgorithm, PasswordIterations);


31: byte[] KeyBytes = DerivedPassword.GetBytes(KeySize / 8);


32: RijndaelManaged SymmetricKey = new RijndaelManaged();


33: SymmetricKey.Mode = CipherMode.CBC;


34: byte[] CipherTextBytes = null;


35: using (ICryptoTransform Encryptor = SymmetricKey.CreateEncryptor(KeyBytes, InitialVectorBytes))


36: {


37: using (MemoryStream MemStream = new MemoryStream())


38: {


39: using (CryptoStream CryptoStream = new CryptoStream(MemStream, Encryptor, CryptoStreamMode.Write))


40: {


41: CryptoStream.Write(PlainTextBytes, 0, PlainTextBytes.Length);


42: CryptoStream.FlushFinalBlock();


43: CipherTextBytes = MemStream.ToArray();


44: MemStream.Close();


45: CryptoStream.Close();


46: }


47: }


48: }


49: SymmetricKey.Clear();


50: return Convert.ToBase64String(CipherTextBytes);


51: }



In fact you had to use different static functions to use other encryption standards (DES, TripleDES, etc). And each of those functions took in different parameters:

DES:



1: public static string Encrypt(string Input, string Key)



vs AES:



1: public static string Encrypt(string PlainText, string Password,


2: string Salt = andquot;Kosherandquot;, string HashAlgorithm = andquot;SHA1andquot;,


3: int PasswordIterations = 2, string InitialVector = andquot;OFRna73m*aze01xYandquot;,


4: int KeySize = 256)



With the newer code though things are different. Instead you can encrypt a string doing this:



1: string Data = andquot;This is a test of the system.andquot;;


2: Data=Data.Encrypt(andquot;Babysfirstkeyandquot;);



Using this function:



1: /// andlt;summaryandgt;


2: /// Encrypts a string


3: /// andlt;/summaryandgt;


4: /// andlt;param name=andquot;Dataandquot;andgt;Text to be encryptedandlt;/paramandgt;


5: /// andlt;param name=andquot;Keyandquot;andgt;Password to encrypt withandlt;/paramandgt;


6: /// andlt;param name=andquot;AlgorithmUsingandquot;andgt;Algorithm to use for encryption (defaults to AES)andlt;/paramandgt;


7: /// andlt;param name=andquot;Saltandquot;andgt;Salt to encrypt withandlt;/paramandgt;


8: /// andlt;param name=andquot;HashAlgorithmandquot;andgt;Can be either SHA1 or MD5andlt;/paramandgt;


9: /// andlt;param name=andquot;PasswordIterationsandquot;andgt;Number of iterations to doandlt;/paramandgt;


10: /// andlt;param name=andquot;InitialVectorandquot;andgt;Needs to be 16 ASCII characters longandlt;/paramandgt;


11: /// andlt;param name=andquot;KeySizeandquot;andgt;Can be 64 (DES only), 128 (AES), 192 (AES and Triple DES), or 256 (AES)andlt;/paramandgt;


12: /// andlt;param name=andquot;EncodingUsingandquot;andgt;Encoding that the original string is using (defaults to UTF8)andlt;/paramandgt;


13: /// andlt;returnsandgt;An encrypted string (Base 64 string)andlt;/returnsandgt;


14: public static string Encrypt(this string Data, string Key,


15: Encoding EncodingUsing = null,


16: SymmetricAlgorithm AlgorithmUsing = null, string Salt = andquot;Kosherandquot;,


17: string HashAlgorithm = andquot;SHA1andquot;, int PasswordIterations = 2,


18: string InitialVector = andquot;OFRna73m*aze01xYandquot;, int KeySize = 256)


19: {


20: if (string.IsNullOrEmpty(Data))


21: return andquot;andquot;;


22: return Data.ToByteArray(EncodingUsing).Encrypt(Key, AlgorithmUsing, Salt, HashAlgorithm, PasswordIterations, InitialVector, KeySize).ToBase64String();


23: }


24:


25: /// andlt;summaryandgt;


26: /// Encrypts a byte array


27: /// andlt;/summaryandgt;


28: /// andlt;param name=andquot;Dataandquot;andgt;Data to be encryptedandlt;/paramandgt;


29: /// andlt;param name=andquot;Keyandquot;andgt;Password to encrypt withandlt;/paramandgt;


30: /// andlt;param name=andquot;AlgorithmUsingandquot;andgt;Algorithm to use for encryption (defaults to AES)andlt;/paramandgt;


31: /// andlt;param name=andquot;Saltandquot;andgt;Salt to encrypt withandlt;/paramandgt;


32: /// andlt;param name=andquot;HashAlgorithmandquot;andgt;Can be either SHA1 or MD5andlt;/paramandgt;


33: /// andlt;param name=andquot;PasswordIterationsandquot;andgt;Number of iterations to doandlt;/paramandgt;


34: /// andlt;param name=andquot;InitialVectorandquot;andgt;Needs to be 16 ASCII characters longandlt;/paramandgt;


35: /// andlt;param name=andquot;KeySizeandquot;andgt;Can be 64 (DES only), 128 (AES), 192 (AES and Triple DES), or 256 (AES)andlt;/paramandgt;


36: /// andlt;returnsandgt;An encrypted byte arrayandlt;/returnsandgt;


37: public static byte[] Encrypt(this byte[] Data, string Key,


38: SymmetricAlgorithm AlgorithmUsing = null, string Salt = andquot;Kosherandquot;,


39: string HashAlgorithm = andquot;SHA1andquot;, int PasswordIterations = 2,


40: string InitialVector = andquot;OFRna73m*aze01xYandquot;, int KeySize = 256)


41: {


42: if (Data == null)


43: return null;


44: if (AlgorithmUsing == null)


45: AlgorithmUsing = new RijndaelManaged();


46: if (string.IsNullOrEmpty(Key))


47: throw new ArgumentNullException(andquot;Keyandquot;);


48: if (string.IsNullOrEmpty(Salt))


49: throw new ArgumentNullException(andquot;Saltandquot;);


50: if (string.IsNullOrEmpty(HashAlgorithm))


51: throw new ArgumentNullException(andquot;HashAlgorithmandquot;);


52: if (string.IsNullOrEmpty(InitialVector))


53: throw new ArgumentNullException(andquot;InitialVectorandquot;);


54: using (PasswordDeriveBytes DerivedPassword = new PasswordDeriveBytes(Key, Salt.ToByteArray(), HashAlgorithm, PasswordIterations))


55: {


56: using (SymmetricAlgorithm SymmetricKey = AlgorithmUsing)


57: {


58: SymmetricKey.Mode = CipherMode.CBC;


59: byte[] CipherTextBytes = null;


60: using (ICryptoTransform Encryptor = SymmetricKey.CreateEncryptor(DerivedPassword.GetBytes(KeySize / 8), InitialVector.ToByteArray()))


61: {


62: using (MemoryStream MemStream = new MemoryStream())


63: {


64: using (CryptoStream CryptoStream = new CryptoStream(MemStream, Encryptor, CryptoStreamMode.Write))


65: {


66: CryptoStream.Write(Data, 0, Data.Length);


67: CryptoStream.FlushFinalBlock();


68: CipherTextBytes = MemStream.ToArray();


69: MemStream.Close();


70: CryptoStream.Close();


71: }


72: }


73: }


74: SymmetricKey.Clear();


75: return CipherTextBytes;


76: }


77: }


78: }



Well, in reality 2 functions, plus there are a number of calls to other extension methods that I’ve added called through out. Anyway, with the newer code most of the static functions have been moved to being extension methods (where it makes sense anyway). On top of that many of the functions now work on multiple data types (the encryption functions now work on strings and byte arrays for example). I've also tried to give decent default values for everything (when I can) and tried to make things a bit more generic. For instance the one encryption method above does AES, DES, and TripleDES (along with RC2 and any other class that inherits from SymmetricAlgorithm). All you do is pass in the algorithm class you want to use and it handles the rest (and if you don't pass in anything it defaults to AES). This should make using the code much simpler and more succinct than it was in the past.

The same thing is going on for a number of classes (FileManager is now a series of extensions for the FileInfo and DirectoryInfo classes, Serialization class is now extension methods added onto byte arrays, XmlDocuments, etc). And in each of these instances I'm trying to reduce the amount of code that you will need to write. At least for me it's easier to write:



1: TestClass TestItem=new TestClass();


2: TestItem.ToXML(@andquot;.\Testing\Test.xmlandquot;);



than



1: TestClass TestObject=new TestClass();


2: Utilities.IO.Serialization.ObjectToXML(TestObject,@andquot;.\Testing\Test.xmlandquot;);



Plus it gives it a nicer fluent interface feel which is easier to follow as I try to make sure that everything returns some value that you can act on. Anyway, if you're at all interested in influencing the direction that I go with this then drop into the CodePlex site and let me know your opinion in the discussions section and next time I'll be starting a series on building a Dependency Injection library.]]> Utility Library Progress

2: /// Encrypts a string


3: /// andlt;/summaryandgt;


4: /// andlt;param name=andquot;PlainTextandquot;andgt;Text to be encryptedandlt;/paramandgt;


5: /// andlt;param name=andquot;Passwordandquot;andgt;Password to encrypt withandlt;/paramandgt;


6: /// andlt;param name=andquot;Saltandquot;andgt;Salt to encrypt withandlt;/paramandgt;


7: /// andlt;param name=andquot;HashAlgorithmandquot;andgt;Can be either SHA1 or MD5andlt;/paramandgt;


8: /// andlt;param name=andquot;PasswordIterationsandquot;andgt;Number of iterations to doandlt;/paramandgt;


9: /// andlt;param name=andquot;InitialVectorandquot;andgt;Needs to be 16 ASCII characters longandlt;/paramandgt;


10: /// andlt;param name=andquot;KeySizeandquot;andgt;Can be 128, 192, or 256andlt;/paramandgt;


11: /// andlt;returnsandgt;An encrypted stringandlt;/returnsandgt;


12: public static string Encrypt(string PlainText, string Password,


13: string Salt = andquot;Kosherandquot;, string HashAlgorithm = andquot;SHA1andquot;,


14: int PasswordIterations = 2, string InitialVector = andquot;OFRna73m*aze01xYandquot;,


15: int KeySize = 256)


16: {


17: if (string.IsNullOrEmpty(PlainText))


18: return andquot;andquot;;


19: if (string.IsNullOrEmpty(Password))


20: throw new ArgumentNullException(andquot;Passwordandquot;);


21: if(string.IsNullOrEmpty(Salt))


22: throw new ArgumentNullException(andquot;Saltandquot;);


23: if(string.IsNullOrEmpty(HashAlgorithm))


24: throw new ArgumentNullException(andquot;HashAlgorithmandquot;);


25: if (string.IsNullOrEmpty(InitialVector))


26: throw new ArgumentNullException(andquot;InitialVectorandquot;);


27: byte[] InitialVectorBytes = Encoding.ASCII.GetBytes(InitialVector);


28: byte[] SaltValueBytes = Encoding.ASCII.GetBytes(Salt);


29: byte[] PlainTextBytes = Encoding.UTF8.GetBytes(PlainText);


30: PasswordDeriveBytes DerivedPassword = new PasswordDeriveBytes(Password, SaltValueBytes, HashAlgorithm, PasswordIterations);


31: byte[] KeyBytes = DerivedPassword.GetBytes(KeySize / 8);


32: RijndaelManaged SymmetricKey = new RijndaelManaged();


33: SymmetricKey.Mode = CipherMode.CBC;


34: byte[] CipherTextBytes = null;


35: using (ICryptoTransform Encryptor = SymmetricKey.CreateEncryptor(KeyBytes, InitialVectorBytes))


36: {


37: using (MemoryStream MemStream = new MemoryStream())


38: {


39: using (CryptoStream CryptoStream = new CryptoStream(MemStream, Encryptor, CryptoStreamMode.Write))


40: {


41: CryptoStream.Write(PlainTextBytes, 0, PlainTextBytes.Length);


42: CryptoStream.FlushFinalBlock();


43: CipherTextBytes = MemStream.ToArray();


44: MemStream.Close();


45: CryptoStream.Close();


46: }


47: }


48: }


49: SymmetricKey.Clear();


50: return Convert.ToBase64String(CipherTextBytes);


51: }



In fact you had to use different static functions to use other encryption standards (DES, TripleDES, etc). And each of those functions took in different parameters:

DES:



1: public static string Encrypt(string Input, string Key)



vs AES:



1: public static string Encrypt(string PlainText, string Password,


2: string Salt = andquot;Kosherandquot;, string HashAlgorithm = andquot;SHA1andquot;,


3: int PasswordIterations = 2, string InitialVector = andquot;OFRna73m*aze01xYandquot;,


4: int KeySize = 256)



With the newer code though things are different. Instead you can encrypt a string doing this:



1: string Data = andquot;This is a test of the system.andquot;;


2: Data=Data.Encrypt(andquot;Babysfirstkeyandquot;);



Using this function:



1: /// andlt;summaryandgt;


2: /// Encrypts a string


3: /// andlt;/summaryandgt;


4: /// andlt;param name=andquot;Dataandquot;andgt;Text to be encryptedandlt;/paramandgt;


5: /// andlt;param name=andquot;Keyandquot;andgt;Password to encrypt withandlt;/paramandgt;


6: /// andlt;param name=andquot;AlgorithmUsingandquot;andgt;Algorithm to use for encryption (defaults to AES)andlt;/paramandgt;


7: /// andlt;param name=andquot;Saltandquot;andgt;Salt to encrypt withandlt;/paramandgt;


8: /// andlt;param name=andquot;HashAlgorithmandquot;andgt;Can be either SHA1 or MD5andlt;/paramandgt;


9: /// andlt;param name=andquot;PasswordIterationsandquot;andgt;Number of iterations to doandlt;/paramandgt;


10: /// andlt;param name=andquot;InitialVectorandquot;andgt;Needs to be 16 ASCII characters longandlt;/paramandgt;


11: /// andlt;param name=andquot;KeySizeandquot;andgt;Can be 64 (DES only), 128 (AES), 192 (AES and Triple DES), or 256 (AES)andlt;/paramandgt;


12: /// andlt;param name=andquot;EncodingUsingandquot;andgt;Encoding that the original string is using (defaults to UTF8)andlt;/paramandgt;


13: /// andlt;returnsandgt;An encrypted string (Base 64 string)andlt;/returnsandgt;


14: public static string Encrypt(this string Data, string Key,


15: Encoding EncodingUsing = null,


16: SymmetricAlgorithm AlgorithmUsing = null, string Salt = andquot;Kosherandquot;,


17: string HashAlgorithm = andquot;SHA1andquot;, int PasswordIterations = 2,


18: string InitialVector = andquot;OFRna73m*aze01xYandquot;, int KeySize = 256)


19: {


20: if (string.IsNullOrEmpty(Data))


21: return andquot;andquot;;


22: return Data.ToByteArray(EncodingUsing).Encrypt(Key, AlgorithmUsing, Salt, HashAlgorithm, PasswordIterations, InitialVector, KeySize).ToBase64String();


23: }


24:


25: /// andlt;summaryandgt;


26: /// Encrypts a byte array


27: /// andlt;/summaryandgt;


28: /// andlt;param name=andquot;Dataandquot;andgt;Data to be encryptedandlt;/paramandgt;


29: /// andlt;param name=andquot;Keyandquot;andgt;Password to encrypt withandlt;/paramandgt;


30: /// andlt;param name=andquot;AlgorithmUsingandquot;andgt;Algorithm to use for encryption (defaults to AES)andlt;/paramandgt;


31: /// andlt;param name=andquot;Saltandquot;andgt;Salt to encrypt withandlt;/paramandgt;


32: /// andlt;param name=andquot;HashAlgorithmandquot;andgt;Can be either SHA1 or MD5andlt;/paramandgt;


33: /// andlt;param name=andquot;PasswordIterationsandquot;andgt;Number of iterations to doandlt;/paramandgt;


34: /// andlt;param name=andquot;InitialVectorandquot;andgt;Needs to be 16 ASCII characters longandlt;/paramandgt;


35: /// andlt;param name=andquot;KeySizeandquot;andgt;Can be 64 (DES only), 128 (AES), 192 (AES and Triple DES), or 256 (AES)andlt;/paramandgt;


36: /// andlt;returnsandgt;An encrypted byte arrayandlt;/returnsandgt;


37: public static byte[] Encrypt(this byte[] Data, string Key,


38: SymmetricAlgorithm AlgorithmUsing = null, string Salt = andquot;Kosherandquot;,


39: string HashAlgorithm = andquot;SHA1andquot;, int PasswordIterations = 2,


40: string InitialVector = andquot;OFRna73m*aze01xYandquot;, int KeySize = 256)


41: {


42: if (Data == null)


43: return null;


44: if (AlgorithmUsing == null)


45: AlgorithmUsing = new RijndaelManaged();


46: if (string.IsNullOrEmpty(Key))


47: throw new ArgumentNullException(andquot;Keyandquot;);


48: if (string.IsNullOrEmpty(Salt))


49: throw new ArgumentNullException(andquot;Saltandquot;);


50: if (string.IsNullOrEmpty(HashAlgorithm))


51: throw new ArgumentNullException(andquot;HashAlgorithmandquot;);


52: if (string.IsNullOrEmpty(InitialVector))


53: throw new ArgumentNullException(andquot;InitialVectorandquot;);


54: using (PasswordDeriveBytes DerivedPassword = new PasswordDeriveBytes(Key, Salt.ToByteArray(), HashAlgorithm, PasswordIterations))


55: {


56: using (SymmetricAlgorithm SymmetricKey = AlgorithmUsing)


57: {


58: SymmetricKey.Mode = CipherMode.CBC;


59: byte[] CipherTextBytes = null;


60: using (ICryptoTransform Encryptor = SymmetricKey.CreateEncryptor(DerivedPassword.GetBytes(KeySize / 8), InitialVector.ToByteArray()))


61: {


62: using (MemoryStream MemStream = new MemoryStream())


63: {


64: using (CryptoStream CryptoStream = new CryptoStream(MemStream, Encryptor, CryptoStreamMode.Write))


65: {


66: CryptoStream.Write(Data, 0, Data.Length);


67: CryptoStream.FlushFinalBlock();


68: CipherTextBytes = MemStream.ToArray();


69: MemStream.Close();


70: CryptoStream.Close();


71: }


72: }


73: }


74: SymmetricKey.Clear();


75: return CipherTextBytes;


76: }


77: }


78: }



Well, in reality 2 functions, plus there are a number of calls to other extension methods that I’ve added called through out. Anyway, with the newer code most of the static functions have been moved to being extension methods (where it makes sense anyway). On top of that many of the functions now work on multiple data types (the encryption functions now work on strings and byte arrays for example). I've also tried to give decent default values for everything (when I can) and tried to make things a bit more generic. For instance the one encryption method above does AES, DES, and TripleDES (along with RC2 and any other class that inherits from SymmetricAlgorithm). All you do is pass in the algorithm class you want to use and it handles the rest (and if you don't pass in anything it defaults to AES). This should make using the code much simpler and more succinct than it was in the past.

The same thing is going on for a number of classes (FileManager is now a series of extensions for the FileInfo and DirectoryInfo classes, Serialization class is now extension methods added onto byte arrays, XmlDocuments, etc). And in each of these instances I'm trying to reduce the amount of code that you will need to write. At least for me it's easier to write:



1: TestClass TestItem=new TestClass();


2: TestItem.ToXML(@andquot;.\Testing\Test.xmlandquot;);



than



1: TestClass TestObject=new TestClass();


2: Utilities.IO.Serialization.ObjectToXML(TestObject,@andquot;.\Testing\Test.xmlandquot;);



Plus it gives it a nicer fluent interface feel which is easier to follow as I try to make sure that everything returns some value that you can act on. Anyway, if you're at all interested in influencing the direction that I go with this then drop into the CodePlex site and let me know your opinion in the discussions section and next time I'll be starting a series on building a Dependency Injection library.]]> http://www.gutgames.com/post/Why-You-Should-Sign-Your-DLLs.aspx James Craig Sun, 07 Aug 2011 21:26:19 GMT

2: using System.Collections.Generic;


3: using System.Linq;


4: using System.Text;


5: using Utilities.DataTypes.Patterns;


6:


7: namespace TestApp


8: {


9: class Program


10: {


11: static void Main(string[] args)


12: {


13: Factoryandlt;string, stringandgt; Factory = new Factoryandlt;string, stringandgt;();


14: Factory.Register(andquot;Aandquot;, andquot;Bandquot;);


15: Console.WriteLine(Factory.Create(andquot;Aandquot;));


16: Console.ReadLine();


17: }


18: }


19: }



It’s simple enough, all it’s doing is using the default System DLLs and one extra DLL called Utilities (and yes, it’s a class from my utility library but let’s assume that it’s not). The Utilities DLL has a class called Factory:



1: using System;


2: using System.Collections.Generic;


3: using System.Linq;


4: using System.Text;


5:


6: namespace Utilities.DataTypes.Patterns


7: {


8: public class Factoryandlt;Key, Tandgt;


9: {


10: #region Constructors


11:


12: /// andlt;summaryandgt;


13: /// Constructor


14: /// andlt;/summaryandgt;


15: public Factory()


16: {


17: Constructors = new Dictionaryandlt;Key, Funcandlt;Tandgt;andgt;();


18: }


19:


20: #endregion


21:


22: #region Protected Variables


23:


24: /// andlt;summaryandgt;


25: /// List of constructors/initializers


26: /// andlt;/summaryandgt;


27: protected virtual Dictionaryandlt;Key, Funcandlt;Tandgt;andgt; Constructors { get; set; }


28:


29: #endregion


30:


31: #region Public Functions


32:


33: /// andlt;summaryandgt;


34: /// Registers an item


35: /// andlt;/summaryandgt;


36: /// andlt;param name=andquot;Keyandquot;andgt;Item to registerandlt;/paramandgt;


37: /// andlt;param name=andquot;Resultandquot;andgt;The object to be returnedandlt;/paramandgt;


38: public virtual void Register(Key Key, T Result)


39: {


40: if (Exists(Key))


41: Constructors[Key] = new Funcandlt;Tandgt;(() =andgt; Result);


42: else


43: Constructors.Add(Key, new Funcandlt;Tandgt;(() =andgt; Result));


44: }


45:


46: /// andlt;summaryandgt;


47: /// Registers an item


48: /// andlt;/summaryandgt;


49: /// andlt;param name=andquot;Keyandquot;andgt;Item to registerandlt;/paramandgt;


50: /// andlt;param name=andquot;Constructorandquot;andgt;The function to call when creating the itemandlt;/paramandgt;


51: public virtual void Register(Key Key, Funcandlt;Tandgt; Constructor)


52: {


53: if (Exists(Key))


54: Constructors[Key] = Constructor;


55: else


56: Constructors.Add(Key, Constructor);


57: }


58:


59: /// andlt;summaryandgt;


60: /// Creates an instance associated with the key


61: /// andlt;/summaryandgt;


62: /// andlt;param name=andquot;Keyandquot;andgt;Registered itemandlt;/paramandgt;


63: /// andlt;returnsandgt;The type returned by the initializerandlt;/returnsandgt;


64: public virtual T Create(Key Key)


65: {


66: if (Exists(Key))


67: return Constructors[Key]();


68: return default(T);


69: }


70:


71: /// andlt;summaryandgt;


72: /// Determines if a key has been registered


73: /// andlt;/summaryandgt;


74: /// andlt;param name=andquot;Keyandquot;andgt;Key to checkandlt;/paramandgt;


75: /// andlt;returnsandgt;True if it exists, false otherwiseandlt;/returnsandgt;


76: public virtual bool Exists(Key Key)


77: {


78: return Constructors.ContainsKey(Key);


79: }


80:


81: #endregion


82: }


83: }





If we compile, we get a line on the screen that just says “B”. Now let’s assume we create another DLL, called Utilities.DLL, with a class called Factory, but instead had it look like this:



1: using System;


2: using System.Collections.Generic;


3: using System.Linq;


4: using System.Text;


5:


6: namespace Utilities.DataTypes.Patterns


7: {


8: public class Factoryandlt;Key, Tandgt;


9: {


10: #region Constructors


11:


12: /// andlt;summaryandgt;


13: /// Constructor


14: /// andlt;/summaryandgt;


15: public Factory()


16: {


17: Constructors = new Dictionaryandlt;Key, Funcandlt;Tandgt;andgt;();


18: }


19:


20: #endregion


21:


22: #region Protected Variables


23:


24: /// andlt;summaryandgt;


25: /// List of constructors/initializers


26: /// andlt;/summaryandgt;


27: protected virtual Dictionaryandlt;Key, Funcandlt;Tandgt;andgt; Constructors { get; set; }


28:


29: #endregion


30:


31: #region Public Functions


32:


33: /// andlt;summaryandgt;


34: /// Registers an item


35: /// andlt;/summaryandgt;


36: /// andlt;param name=andquot;Keyandquot;andgt;Item to registerandlt;/paramandgt;


37: /// andlt;param name=andquot;Resultandquot;andgt;The object to be returnedandlt;/paramandgt;


38: public virtual void Register(Key Key, T Result)


39: {


40: if (Exists(Key))


41: Constructors[Key] = () =andgt; MyFunction();


42: else


43: Constructors.Add(Key, () =andgt; MyFunction());


44: }


45:


46: /// andlt;summaryandgt;


47: /// Registers an item


48: /// andlt;/summaryandgt;


49: /// andlt;param name=andquot;Keyandquot;andgt;Item to registerandlt;/paramandgt;


50: /// andlt;param name=andquot;Constructorandquot;andgt;The function to call when creating the itemandlt;/paramandgt;


51: public virtual void Register(Key Key, Funcandlt;Tandgt; Constructor)


52: {


53: if (Exists(Key))


54: Constructors[Key] = () =andgt; MyFunction();


55: else


56: Constructors.Add(Key, () =andgt; MyFunction());


57: }


58:


59: private T MyFunction()


60: {


61: Console.Write(andquot;I deleted something importantandquot;);


62: return default(T);


63: }


64:


65: /// andlt;summaryandgt;


66: /// Creates an instance associated with the key


67: /// andlt;/summaryandgt;


68: /// andlt;param name=andquot;Keyandquot;andgt;Registered itemandlt;/paramandgt;


69: /// andlt;returnsandgt;The type returned by the initializerandlt;/returnsandgt;


70: public virtual T Create(Key Key)


71: {


72: if (Exists(Key))


73: return Constructors[Key]();


74: return default(T);


75: }


76:


77: /// andlt;summaryandgt;


78: /// Determines if a key has been registered


79: /// andlt;/summaryandgt;


80: /// andlt;param name=andquot;Keyandquot;andgt;Key to checkandlt;/paramandgt;


81: /// andlt;returnsandgt;True if it exists, false otherwiseandlt;/returnsandgt;


82: public virtual bool Exists(Key Key)


83: {


84: return Constructors.ContainsKey(Key);


85: }


86:


87: #endregion


88: }


89: }




Instead of having a line that says simply “B”, we’re going to get “I deleted something important”. If I copy this second Utilities.DLL into the location of the first, TestApp will load it without thinking twice. That should make you worry right about now because what if instead of saying “I deleted something important”, I actually went ahead and deleted something important? Now if you sign a DLL (and the other person doesn’t have access to the key), you will not get this issue. Instead you will get a nice error that is thrown saying “can’t load XXXXX.DLL”. If the public keys don’t match, it’s not loaded. If the third party DLLs had been signed my first week at that job would have been a lot easier. So to make things easier on new hires (and to prevent the possibility of some more nefarious possibilities), please sign your DLLs.]]> Why You Should Sign Your DLLs

2: using System.Collections.Generic;


3: using System.Linq;


4: using System.Text;


5: using Utilities.DataTypes.Patterns;


6:


7: namespace TestApp


8: {


9: class Program


10: {


11: static void Main(string[] args)


12: {


13: Factoryandlt;string, stringandgt; Factory = new Factoryandlt;string, stringandgt;();


14: Factory.Register(andquot;Aandquot;, andquot;Bandquot;);


15: Console.WriteLine(Factory.Create(andquot;Aandquot;));


16: Console.ReadLine();


17: }


18: }


19: }



It’s simple enough, all it’s doing is using the default System DLLs and one extra DLL called Utilities (and yes, it’s a class from my utility library but let’s assume that it’s not). The Utilities DLL has a class called Factory:



1: using System;


2: using System.Collections.Generic;


3: using System.Linq;


4: using System.Text;


5:


6: namespace Utilities.DataTypes.Patterns


7: {


8: public class Factoryandlt;Key, Tandgt;


9: {


10: #region Constructors


11:


12: /// andlt;summaryandgt;


13: /// Constructor


14: /// andlt;/summaryandgt;


15: public Factory()


16: {


17: Constructors = new Dictionaryandlt;Key, Funcandlt;Tandgt;andgt;();


18: }


19:


20: #endregion


21:


22: #region Protected Variables


23:


24: /// andlt;summaryandgt;


25: /// List of constructors/initializers


26: /// andlt;/summaryandgt;


27: protected virtual Dictionaryandlt;Key, Funcandlt;Tandgt;andgt; Constructors { get; set; }


28:


29: #endregion


30:


31: #region Public Functions


32:


33: /// andlt;summaryandgt;


34: /// Registers an item


35: /// andlt;/summaryandgt;


36: /// andlt;param name=andquot;Keyandquot;andgt;Item to registerandlt;/paramandgt;


37: /// andlt;param name=andquot;Resultandquot;andgt;The object to be returnedandlt;/paramandgt;


38: public virtual void Register(Key Key, T Result)


39: {


40: if (Exists(Key))


41: Constructors[Key] = new Funcandlt;Tandgt;(() =andgt; Result);


42: else


43: Constructors.Add(Key, new Funcandlt;Tandgt;(() =andgt; Result));


44: }


45:


46: /// andlt;summaryandgt;


47: /// Registers an item


48: /// andlt;/summaryandgt;


49: /// andlt;param name=andquot;Keyandquot;andgt;Item to registerandlt;/paramandgt;


50: /// andlt;param name=andquot;Constructorandquot;andgt;The function to call when creating the itemandlt;/paramandgt;


51: public virtual void Register(Key Key, Funcandlt;Tandgt; Constructor)


52: {


53: if (Exists(Key))


54: Constructors[Key] = Constructor;


55: else


56: Constructors.Add(Key, Constructor);


57: }


58:


59: /// andlt;summaryandgt;


60: /// Creates an instance associated with the key


61: /// andlt;/summaryandgt;


62: /// andlt;param name=andquot;Keyandquot;andgt;Registered itemandlt;/paramandgt;


63: /// andlt;returnsandgt;The type returned by the initializerandlt;/returnsandgt;


64: public virtual T Create(Key Key)


65: {


66: if (Exists(Key))


67: return Constructors[Key]();


68: return default(T);


69: }


70:


71: /// andlt;summaryandgt;


72: /// Determines if a key has been registered


73: /// andlt;/summaryandgt;


74: /// andlt;param name=andquot;Keyandquot;andgt;Key to checkandlt;/paramandgt;


75: /// andlt;returnsandgt;True if it exists, false otherwiseandlt;/returnsandgt;


76: public virtual bool Exists(Key Key)


77: {


78: return Constructors.ContainsKey(Key);


79: }


80:


81: #endregion


82: }


83: }





If we compile, we get a line on the screen that just says “B”. Now let’s assume we create another DLL, called Utilities.DLL, with a class called Factory, but instead had it look like this:



1: using System;


2: using System.Collections.Generic;


3: using System.Linq;


4: using System.Text;


5:


6: namespace Utilities.DataTypes.Patterns


7: {


8: public class Factoryandlt;Key, Tandgt;


9: {


10: #region Constructors


11:


12: /// andlt;summaryandgt;


13: /// Constructor


14: /// andlt;/summaryandgt;


15: public Factory()


16: {


17: Constructors = new Dictionaryandlt;Key, Funcandlt;Tandgt;andgt;();


18: }


19:


20: #endregion


21:


22: #region Protected Variables


23:


24: /// andlt;summaryandgt;


25: /// List of constructors/initializers


26: /// andlt;/summaryandgt;


27: protected virtual Dictionaryandlt;Key, Funcandlt;Tandgt;andgt; Constructors { get; set; }


28:


29: #endregion


30:


31: #region Public Functions


32:


33: /// andlt;summaryandgt;


34: /// Registers an item


35: /// andlt;/summaryandgt;


36: /// andlt;param name=andquot;Keyandquot;andgt;Item to registerandlt;/paramandgt;


37: /// andlt;param name=andquot;Resultandquot;andgt;The object to be returnedandlt;/paramandgt;


38: public virtual void Register(Key Key, T Result)


39: {


40: if (Exists(Key))


41: Constructors[Key] = () =andgt; MyFunction();


42: else


43: Constructors.Add(Key, () =andgt; MyFunction());


44: }


45:


46: /// andlt;summaryandgt;


47: /// Registers an item


48: /// andlt;/summaryandgt;


49: /// andlt;param name=andquot;Keyandquot;andgt;Item to registerandlt;/paramandgt;


50: /// andlt;param name=andquot;Constructorandquot;andgt;The function to call when creating the itemandlt;/paramandgt;


51: public virtual void Register(Key Key, Funcandlt;Tandgt; Constructor)


52: {


53: if (Exists(Key))


54: Constructors[Key] = () =andgt; MyFunction();


55: else


56: Constructors.Add(Key, () =andgt; MyFunction());


57: }


58:


59: private T MyFunction()


60: {


61: Console.Write(andquot;I deleted something importantandquot;);


62: return default(T);


63: }


64:


65: /// andlt;summaryandgt;


66: /// Creates an instance associated with the key


67: /// andlt;/summaryandgt;


68: /// andlt;param name=andquot;Keyandquot;andgt;Registered itemandlt;/paramandgt;


69: /// andlt;returnsandgt;The type returned by the initializerandlt;/returnsandgt;


70: public virtual T Create(Key Key)


71: {


72: if (Exists(Key))


73: return Constructors[Key]();


74: return default(T);


75: }


76:


77: /// andlt;summaryandgt;


78: /// Determines if a key has been registered


79: /// andlt;/summaryandgt;


80: /// andlt;param name=andquot;Keyandquot;andgt;Key to checkandlt;/paramandgt;


81: /// andlt;returnsandgt;True if it exists, false otherwiseandlt;/returnsandgt;


82: public virtual bool Exists(Key Key)


83: {


84: return Constructors.ContainsKey(Key);


85: }


86:


87: #endregion


88: }


89: }




Instead of having a line that says simply “B”, we’re going to get “I deleted something important”. If I copy this second Utilities.DLL into the location of the first, TestApp will load it without thinking twice. That should make you worry right about now because what if instead of saying “I deleted something important”, I actually went ahead and deleted something important? Now if you sign a DLL (and the other person doesn’t have access to the key), you will not get this issue. Instead you will get a nice error that is thrown saying “can’t load XXXXX.DLL”. If the public keys don’t match, it’s not loaded. If the third party DLLs had been signed my first week at that job would have been a lot easier. So to make things easier on new hires (and to prevent the possibility of some more nefarious possibilities), please sign your DLLs.]]> http://www.gutgames.com/post/Setting-Up-Hg-Git.aspx James Craig Thu, 28 Jul 2011 22:22:23 GMT
From here on you should be able to clone your repository and start pushing code. However I’ve learned that I need to set the master bookmark to whatever I actually want to push for some odd reason. That doesn’t seem like something I should have to do but it is what it is. Anyway, that’s what I went through to get it up and running. For now I’ll be updating the code on those two pages and not the CodePlex page (that will change once they actually update my repository there). So choose whichever you like more and happy coding. Oh and I’ve set it up to link to the Twitter account (sorry for spamming the tests earlier today), so if you want to keep up to date with both my site here and updates as I push them to github/bitbucket you will be able to do that now.
]]> Setting Up Hg-Git
From here on you should be able to clone your repository and start pushing code. However I’ve learned that I need to set the master bookmark to whatever I actually want to push for some odd reason. That doesn’t seem like something I should have to do but it is what it is. Anyway, that’s what I went through to get it up and running. For now I’ll be updating the code on those two pages and not the CodePlex page (that will change once they actually update my repository there). So choose whichever you like more and happy coding. Oh and I’ve set it up to link to the Twitter account (sorry for spamming the tests earlier today), so if you want to keep up to date with both my site here and updates as I push them to github/bitbucket you will be able to do that now.
]]>