4-Tier Architecture in ASP.NET with C#

4-Tier Architecture in ASP.NET with C# I am using 3-Tier architecture in my different projects, but adding a 4th tier is a novelty for me After reading this article, I can see the benefits to add a Business Access Layer in some complex scenarios From the author: Almost all of us must have heard about 3-Tier architecture but what is this 4-Tier architecture? What are the benefits and how it is different from other architectures? Well, the architecture I am going to demonstrate here is just enhancement of 3-Tier archicture In this architecture; you no need of writing long function parameters throughout the layers (as in traditionally 3-Tier archicture has to) and the actual objects of the application will be in a separate tier so that in future you can separately use these objects for enhancements Change in the object definition can be done without touching the entire Business Access Layers Let me explain you step-wise process of creatioin of 4-Tier architecture application In this application, I am going to take example of a Person that will have properties: FirstName, LastName, Age We will create a separate pages to insert these records (default.aspx) into database and list,update,delete records (list.aspx) from database In this application we will have following 4-Tiers Business Object [BO] Business Access Layer [BAL] Data Access Layer [DAL] UI (4-Tier) folder [UI] Well, the architecture I am going to demonstrate here is just enhancement of 3-Tier archicture In this architecture; you no need of writing long function parameters throughout the layers (as in traditionally 3-Tier archicture has to) and the actual objects of the application will be in a separate tier so that in future you can separately use these objects for enhancements Change in the object definition can be done without touching the entire Business Access Layers Let me explain you step-wise process of creatioin of 4-Tier architecture application In this application, I am going to take example of a Person that will have properties: FirstName, LastName, Age We will create a separate pages to insert these records (default.aspx) into database and list,update,delete records (list.aspx) from database In this application we will have following 4-Tiers Business Object [BO] Business Access Layer [BAL] Data Access Layer [DAL] UI (4-Tier) folder [UI] Picture - (Solution Explorer) For simplicity reason, I have created separate folders for first 3-tiers into App_Code folder You can create a separate projects for these tiers and add into forth tier (UI) solution Lets create above tiers one by one Business Object [BO - Person.cs] Create a separate folder by right-clicking App_Code folder and name it as BO Right click this folder and create a new cs (Class) file named Person.cs Write following code inside it - Hide Code int m_PersonID = 0; string m_FirstName = string.Empty; string m_LastName = string.Empty; int m_Age = 0; #region Propertiers public int PersonID { get { return m_PersonID; } set { m_PersonID = value; } } public string FirstName { get { return m_FirstName; } set { m_FirstName = value; } } public string LastName { get { return m_LastName; } set { m_LastName = value; } } public int Age { get { return m_Age; } set { m_Age = value; } } #endregion Properties Here, we are first declaring variables for corresponding properites and defining properties for them.This is your Business Object with all its properties/attributes to work with Next step is to create Data Access Layer Data Access Layer [DAL - PersonDAL.cs] The way you created BO folder inside App_Code folder, create another folder named DAL Create a cs file inside it and name it as PersonDAL.cs Write following code inside it (You can copy-paste) - Hide Code using System; using System.Data; using System.Configuration; using System.Web; using System.Web.Security; using System.Web.UI; using System.Web.UI.WebControls; using System.Web.UI.WebControls.WebParts; using System.Web.UI.HtmlControls; using System.Data.SqlClient; /// /// Summary description for PersonDAL /// public class PersonDAL { string connStr = ConfigurationManager.ConnectionStrings["TutTestConn"].ToString(); public PersonDAL() { } /// /// Used to insert records into database /// /// /// public int Insert(Person person) { SqlConnection conn = new SqlConnection(connStr); conn.Open(); SqlCommand dCmd = new SqlCommand("InsertData", conn); dCmd.CommandType = CommandType.StoredProcedure; try { dCmd.Parameters.AddWithValue("@firstName", person.FirstName); dCmd.Parameters.AddWithValue("@lastName", person.LastName); dCmd.Parameters.AddWithValue("@age", person.Age); return dCmd.ExecuteNonQuery(); } catch { throw; } finally { dCmd.Dispose(); conn.Close(); conn.Dispose(); } } /// /// Update record into database /// /// /// public int Update(Person person) { SqlConnection conn = new SqlConnection(connStr); conn.Open(); SqlCommand dCmd = new SqlCommand("UpdateData", conn); dCmd.CommandType = CommandType.StoredProcedure; try { dCmd.Parameters.AddWithValue("@firstName", person.FirstName); dCmd.Parameters.AddWithValue("@lastName", person.LastName); dCmd.Parameters.AddWithValue("@age", person.Age); dCmd.Parameters.AddWithValue("@personID", person.PersonID); return dCmd.ExecuteNonQuery(); } catch { throw; } finally { dCmd.Dispose(); conn.Close(); conn.Dispose(); } } /// /// Load all records from database /// /// public DataTable Load() { SqlConnection conn = new SqlConnection(connStr); SqlDataAdapter dAd = new SqlDataAdapter("LoadAll", conn); dAd.SelectCommand.CommandType = CommandType.StoredProcedure; DataSet dSet = new DataSet(); try { dAd.Fill(dSet, "PersonTable"); return dSet.Tables["PersonTable"]; } catch { throw; } finally { dSet.Dispose(); dAd.Dispose(); conn.Close(); conn.Dispose(); } } /// /// Delete record from database /// /// /// public int Delete(Person person) { SqlConnection conn = new SqlConnection(connStr); conn.Open(); SqlCommand dCmd = new SqlCommand("DeleteData", conn); dCmd.CommandType = CommandType.StoredProcedure; try { dCmd.Parameters.AddWithValue("@personID", person.PersonID); return dCmd.ExecuteNonQuery(); } catch { throw; } finally { dCmd.Dispose(); conn.Close(); conn.Dispose(); } } } In this class file, we have Insert, Update, Delete, Load methods In this class file, first I am getting the connection string from the web.config file in a class level variable called connStr and using the same string in all my methods to open the connection For simplicity reason, I have not shown the code for Stored Procedure, however you can get the complete database and code by downloading the Source Code files This was your Data Access Layer Till now you have your Business Object and Data Access Layer ready Now lets go to the third layer and create Business Access Layer Business Access Layer [BAL - PersonBAL.cs] Again, right click App_Code folder and add a new folder named BAL Create a new class file inside it and name it as PersonBAL.cs Write following code inside it - Hide Code using System; using System.Data; using System.Configuration; using System.Web; using System.Web.Security; using System.Web.UI; using System.Web.UI.WebControls; using System.Web.UI.WebControls.WebParts; using System.Web.UI.HtmlControls; /// /// Summary description for PersonBAL /// public class PersonBAL { public PersonBAL() { } /// /// insert records into database /// /// /// public int Insert(Person person) { PersonDAL pDAL = new PersonDAL(); try { return pDAL.Insert(person); } catch { throw; } finally { pDAL = null; } } /// /// Update records into database /// /// /// public int Update(Person person) { PersonDAL pDAL = new PersonDAL(); try { return pDAL.Update(person); } catch { throw; } finally { pDAL = null; } } /// /// Load records from database /// /// public DataTable Load() { throw; } finally { pDAL = null; } } } Here, we are creating separate methods each for respective PersonDAL.cs methods here As in our case we don't have any business logic, so we are just instantiating the Data Access Layer objects, using its methods and and returning to UI (fourth layer, described later on) You must have noticed here that in the try catch block, I am just writing throw; statement This is because when any error will occur it will be send to the calling layers (in our case UI) and there we will handle it Till now, we have BO, BAL and DAL ready Now we are left with our application face, I mean UI Lets first create default.aspx file that will contain one form and textboxs that will be used to enter records User Interface - [UI]-Default.aspx Create a separate folder in your UI solution named 4-Tier and add one aspx page called Default.aspx (Picture - 2) In this page, we will write ASP.NET code to render textboxes and buttons OnClick event of the button we will calll AddRecords method that will ultimately insert the records into database Below is the code to render the asp.net form - Hide Code

