[Note: This document is an advance copy of a new topic that will be released with the documentation for Visual Studio 2010 and ASP.NET 4. Comments are welcome and will be taken into account when the final version of the document is prepared for release.]
In Visual Studio you can create Web application projects or Web site projects. Each type has advantages and disadvantages, and you must understand the differences between them in order to select the best type. It is important to select the appropriate project type before you create a project, because it is not an easy task to convert from one project type to the other.
Note For some scenarios you do not have a choice. For example, if you want to create an ASP.NET MVC application, you must use a Web application project.
The primary factor in selecting between a Web application project and a Web site project is how you intend to deploy your project and how you want to maintain it after it is deployed. Scenarios in which Web application projects are the preferred choice include the following:
· You want to use MSBuild to compile the project. For example, you might want to add pre-build and post-build steps.
· You want the compiler to create a single assembly for the entire site.
· You want control over the assembly name and version number that is generated for the site.
· You want to refer to the code-behind classes of pages and user-controls from standalone classes.
· You want to establish project dependencies between multiple Web projects.
Scenarios in which Web site projects are the preferred choice include the following:
· You 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.
· You do not want to explicitly compile the project in Release configuration in order to deploy it.
· You 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.
Summary of Differences
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.
· You explicitly compile the source code on the computer that is used for development or source control.
· By default, compilation of code files (excluding .aspx and .ascx files) produces a single assembly.
· The source code is typically compiled dynamically (automatically) by ASP.NET on the server the first time a request is received after the site has been installed or updated.
You can precompile the site (compile in advance on a development computer or on the server).
· By default, compilation produces multiple assemblies.
Explicit namespaces are added to pages, controls, and classes by default.
Explicit namespaces are not added to pages, controls, and classes by default, but you can add them manually.
· You copy the assembly to a server. The assembly is produced by compiling the application.
· Visual Studio provides tools that integrate with the IIS Web deployment tool to automate many deployment tasks.
· You copy the application source files to a computer that has IIS installed on it.
· If you precompile the site on a development computer, you copy the assemblies produced by compilation to the IIS server.
· Visual Studio provides tools for deployment, but they do not automate as many deployment tasks as the tools available for Web application projects.
Project File Structure
Web application projects use Visual Studio project files (.csproj or .vbproj) to keep track of information about the project. Among other tasks, 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 you want to exclude something from compilation, you 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 you do not lose track of them, because they remain in the folder structure. For example, if a page is not ready to be deployed, you can temporarily exclude it from the build without deleting it from the folder structure. You can deploy the compiled assembly, and then include the file in the project again. This is especially important if you are working with a source control repository.
An advantage of using folder structure without project files in Web site projects is the following:
· You do not have to manage the project's structure exclusively in Visual Studio. For example, you can copy files into the project or delete them from the project by using Windows Explorer.
For Web application projects, you 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, you 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). You 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:
· You 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, you can precompile the site. However, then some of the advantages of dynamic compilation are lost.)
· You have complete control over where you put code files in the project folder structure, and how you 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. You cannot refer to a page or user control class from a class in App_Code.)
· The Visual Studio Code Analysis feature works for Web application projects but not Web site projects.
Advantages of the compilation model for Web site projects include the following:
· You 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, you 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. You can update individual source code files on the production server without having to explicitly recompile the site. You can update individual files that are ready for deployment even if other files are not ready due to compile errors. You 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 you 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.
Note There is no difference in performance between a Web site project and a Web application project. The only significant exceptions are the ones that have already been noted, and as a practical matter they apply only to very large sites. The first request to the Web site might require the site to be compiled, which can result in a delay. And if the Web site is running on an IIS server that is short on memory, including the entire site in a single assembly might use more memory than would be required for multiple assemblies.
To deploy a Web application project, you copy the assembly that is created by compiling the project to an IIS server. In contrast, to deploy a Web site project, you typically copy the project source files to an IIS server.
Advantages of the deployment strategy for Web application projects include the following:
· You can avoid deploying source code to the IIS server. In some scenarios, such as shared hosting environments, you might be concerned about unauthorized access to source code on the IIS server. (For a Web site project, You can avoid this risk by precompiling on a development computer and deploying the generated assemblies instead of the source code. However, in that case you lose some of the benefits of easy site updates.)
· Deployment often involves other tasks in addition to copying assemblies or code to a server. For example, database scripts might have to run in production, and connection strings in the Web.config file might have to be changed for a production server. Visual Studio provides tools such as one-click publish that work with Web application projects to automate many of these tasks. These tools are not available for Web site projects.
Advantages of the deployment strategy for Web site projects include the following:
· If you make a small change to a Web application, you do not have to redeploy the whole application. Instead, can copy just the changed file or files to the production IIS server. You can also edit files directly on the production server. (Because a Web application project's code files are compiled into a single assembly file, you must deploy the whole site even for small changes, unless the only change is to an .aspx or .ascx file.)
Give Your Feedback on the DocumentationHelp us improve the developer documentation by taking the Visual Studio and .NET Framework Content Survey. This survey will give us a better understanding of the type of applications you are developing as well as how you use Help and how we can improve it. The survey takes only 10 minutes, and we appreciate your feedback.