NFetchSpec Code – Entity Framework Repository, Fetching Strategies, Specifications, Code Only, Mapping, POCO and Making Roles Explicit.
I have made the code from the NFetchSpec spiking / proof of concept available here. Be aware that it requires .NET Framework 4.0, Entity Framework 4.0 and the Feature CTP versions 2 or 3. I won’t be revising this code until the official release of version 4.0 and it will likely get some reworking. In the meantime if you want to understand the ideas in parts 1, 2, 3, and 4 of Helping the Entity Framework Play it’s <ROLE> the you can feel free to pull the code apart and do with it what you will. Until then.
No commentsEntity Framework 4.0 and Fetching Strategies
I have spent a fair amount of time already trying to improve my experience with the Entity Framework with versions 1.0, 2.0 and 3.0. Well that’s a bit of joke really because there was and never will be versions 2.0 or 3.0 for the Entity Framework with the decision to take the next version straight to Version 4.0 to align with the .Net Framework Version. Nonetheless I have previously spent quite a bit of time working at being more explicit with how to fetch data with the Entity Framework.
Fetching Strategies are a key concept when considering tuning your data access code in Event Driven Architectures. By using ‘roles’ to explicitly fetch data either eagerly, lazily or some combination thereof, we can build fetching strategies to load accordingly when a role has been specified. The role can be reasoned as a business event of sorts. Udi has written extensively on this and developed a method for using fetching strategies with NHibernate and if you haven’t yet checked out what he’s had to say to date on the subject I suggest you take a look.
With Entity Framework 4.0 I wanted to refine my approach taken with EF 1.0 previously. Fetching Strategies are a key component in the framework (which I call NFetchSpec4Ef) and helps me work in a manner that fit’s with my use of Domain Driven Design.
Demonstrate your intentions
Before we get to the strategies themselves we need some way to state our intent with regards to fetching data and so this leads us to Fetching Intentions.
public class EagerFetchingIntention { private static EagerFetchingIntention _factory_intent; private readonly string _fetchAssociate; public string FetchAssociate { get { return _fetchAssociate; } } internal EagerFetchingIntention(string fetch) { _fetchAssociate = fetch; } private EagerFetchingIntention() { } public static EagerFetchingIntention CreateInstance<TRootEntity, TFetchEntity> (Expression<Func<TRootEntity, TFetchEntity>> fetch) { if(fetch == null) return new EagerFetchingIntention(string.empty); int dot = fetch.Body.ToString().IndexOf(“.”) + 1; string includes = fetch.Body.ToString().Remove(0, dot); _factory_intent = new EagerFetchingIntention(includes); return _factory_intent; } }
We can chain intentions together with a fluent interface provided by an .And()extension method.
public static class EagerFetchingIntentionExtensions { public static EagerFetchingIntention And( this EagerFetchingIntention original, EagerFetchingIntention addTo) { EagerFetchingIntention compound_intention; compound_intention = new EagerFetchingIntention( original.FetchAssociate + “.” + addTo.FetchAssociate); return compound_intention; } }
Fetching Strategies Refactored
Like all parts of NFetchSpec4Ef, Fetching Strategies needed to be rethought as part of addressing the 4.0 changes to the Entity Framework and in particular it’s new support for POCO entities and (somewhat) implicit lazy loading. So what do Fetching Strategies look like now? Fetching Intentions remained (as seen above) but generally speaking the API changed somewhat.
public interface IFetchingStrategy { IList<EagerFetchingIntention> Intentions { get; } IEnumerable<string> Includes { get; } void AddIntentions(EagerFetchingIntention[] intentions); bool ShouldLazyLoad { get; } bool HasInstructions { get; } } public interface IFetchingStrategy<TRole> : IFetchingStrategy { }
These two interfaces form the basis of Fetching Strategies in NFetchSpec4Ef. In the next version of NFetchSpec4Ef, the implementation no longer required implementing these interfaces directly when creating a new strategy, rather we inherit from a super class that has already done this for us. You might also notice that the aspects to this interface for non-public consumption have been hidden through explicit implementation.
public class FetchingStrategy : IFetchingStrategy { private readonly IList<EagerFetchingIntention> _intentions; private readonly bool _includeDeferedLoading = default(bool); public FetchingStrategy(bool useDeferedLoading) { _includeDeferedLoading = useDeferedLoading; _intentions = new List<EagerFetchingIntention>(); } private FetchingStrategy() { } public void AddIntentions(EagerFetchingIntention[] intentions) { if ((intentions == null) || (intentions.Count() < 1)) return; intentions.ToList().ForEach(i => _intentions.Add(i)); } public IEnumerable<string> Includes { get { if(((IFetchingStrategy)this).HasInstructions == false) return new List<string>().AsEnumerable(); IEnumerable<String> includes = (from intents in _intentions select intents.FetchAssociate).AsEnumerable(); return includes; } } IList<EagerFetchingIntention> IFetchingStrategy.Intentions { get { return _intentions; } } bool IFetchingStrategy.ShouldLazyLoad { get { return _includeDeferedLoading; } } bool IFetchingStrategy.HasInstructions { get { return _intentions.Count > 0 || _includeDeferedLoading; } } }
Our goal includes notifying our infrastructure of our fetching intent by being explicit through the use of roles which have been defined as Interfaces. The infrastructure is able now to employ IoC / DI to locate the most appropriate Fetching Strategy from a container. This frees us to swap out fetching details for specific business events, after all, in some situations such as “IMakeCustomerPreferred” (see below), I might want to eager fetch all my customers orders and order lines in one go. Here’s the base class implementation of IFetchingStrategy<T> for role based fetching strategies, followed by a custom Fetching Strategy:
public abstract class FetchingStrategyForRoles<TRole> : FetchingStrategy, IFetchingStrategy<TRole> { public FetchingStrategyForRoles(bool useDeferedLoading) : base(useDeferedLoading) { SetupIntentions(); } public abstract void SetupIntentions(); }
class CustomerPreferedFetchingStratey : FetchingStrategyForRoles<IMakeCustomerPrefered> { public CustomerPreferedFetchingStratey() : base(false) { } public override void SetupIntentions() { var orders_intention = EagerFetchingIntention .CreateInstance<Customer, IList<Order>>(c => c.Orders); var orderlines_intention = EagerFetchingIntention .CreateInstance<Order, IList<OrderLine>>(o => o.OrderLines); var iFetch = this as IFetchingStrategy; iFetch.AddIntentions(new EagerFetchingIntention[] { orders_intention, orders_intention.And(orderlines_intention) }); } }
var repo =
new EntitiesRepository<NorthwindEntities, Customer>
(new NorthwindEntities());
repo.Get<IMakeCustomerPreferred>();
We leave the container (IoC) to deal with locating the right fetching strategy based on the role of IMakeCustomerPrefered. The dependency injection happens inside of the Repository.
The next part of NFetchSpec4Ef to discuss will be how Specifications fit in and what they offer to Repositories.
Update March 19th 2010:
If you are interested further in using Fetching Strategies with the Entity Framework, then you might find this series of posts interesting.
Helping the Entity Framework Play it’s <Role> Part 1.0
Helping the Entity Framework Play it’s <Role> Part 2.0
Helping the Entity Framework Play it’s <Role> Part 3.0
Helping the Entity Framework Play it’s <Role> Part 4.0
4 commentsGOF Series: Episode #5 : [The Prototype Pattern] - In IronRuby
Firstly let me mention that whilst this series started out as demonstrating the Gang of Fours patterns in C# I have since decided to change direction a little bit and have the rest of the series presented in IronRuby. Why? My Reasons are twofold, firstly there are probably more than enough examples of the patterns in C# that another one will certainly not be missed and second completing the series in IronRuby will serve as great learning tool on the way to better knowing the language. I have previously posted on the Builder Pattern implemented in IronRuby and for that example I used Sapphire in Steel to develop the code and I am really hoping that we get a great code editor for IronRuby when it makes it’s official debut.
What purpose does this pattern serve?
Implementing the prototype pattern facilitates creating a prototypical object and subsequently being able to produce copies of that prototype.
Example Code:
First lets start with our Vehicle manager which will hold the prototyped vehicles that we wish to take copies of.
class VehicleManager def initialize @cars = {} end def add key, prototype @cars[key] = prototype end def remove key @cars.delete key end def get_vehicle_by_key key @cars[key].deep_copy end end
Next we create a module that we will use as a mixin to extend a ‘vehicles’ behaviour to include cloning.
module Cloneable attr_accessor :id attr_accessor :horse_power def deep_copy Marshal.load(Marshal.dump(self)) end end
class Car include Cloneable def initialize horse_power, id @id = id @horse_power = horse_power end end class MotorCycle include Cloneable def initialize horse_power, id @id = id @horse_power = horse_power end end
All that’s left is to look at how to create some prototype’s using these classes.
$counter = 1 #new up a VehicleManager to store vehicles #that we are interested in cloning vmanager = VehicleManager.new #add a car and motor cycle to the manager vmanager.add :eighty, Car.new(80, $counter) $counter += 1 vmanager.add :ninety , MotorCycle.new(90, $counter) #retrieve clones of the car and motor cycle vehicle_car = vmanager.get_vehicle_by_key :eighty vehicle_bike = vmanager.get_vehicle_by_key :ninety #print the results puts “The horse power for the car is “ + “#{vehicle_car.horse_power} and the ID is :#{vehicle_car.id}” puts “The horse power for the motor cycle is “ + “#{vehicle_bike.horse_power} and the ID is :#{vehicle_bike.id}”