List Records

Add Records First Name: Last Name: Age: Picture - (Default.aspx) AddRecords method - Hide Code protected void AddRecords(object sender, EventArgs e) { //Lets validate the page first if (!Page.IsValid) return; int intResult = 0; // Page is valid, lets go ahead and insert records // Instantiate BAL object PersonBAL pBAL = new PersonBAL(); // Instantiate the object we have to deal with Person person = new Person(); // set the properties of the object person.FirstName = txtFirstName.Text; person.LastName = txtLastName.Text; person.Age = Int32.Parse(txtAge.Text); try { intResult = pBAL.Insert(person); if (intResult > 0) lblMessage.Text = "New record inserted successfully."; else lblMessage.Text = "FirstName ["+ txtFirstName.Text +"] alredy exists, try another name"; } catch (Exception ee) { lblMessage.Text = ee.Message.ToString(); } finally { person = null; pBAL = null; } } In the above method, I am doing following things mainly: Instantiating BAL object Instantiating BO object Settinng properties of BO object by the textbox values Calling Insert method of the BAL object and passing BO object as parameter [pBAL.Insert(person)] in try block Checking for number of records affected, If the number is more than zero, I am writing Success message otherwise Duplicate records found If any layer will throw any error, I am catching it and displaying to the user in throw block Whatever objects I had instantiated, I am specifying their values to null to let the GC know that I am no more going to use them User Interface - [UI]-List.aspx In this page, I am going to use a GridView to List, Modify, Sort and Delete records from the database Create an aspx page in the same 4-Tier folder named List.aspx (Picture - 3) Following is the code for the GridView that will data manipulation for us - Hide Code

Add Record

Picture - (List.aspx) On the OnRowEditing, OnRowUpdating, OnRowCancelEdit, OnSorting and OnRowDeleting events we are calling respective methods to data manipulation Following are codes to bind the GridView and methods that will fire on GridView events - Hide Code protected void Page_Load(object sender, EventArgs e) { if (!IsPostBack) BindGrid(); } /// /// Fired when Cancel button is clicked /// /// /// protected void CancelRecord(object sender, GridViewCancelEditEventArgs e) { GridView1.EditIndex = -1; BindGrid(); } /// /// Fires when Edit button is clicked /// /// /// protected void EditRecord(object sender, GridViewEditEventArgs e) { GridView1.EditIndex = e.NewEditIndex; BindGrid(); } /// /// Fires when Update button is clicked /// /// /// protected void UpdateRecord(object sender, GridViewUpdateEventArgs e) { int personID = Int32.Parse(GridView1.DataKeys[e.RowIndex].Value.ToString()); int intResult = 0; GridViewRow row = GridView1.Rows[e.RowIndex]; TextBox tFN = (TextBox) row.FindControl("txtFName"); TextBox tLN = (TextBox)row.FindControl("txtLName"); TextBox tAge = (TextBox)row.FindControl("txtAge"); // instantiate BAL PersonBAL pBAL = new PersonBAL(); Person person = new Person(); try { person.PersonID = personID; person.FirstName = tFN.Text; person.LastName = tLN.Text; person.Age = Int32.Parse(tAge.Text); intResult = pBAL.Update(person); if (intResult > 0) lblMessage.Text = "Record Updated Successfully."; else lblMessage.Text = "Record couldn't updated"; } catch (Exception ee) { lblMessage.Text = ee.Message.ToString(); } finally { person = null; pBAL = null; } GridView1.EditIndex = -1; // Refresh the list BindGrid(); } /// /// fires when Delete button is clicked /// /// /// protected void DeleteRecord(object sender, GridViewDeleteEventArgs e) { int personID = Int32.Parse(GridView1.DataKeys[e.RowIndex].Value.ToString()); // instantiate BAL PersonBAL pBAL = new PersonBAL(); Person person = new Person(); try { person.PersonID = personID; pBAL.Delete(person); lblMessage.Text = "Record Deleted Successfully."; } catch (Exception ee) { lblMessage.Text = ee.Message.ToString(); } finally { person = null; pBAL = null; } GridView1.EditIndex = -1; // Refresh the list BindGrid(); } /// /// Fires when page links are clicked /// /// /// protected void ChangePage(object sender, GridViewPageEventArgs e) { GridView1.PageIndex = e.NewPageIndex; // Refresh the list BindGrid(); } /// /// Fires when Columns heading are clicked /// /// /// protected void SortRecords(object sender, GridViewSortEventArgs e) { DataTable dataTable = GridDataSource(); if (dataTable != null) { DataView dataView = new DataView(dataTable); dataView.Sort = GetSortExpression(e); GridView1.DataSource = dataView; GridView1.DataBind(); } } #region Private Methods /// /// Bind the gridview /// private void BindGrid() { GridView1.DataSource = GridDataSource(); GridView1.DataBind(); } /// /// Get GridView DataSource /// private DataTable GridDataSource() { PersonBAL p = new PersonBAL(); DataTable dTable = new DataTable(); try { dTable = p.Load(); } catch (Exception ee) { lblMessage.Text = ee.Message.ToString(); } finally { p = null; } return dTable; } /// /// Get sort expression for the gridview /// /// /// private string GetSortExpression(GridViewSortEventArgs e) { string sortDirection = string.Empty; // if clicked on the same column twice then let it toggle the sort order, else reset to ascending if (ViewState["SortExpression"] != null) { if (!ViewState["SortExpression"].ToString().Equals(e.SortExpression.ToLower())) { ViewState["SortDirection"] = null; } } if (ViewState["SortDirection"] != null) { if (ViewState["SortDirection"].ToString().Equals("ASC")) { sortDirection = "DESC"; ViewState["SortDirection"] = "DESC"; } else { sortDirection = "ASC"; ViewState["SortDirection"] = "ASC"; } } else { ViewState["SortDirection"] = "ASC"; } ViewState["SortExpression"] = e.SortExpression.ToLower(); return e.SortExpression + " " + sortDirection; } #endregion Private Methods Thats it!!! Now we have done all our home work, Its time to enjoy now Just build the application by pressing Ctrl+Shift+B, once it shows Build Succeeded in the status bar at the bottom, you are ready to enjoy your 4-Tier architecture application Browse it as http://localhost/4-Tier (Provided you have created "4-Tier" virtual directory in your IIS or you can choose your own virtual directory name), you should see your screens as shown above (default.aspx and list.aspx pages) Try manipulating data and see how effectively its happening This was a simple application, based on this architecture, you can create larger application by adding separate objects and their corresponding tiers In order to use namespace in different tiers, you should define your namespace in respective tiers objects and use those namespace by using statement whereever you need ... ee.Message.ToString(); } finally { person = null; pBAL = null; } } In the above method, I am doing following things mainly: Instantiating BAL object Instantiating BO object Settinng properties... it - Hide Code using System; using System.Data; using System.Configuration; using System.Web; using System.Web.Security; using System.Web.UI; using System.Web.UI.WebControls; using System.Web.UI.WebControls.WebParts;... using System.Data; using System.Configuration; using System.Web; using System.Web.Security; using System.Web.UI; using System.Web.UI.WebControls; using System.Web.UI.WebControls.WebParts; using