利用模板生成html頁面(NVelocity)
阿新 • • 發佈：2019-08-05
公司的網站需要有些新聞，每次的新聞格式都是一樣的，而不想每次都查詢操作，所以想把這些新聞的頁面儲存成靜態的html，之後搜尋了下就找到了這個模板引擎，當然其他的模板引擎可以的，例如：Razor，自己寫的手動替換等。NVelocity是Apache Jakarta Velocity中的一個優秀專案，有java版的（Velocity），.NET版（NVelocity），它是非常簡單，易於學習和可擴充套件的模板引擎，並且支援.NET Core.
在NVelocity中對變數的引用都是以$開頭,加上變數名稱,當使用 ! 時表示為空字串，語法都是#開頭。
語法
1. 賦值指令#set
#set($book.title="test")
2.條件指令#if if/elseif/else
#if($books.Total>1) $books.Total #else 沒有資料 #end
3.迴圈指令 #foreach
#foreach($book in $books) $book.Title #end 高階foreach #foreach($i in $items) #each 每次【迴圈】顯示的文字 #before 每次【迴圈前】顯示的文字 #after 每次【迴圈後】顯示的文字 #between 每【兩次】【迴圈】顯示的文字 #odd 奇數顯示 #even 偶數顯示 #nodata 空或者沒有資料 #beforeall 迴圈之前顯示 #afterall 迴圈之後顯示 #end
4.引用靜態資源指令 #include
#include('jquery.js') 會把當前js當作當前流插入到內容中
5.引用並解析資源指令 #parse
#parse('temo.js');
與#include不同的是,假如temp.js中有NVelocity的指令,變數進行處理,並把結果插入到當前流中;
6. 雙數執行 #even odd
#foreach(book in $books)
#even
<p>雙行：$book.Title</p>
#odd
<p>單行：$book.Title</p>
#end7. 關係運算符
AND、OR 和 NOT 操作符，分別對應&&、||和! #if($foo && $bar) #end
C#例子
1.Nuget中引用NVelocity
2.編寫模板頁（Hellovelocity.vm，也可以是Hellovelocity.html等任意的名稱字尾）
<!DOCTYPE html>
<html lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>$news.Title</title>
</head>
<body>
<h3>$news.Title</h3>
<div>
<span>$news.Desc</span>
</div>
<div>
$news.Content
</div>
</body>
</html>
3.編寫後臺程式
public static string TransformBooksToHtml(News news, string resourceTemplateName)
{
// 初始化模板引擎
VelocityEngine ve = new VelocityEngine();
ve.Init();
// 獲取模板檔案
Template t = ve.GetTemplate(resourceTemplateName);
// 設定變數
VelocityContext ctx = new VelocityContext();
ctx.Put("news", news);
// 輸出
StringWriter sw = new StringWriter();
t.Merge(ctx, sw);
string message = sw.ToString();
sw.Dispose();
File.WriteAllText($@"{DateTime.Now.ToString("yyyy-MM-dd-HH-mm-ss")}.html", sw.ToString());//生成檔案的路徑可以自由選擇
return message;
}
4. 程式呼叫
News news = new News() { Title = $"{DateTime.Now} 新聞", Desc = "新聞的描述資訊", Content = "新聞的詳細內容", CreateTime = DateTime.Now };
Console.WriteLine(MyNVelocity.TransformBooksToHtml(news, @"/NVelocityTest/Hellovelocity.html"));//這裡的模板路徑是NVelocityTest目錄下的，可以任意
5. 檢視生成的檔案
<!DOCTYPE html>
<html lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>2019/08/05 14:20:14 新聞</title>
</head>
<body>
<h3>2019/08/05 14:20:14 新聞</h3>
<div>
<span>新聞的描述資訊</span>
</div>
<div>
新聞的詳細內容
</div>
</body>
</html>
總結
NVelocity可以應用在很多地方，不僅僅侷限於生成html頁，也可以是郵件模板