Code Generator for Resource

2010-12-30

3914
0

問題描述

當使用Resource檔來獲取資源(圖片、文字)時，如下列所示，會導致一些問題。

string msg = MessageHelper.GetMessage(DCMSConfigurationType.DataModelQueryDesigner, “Wrn_005”);

Wrn_005 為 string，可能會手誤打錯
當Resx檔移除Wrn_005，使用到Wrn_005的Client端仍然不會發生任何的錯誤或警告訊息

解決方案描述

自製一個Code Generator 小工具使用 T4 Template技術，可以根據resx檔產生對應的類別包含字串

產生的類別如下所示:

using System;
namespace Digiwin.Designer.Utilities.Resources 
{
	// Note: Attributes, access modifiers, inheritance and template parameter constraints
	//       can be added in another partial type definition.

		public static partial class DataModelQueryDesignerResourcesConst
		{
			public const string DMQG_ROOT_NODE = "DMQG_root_node";
			public const string DMQ_COLUMNS_NODE = "DMQ_columns_node";
			...
		}

}

使用後，Client使用方式可改成

MessageHelper.GetMessage(DCMSConfigurationType.DataModelQueryDesigner, DataModelQueryDesignerResourcesConst.WRN_005);

Resource字串(如Wrn_005) 可以獲得靜態程式碼檢查，並且避免手誤

解決方案

加入一個附檔名.tt的檔案(EX: Template.tt)
貼上下列的內容，修改 inputFile 及 NameSpace

<#

//相對於此tt檔的相對路徑 <= resource 檔名

var inputFile = "DataModelQueryDesignerResources.resx";

//欲產生的NameSpace

var nameSpace = "Digiwin.Designer.Utilities.Resources";

#>

<#

string templateDirectory = Path.GetDirectoryName(Host.TemplateFile);

var test = RexGenerator.Class(Path.Combine(templateDirectory, inputFile), nameSpace) ;

#>

<#= test #>

<#@ include file="Rex.ttinclude"#>