In Visual Studio we can create Web application projects or web site projects. We create or open a web application project by choosing New Project or Open Project in the Visual Studio File menu. We create or open a web site project by choosing New Web Site or Open Web Site in the File menu. It’s best to choose the right type before we create a web project, because it can be time-consuming, difficult, and error-prone to convert from one type to the other.
Scenarios
Scenarios in which web application projects are the preferred choice include the following:
- We want to be able to use the Edit and Continue feature of the Visual Studio debugger.
- We want to run unit tests on code that is in the class files that are associated with ASP.NET pages.
- We want to refer to the classes that are associated with pages and user controls from standalone classes.
- We want to establish project dependencies between multiple web projects.
- We want the compiler to create a single assembly for the entire site.
- We want control over the assembly name and version number that is generated for the site.
- We want to use MSBuild or Team Build to compile the project. For example, we might want to add prebuild and postbuild steps.
- We want to avoid putting source code on a production server.
Scenarios in which Web site projects are the preferred choice include the following:
- We want to include both C# and Visual Basic code in a single web project. (By default, a web application is compiled based on language settings in the project file. Exceptions can be made, but it is relatively difficult.)
- We want to open the production site in Visual Studio and update it in real time by using FTP.
- We do not want to have to explicitly compile the project in order to deploy it.
- If we do precompile the site, we want the compiler to create multiple assemblies for the site, which can include one assembly per page or user control, or one or more assemblies per folder.
- We want to be able to update individual files in production by just copying new versions to the production server, or by editing the files directly on the production server.
- If we precompile the site, we want to be able to update individual ASP.NET web pages (.aspx files) without having to recompile the entire site.
- We like to keep your source code on the production server because it can serve as an additional backup copy.
Summary of Differences
The following table summarizes the main differences.
Area
|
Web application projects
|
Web site projects
|
Project file structure
|
A Visual Studio project file (.csproj or .vbproj) stores information about the project, such as the list of files that are included in the project, and any project-to-project references.
|
There is no project file (.csproj or .vbproj). All the files in a folder structure are automatically included in the site.
|
Compilation
|
|
We can precompile the site (compile in advance on a development computer or on the server).
|
Namespaces
|
Explicit namespaces are added to pages, controls, and classes by default.
|
Explicit namespaces are not added to pages, controls, and classes by default, but we can add them manually.
|
Deployment
|
|
|
Project File Structure
Web application projects use Visual Studio project files (.csproj or .vbproj) to keep track of information about the project. This makes it possible to specify which files are included in or excluded from the project, and therefore which files are compiled during a build.
For web site projects, all files in a folder structure are automatically considered to be included in the web site. If we want to exclude something from compilation, we must remove the file from the web site project folder or change its file-name extension to an extension that is not compiled and is not served by IIS.
An advantage of using project files in web application projects is the following:
- It is easy to temporarily remove files from the site but still make sure that we do not lose track of them, because they remain in the folder structure. For example, if a page is not ready to be deployed, we can temporarily exclude it from the build without deleting it from the folder structure. We can deploy the compiled assembly, and then include the file in the project again. This is especially important if we are working with a source control repository.
An advantage of using folder structure without project files in Web site projects is the following:
- We do not have to manage the project's structure exclusively in Visual Studio. For example, we can copy files into the project or delete them from the project by using File Explorer.
Compilation
For web application projects, we typically build the project in Visual Studio or by using the ASP.NET batch compiler on a computer that is not the production IIS server. All code-behind class files and standalone class files in the project are compiled into a single assembly, which is then put in the web application project's Bin folder. (The .aspx and .ascx files are compiled dynamically in a manner similar to what is done for web site projects.)
For web site projects, we do not have to manually compile the project. web site projects are typically compiled dynamically by ASP.NET (on both the development computer and the production IIS server). We can choose between batch compilation mode, which typically produces one assembly per folder, and fixed compilation mode, which typically produces one assembly for each page or user control.
Advantages of the compilation model for web application projects include the following:
- We can use MSBuild to create a custom batch-compilation process.
- It is easy to specify assembly attributes such as name and version.
- Compiling in advance makes sure that users do not have to wait while the site compiles on the production server. (If the site is very large, dynamic compilation of a web site project might take a noticeable amount of time. Dynamic compilation occurs when a request for a site resource is received after an update to the site, and the request that triggers compilation might be delayed while the required resources are compiled. If the delay is unacceptable, we can precompile the site. However, then some of the advantages of dynamic compilation are lost.)
- We have complete control over where we put code files in the project folder structure, and how we how classes in the project refer to each other. (Dynamic compilation requires that the source code for any classes that are used throughout the site must be in the App_Code folder. We cannot refer to a page or user control class from a class in App_Code.)
Advantages of the compilation model for Web site projects include the following:
- We can test specific pages regardless of the state of other pages. This is because running an individual page does not require that the whole site compile successfully, only the page and any components it depends on, such as code in the App_Code folder or the Global.asax file. (In a web application project, if there are compilation errors anywhere in the site, we cannot create the assembly and therefore cannot test even the pieces of the site that compile.)
- It is easy to update a Web site in production. We can update individual source code files on the production server without having to explicitly recompile the site. We can update individual files that are ready for deployment even if other files are not ready due to compile errors. We can also open the Web site on the production IIS server directly in Visual Studio and update the Web site in real time.
- Precompiling to multiple assemblies can have a performance advantage in some scenarios. A typical example is a site that has many pages with lots of code written for them. Most of the pages are rarely requested and only some are used frequently. If we compile a site like this into multiple assemblies, the production server can load only the assemblies that are required for the current requests. If a page is not requested, its corresponding assembly is not loaded.
