一款基于模板的代碼生成工具Template Studio
LLBL Gen作為一個優(yōu)秀的ORM代碼生成工具,可以基于模板快速生成應(yīng)用程序代碼??赡苣阋矔扑]T4,Code Smith等模板生成器,但是先別急,先看看這篇文章作為入門教程,再來比較各自的優(yōu)勢和不足。
以第三方的模板Provide common SQL Functions for Microsoft SQL Server為例子,來講解模板生成的步驟。
設(shè)計模板
打開Template Studio,選擇TemplateBindings Viewer,點擊New按鈕,新增加一個模板TemplateBinding文件
這是方便LLBL Gen工作而進行的設(shè)定,有幾個關(guān)鍵項
For database是模板支持的數(shù)據(jù)庫類型,只可以選擇一種數(shù)據(jù)庫類型;選擇Platform表示生成的代碼可以支持的.NET Framework版本,這將影響到可以生成的Visual Studio的sln和cs/vb.proj文件的版本。Target language選擇C#,以表明生成C#代碼;Logic language表示書寫模板用的語言是TDL語法。
請在TemplateID-Filename bindings中綁定模板標(biāo)識和對應(yīng)的模板文件名稱。
TemplateBinding是一個XML格式的配置文件,其內(nèi)容如下
- <?xml version="1.0"?>
- <templateBindings xmlns="http://sd/llblgen/pro/templateBindingsDefinition.xsd"name="WB.TemplateBindings.SqlServerSpecific.NET20"
- description ="Template bindings for the templates which are specific for SqlServer based databases (7/2000/2005/CE). For .NET 2.0 based platforms"
- databaseDriverID="2D18D138-1DD2-467E-86CC-4838250611AE" precedenceLevel="10"> description ="Template bindings for the templates which are specific for SqlServer based databases (7/2000/2005/CE). For .NET 2.0 based platforms"
- databaseDriverID="2D18D138-1DD2-467E-86CC-4838250611AE" precedenceLevel="10">
- <supportedPlatforms>
- <platform name=".NET 2.0"/>
- <platform name="CF.NET 2.0"/>
- </supportedPlatforms>
- <language name="C#">
- <!-- DB Specific template bindings -->
- <templateBinding emplateID="WB.SQLSystemFunctionsTemplate" filename="SqlServerSpecificNet2.xC#WB.SQLSystemFunctions.template" />
- </language>
- </templateBindings>
這是代碼批處理生成的思想。比如我有五個模板,現(xiàn)在給這五個模板添加一個配置文件,引用到這五個模板,然后
只需要啟動配置文件,生成代碼時,會自動傳遞參數(shù)到這五個模板中,批次生成代碼。
選中WB.SQLSystemFunctionsTemplate,用快捷鍵CTRL+E,編輯它對應(yīng)的模板文件WB.SQLSystemFunctions.template。
LogicTDL語法和ASP.NET很相似,但是使用<[和]>表示模板中使用到的變量。
在《LLBLGenPro2.6SDKDocumentation》文檔的Template Sets - Template Definition Language (TDL)節(jié),提到了<[RootNamespace]>的含義,原文是Will be replaced by the specified Root namespace in the generator configuration screen,理解為取生成代碼時輸入的命名空間變量。
啟動LLBL Gen,配置生成參數(shù)
F7調(diào)出代碼生成界面,切換到Task queue to execute,Add Tasks添加一個新任務(wù),選擇類型為SD.Tasks.Base.ConsumeTDLTemplate, 這個任務(wù)將會用于編譯第一節(jié)寫的模板,并生成C#代碼。
修改參數(shù) filenameFormat=SqlFunctionCalls.[extension],templateID=WB.SQLSystemFunctionsTemplate
這其實是在配置代碼生成的preset文件,文件內(nèi)容如下
- <?xml version="1.0" encoding="utf-8"?>
- <preset name="SQL Functions" lastModifiedOn="2011-08-30T22:40:50.3165235+08:00" createdBy="Northwind" isSealed="false" xmlns="http://sd/llblgen/pro/presetElementDefinitions.xsd">
- <supportedPlatforms>
- <platform name=".NET 2.0" />
- </supportedPlatforms>
- <supportedTemplateGroups>
- <templateGroup name="Adapter" />
- </supportedTemplateGroups>
- <taskPresets>
- <taskPreset name="SD.Tasks.Base.ConsumeTDLTemplate">
- <parameters>
- <parameter name="destinationFolder" value="" />
- <parameter name="filenameFormat" value="SqlFunctionCalls.[extension]" />
- <parameter name="templateID" value="WB.SQLSystemFunctionsTemplate" />
- </parameters>
- </taskPreset>
- </taskPresets>
- </preset>
到此,已經(jīng)配置完畢,點擊Start generator按鈕,生成代碼。
模板文件的分析
再來看一下模板的作用,這個模板的作用是把內(nèi)置SQL Server系統(tǒng)中的date和string函數(shù),轉(zhuǎn)化為C#代碼。
如果要調(diào)用SQL Server中的YEAR函數(shù),可能要寫這樣的方法
- private int GetSQLServerYear()
- {
- ResultsetFields fields = new ResultsetFields(1);
- fields.DefineField(new EntityField("AFld", new DbFunctionCall("YEAR", new object[] { DateTime.Today })), 0);
- TypedListDAO dao = new TypedListDAO();
- return (int) dao.GetScalar(fields, null, null, null, null);
- }
如果使用這個模板,下面的代碼已經(jīng)為你生成好了,直接使用即可。
- private int GetSQLServerYear()
- {
- ResultsetFields fields = new ResultsetFields(1);
- fields.DefineField(new EntityField("AFld", SqlFunctionFactory.Year(DateTime.Today), 0);
- TypedListDAO dao = new TypedListDAO();
- return (int) dao.GetScalar(fields, null, null, null, null);
- }
也就是說白了,用于簡化對SQL Server函數(shù)的調(diào)用方法。
但是,上面的代碼僅僅是對SQL Server內(nèi)置的函數(shù)有作用,還沒有為用戶自定義的函數(shù)生成C#代碼,如果你有一個自定義的函數(shù)SomeFunctionToGetASetting,則需要添加一個partial的SqlFunctionFactory類,代碼如下
- public partial class SqlFunctionFactory
- {
- public static IExpression SomeFunctionToGetASetting(int someParameter)
- {
- return new DbFunctionCall("dbo", "SomeFunctionToGetASetting", new object[] { someParameter });
- }
- }
再增加一層代碼,供客戶端方便調(diào)用
- public partial class SqlFunctionCalls
- {
- private SqlFunctionCalls()
- {
- }
- public static bool SomeFunctionToGetASetting(int someParameter)
- {
- return (bool)SqlFunctionFactory.GetScalar(SqlFunctionFactory.SomeFunctionToGetASetting(someParameter));
- }
- }
最終的調(diào)用代碼像下面這樣
bool someSetting=SqlFunctionCalls.SomeFunctionToGetASetting(12);
總結(jié):LLBL Gen的模板生成器Template Studio由于其商業(yè)性的原因,普及程度不高,入門起來也沒有Code Smith/T4之類的快速,文檔少。官方認(rèn)為,大部分的可能情況下,你不需要使用到自定義模板,LLBL Gen的安裝程序包已經(jīng)附帶了完整的Adapter/SelfServicing模板。但如果要徹底的把握LLBL Gen這一ORM工具,了解和學(xué)習(xí)它的模板技術(shù),是很有必要的。
原文鏈接:http://www.cnblogs.com/JamesLi2015/archive/2011/08/31/2160285.html