This article describes how to build ASP.NET applications using n-tier architecture. The benefits of having n-tier architecture is that all the modules having dedicated functionality will be independent of each other. Changing one tier will not effect other tiers and there is no single point of failure even if some tier is not working.
Background
In a typical n-tier application there will be 4 Layers. The bottom most layer is the Data layer which contains the tables and stored procedures, scaler function, table values function. This Data layer is typically the database engine itself. We will be using SqlServeras the data layer in our example.
On top of Data Layer, we have a Data Access Layer (DAL). This layer is responsible for handling Database related tasks i.e. only data access. This Data access layer is created as a separate solution so that the changes in DALonly need the recompilation of DAL and not the complete website. The benefit of having this layer as a separate solution is that in case the database engine is changes we only need to change the DALand the other areas of the website need not be changed and recompiled. Also the changes in other areas outside this solution will not demand for DAL recompilation.
On top of DAL, we have our Business Logic Layer(BLL). BLLcontains all the calculations and Business Rule validations that are required in the application. It is also in a separate solution for the reason that if the Business rules change or the calculations change we only need to recompile the BLL and the other layers of the application will remain unaffected.
Finally on top of BLLwe have our Presentation Layer. The Presentation layer for an ASP.NET web forms application is all the Forms ( apsxpages and their code behinds) and the classes contained in the App_Code folder. The Presentation layer is responsible for taking the user input, showing the data to the user and mainly performing input data validation.
Note: Input data filtration and validation is typically done at the Presentation Layer(Both client side and server side). The business Rule validation will be done at the BLL.
So to visualize the above mentioned architecture:
Note: The Data Access Layer in this article was written using classic ADO.NET, due to which the amount of code in DALis little too much. Nowadays using ORMs like Entity framework to generate the DALis recommended. The DALcode will be generated by ORM itself.
Using the code
Let us develop a small Toy ASP.NET application that will use n-tier architecture. We will develop a small Employee Management application for the NorthWindDatabase. (For simplicity, I have removed all other tables from the DB and some columns from the Employee table). This application should be able to perform the basic CRUD operations on the DB.
The solution for this application will contain separate projects for DALand BLL. The Data Layer will be SqlServer. The Presentation Layer is an ASP.NET website running on top of these projects.
The Data Layer
The data layer in this example contain only one table called Employee. The data layer also contains the stored procedures for all the basic operations on the Employee table. So let us look at the table and all the stored Procedures we have in our Data Layer.
Now we will create a set of stored procedures to perform the operations on the Employees Table.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 |
--1. Procedure to add a new employee CREATE PROCEDURE dbo.AddNewEmployee ( @LastName nvarchar(20), @FirstName nvarchar(10), @Title nvarchar(30), @Address nvarchar(60), @City nvarchar(15), @Region nvarchar(15), @PostalCode nvarchar(10), @Country nvarchar(15), @Extension nvarchar(4) ) AS insert into Employees (LastName, FirstName, Title, Address, City, Region, PostalCode, Country, Extension) values (@LastName, @FirstName, @Title, @Address, @City, @Region, @PostalCode, @Country, @Extension) RETURN --2. Procedure to delete an employee CREATE PROCEDURE dbo.DeleteEmployee ( @empId int ) AS delete from Employees where EmployeeID = @empId RETURN --3. Procedure to add get an employee details CREATE PROCEDURE dbo.GetEmployeeDetails ( @empId int ) AS Select * from Employees where EmployeeID = @empId RETURN --4. Procedure to get all the employees in the table CREATE PROCEDURE dbo.GetEmployeeList AS Select * from Employees RETURN --5. Procedure to update an employee details CREATE PROCEDURE dbo.UpdateEmployee ( @EmployeeID int, @LastName nvarchar(20), @FirstName nvarchar(10), @Title nvarchar(30), @Address nvarchar(60), @City nvarchar(15), @Region nvarchar(15), @PostalCode nvarchar(10), @Country nvarchar(15), @Extension nvarchar(4) ) AS update Employees set LastName = @LastName, FirstName = @FirstName, Title = @Title, Address = @Address, City = @City, Region = @Region, PostalCode = @PostalCode, Country = @Country, Extension = @Extension where EmployeeID = @EmployeeID RETURN |
Now we have our Data Layer ready.
The Data Access Layer
Now we will go ahead and create a Data Access Layer for our application. The data access layer will contain 2 main type of classes. A set of classes that will represent the Table entities. And classes to perform the CRUDoperations on the database.
The Employeeclass in the above diagram is the Entity that will represent the Employeetable. This class has been created so that the Layers above the DALwill use this class to perform operations in Employee table and they need not worry about the table schema related details.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 |
public class Employee { int employeeID; string lastName; // should be (20) chars only string firstName; // should be (10) chars only string title; // should be (30) chars only string address; // should be (60) chars only string city; // should be (15) chars only string region; // should be (15) chars only string postalCode; // should be (10) chars only string country; // should be (15) chars only string extension; // should be (4) chars only public int EmployeeID { get { return employeeID; } set { employeeID = value; } } public string LastName { get { return lastName; } set { lastName = value; } } public string FirstName { get { return firstName; } set { firstName = value; } } public string Title { get { return title; } set { title = value; } } public string Address { get { return address; } set { address = value; } } public string City { get { return city; } set { city = value; } } public string Region { get { return region; } set { region = value; } } public string PostalCode { get { return postalCode; } set { postalCode = value; } } public string Country { get { return country; } set { country = value; } } public string Extension { get { return extension; } set { extension = value; } } } |
The EmployeeDBAccessclass expose the methods to perform the CRUDoperations on the Employee table.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
public class EmployeeDBAccess { public bool AddNewEmployee(Employee employee) { SqlParameter[] parameters = new SqlParameter[] { new SqlParameter("@LastName", employee.LastName), new SqlParameter("@FirstName", employee.FirstName), new SqlParameter("@Title", employee.Title), new SqlParameter("@Address", employee.Address), new SqlParameter("@City", employee.City), new SqlParameter("@Region", employee.Region), new SqlParameter("@PostalCode", employee.PostalCode), new SqlParameter("@Country", employee.Country), new SqlParameter("@Extension", employee.Extension) }; return SqlDBHelper.ExecuteNonQuery("AddNewEmployee", CommandType.StoredProcedure, parameters); } public bool UpdateEmployee(Employee employee) { SqlParameter[] parameters = new SqlParameter[] { new SqlParameter("@EmployeeID", employee.EmployeeID), new SqlParameter("@LastName", employee.LastName), new SqlParameter("@FirstName", employee.FirstName), new SqlParameter("@Title", employee.Title), new SqlParameter("@Address", employee.Address), new SqlParameter("@City", employee.City), new SqlParameter("@Region", employee.Region), new SqlParameter("@PostalCode", employee.PostalCode), new SqlParameter("@Country", employee.Country), new SqlParameter("@Extension", employee.Extension) }; return SqlDBHelper.ExecuteNonQuery("UpdateEmployee", CommandType.StoredProcedure, parameters); } public bool DeleteEmployee(int empID) { SqlParameter[] parameters = new SqlParameter[] { new SqlParameter("@empId", empID) }; return SqlDBHelper.ExecuteNonQuery("DeleteEmployee", CommandType.StoredProcedure, parameters); } public Employee GetEmployeeDetails(int empID) { Employee employee = null; SqlParameter[] parameters = new SqlParameter[] { new SqlParameter("@empId", empID) }; //Lets get the list of all employees in a datataable using (DataTable table = SqlDBHelper.ExecuteParamerizedSelectCommand("GetEmployeeDetails", CommandType.StoredProcedure, parameters)) { //check if any record exist or not if (table.Rows.Count == 1) { DataRow row = table.Rows[0]; //Lets go ahead and create the list of employees employee = new Employee(); //Now lets populate the employee details into the list of employees employee.EmployeeID = Convert.ToInt32(row["EmployeeID"]); employee.LastName = row["LastName"].ToString(); employee.FirstName = row["FirstName"].ToString(); employee.Title = row["Title"].ToString(); employee.Address = row["Address"].ToString(); employee.City = row["City"].ToString(); employee.Region = row["Region"].ToString(); employee.PostalCode = row["PostalCode"].ToString(); employee.Country = row["Country"].ToString(); employee.Extension = row["Extension"].ToString(); } } return employee; } public List<employee> GetEmployeeList() { List<employee> listEmployees = null; //Lets get the list of all employees in a datataable using (DataTable table = SqlDBHelper.ExecuteSelectCommand("GetEmployeeList", CommandType.StoredProcedure)) { //check if any record exist or not if (table.Rows.Count > 0) { //Lets go ahead and create the list of employees listEmployees = new List<employee>(); //Now lets populate the employee details into the list of employees foreach (DataRow row in table.Rows) { Employee employee = new Employee(); employee.EmployeeID = Convert.ToInt32(row["EmployeeID"]); employee.LastName = row["LastName"].ToString(); employee.FirstName = row["FirstName"].ToString(); employee.Title = row["Title"].ToString(); employee.Address = row["Address"].ToString(); employee.City = row["City"].ToString(); employee.Region = row["Region"].ToString(); employee.PostalCode = row["PostalCode"].ToString(); employee.Country = row["Country"].ToString(); employee.Extension = row["Extension"].ToString(); listEmployees.Add(employee); } } } return listEmployees; } } </employee></employee></employee> |
The class SqlDbHelperis a wrapper class for ADO.NETfunctions providing a more simpler interface to use by the rest of DAL.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 |
class SqlDBHelper { const string CONNECTION_STRING = @"Data Source=.\SQLEXPRESS;AttachDbFilename=|DataDirectory|\NORTHWND.MDF;Integrated Security=True;User Instance=True"; // This function will be used to execute R(CRUD) operation of parameterless commands internal static DataTable ExecuteSelectCommand(string CommandName, CommandType cmdType) { DataTable table = null; using (SqlConnection con = new SqlConnection(CONNECTION_STRING)) { using (SqlCommand cmd = con.CreateCommand()) { cmd.CommandType = cmdType; cmd.CommandText = CommandName; try { if (con.State != ConnectionState.Open) { con.Open(); } using (SqlDataAdapter da = new SqlDataAdapter(cmd)) { table = new DataTable(); da.Fill(table); } } catch { throw; } } } return table; } // This function will be used to execute R(CRUD) operation of parameterized commands internal static DataTable ExecuteParamerizedSelectCommand(string CommandName, CommandType cmdType, SqlParameter[] param) { DataTable table = new DataTable(); using (SqlConnection con = new SqlConnection(CONNECTION_STRING)) { using (SqlCommand cmd = con.CreateCommand()) { cmd.CommandType = cmdType; cmd.CommandText = CommandName; cmd.Parameters.AddRange(param); try { if (con.State != ConnectionState.Open) { con.Open(); } using (SqlDataAdapter da = new SqlDataAdapter(cmd)) { da.Fill(table); } } catch { throw; } } } return table; } // This function will be used to execute CUD(CRUD) operation of parameterized commands internal static bool ExecuteNonQuery(string CommandName, CommandType cmdType, SqlParameter[] pars) { int result = 0; using (SqlConnection con = new SqlConnection(CONNECTION_STRING)) { using (SqlCommand cmd = con.CreateCommand()) { cmd.CommandType = cmdType; cmd.CommandText = CommandName; cmd.Parameters.AddRange(pars); try { if (con.State != ConnectionState.Open) { con.Open(); } result = cmd.ExecuteNonQuery(); } catch { throw; } } } return (result > 0); } } |
Note: If we use any ORM(Object Relation Mapper) then DAL need not be written. The ORMwill generate all the DAL code. Entity frameworkis one of the best ORMsavailable. This DAL can simply be replaced with a class library containing the Entity Framework generated Entities and Contexts.
The Business Logic Layer
The business logic layer will have a reference to the DAL and will mainly perform Business rule validation and business logic specific calculations. In out example, I will write a simple BLLthat will govern the IO between the DALand Presentation layer. In real applications the BLLwill contain more logic and code.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
public class EmployeeHandler { // Handle to the Employee DBAccess class EmployeeDBAccess employeeDb = null; public EmployeeHandler() { employeeDb = new EmployeeDBAccess(); } // This fuction does not contain any business logic, it simply returns the // list of employees, we can put some logic here if needed public List<employee> GetEmployeeList() { return employeeDb.GetEmployeeList(); } // This fuction does not contain any business logic, it simply returns the // list of employees, we can put some logic here if needed public bool UpdateEmployee(Employee employee) { return employeeDb.UpdateEmployee(employee); } // This fuction does not contain any business logic, it simply returns the // list of employees, we can put some logic here if needed public Employee GetEmployeeDetails(int empID) { return employeeDb.GetEmployeeDetails(empID); } // This fuction does not contain any business logic, it simply returns the // list of employees, we can put some logic here if needed public bool DeleteEmployee(int empID) { return employeeDb.DeleteEmployee(empID); } // This fuction does not contain any business logic, it simply returns the // list of employees, we can put some logic here if needed public bool AddNewEmployee(Employee employee) { return employeeDb.AddNewEmployee(employee); } } |
The Presentation Layer
The presentation layer now contains only a set of pages and code behinds and it will use the BLLand the the Employee class to perform all the operations. The add Operation can be seen as an example how the BLLis being used to perform an operation.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
Employee emp = new Employee(); emp.LastName = txtLName.Text; emp.FirstName = txtFName.Text; emp.Address = txtAddress.Text; emp.City = txtCity.Text; emp.Country = txtCountry.Text; emp.Region = txtRegion.Text; emp.PostalCode = txtCode.Text; emp.Extension = txtExtension.Text; emp.Title = txtTitle.Text; EmployeeHandler empHandler = new EmployeeHandler(); if (empHandler.AddNewEmployee(emp) == true) { //Successfully added a new employee in the database Response.Redirect("Default.aspx"); } |
Note: All the CRUD operations have been implemented. Please refer tio the sample code for all the details. When we run the application we can see all the EDIT/UPDATE, DELETE and ADD operations in action.
Point of Interest
I created this small application to demonstrate application development using n-tier architecture. The demo application has been created to show the basic idea behind the 3-tier architecture. There are many things that are still missing from this sample from the completion perspective. Client side validation and server side validation in presentation layer, Business rule validation and calculations in BLL are some missing things.
Since the idea here was to talk about how to put n-tier architecture in actual code, I think this article might have provided some useful information on that. I hope this has been informative.
[UPDATE] Note: In this article I am reusing the Employeemodel in the presentation layer. This model is defined in Data Access Layer. Due to this the presentation layer has to refer to the data access layer. This is not ideal in the real world scenarios(as pointed out in many of the comments below). Ideal solution for this would be to have two different models for Employee. the current model which is defined in the data access layer can be called as the data model and the business logic layer can create a model for employee which will be called as domain model. The business logic layer will then have to contain the code for mapping the data model to the domain model and vice versa. This mapping can be done either manually or a tool like AutoMappercan also be used to perform such mapping. With this change the presentation layer need not refer to the data access layer but it can refer to the business logic layer and use the Employee domain model from that.
In this article the n-tier architecture is specifically a data centric n-tier and not a domain centric one. If we need to design the application in a domain centric n-tier architecture then we need to follow a different way of organizing our layers. But perhaps that is a topic which deserves a separate discussion altogether but I wanted to point out the possibility of a domain centric n-tier architecture in this article.
Download sample code for this article: nTierDemo