Tutorial: Code First with Entity Framework
This tutorial introduces the new functionalities that were added to Entity Framework. It shows the differences between the approaches and acts as an introduction to these new features.
Database First & Model First
The Database First approach is interesting when the database already exists. You use Visual Studio and the Entity Framework Designer to generate the C# and VB.NET classes which reflect the existing database model.
You may then change relations and structures using the Designer (or the XML mapping files) to further optimize the model. The priority is the database – the code and the model are only secondary.
The Model First approach is important when you begin from scratch. You start with the entity model and use the Entity Framework Designer to design the relations and the entities.
Then you generate the C# and VB.NET classes and also the database from within Visual Studio. The priority is the model – the code and the database are only secondary.
When your priority is the code and you want to begin from scratch without any existing schemas or XML mapping files using source code, then the approach is called Code First.
You simply create your domain classes and Entity Framework will easily allow to use them with the database and the future model.
You use a context and are able to execute Linq2Entities queries in no time ! You may even take advantage of the change tracking features !
Entity Framework handles all of the background work and manages the interaction with the database. All the classes that are used during runtime are auto-generated.
In this case the configuration is not read from XML files but instead read from the configuration of the DbContext object in memory.
Code First allows:
- Developing without the need to use the Designer or XML mapping files
- Defining the objects of the model based on a POCO (Plain Old CLR Objects) approach
- Design and implement a company domain with Managers, Collaborators and Departments.
- Create your classes using a standard object oriented approach and using inheritance when appropriate.
- Use the POCO approach for your classes where possible.
- Note that for being able to use the auto-mapping feature for the primary keys you need to have named your class properties like this : [Classname]Id.
- Entity Framework allows connecting those POCO classes with the database very easily by using the ObjectContext class (and in particular the DbContext class).
- The last step consists of defining the connection to the database within the web.config or app.config files. Note that EF will search for the connection string that has the same name as the class that was inherited from the DbContext class. You may however define a different name (“CompanyContext” in our example).
Data Annotations & Code First Fluent API
The new version of Entity Framework supports the usage of Data Annotations. Data Annotations are used for validation purposes and also for mapping definitions between code and columns in the database.
All annotations are implemented as attributes which can be found in the System.ComponentModel.DataAnnotations namespace (same attributes that are used for ASP.NET MVC validation purposes).
- [Key] – Column(s) that define the Primary Key in the database table
- [StringLength] – Minimal and maximal string length (only used for validation purposes not as database constraints)
- [MaxLength] – Can be used instead of [StringLength] to just define the maximal string length of a column
- [ConcurrencyCheck] – Flag that indicates that concurrency checks are activated for the column
- [Required] – Flag that indicates that a value is required for the column (column is flagged as not null)
- [Timestamp] – Flag on time stamp columns which is used for concurrency checks
- [Column] – Specify the name of a column (default property name), can also be used to define the column position
- [Table] – Specify the name of a table (default class name)
- [DatabaseGenerated] – Flag that indicates that the value is filled by the database (possible values are Computed, Identity, None)
- [NotMapped] – Is used to define a property in the class that does not get generated in the database.
- [ForeignKey] and [InverseProperty] – Column(s) that are defined as Foreign Keys
Following an example for the usage of Data Annotations that was applied to our company domain. The Manager class does not currently contain any properties that could automatically be identified as primary key.
By adding the [Key] attribute to the ManagerCode property you define that this property should act as primary key. You furthermore add a concurrency check as well as a minimum and maximum length setting for the Name property.
In the following example we add a required constraint to the Department class by applying the [Required] Data Annotation to the Name property.
Data Annotations are definitely easy to use but it is preferable to use a programmatic approach that provides much more flexibility. This approach is based on the Code First Fluent API.
You have to implement the OnModelCreating method within the derived CompanyContext class. Then you define your constraints applicable to your domain within this method programmatically.
When using this approach you may even describe relations between tables and columns. The following code example defines that the Manager entity contains a Department entity. The key that relates both is the DepartmentId. If the Manager entity is deleted then the corresponding Department must also be deleted (CascadeOnDelete).
Data validation is a very important subject when developing applications. You have to assure good quality and high integrity of your data for being able to exploit it correctly. You need to avoid storing any corrupt, incomplete or wrong data in your database which will most certainly lead to misbehavior within your applications.
The following example shows how to implement a constraint on the Name property (required / string length between 5 and 20 characters) via Data Annotations.
Validation is automatically done when calling the Save method to persist any changes applied to your objects in memory. But you may as well do it before by calling the GetValidationErrors method.
Lets say when the code above is executed it will fail due to validation errors. In this case error messages will be displayed for each constraint that was not respected. In our example we defined that the Name property should have a minimum string length of 5 characters, but the property only contains 4 characters. Since we did not define a specific error message, a generic error message will be displayed for this validation error.
There are multiple Data Annotations that allow for type validation, format validation, regular expression matching, etc…
Data Audit with Entity Framework
All properties within objects managed by the Entity Framework can be audited. This is very helpful if you need to display changes to objects before saving them, cancel modifications by resetting the current value with the initial value or handling concurrency problems.
Entity Framework permits accessing the following property versions of an entity:
- Database Value
- Original Value
- Current Value
When executing the code above the different values for the Name property of the Manager class are displayed.
As you see, adding audit functionality to your applications is really quick to do, Entity Framework contains already everything necessary to implement it very easily.
Assuring the consistence and coherence of data in the database is a very important topic. Concurrency problems come up when multiple source (clients, systems, etc…) try to modify data at the same time.Your application must be able to choose whether to accept or reject any data changes that arrive simultaneously.
Simultaneous execution of transactions must provide the same results as sequential execution of those same transactions.If you achieve this goal then your system is well prepared for correct concurrency handling.
Entity Framework includes a very complete concurrency approach. The DbContext class that we already saw before allows for efficient concurrency handling.
This resolution strategy defines that the first modification wins if there are concurrency conflicts. All following modifications on the same data are ignored and clients get exceptions that tell them that their transactions did not complete because the data was already changed.
You have to determine which properties might be subject to concurrency problems. You may have properties which do not need any concurrency handling. A property that contains the last modified date might not need to implement any concurrency handling for example.
All properties that must be checked for concurrency need to have the [ConcurrencyCheck] attribute set as shown below:
If you don’t like using attributes, you may also use the CodeFirst Fluent API on your properties to activate concurrency checking:
You have to add concurrency checks only on properties that really need it since this will have some impact on performance within your code. The more properties with activated concurrency checks you have the worse your performance might be depending on your implementation !
In the example above we retrieve a manager object from the database, store it in memory and change some property values (but only in memory). We then change some values on the same data directly in the database to simulate concurrency as if two clients did modifications at the same time.
When we call the SaveChanges() method you will see that we get an exception of type DbUpdateConcurrencyException. This is where you need to add your custom concurrency conflict resolution logic. In this example we decided to guard the first modification (First Wins). In the last step we update the context in memory with the data that was changed in the database via ex.GetEntry(context).Reload().
This is the default resolution strategy of EF in case of concurrency conflicts. It defines that the last modification wins if there are concurrency conflicts. All previous modifications on the same data are overwritten. Clients only get informed if they use the [ConcurrencyCheck] attribute, some kind of log, some event or other treatment.
The example above shows how to implement a Last Wins approach. If there are exceptions due to concurrency conflicts we store the new initial value in the context thus synchronizing with the source. We then retry saving the data until it is saved to the database and the processing is successfully completed.
I hope this tutorial gave you a first insight on the new features of EF which are quite powerful even for code purists. With the new features presented in this tutorial EF becomes one of the most complete products on the ORM market. Today, it is the only product that proposes all 3 approaches CodeFirst, Database First and Model First at the same time. Some features are missing like auto-synchronization of the database if the class structure changes and stored procedure integration but they will be added in the next weeks / months.
If using .NET Core and Entity Framework Core, and `.Include(x => x.TableName )` is not returning relationships (from principal table to dependent table), or only returning one row of data, FIX HERE:
Also, in Startup.cs make sure you have this at the top:
*For this as well as older .NET you can use the [JsonIgnore] attribute as well.