I'm a freelance programmer, and one of the major bugbears with working by myself is that I have no-one to bounce ideas off, so my code becomes very personal, if that's the right word, and I sometimes wonder if I'm doing things the right way. For instance, when I interrogate my database using Linq to Entities I use the following code (to return an instance of the purchase class).
internal static Purchase ReturnPurchaseItem(int PiD)
RegulusEntities RG = new RegulusEntities();
Purchase purchase = (from PU in RG.Purchases
where PU.PurchaseID == PiD
I would be very grateful if you could critique my code and maybe suggest more efficient ways of returning an instance of a class, or using the entity framework for that matter.
(If I've got this in the wrong forum, please forgive me, and transfer me to the right one!).
There simply isn't enough code here to make any real judgment of what you're doing. I can see some smallish things but nothing about any patterns you're using.
1) Your method is called "Return..." something. Personally, I always name methods that return something "Get...". Return is a bit more vague as to what it does. Does "Return" refer to retrieving a database object, or does it refer to some business rule method. It's the concept of "self documenting code". Method names should describe exactly what they do.
2) Entities (or DbContext) classes should be Disposed when you're done with them. It should be something like this:
internalstatic Purchase GetPurchaseItem(int purchaseId)
Purchase purchase = null;
using (var context = new RegulusEntities())
3) If you have a primary key Id for an object, you don't need an entire Linq query to find it. You just need to call the Find method to retrieve it. Find() will return the object with the specified key. If it's not found, it'll throw a InvalidOperationException. You can replace it with FirstOrDefault() if you want the "Get..." method to return a null of the specified type instead of throwing.
Other than that, a couple of rules I follow:
I don't have my database code return any ViewModel objects, not does it accept any. My database layer will accept and return Entity objects only. If these objects need to be translated into ViewModel objects, I can have another layer above this that does the translation, such as in an MVC Controller class or what I call a "Services" class.
I never expose my database layer directly to UI code.
Thanks for the reasoned and well thought out answer Dave. In showing you only a tiny patch of my code, I actually missed out the whole structure that this little method sits in.
This method, as with all my other calls to EF sits in a service class written to handle all the calls to a particular table. for example, all the calls to the purchase table are made from the clsPurchaseHandler class, thus separating it from the UI.
Your answer is exactly what I wanted. as I explained I am a freelance programmer running my own little operation, and I haven't got the luxury of being able to discuss code with anyone, and there's always the niggle at the back of my mind that 'I know it works, but is it the most efficient'. Your code detailing the disposal of entities after use and the find method is invaluable.
As for my naming of the method "ReturnPurchaseItem", that's my usual practise, as that's what the method does, I take your point that it may sound vague, but I've got a lot of code out in the wild that uses this notation, so for now, I'll stick with it.
Sorry to be a pest Dave, but the 'find' method you suggest isn't available to my version of EF. I've read up on it and it appears to come in after EF 4.0. I appear to be running EF 6.0, but I still can't see it. What am I doing wrong?
I've done all of that Dave, and I still get the red squiggly. It's got to be something to do with the version of the System.data.entity dll that I'm importing. EF reports that it's using version 6, but the DLL reports version 4. I'll keep trying, but until then, I'll use the version that works, but I can't help feeling that i's going to get up and bite me one day.
If you've got a mismatch like that, something went terribly wrong.
Go to the Package Manager Console and do a Uninstall-Package EntityFramework. Then go through the References in the project and remove the EntityFramework reference if it's still there.
Once that's done, you can go back to the Package Manager Console and do a
Install-Package EntityFramework".<br />
That should take care of any mismatches.<br />
<div class="signature"><small><a href="http://www.codeproject.com/scrapbook/ForumGuidelines.asp">A guide to posting questions on CodeProject</a>[<a href="http://www.codeproject.com/scrapbook/ForumGuidelines.asp" target="_blank" title="New Window">^</a>]</small><br><br />
<font color="Blue">Dave Kreskowiak</font><br />
I've been battling since Tuesday to fix this Dave. (sorry for taking so much of your time), I've done what you detailed above, but still the 'find' method isn't recognised. Funny thing though, the text I get when I try to use the method is:
"Error 1 'System.Data.Objects.ObjectSet<entityresearch.purchase>' does not contain a definition for 'find' EntityResearch...."
I thought the find method would be in System.Data.Entity?
I've gone so far as repairing my .NET 4.5 but that didn't work either.
Repairing anything isn't going to do anything for you. Nothing is broken except your code.
There are multiple Find methods. The one that works on DbSets is in System.Data.Entity. If it's saying the you're using the System.Data.Objects namespace version, you're not using Entity Framework. Your entity sets have been defined using ObjectSet instead of DbSet.
I've found what I've been doing wrong Dave. When I've been adding the Entity Data model when I started the project, I've been deleting the two .tt template files and setting the code generation strategy in the edmx properties to 'default'. This hasn't been generating the (correct) code to use dBSet. I've still got a lot to learn yet about this, as it's opened a few more cans of worms for me, (For example, what happened to my 'AddObject' methods?)
This highlights my original point. I'm a freelance developer, and have been for about 10 years now. I work by myself, and I have no-one to bounce ideas off, or show me my mistakes. I learnt EF by buying Julia Lerman's book and studying enough of it to get my current project up and running, but not going any further. When I worked for a software house in England, I used to dread code review day, but I can see now how useful it was.
I know I'm still missing a lot, and I would be grateful if you could point me to a good tutorial about the correct way to deal with Entity Framework, and .tt files and all.
Thanks for all your patience Dave, it's been much appreciated.
I'm sorry, but this is probably not the answer you would wish for, but to be honest, the best practice of MS Entity Framework is to not use it at all...
First of all, you should REALLY consider the actual need for using such technology on a project by project basis, don't just use it because it's an easy way to stay away from writing SELECT statements and Plain SQL.
EF solutions adds A LOT of complexity to a project behind the scenes. It doesn't just map one table to a class and gets done with it, but it seriously does some crazy s*** behind the curtains that you don't want to see. (probably why you don't see it in the first place).
Why do I say this? Consider the following:
For each first-time call to a EF mapped database the machinery has to go through (among other things) these steps:
1. Mapping of the views:
Mapping Views are executable representations of the transformations specified in the mapping for each entity set and association. Internally, these mapping views take the shape of "canonical query trees".
There are two types of mapping views:
These represent the transformation necessary to go from the database schema to the conceptual schema.
These represent the transformation necessary to go from the conceptual model to the database schema.
The process of computing these views based on the specification of the mapping is what's called "view generation".
View generation can either take place dynamically when a model is loaded, or at build time, by using "pre-generated views".
The latter are serialized in the form of Entity SQL statements to a C# file.
2. Validation of the Schema:
When views are generated, they are also validated. From a performance standpoint, the vast majority of the cost of view generation is actually the validation of the views which ensures that the connections between the entities make sense and have the correct cardinality for all the supported operations.
When a query is executed, the query is combined with the corresponding query view, and the result is run through the compiler to create a representation of the query that the backing store can understand.
For MS SQL Server it will be T-SQL SELECT statements.
The first time an update over an entity set is performed, the update view is run through a similar process to transform it into DML statements for the target DB.
If two Entities are connected via an inheritance chain or an Association, they are said to be connected. Similarly if two tables are connected via a foreign key, they are connected, and if this is not the case in your project, drop EF all together as it is overkill.
As the number of connected Entities and tables in your schemas increase, the view generation cost increases.
So, is all hope lost?
Well, you can speed things up by pre-configuring the views needed. This gives a formidable boost in performance in most cases.
If your model is in EDMX format, you should read up on T4 Template creation and use that.
Using pre-generated views moves the cost of view generation from model loading (run time) to compile time. So basically your users will rejoice and you will bang your head in the desk waiting for compiling to get done with it.
Some tips and tricks to consider:
1. EDMX models are validated at compile time, even if the model is unchanged. If your model has already been validated, you can suppress validation at compile time by setting the "Validate on Build" property to false in the properties window.
If your model isn't an edmx but is created using EDMGen, one of the outputs will be a "Views" file. This is a code file containing Entity SQL snippets for each entity set. To enable pre-generated views, you simply include the file in your project.
If you manually make edits to the schema files for the model, you will need to re-generate the views file. You can do this by running EDMGen with the /mode:ViewGeneration flag.
2. If your application is only used for query scenarios, you can mark the model as read-only by adding a GenerateUpdateViews attribute on the EntityContainerMapping element in your XML mapping and setting it to false.
3. Using statically compiled query instances (CompiledQuery)
The Customer Advisory Team discusses this in their "Potential Performance Issues with Compiled LINQ Query Re-Compiles" blog post: http://blogs.msdn.com/b/appfabriccat/archive/2010/08/06/potential-performance-issues-with-compiled-linq-query-re-compiles.aspx.
4. Entity Framework 5 introduces automatic caching for LINQ to Entities. In past editions of Entity Framework creating a CompiledQuery to speed your performance was a common practice, as this would make your LINQ to Entities query cacheable. Since caching is now done automatically without the use of a CompiledQuery, we call this feature “autocompiled queries”. For more information, see:
Last Visit: 31-Dec-99 18:00 Last Update: 30-Sep-22 22:55