ASP.NET MVC View Engines (Community Wiki)
Since a comprehensive list does not appear exist, let's start one here on SO. This can be of great value to the ASP.NET MVC community if people add their experience (esp. anyone who contributed to one of these). Anything implementing
IViewEngine (e.g. VirtualPathProviderViewEngine) is fair game here. Just alphabetize new View Engines (leaving WebFormViewEngine at the top), and try to be objective in comparisons.
Design Goals:
A view engine that is used to render a Web Forms page to the response.
Pros:
- ubiquitous since it ships with ASP.NET MVC
- familiar experience for ASP.NET developers
- IntelliSense
- can choose any language with a CodeDom provider (e.g. C#, VB.NET, F#, Boo, Nemerle)
- on-demand compilation or precompiled views
Cons:
- usage is confused by existence of "classic ASP.NET" patterns which no longer apply in MVC (e.g. ViewState PostBack)
- can contribute to anti-pattern of "tag soup"
- code-block syntax and strong-typing can get in the way
- IntelliSense enforces style not always appropriate for inline code blocks
- can be noisy when designing simple templates
Example:
<%@ Control Inherits="System.Web.Mvc.ViewPage<IEnumerable<Product>>" %><% if(model.Any()) { %><ul>
<% foreach(var p in model){%>
<li><%=p.Name%></li>
<%}%></ul>
<%}else{%>
<p>No products available</p>
<%}%>
Design goals:
- Respect HTML as first-class language as opposed to treating it as "just text".
- Don't mess with my HTML! The data binding code (Bellevue code) should be separate from HTML.
- Enforce strict Model-View separation
Design Goals:
The Brail view engine has been ported from MonoRail to work with the Microsoft ASP.NET MVC Framework. For an introduction to Brail, see the documentation on the Castle project website.
Pros:
- modeled after "wrist-friendly python syntax"
- On-demand compiled views (but no precompilation available)
Cons:
- designed to be written in the language Boo
Example:
<html> <head> <title>${title}</title>
</head> <body>
<p>The following items are in the list:</p>
<ul><%for element in list: output "<li>${element}</li>"%></ul>
<p>I hope that you would like Brail</p> </body>
</html>
Hasic uses VB.NET's XML literals instead of strings like most other view engines.
Pros:
- Compile-time checking of valid XML
- Syntax colouring
- Full intellisense
- Compiled views
- Extensibility using regular CLR classes, functions, etc
- Seamless composability and manipulation since it's regular VB.NET code
- Unit testable
Cons:
- Performance: Builds the whole DOM before sending it to client.
Example:
Protected Overrides Function Body() As XElement
Return _
<body>
<h1>Hello, World</h1>
</body>
End Function
Design Goals:
NDjango is an implementation of the Django Template Language on the .NET platform, using the F# language.
Pros:
- NDjango release 0.9.1.0 seems to be more stable under stress than
WebFormViewEngine - Django Template Editor with syntax colorization, code completion, and as-you-type diagnostics (VS2010 only)
- Integrated with ASP.NET, Castle MonoRail and Bistro MVC frameworks
Design Goals:
.NET port of Rails Haml view engine. From the Haml website:Haml is a markup language that's used to cleanly and simply describe the XHTML of any web document, without the use of inline code... Haml avoids the need for explicitly coding XHTML into the template, because it is actually an abstract description of the XHTML, with some code to generate dynamic content.
Pros:
- terse structure (i.e. D.R.Y.)
- well indented
- clear structure
- C# Intellisense (for VS2008 without ReSharper)
Cons:
- an abstraction from XHTML rather than leveraging familiarity of the markup
- No Intellisense for VS2010
Example:
@type=IEnumerable<Product>
- if(model.Any())
%ul
- foreach (var p in model)
%li= p.Name
- else
%p No products available
Design Goals:
Pros:
- easy to read/write
- concise view code
Cons:
- limited number of helper methods available on the view
- does not automatically have Visual Studio integration (IntelliSense, compile-time checking of views, or refactoring)
Example:
#foreach ($p in $viewdata.Model)
#beforeall
<ul>
#each
<li>$p.Name</li>
#afterall
</ul>
#nodata
<p>No products available</p>
#end
Design Goals:
Pros:
- Compact, Expressive, and Fluid
- Easy to Learn
- Is not a new language
- Has great Intellisense
- Unit Testable
Cons:
- No documented API
Design Goals:
SharpTiles is a partial port of JSTL combined with concept behind the Tiles framework (as of Mile stone 1).
Pros:
- familiar to Java developers
- XML-style code blocks
Cons:
- ...
Example:
<c:if test="${not fn:empty(Page.Tiles)}">
<p class="note">
<fmt:message key="page.tilesSupport"/>
</p>
</c:if>
Design Goals:
The idea is to allow the html to dominate the flow and the code to fit seamlessly.
Pros:
- Produces more readable templates
- C# Intellisense (for VS2008 without ReSharper)
- SparkSense plug-in for VS2010 (works with ReSharper)
- Provides a powerful Bindings feature to get rid of all code in your views and allows you to easily invent your own HTML tags
Cons:
- No clear separation of template logic from literal markup (this can be mitigated by namespace prefixes)
Example:
<viewdata products="IEnumerable[[Product]]"/>
<ul if="products.Any()">
<li each="var p in products">${p.Name}</li>
</ul>
<else>
<p>No products available</p>
</else>
<Form style="background-color:olive;">
<Label For="username" />
<TextBox For="username" />
<ValidationMessage For="username" Message="Please type a valid username." />
</Form>
Design Goals:
- Lightweight. No page classes are created.
- Fast. Templates are written to the Response Output stream.
- Cached. Templates are cached, but utilize a FileSystemWatcher to detect file changes.
- Dynamic. Templates can be generated on the fly in code.
- Flexible. Templates can be nested to any level.
- In line with MVC principles. Promotes separation of UI and Business Logic. All data is created ahead of time, and passed down to the template.
Pros:
- familiar to StringTemplate Java developers
Cons:
- simplistic template syntax can interfere with intended output (e.g. jQuery conflict)
Wing Beats is an internal DSL for creating XHTML. It is based on F# and includes an ASP.NET MVC view engine, but can also be used solely for it's capability of creating XHTML.
Pros:
- Compile-time checking of valid XML
- Syntax colouring
- Full intellisense
- Compiled views
- Extensibility using regular CLR classes, functions, etc
- Seamless composability and manipulation since it's regular F# code
- Unit testable
Cons:
- You don't really write HTML but code that represents HTML in a DSL.
Design Goals:
Builds views from familiar XSLT
Pros:
- widely ubiquitous
- familiar template language for XML developers
- XML-based
- time-tested
Cons:
- functional language style makes flow control difficult
No comments:
Post a Comment