Razor - 模板引擎 / 代碼生成 - RazorEngine

目錄

• Brief
• Authors
• Official Website
• RazorEngine 的原理 - 官方解釋
• 安裝記錄
• Supported Syntax (默認實現支持的語法)
• 測試記錄 - can't cleanup temp files
• 測試記錄 - Quick Start
• 測試記錄 - Configuration
• 測試記錄 - 對比 3 種 Type 的 model 的語法
• 測試記錄 - 擴展模板語法
• 測試記錄 - Layout
• 測試記錄 - Partial (@Include())
• Encoding Values - @Raw()
• RazorEngine.Razor 已廢棄，請改用 Engine.Razor
• 緩存
• 作者說: 無法稍毀緩存
• 某網文代碼
• 安全 - 只可能內部使用、不能讓用戶定義模板
• Resource - Hello World
• Resource - Advanced
• base or advanced

Brief

Open source templating engine based on Microsoft's Razor parsing engine.

Authors

• Matthew Abbott
• Ben Dornis
• Matthias Dittrich

Official Website

GitHub

• http://github.com/Antaris/RazorEngine
• http://github.com/Antaris/RazorEngine#quickstart - quick start
• http://antaris.github.io/RazorEngine - latest documentation available (官方文檔 - 截至 2016-07-24 能找到的最好的文檔)

• http://antaris.github.io/RazorEngine/ReferenceResolver.html - Reference Resolver - 截至 2016-08-20 暫未遇到應用場景，留待有需要時再深入研究。
• http://antaris.github.io/RazorEngine/Isolation.html - RazorEngine Isolation API - 截至 2016-08-20 暫未遇到應用場景，留待有需要時再深入研究。

• Resolving and Caching Templates
• http://antaris.github.io/RazorEngine/TemplateManager.html - ITemplateManager and ICachingProvider - 截至 2016-08-21 暫未遇到應用場景，留待有需要時再深入研究。

• http://antaris.github.io/RazorEngine/Upgrading.html - Upgrading RazorEngine
• http://antaris.github.io/RazorEngine/IntellisenseAndResharper.html - Intellisense and ReSharper
• http://antaris.github.io/RazorEngine/references/index.html - references

CodePlex - obsolete

• http://razorengine.codeplex.com/
• http://razorengine.codeplex.com/documentation

NuGet

Install-Package RazorEngine
Install-Package RazorEngine -Version 3.6.4
https://www.nuget.org/packages/RazorEngine/ - latest: RazorEngine 3.6.4, Friday, March 27 2015

Stack Overflow

• http://stackoverflow.com/search?q=RazorEngine - 1,100 results at 2016-08-14
• http://stackoverflow.com/questions/tagged/razorengine

RazorEngine 的原理 - 官方解釋

There is often a confusion about where Razor sits in this set of technologies. Essentially Razor is the parsing framework that does the work to take your text template and convert it into a compilable class. In terms of MVC and WebPages, they both utilise this parsing engine to convert text templates (view/page files) into executable classes (views/pages). Often we are asked questions such as "Where is @Html, @Url", etc. These are not features provided by Razor itself, but implementation details of the MVC and WebPages frameworks.

RazorEngine is another consumer framework of the Razor parser. We wrap up the instantiation of the Razor parser and provide a common framework for using runtime template processing.

-- Razor vs. MVC vs. WebPages vs. RazorEngine

安裝記錄

Installed into Net451Console via NuGet at 2016-07-31:

