.NET10 Razor Template Engine
.NET10 Razor Template Engine. No legacy code. No breaking changes.
Install-Package RazorEngineCore✅ Feel free to create new issues and vote for existing ones!
template.Run(object model = null)
template.RunAsync(object model = null)
template.Run(TModel model = null)
template.RunAsync(TModel model = null)RazorEngineCore is not HTML safe by default.
It can be easily turned on: see #65 and @Raw
IRazorEngine razorEngine = new RazorEngine();
IRazorEngineCompiledTemplate template = razorEngine.Compile("Hello @Model.Name");
string result = template.Run(new
{
Name = "Alexander"
});
Console.WriteLine(result);IRazorEngine razorEngine = new RazorEngine();
string templateText = "Hello @Model.Name";
// yeah, heavy definition
IRazorEngineCompiledTemplate> template = razorEngine.Compile>(templateText);
string result = template.Run(instance =>
{
instance.Model = new TestModel()
{
Name = "Hello",
Items = new[] {3, 1, 2}
};
});
Console.WriteLine(result);Compile template with IncludeDebuggingInfo() option and call EnableDebugging() before running template. If template was compiled with IncludeDebuggingInfo() option, saving and loading will keep original template source code and pdb.
IRazorEngineCompiledTemplate template2 = razorEngine.Compile(templateText, builder =>
{
builder.IncludeDebuggingInfo();
});
template2.EnableDebugging(); // optional path to output directory
string result = template2.Run(new
{
Title = "Welcome"
});Place @{ Breakpoint(); } anywhere in template to stop at.
Most expensive task is to compile template, you should not compile template every time you need to run it
IRazorEngine razorEngine = new RazorEngine();
IRazorEngineCompiledTemplate template = razorEngine.Compile("Hello @Model.Name");
// save to file
template.SaveToFile("myTemplate.dll");
//save to stream
MemoryStream memoryStream = new MemoryStream();
template.SaveToStream(memoryStream);IRazorEngineCompiledTemplate template1 = RazorEngineCompiledTemplate.LoadFromFile("myTemplate.dll");
IRazorEngineCompiledTemplate template2 = RazorEngineCompiledTemplate.LoadFromStream(myStream);IRazorEngineCompiledTemplate template1 = RazorEngineCompiledTemplate.LoadFromFile("myTemplate.dll");
IRazorEngineCompiledTemplate template2 = RazorEngineCompiledTemplate.LoadFromStream(myStream);RazorEngineCore is not responsible for caching. Each team and project has their own caching frameworks and conventions therefore making it impossible to have builtin solution for all possible needs.
If you dont have one, use following static ConcurrentDictionary example as a simplest thread safe solution.
private static ConcurrentDictionary TemplateCache = new ConcurrentDictionary();private string RenderTemplate(string template, object model)
{
int hashCode = template.GetHashCode();
IRazorEngineCompiledTemplate compiledTemplate = TemplateCache.GetOrAdd(hashCode, i =>
{
RazorEngine razorEngine = new RazorEngine();
return razorEngine.Compile(Content);
});
return compiledTemplate.Run(model);
}Or use RazorTemplateCache.cs
static void CachedHtmlSafeExample()
{
string result = RazorTemplateCache.RenderHtmlSafe("Hello
@Model.Name
", new { Name = "Alex" });
Console.WriteLine(result);
}ASP.NET Core way of defining template functions:
@{ RecursionTest(3); }
@{
void RecursionTest(int level)
{
if (level template = razorEngine.Compile(content);
string result = template.Run(instance =>
{
instance.A = 10;
instance.B = "Alex";
});
Console.WriteLine(result);public class CustomTemplate : RazorEngineTemplateBase
{
public int A { get; set; }
public string B { get; set; }
public string Decorator(object value)
{
return "-=" + value + "=-";
}
}Keep your templates as simple as possible, if you need to inject "unusual" assemblies most likely you are doing it wrong.
Writing @using System.IO in template will not reference System.IO assembly, use builder to manually reference it.
IRazorEngine razorEngine = new RazorEngine();
IRazorEngineCompiledTemplate compiledTemplate = razorEngine.Compile(templateText, builder =>
{
builder.AddAssemblyReferenceByName("System.Security"); // by name
builder.AddAssemblyReference(typeof(System.IO.File)); // by type
builder.AddAssemblyReference(Assembly.Load("source")); // by reference
});
string result = compiledTemplate.Run(new { name = "Hello" });This package is inspired by Simon Mourier SO post
No open issues yet, or sync has not completed.