Today's RIA applications require us to build robots apps with minimal post-backs cycles, this requirement forces us to make an extensive use of JavaScript and technologies as AJAX.
Today I want to blog about "Rendering Dynamically JavaScript Files from Server Side Code", this is a very useful and elegant (and strangely not discussed enough) technique that can improve our RIA application architecture.
You work on a "Rental Car" application that is in charge of keeping track of all rented cars and sends an email notification to the "Rental Car" company manager about cars that their rental period already exceeded.
As mentioned before, your app makes an extensive use of JavaScript and AJAX in order to improve users experience.
Now, let's also say that you need to read the SMTP configuration parameters, such as SMTP Host Name, user name, password and sender email address from your Web Config or from a Data Base.
You have several option to perform this task, but I will stick to the main ones:
Obviously you could improve your little piece of code so it will save the data in a JavaScript variable so you don't need to perform AJAX calls again and again, but you will still need to perform at least one AJAX call for every page refresh. Taking in consideration that in a big enterprise application you could reach situations where you waste dozens of AJAX calls for every page refresh. Its not a perfect idea.
As you know when a page makes its way back to the client it contains HTML.
With a small effort we can make our server generate JavaScript files dynamically and make use of server side code to retrieve the SMTP data, without unnecessary post-backs and AJAX calls.
Two important things to note:
Our "ServerSide - JavaScript" contains a simple JSON object that will be filled by the C# code with the corresponding data:
From our simple ASP.NET standard page we are able to write the following code:
The sample I just show you is very simple, but with a little imagination, instead of simply reading data from our Web Config we can think on more complex scenarios like retrieve data from data base or from a complex Business Logic method that returns list of items etc.
Today I want to blog about "Rendering Dynamically JavaScript Files from Server Side Code", this is a very useful and elegant (and strangely not discussed enough) technique that can improve our RIA application architecture.
Good But Not Perfect
So let's try to describe a small task and it's solution to make a good picture about this strong technique.You work on a "Rental Car" application that is in charge of keeping track of all rented cars and sends an email notification to the "Rental Car" company manager about cars that their rental period already exceeded.
As mentioned before, your app makes an extensive use of JavaScript and AJAX in order to improve users experience.
Now, let's also say that you need to read the SMTP configuration parameters, such as SMTP Host Name, user name, password and sender email address from your Web Config or from a Data Base.
You have several option to perform this task, but I will stick to the main ones:
- You can turn a blind eye, and make a small post-back to the server to help you with this.
- You can make a small AJAX call to your server side Business Logic Layer or Data Access Layer, "make them" retrieve the requested data from the Web Config file or Data Base and reply back to your browser a nice JSON object containing the requested data.
Obviously you could improve your little piece of code so it will save the data in a JavaScript variable so you don't need to perform AJAX calls again and again, but you will still need to perform at least one AJAX call for every page refresh. Taking in consideration that in a big enterprise application you could reach situations where you waste dozens of AJAX calls for every page refresh. Its not a perfect idea.
The Elegant Solution
Let's think about a wonderful world where we could:- Retrieve the SMTP data from our server side (Business Logic Layer or Data Access Layer) ones and preserve it even between post-backs
- Cache data in the client (browser)
- In conjunction with HTTP protocol (I will blog about this one...) we also could have a full control on the cache expiration date (i.e re call server via AJAX only next week or only when data was changed etc)
As you know when a page makes its way back to the client it contains HTML.
With a small effort we can make our server generate JavaScript files dynamically and make use of server side code to retrieve the SMTP data, without unnecessary post-backs and AJAX calls.
Let's Code
Here a simple ASP.NET standard page that is used to render HTML back to our browser:<%@ Page Language="C#" AutoEventWireup="true" CodeBehind="WebForm1.aspx.cs" Inherits="ServerSideJS.WebForm1" %>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
ServerSideJS
</head>
<body>
</body>
</html>
In order to tell the server that instead we want to render some JavaScript code your page should look like this:<%@ Page Language="C#" AutoEventWireup="true" CodeBehind="js.aspx.cs" Inherits="ServerSideJS.js" ContentType="application/x-javascript" %>
Two important things to note:
- This file still has it's own server side although it generates JavaScript code, that means that some how we can use the power of server side C# / VB to generate those JavaScript lines
- ContentType="application/x-javascript" is the key of Rendering Dynamically JavaScript Files technique, this small piece of code tells the server side code to generate JavaScript instead of HTML
Our "ServerSide - JavaScript" contains a simple JSON object that will be filled by the C# code with the corresponding data:
<%@ Page Language="C#" AutoEventWireup="true" CodeBehind="js.aspx.cs" Inherits="ServerSideJS.js" ContentType="application/x-javascript" %>
var SMTPData={
HostName:'<%= ConfigurationManager.AppSettings["HostName"].ToString()%>',
Password:'<%= ConfigurationManager.AppSettings["Password"].ToString()%>',
UserName:'<%= ConfigurationManager.AppSettings["UserName"].ToString()%>',
SenderEmail:'<%= ConfigurationManager.AppSettings["SenderEmail"].ToString()%>'
};
From our simple ASP.NET standard page we are able to write the following code:
<%@ Page Language="C#" AutoEventWireup="true" CodeBehind="WebForm1.aspx.cs" Inherits="ServerSideJS.WebForm1" %>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
ServerSideJS
</head>
<body onload="load()">
</body>
</html>
The sample I just show you is very simple, but with a little imagination, instead of simply reading data from our Web Config we can think on more complex scenarios like retrieve data from data base or from a complex Business Logic method that returns list of items etc.
Comments