1. ------- 正在安裝...RazorEngine 3.9.0 -------
2. 正在嘗試解析依賴項“Microsoft.AspNet.Razor (≥ 3.0.0)”。
3. 正在安裝“Microsoft.AspNet.Razor 3.0.0”。
4. 已將文件“System.Web.Razor.dll”添加到文件夾“Microsoft.AspNet.Razor.3.0.0\lib\net45”。
5. 已將文件“System.Web.Razor.xml”添加到文件夾“Microsoft.AspNet.Razor.3.0.0\lib\net45”。
6. 已將文件“Microsoft.AspNet.Razor.3.0.0.nuspec”添加到文件夾“Microsoft.AspNet.Razor.3.0.0”。
7. 已將文件“Microsoft.AspNet.Razor.3.0.0.nupkg”添加到文件夾“Microsoft.AspNet.Razor.3.0.0”。
8. 已成功安裝“Microsoft.AspNet.Razor 3.0.0”。
9. 正在安裝“RazorEngine 3.9.0”。
10. 已將文件“RazorEngine.dll”添加到文件夾“RazorEngine.3.9.0\lib\net40”。
11. 已將文件“RazorEngine.xml”添加到文件夾“RazorEngine.3.9.0\lib\net40”。
12. 已將文件“RazorEngine.dll”添加到文件夾“RazorEngine.3.9.0\lib\net45”。
13. 已將文件“RazorEngine.xml”添加到文件夾“RazorEngine.3.9.0\lib\net45”。
14. 已將文件“LICENSE.md”添加到文件夾“RazorEngine.3.9.0”。
15. 已將文件“RazorEngine.3.9.0.nuspec”添加到文件夾“RazorEngine.3.9.0”。
16. 已將文件“RazorEngine.3.9.0.nupkg”添加到文件夾“RazorEngine.3.9.0”。
17. 已成功安裝“RazorEngine 3.9.0”。
18. 正在將“Microsoft.AspNet.Razor 3.0.0”添加到 Console。
19. 已將引用“System.Web.Razor”添加到項目“Console”
20. 已添加文件“packages.config”。
21. 已將文件“packages.config”添加到項目“Console”
22. 已成功將“Microsoft.AspNet.Razor 3.0.0”添加到 Console。
23. 正在將“RazorEngine 3.9.0”添加到 Console。
24. 已將引用“RazorEngine”添加到項目“Console”
25. 已添加文件“packages.config”。
26. 已成功將“RazorEngine 3.9.0”添加到 Console。
27. ==============================

總結: 共安裝了兩個 DLL: System.Web.Razor.dll、RazorEngine.dll。

Supported Syntax (默認實現支持的語法)

You can access several things when you use the default TemplateBase<> implementation:
* @using Custom.Namespace (see also the quick intro and assembly resolvers for custom references)
* @model ModelType
* @inherits HtmlSupportTemplateBase<ModelType> (see below)
* Set a layout (and @RenderBody() within the layout template): @{ Layout = "layout.cshtml"; }
* @Include("templateName", model = null, modelType = null) to include another template.
* Accessing the ViewBag: <h1>@ViewBag.Title</h1>
* Sections (@DefineSection, @RenderSection and @IsSectionDefined)

-- http://antaris.github.io/RazorEngine/TemplateBasics.html#Supported-syntax

測試記錄 - can't cleanup temp files

2015-10-19 Tony 在 .NET4.51 Console Application 中單步執行以下代碼時彈出命令行窗口顯示以下信息:

代碼:

1. using RazorEngine;
2. using RazorEngine.Templating;
4. namespace Net451ConsoleApplication
5. {
6. class Program
7. {
8. static void Main(string[] args)
9. {
10. // using RazorEngine.Templating; // Dont forget to include this.
11. string template = "Hello @Model.Name, welcome to RazorEngine!";
12. var result = Engine.Razor.RunCompile(template, "templateKey", null, new { Name = "World" });
13. }
14. }
15. }

信息:

1. RazorEngine: We can't cleanup temp files if you use RazorEngine on the default Appdomain.
2. Create a new AppDomain and use RazorEngine from there.
3. Read the quickstart or https://github.com/Antaris/RazorEngine/issues/244 for details!
4. You can ignore this and all following 'Please clean ... manually' messages if you are using DisableTempFileLocking, which is not recommended.
5. Please clean 'C:\Users\User0\AppData\Local\Temp\RazorEngine_********.***' manually!

每次單步執行 RazorEngine.Engine.Razor.RunCompile() 后，都會生成 1 個目錄及該目錄中的 6 個文件，該目錄及其中的全部文件的名稱都是隨機的，例如:

1. "C:\Users\User0\AppData\Local\Temp\RazorEngine_pv3sxecv.dyv\CompiledRazorTemplates.Dynamic.RazorEngine_290440367cc04e8c9d06a99a7a805d08.dll"
2. "C:\Users\User0\AppData\Local\Temp\RazorEngine_pv3sxecv.dyv\filbbops.0.cs"
3. "C:\Users\User0\AppData\Local\Temp\RazorEngine_pv3sxecv.dyv\filbbops.cmdline"
4. "C:\Users\User0\AppData\Local\Temp\RazorEngine_pv3sxecv.dyv\filbbops.err"
5. "C:\Users\User0\AppData\Local\Temp\RazorEngine_pv3sxecv.dyv\filbbops.out"
6. "C:\Users\User0\AppData\Local\Temp\RazorEngine_pv3sxecv.dyv\filbbops.tmp"

單步執行完畢后 (Tony 理解為應用程序域已終止並釋放)，其它 5 個文件已自動移除，但 .dll 文件及該目錄會殘留。以下為 4 次單步執行后的殘留:

1. "C:\Users\User0\AppData\Local\Temp\RazorEngine_bmze52rx.ovb\CompiledRazorTemplates.Dynamic.RazorEngine_a291215db8fd497cae3e4a2bfcabe7b2.dll"
2. "C:\Users\User0\AppData\Local\Temp\RazorEngine_tkidehx4.qay\CompiledRazorTemplates.Dynamic.RazorEngine_bd299256d8b94f64ba943c5a09014ed6.dll"
3. "C:\Users\User0\AppData\Local\Temp\RazorEngine_a1anyws2.vvo\CompiledRazorTemplates.Dynamic.RazorEngine_f890b330f6104de19631e25ea528a6e8.dll"
4. "C:\Users\User0\AppData\Local\Temp\RazorEngine_pv3sxecv.dyv\CompiledRazorTemplates.Dynamic.RazorEngine_290440367cc04e8c9d06a99a7a805d08.dll"

官網提供了上述問題的解決方案，2017-03-15 編寫以下代碼對該方案進行了測試，結論: 該方案在控制台程序中有效:

1. //Program.cs
3. using RazorEngine;
4. using RazorEngine.Templating;
6. namespace Net451Console
7. {
8. class Program
9. {
10. //static void Main(string[] args)
11. static int Main(string[] args)
12. {
13. bool isDefaultAppDomain = NewDomain.Switch();
14. if(isDefaultAppDomain) {
15. return 0;
16. }
18. #region test code:
19. string template = "Hello @Model.Name, welcome to RazorEngine!";
20. var result = Engine.Razor.RunCompile(template, "templateKey", null, new { Name = "World" });
21. //執行上一行后創建了 "C:\Users\User0\AppData\Local\Temp\RazorEngine_tbr5ujmj.fju" 目錄及其中的 6 個文件。
22. var isTrue = result == "Hello World, welcome to RazorEngine!";
23. #endregion test code.
25. return 123;
26. }
27. //退出 Main() 后 "C:\Users\User0\AppData\Local\Temp\RazorEngine_tbr5ujmj.fju" 目錄被刪除。
28. }
29. }

1. //NewDomain.cs
3. using System;
4. using System.Reflection;
5. using System.Security;
6. using System.Security.Permissions;
7. using System.Security.Policy;
9. namespace Net451Console
10. {
11. class NewDomain
12. {
13. /// <summary>
14. /// 如果 應用程序域 非 進程的默認應用程序域，則 不作任何處理、直接返回 false;
15. /// 如果 應用程序域 是 進程的默認應用程序域，則 創建新的應用程序域、並在該域中執行當前程序集、接着卸載該域、並返回 true。
16. /// </summary>
17. public static bool Switch()
18. {
19. bool isDefaultAppDomain = AppDomain.CurrentDomain.IsDefaultAppDomain();
20. if(!isDefaultAppDomain) {
21. return false;
22. }
24. // RazorEngine cannot clean up from the default appdomain...
25. Console.WriteLine("Switching to second AppDomain, for RazorEngine...");
27. //2017-03-15 已測試證明以下兩行代碼無用:
28. //AppDomainSetup adSetup = new AppDomainSetup();
29. //adSetup.ApplicationBase = AppDomain.CurrentDomain.SetupInformation.ApplicationBase;
30. //測試記錄: 至此 adSetup.ApplicationBase 的值為 "D:\Test\Net451Console\branches\RazorEngine\Net451Console\bin\Debug\"。
32. // You only need to add strongnames when your appdomain is not a full trust environment.
33. AppDomain domain = AppDomain.CreateDomain(
34. "MyMainDomain",
35. null,
36. AppDomain.CurrentDomain.SetupInformation,
37. new PermissionSet(PermissionState.Unrestricted),
38. new StrongName[0]
39. );
40. string location = Assembly.GetExecutingAssembly().Location;
41. //測試記錄: 至此 location 的值為 "D:\Test\Net451Console\branches\RazorEngine\Net451Console\bin\Debug\Net451Console.exe"。
42. int exitCode = domain.ExecuteAssembly(location);
43. //執行上一行的 domain.ExecuteAssembly() 導致重新執行 Main()，屆時 isDefaultAppDomain 為 false，將跳過本方法主體轉而執行 Mian() 中的剩余代碼，Main() 的返回值將成為上一行的返回值並賦給 exitCode，接着執行下 2 行代碼，最后退出本方法。
44. // Note that you need to Unload the domain to trigger cleanup.
45. // RazorEngine will cleanup.
46. AppDomain.Unload(domain);
47. //執行上一行后 "C:\Users\User0\AppData\Local\Temp\RazorEngine_tbr5ujmj.fju" 目錄中的 6 個文件僅剩下 1 個 .dll 文件。
48. return true;
49. }
50. }
51. }

測試記錄 - 以上方案僅在控制台程序中有效、在 ASP.NET MVC 中無效

1. 在 ASP.NET MVC 中 AppDomain.CurrentDomain.IsDefaultAppDomain() 總是返回 false。
2. 執行 Assembly.GetExecutingAssembly().Location 返回 C:\Users\User0\AppData\Local\Temp\Temporary ASP.NET Files\root\b54c3416\14425600\assembly\dl3\57a31749\d172b5e9_d29fd201\Net451MvcNoAuth.dll，接着執行下一行 domain.ExecuteAssembly(location) 報錯 異常詳細信息: System.MissingMethodException: 未在程序集“Net451MvcNoAuth, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null”中找到入口點。。

測試記錄 - Quick Start

以下測試代碼整理自 http://antaris.github.io/RazorEngine/index.html#Quickstart:

1. using RazorEngine;
2. using RazorEngine.Templating;
4. namespace Net451Console
5. {
6. class Program
7. {
8. //static void Main(string[] args)
9. static int Main(string[] args)
10. {
11. bool isDefaultAppDomain = NewDomain.Switch();
12. if(isDefaultAppDomain) {
13. return 0;
14. }
16. #region test code:
17. //All you need to do is use the static Engine class (the Engine.Razor instance) in the 'RazorEngine' namespace:
18. string template = "Hello @Model.Name, welcome to RazorEngine!";
19. string key = "templateKey";
20. var result0 = Engine.Razor.RunCompile(template, key, null, new { Name = "World" });
22. //The "templateKey" must be unique and after running the above example you can re-run the cached template with this key.
23. var result1 = Engine.Razor.Run(key, null, new { Name = "Max" });
25. //The null parameter is the modelType and null in this case means we use dynamic as the type of the model. You can use a static model as well by providing a type object.
26. var result2 = Engine.Razor.RunCompile(key, typeof(Person), new Person { Name = "Max" });
27. //Note that we now re-compile the model with a different type. When you do not run the same template a lot of times (like several 1000 times), compiling uses the most time. So the benefit you get from a static type will most likely not compensate the additional compile time. Therefore you should either stick to one type for a template (best of both worlds) or just use (the slower) dynamic (null). You can specify the modelType of a template with the @model directive. When you do this the modelType parameter is ignored, but you should use the same type instance (or null) on every call to prevent unnecessary re-compilations because of type mismatches in the caching layer.
28. #endregion test code.
30. return 123;
31. }
32. }
33. public class Person
34. {
35. public string Name { get; set; }
36. }
37. }

測試記錄 - Configuration

以下測試代碼整理自 http://antaris.github.io/RazorEngine/index.html#Configuration:

1. using RazorEngine;
2. using RazorEngine.Configuration;
3. using RazorEngine.Templating;
4. using RazorEngine.Text;
6. namespace Net451Console
7. {
8. class Program
9. {
10. //static void Main(string[] args)
11. static int Main(string[] args)
12. {
13. bool isDefaultAppDomain = NewDomain.Switch();
14. if(isDefaultAppDomain) {
15. return 0;
16. }
18. #region test code:
19. //You can configure RazorEngine with the TemplateServiceConfiguration class.
20. var config = new TemplateServiceConfiguration();
22. // ... configure your instance
24. //General Configuration
25. //By default RazorEngine is configured to encode using Html. This supports the majority of users but with some configuration changes you can also set it to encode using Raw format which is better suited for templates that generate things like javascript, php, C# and others.
26. config.Language = Language.CSharp; // C# as template language.
27. config.EncodedStringFactory = new RawStringFactory(); // Raw string encoding.
28. //config.EncodedStringFactory = new HtmlEncodedStringFactory(); // Html encoding.
30. //One thing you might want to enable is the debugging feature:
31. config.Debug = true;
33. IRazorEngineService service = RazorEngineService.Create(config);
35. //If you want to use the static Engine class with this new configuration:
36. Engine.Razor = service;
38. //When Debug is true you can straight up debug into the generated code. RazorEngine also supports debugging directly into the template files (normally .cshtml files). As as you might see in the above code there is no file to debug into. To provide RazorEngine with the necessary information you need to tell where the file can be found:
39. string template = "Hello @Model.Name, welcome to RazorEngine!";
40. string templateFile = "d:/mytemplate.cshtml";
41. // Provide a non-null file to improve debugging
42. var loadedTemplateSource = new LoadedTemplateSource(template, templateFile);
43. var result = Engine.Razor.RunCompile(loadedTemplateSource, "templateKey", null, new { Name = "World" });
44. //This time when debugging the template you will jump right into the template file.
45. #endregion test code.
47. return 123;
48. }
49. }
50. }

上述代碼中的 d:/mytemplate.cshtml 的測試記錄:

• 該文件中的斷點有效。
• 該文件的內容與 template 的值無關。
• 該文件的內容可為任意字符 (包括空文件)。
• 該文件不能放在 Windows10 的 C 分區，否則會因為訪問權限而報錯。

測試記錄 - 對比 3 種 Type 的 model 的語法

以下測試代碼整理自 http://antaris.github.io/RazorEngine/TemplateBasics.html:

1. using RazorEngine;
2. using RazorEngine.Templating;
3. using System.Dynamic;
5. namespace Net451Console
6. {
7. class Program
8. {
9. //static void Main(string[] args)
10. static int Main(string[] args)
11. {
12. bool isDefaultAppDomain = NewDomain.Switch();
13. if(isDefaultAppDomain) {
14. return 0;
15. }
17. #region test code:
18. string template = "<div>Hello @Model.Name</div>";
20. var model0 = new Person { Name = "Matt" }; //statically type
21. var model1 = new { Name = "Matt" }; //anonymous type
22. dynamic model2 = new ExpandoObject(); //dynamic type
23. model2.Name = "Matt"; //dynamic type
25. string result0 = Engine.Razor.RunCompile(template, "key0", typeof(Person), model0); //statically type
26. string result1 = Engine.Razor.RunCompile(template, "key1", null, model1); //anonymous type
27. string result2 = Engine.Razor.RunCompile(template, "key2", null, (object)model2); //dynamic type
28. //執行至此 result0-2 均為 "<div>Hello Matt</div>"。
29. #endregion test code.
31. return 123;
32. }
33. }
35. public class Person
36. {
37. public string Name { get; set; }
38. }
39. }

測試記錄 - 擴展模板語法

以下測試代碼整理自 http://antaris.github.io/RazorEngine/TemplateBasics.html#Extending-the-template-Syntax:

1. using RazorEngine.Configuration;
2. using RazorEngine.Templating;
3. using RazorEngine.Text;
4. using System;
6. namespace Net451Console
7. {
8. class Program
9. {
10. //static void Main(string[] args)
11. static int Main(string[] args)
12. {
13. bool isDefaultAppDomain = NewDomain.Switch();
14. if(isDefaultAppDomain) {
15. return 0;
16. }
18. #region test code:
19. var config = new TemplateServiceConfiguration();
20. // You can use the @inherits directive instead (this is the fallback if no @inherits is found).
21. config.BaseTemplateType = typeof(HtmlSupportTemplateBase<>);
22. using(var service = RazorEngineService.Create(config)) {
23. string template0 = "@Model.Data";
24. string template1 = "@Html.Raw(Model.Data)";
25. string data = "My raw double quotes appears here \"hello!\"";
26. var model = new { Data = data };
28. string result0 = service.RunCompile(template0, "htmlRawTemplate0", null, model);
29. string result1 = service.RunCompile(template1, "htmlRawTemplate1", null, model);
31. if(result0 == "My raw double quotes appears here "hello!"") {
32. Console.WriteLine("* 默認行為: 引號被 HTML 實體編碼。");
33. }
34. if(result1 == data) {
35. Console.WriteLine("* @Html.Raw() 原樣輸出。");
36. }
37. }
38. #endregion test code.
40. return 123;
41. }
42. }
44. public class MyHtmlHelper
45. {
46. public IEncodedString Raw(string rawString)
47. {
48. return new RawString(rawString);
49. }
50. }
52. public abstract class HtmlSupportTemplateBase<T> : TemplateBase<T>
53. {
54. //public MyClassImplementingTemplateBase()
55. public HtmlSupportTemplateBase()
56. {
57. Html = new MyHtmlHelper();
58. }
59. public MyHtmlHelper Html { get; set; }
60. }
61. }

測試記錄 - Layout

以下測試代碼整理自 http://antaris.github.io/RazorEngine/LayoutAndPartial.html#Layout-template:

1. using RazorEngine;
2. using RazorEngine.Templating;
4. namespace Net451Console
5. {
6. class Program
7. {
8. //static void Main(string[] args)
9. static int Main(string[] args)
10. {
11. bool isDefaultAppDomain = NewDomain.Switch();
12. if(isDefaultAppDomain) {
13. return 0;
14. }
16. #region test code:
17. IRazorEngineService service = Engine.Razor;
18. service.AddTemplate("Layout0", @"<html>@RenderBody()</html>");
19. service.AddTemplate("Layout1", @"<body>@RenderBody()</body>@{ Layout = ""Layout0""; }");
20. service.AddTemplate("Layout2", @"<div> @RenderBody()</div> @{ Layout = ""Layout1""; }");
21. service.AddTemplate("templet", @"<h1> content in h1</h1> @{ Layout = ""Layout2""; }");
22. service.Compile("templet");
23. string result = service.Run("templet");
24. bool isTrue = result == "<html><body><div> <h1> content in h1</h1> </div> </body></html>";
25. #endregion test code.
27. return 123;
28. }
29. }
30. }

測試記錄 - Partial (@Include())

以下測試代碼整理自 http://antaris.github.io/RazorEngine/LayoutAndPartial.html#Partial-templates:

1. using RazorEngine;
2. using RazorEngine.Templating;
4. namespace Net451Console
5. {
6. class Program
7. {
8. //static void Main(string[] args)
9. static int Main(string[] args)
10. {
11. bool isDefaultAppDomain = NewDomain.Switch();
12. if(isDefaultAppDomain) {
13. return 0;
14. }
16. #region test code:
17. var service = Engine.Razor;
18. service.AddTemplate("part", @"my template");
19. // If you leave the second and third parameters out the current model will be used.
20. // If you leave the third we assume the template can be used for multiple types and use "dynamic".
21. // If the second parameter is null (which is default) the third parameter is ignored.
22. // To workaround in the case you want to specify type "dynamic" without specifying a model use Include("p", new object(), null)
23. service.AddTemplate("template", @"<h1>@Include(""part"", @Model.SubModel, typeof(Net451Console.SubModel))</h1>");
24. service.Compile("template", typeof(MyModel));
25. service.Compile("part", typeof(SubModel));
26. var result = service.Run(
27. "template",
28. typeof(MyModel),
29. new MyModel {
30. ModelProperty = "model",
31. SubModel = new SubModel { SubModelProperty = "submodel" }
32. }
33. );
34. bool isTrue = result == "<h1>my template</h1>";
35. #endregion test code.
37. return 123;
38. }
39. }
41. public class SubModel
42. {
43. public string SubModelProperty { get; set; }
44. }
46. public class MyModel
47. {
48. public string ModelProperty { get; set; }
49. public SubModel SubModel { get; set; }
50. }
51. }

測試發現很多參數都可省略:

1. using RazorEngine;
2. using RazorEngine.Templating;
4. namespace Net451Console
5. {
6. class Program
7. {
8. //static void Main(string[] args)
9. static int Main(string[] args)
10. {
11. bool isDefaultAppDomain = NewDomain.Switch();
12. if(isDefaultAppDomain) {
13. return 0;
14. }
16. #region test code:
17. var service = Engine.Razor;
18. service.AddTemplate("part", @"Text in the part.");
19. service.AddTemplate("template", @"<h1>@Include(""part"")</h1>");
20. service.Compile("template");
21. service.Compile("part");
22. var result = service.Run("template");
23. bool isTrue = result == "<h1>Text in the part.</h1>";
24. #endregion test code.
26. return 123;
27. }
28. }
29. }

Encoding Values - @Raw()

以下測試代碼整理自 http://antaris.github.io/RazorEngine/Encoding.html:

1. using RazorEngine;
2. using RazorEngine.Templating;
4. namespace Net451Console
5. {
6. class Program
7. {
8. //static void Main(string[] args)
9. static int Main(string[] args)
10. {
11. bool isDefaultAppDomain = NewDomain.Switch();
12. if(isDefaultAppDomain) {
13. return 0;
14. }
16. #region test code:
17. //By default RazorEngine is configured to encode as Html. This sometimes this presents problems were certain characters are encoded as Html but what you want is to output them as-is. To output something in raw format use the @Raw() built-in method as shown in the following example:
18. string template0 = "@Model.Data";
19. string template1 = "@Raw(Model.Data)";
20. var model = new { Data = "My raw double quotes appears here \"hello!\"" };
21. string result0 = Engine.Razor.RunCompile(template0, "templateKey0", null, model);
22. string result1 = Engine.Razor.RunCompile(template1, "templateKey1", null, model);
23. bool isTrue0 = result0 == @"My raw double quotes appears here "hello!"";
24. bool isTrue1 = result1 == @"My raw double quotes appears here ""hello!""";
25. #endregion test code.
27. return 123;
28. }
29. }
30. }

測試記錄 - 不支持 @Html.Raw()

執行 string test = Engine.Razor.RunCompile(@"@Html.Raw(""asdf"")", "key", null, string.Empty); 時拋出異常 "當前上下文中不存在名稱“Html”"。

RazorEngine.Razor 已廢棄，請改用 Engine.Razor

1. #region 程序集 RazorEngine.dll, v3.9.0.0
2. // D:\Test\Net451Console\branches\RazorEngine\packages\RazorEngine.3.9.0\lib\net45\RazorEngine.dll
3. #endregion
5. namespace RazorEngine
6. {
7. [Obsolete("Please use the Engine.Razor instance instead.")]
8. public static class Razor {
9. public static void Compile(string razorTemplate, string name);
10. ...
11. public static ITemplate CreateTemplate(string razorTemplate);
12. ...
13. public static ITemplate GetTemplate(string razorTemplate, string name);
14. ...
15. public static string Parse(string razorTemplate);
16. ...
17. public static ITemplate Resolve(string name);
18. ...
19. public static string Run(string name);
20. ...
21. public static void SetTemplateService(ITemplateService service);
22. }
23. }

緩存

1. How are templates in RazorEngine cached?
2. Antaris RazorEngine How to Recompile a template using the same Key?
3. RazorEngine Memory Usage
4. RazorEngine IsolatedTemplateService is not preventing growth of number of loaded assemblies
5. Use external cache provider for RazorEngine
6. Memcached Caching Provider and Serialization Issue #278

作者說: 無法稍毀緩存

When you change and recompile templates you have a memory leak, because you cannot unload loaded assemblies (which RazorEngine compiles and loads for you in the background).

The only way to really free the memory is to reload the AppDomain or restart the process.

-- http://stackoverflow.com/questions/14369614/razorengine-un-cache-compiled-templates

• RazorEngine un-cache compiled templates
• http://github.com/Antaris/RazorEngine/issues/232#issuecomment-128802285
• Essential Templating - is a set of libraries to render templated objects (like web pages or emails).

某網文代碼

《ASP.NET MVC 解析模板生成靜態頁一 (RazorEngine)》 全文共兩部分: 1. 基本的單數據模型模板解析; 2. 面向接口的多數據模型模板解析。該網文僅涉及到 RazorEngine 最基礎的 API，未展示 Hello World 之外的功能。以下為第一部分的原始代碼 (未改動、僅格式化)。第二部分核心代碼與第一部分完全相同，僅增加了 TemplateView 模型解析類中間件、Repository、泛型、面向接口、Spring 依賴注入、反射賦值，所有這些增加的部分都是面向對象與設計模式的半桶水套路，無作用無意義徒增壞味道，跳過。

1. public class Articles
2. {
3. public int Id { get; set; }
4. public string Title { get; set; }
5. public string Content { get; set; }
6. public string Author { get; set; }
7. public DateTime CreateDate { get; set; }
8. }

1. <html xmlns="http://www.w3.org/1999/xhtml">
2. <head>
3. <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
4. <title>@Model.Title</title>
5. </head>
6. <body>
7. <h1>@Model.Title</h1>
8. <p>作者：@Model.Author - 發布時間：@Model.CreateDate</p>
9. <p>@Raw(Model.Content)</p>
10. </body>
11. </html>

1. /// <summary>
2. /// 獲取頁面的Html代碼
3. /// </summary>
4. /// <param name="url">模板頁面路徑</param>
5. /// <param name="encoding">頁面編碼</param>
6. public string GetHtml(string url, System.Text.Encoding encoding)
7. {
8. byte[] buf = new WebClient().DownloadData(url);
9. if(encoding != null){
10. return encoding.GetString(buf);
11. }
12. string html = System.Text.Encoding.UTF8.GetString(buf);
13. encoding = GetEncoding(html);
14. if(encoding == null || encoding == System.Text.Encoding.UTF8){
15. return html;
16. }
17. return encoding.GetString(buf);
18. }
20. /// <summary>
21. /// 獲取頁面的編碼
22. /// </summary>
23. /// <param name="html">Html源碼</param>
24. public System.Text.Encoding GetEncoding(string html)
25. {
26. string pattern = @"(?i)/bcharset=(?<charset>[-a-zA-Z_0-9]+)";
27. string charset = Regex.Match(html, pattern).Groups["charset"].Value;
28. try{
29. return System.Text.Encoding.GetEncoding(charset);
30. }
31. catch(ArgumentException){
32. return null;
33. }
34. }

1. /// <summary>
2. /// 創建靜態文件
3. /// </summary>
4. /// <param name="result">Html代碼</param>
5. /// <param name="createpath">生成路徑</param>
6. public bool CreateFileHtmlByTemp(string result, string createpath)
7. {
8. if(!string.IsNullOrEmpty(result)) {
9. if(string.IsNullOrEmpty(createpath)) {
10. createpath = "/default.html";
11. }
12. string filepath = createpath.Substring(createpath.LastIndexOf(@"/"));
13. createpath = createpath.Substring(0, createpath.LastIndexOf(@"/"));
14. if (!Directory.Exists(createpath)) {
15. Directory.CreateDirectory(createpath);
16. }
17. createpath = createpath + filepath;
18. try {
19. FileStream fs2 = new FileStream(createpath, FileMode.Create);
20. StreamWriter sw = new StreamWriter(fs2, new System.Text.UTF8Encoding(false));//去除UTF-8 BOM
21. sw.Write(result);
22. sw.Close();
23. fs2.Close();
24. fs2.Dispose();
25. return true;
26. }
27. catch { return false; }
28. }
29. return false;
30. }

1. /// <summary>
2. /// 解析模板生成靜態頁
3. /// </summary>
4. /// <param name="temppath">模板地址</param>
5. /// <param name="path">靜態頁地址</param>
6. /// <param name="t">數據模型</param>
7. public bool CreateStaticPage(string temppath, string path, Articles t)
8. {
9. try {
10. //獲取模板Html
11. string TemplateContent = GetHtml(temppath, System.Text.Encoding.UTF8);
12. //解析模板生成靜態頁Html代碼
13. string result = Razor.Parse(TemplateContent, t);
14. //創建靜態文件
15. return CreateFileHtmlByTemp(result, path);
16. }
17. catch (Exception e) {
18. throw e;
19. }
20. }

安全 - 只可能內部使用、不能讓用戶定義模板

1. How dangerous is it to let users specify RazorEngine templates?
2. RazorEngine for user templates - Security?
3. ASP.NET Razor templates editable by users - remove @ for security reasons

Resource - Hello World

1. 利用 RazorEngine 打造簡單的泛用代碼生成器 - 基於 ExpandoObject
2. 利用 RazorEngine 更加直觀的格式化字符串 - Note: 反射取值的 Regex.Replace() 有實用價值

Resource - Advanced

1. 第四篇 基於 .NET 搭建熱插拔式 Web 框架 (RazorEngine 實現)
2. 用 Razor 語法寫範本 - RazorEngine 組件介紹
3. 讓 Windows2003 Server NET4.0 Frameworks 可以上使用 RazorEngine 程序集
4. C# 模板引擎 RazorEngine 3.7 的簡單使用
5. RazorEngine 在非 MVC 下的使用，以及使用自定義模板
6. .NET MVC Razor 也可以這樣玩
7. 在 ASP.NET WebAPI 中使用 Razor
8. DIY RazorEngine 的程序集生成方式
9. 拋棄 NVelocity，來玩玩 Razor - 文件嵌套、@Include()
10. Razor Engine，實現代碼生成器的又一件利器
11. Razor 模板引擎使用 - 緩存源碼?
12. C# & SQlite 代碼生成器 - 非 HTML 模板示例
13. Razor 模板引擎 - 緩存測試 & 封裝
14. 使用 Razor 模板構建應用注意的細節

base or advanced

1. 用 Razor 語法寫範本 - RazorEngine 組件介紹
2. 用 Razor 語法寫範本 - RazorEngine 組件介紹
3. 讓 Windows2003 Server NET4.0 Frameworks 可以上使用 RazorEngine 程序集
4. RazorEngine - @Html.LabelFor OK, @Html.EditorFor "not implemented exception" on Execute()
5. Dynamic CSS using Razor Engine
6. Razor Templating Engine
7. 代碼生成就用 Razor 模板
8. C# 模板引擎 RazorEngine 3.7 的擴展 — 引入外部文件
9. C# 模板引擎 RazorEngine 3.7 的擴展 — 引用布局頁
10. 在非網頁程序里使用 Razor 模板引擎
11. ASP.NET MVC 解析模板生成靜態頁一 (RazorEngine) - 詳見本文 "某網文代碼" 小節
12. DIY RazorEngine 的程序集生成方式