动易模板解析引擎使用外部组件实战.docx

模板解析引擎使用外部组件实战

引言
随着08年3月SiteFactory CMS正式版的发布，动易网络正式拉开了下一代网站管理应用的序幕，并提供了一个高度的稳定、灵活、安全、易用的管理环境。
08年12月，动易网络正式发布了SiteFactory 2.0以及BizIeda 2.0 版本，这是一个更加重要的升级和里程碑版本。
毫无疑问，你已经知道SiteFactory独创的Xpower模板解析引擎聚合了紧密相关的多种技术，彻底改变了传统模板解析的不足和局限性。而标签解析引擎是SiteFactory中最重要的部件，你要用它去转换数据至Web呈现。
SiteFactory 的用户很容易对标签解析引擎技术感兴趣，毫不夸张的说，SiteFactory的Xpower引擎是针对转换数据呈现最为完整的技术平台。Xpower引擎输出页面的每一个字节都交给了用户进行控制、多种数据源的支持、丰富的函数库。本教程将讲述Xpower引擎对外部组件的支持。

读者对象
本教程是针对有一定服务端Web开发知识的开发者。本教程没有完整的描述教程所涉及到的每一个细节，否则，那样可能是好几本书的大辞典（比如如何去写C#代码）。相反，本教程为开发者提供精练的Xpower引擎对外部组件的技术介绍，而这类读者基本上都不想去重复那些最基本的概念。在阅读本教程的过程中，你要关注的是需要用来构建专业网站管理应用程序SiteFactory的Xpower模板解析引擎技术。
为了更好的理解本教程，你最好熟悉C#语法，XSLT转换以及面向对象的概念。如果你熟悉Java或者C++但没有用过.NET。否则你可能需要同时考虑阅读一些介绍.NET的书籍。
学习本教程的硬件和软件环境
你需要一个安装有Visual Studio（也可以选择免费Sharp Developer、Visual Studio Web Developer Express）、SiteFactory 2.0的电脑来配合阅读本教程。虽然理论上说你可以手写代码，但这是极其乏味的，并且极易出错，所以在专业环境下从来不用这种方法。
客户支持
我们非常重视读者的反馈，我们也希望能了解你对本教程的看法——哪些是你喜欢的地方，哪些是你不喜欢的地方，还有你希望我们应该在下次改进的地方，以及你更希望关注SiteFactory哪方面的教程，甚至是你觉得标签解析引擎在哪里需要改进。你可以至（动易官方论坛）参与讨论。
示例代码
在本教程的末尾有与本教程配套的示例代码，在使用这些代码之前，需要解压缩下载文件。本教程的示例代码项目版本为Visual Studio 2008 你可能需要相应或者更高的版本来打开。
模板解析引擎使用外部组件实战
（一） 建立类库项目：
如下图所示，在新建项目对话框，模板选择类库，指定名称，这里命名为Components（组件之意）完成后点确定。

Visual Studio会自动创建一个项目并且包含一个Class1.cs的文件，对这个文件单击右键将其重命名为MyUtils.cs，并且在此文件中的MyUtils类中键入下面的代码：
/// <summary>
/// 返回字符串真实长度, 1个汉字长度为2
/// </summary>
/// <returns>字符长度</returns>
public static int GetStringLength(string str)
{
return Encoding.Default.GetBytes(str).Length;
}
此主题如下：

（注意：示例源代码中包含了数十个有用的方法，简繁体转换，比较时间差等等，本教程重点在教授如何在SiteFactory标签解析引擎中使用外部组件，而非教授大家如何去编写C#代码。）
（二） 编译组件，并将组件复制到SiteFactory站点根目录下的bin文件夹中
（三） 配置站点根目录下Config文件夹中的ConsumerExtensionObject.config文件。
打开此文件后会发现这就是一个xml文件，结构良好并且严谨。下面是对属性的释义：
1. <Object>标签对：为注册一个外部程序集所必要的配置节
2. Assembly程序集：此为组件的名称，比如范例中编译完成的Components.dll
3. className类名：只有通过类名才能反射到类中所包含的方法
4. xmlns命名空间：浅显的可理解为名字空间就是给文档做一个标记
按照上文罗列的释义，配置适应刚才编译的Components.dll文件，配置代码如下：
<Object assembly="Components" className="Components.MyUtils" xmlns="MyUtils" />
（四） 配置标签模板
随意新建立一个标签，类型选择简单XSLT解析，不需要任何参数，下一步到标签内容编辑面板，在XSLT样式表的头部注册第三部我们配置的命名空间。如下所示：
<xsl:transform version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:pe="labelproc" xmlns:MyTest="MyUtils" exclude-result-prefixes="pe MyTest">
正如ConsumerExtensionObject配置文件中的一样,xmlns命名空间的名称可以任意指定，但是其值一定要与ConsumerExtensionObject配置中xmlns的的值匹配。
（五） 使用组件中的方法
在模板的模板主体部位调用方法，如下面的示例：
<xsl:value-of select="MyTest: GetStringLength('一些字符串')"/>
上面的代码将会返回数字10，也就是字符的长度。
<xsl:value-of select="MyTest:ToTChinese('卖身不卖艺')"/>
上面的代码会返回 賣身不賣藝（转为繁体）
<xsl:value-of select="MyTest:GetSourceTextByUrl('
上面的代码会返回

下面是Components组件提供的方法，这些方法是系统默认没有提供的，通过这些能够充分体现SiteFactory Xpower标签解析引擎支持外部组件的美丽体验
using System;
using System.IO;
using System.Net;
using System.Security.Cryptography;
using System.Text;
using System.Text.RegularExpressions;
using Microsoft.VisualBasic;

namespace Components
{
public class MyUtils
{
/// <summary>
/// 返回字符串真实长度, 1个汉字长度为2
/// </summary>
/// <returns>字符长度</returns>
public static int GetStringLength(string str)
{
return Encoding.Default.GetBytes(str).Length;
}

/// <summary>
/// 从字符串的指定位置截取指定长度的子字符串
/// </summary>
/// <param name="str">原字符串</param>
/// <param name="startIndex">子字符串的起始位置</param>
/// <param name="length">子字符串的长度</param>
/// <returns>子字符串</returns>
public static string CutString(string str, int startIndex, int length)
{
if (startIndex >= 0)
{
if (length < 0)
{
length = length*-1;
if (startIndex - length < 0)
{
length = startIndex;
startIndex = 0;
}
else
{
startIndex = startIndex - length;
}
}

if (startIndex > str.Length)
{
return "";
}
}
else
{
if (length < 0)
{
return "";
}
if (length + startIndex > 0)
{
length = length + startIndex;
startIndex = 0;
}
else
{
return "";
}
}

if (str.Length - startIndex < length)
{
length = str.Length - startIndex;
}

return str.Substring(startIndex, length);
}

/// <summary>
/// 从字符串的指定位置开始截取到字符串结尾的了符串
/// </summary>
/// <param name="str">原字符串</param>
/// <param name="startIndex">子字符串的起始位置</param>
/// <returns>子字符串</returns>
public static string CutString(string str, int startIndex)
{
return CutString(str, startIndex, str.Length);
}

/// <summary>
/// MD5函数
/// </summary>
/// <param name="str">原始字符串</param>
/// <returns>MD5结果</returns>
public static string MD5(string str)
{
byte[] b = Encoding.Default.GetBytes(str);
b = new MD5CryptoServiceProvider().ComputeHash(b);
string ret = "";
for (int i = 0; i < b.Length; i++)
ret += b[i].ToString("x").PadLeft(2, '0');
return ret;
}

/// <summary>
/// 字符串如果操过指定长度则将超出的部分用指定字符串代替
/// </summary>
/// <param name="p_SrcString">要检查的字符串</param>
/// <param name="p_Length">指定长度</param>
/// <param name="p_TailString">用于替换的字符串</param>
/// <returns>截取后的字符串</returns>
public static string GetSubString(string p_SrcString, int p_Length, string p_TailString)
{
return GetSubString(p_SrcString, 0, p_Length, p_TailString);
}

/// <summary>
/// 取指定长度的字符串
/// </summary>
/// <param name="p_SrcString">要检查的字符串</param>
/// <param name="p_StartIndex">起始位置</param>
/// <param name="p_Length">指定长度</param>
/// <param name="p_TailString">用于替换的字符串</param>
/// <returns>截取后的字符串</returns>
public static string GetSubString(string p_SrcString, int p_StartIndex, int p_Length, string p_TailString)
{
string myResult = p_SrcString;

Byte[] bComments = Encoding.UTF8.GetBytes(p_SrcString);
foreach (char c in Encoding.UTF8.GetChars(bComments))
{
//当是日文或韩文时(注:中文的范围:\u4e00 - \u9fa5, 日文在\u0800 - \u4e00, 韩文为\xAC00-\xD7A3)
if ((c > '\u0800' && c < '\u4e00') || (c > '\xAC00' && c < '\xD7A3'))
{
//当截取的起始位置超出字段串长度时
return p_StartIndex >= p_SrcString.Length
? ""
: p_SrcString.Substring(p_StartIndex,
((p_Length + p_StartIndex) > p_SrcString.Length)
? (p_SrcString.Length - p_StartIndex)
: p_Length);
}
}

if (p_Length >= 0)
{
byte[] bsSrcString = Encoding.Default.GetBytes(p_SrcString);

//当字符串长度大于起始位置
if (bsSrcString.Length > p_StartIndex)
{
int p_EndIndex = bsSrcString.Length;

//当要截取的长度在字符串的有效长度范围内
if (bsSrcString.Length > (p_StartIndex + p_Length))
{
p_EndIndex = p_Length + p_StartIndex;
}
else
{
//当不在有效范围内时,只取到字符串的结尾

p_Length = bsSrcString.Length - p_StartIndex;
p_TailString = "";
}

int nRealLength = p_Length;
var anResultFlag = new int[p_Length];

int nFlag = 0;
for (int i = p_StartIndex; i < p_EndIndex; i++)
{
if (bsSrcString[i] > 127)
{
nFlag++;
if (nFlag == 3)
{
nFlag = 1;
}
}
else
{
nFlag = 0;
}

anResultFlag[i] = nFlag;
}

if ((bsSrcString[p_EndIndex - 1] > 127) && (anResultFlag[p_Length - 1] == 1))
{
nRealLength = p_Length + 1;
}

var bsResult = new byte[nRealLength];

Array.Copy(bsSrcString, p_StartIndex, bsResult, 0, nRealLength);

myResult = Encoding.Default.GetString(bsResult);

myResult = myResult + p_TailString;
}
}

return myResult;
}

/// <summary>
/// 自定义的替换字符串函数
/// </summary>
public static string ReplaceString(string SourceString, string SearchString, string ReplaceString,
bool IsCaseInsensetive)
{
return Regex.Replace(SourceString, Regex.Escape(SearchString), ReplaceString,
IsCaseInsensetive ? RegexOptions.IgnoreCase : RegexOptions.None);
}

/// <summary>
/// 生成指定数量的html空格符号
/// </summary>
public static string GetSpacesString(int spacesCount)
{
var sb = new StringBuilder();
for (int i = 0; i < spacesCount; i++)
{
sb.Append(" &nbsp;&nbsp;");
}
return sb.ToString();
}

/// <summary>
/// 返回URL中结尾的文件名
/// </summary>
public static string GetFilename(string url)
{
if (url == null)
{
return "";
}
string[] strs1 = url.Split(new[] {'/'});
return strs1[strs1.Length - 1].Split(new[] {'?'})[0];
}

/// <summary>
/// 转换为简体中文
/// </summary>
public static string ToSChinese(string str)
{
return Strings.StrConv(str, VbStrConv.SimplifiedChinese, 0);
}

/// <summary>
/// 转换为繁体中文
/// </summary>
public static string ToTChinese(string str)
{
return Strings.StrConv(str, VbStrConv.TraditionalChinese, 0);
}

/// <summary>
/// 返回相差的秒数
/// </summary>
/// <param name="Time"></param>
/// <param name="Sec"></param>
/// <returns></returns>
public static int StrDateDiffSeconds(string Time, int Sec)
{
TimeSpan ts = DateTime.Now - DateTime.Parse(Time).AddSeconds(Sec);
if (ts.TotalSeconds > int.MaxValue)
{
return int.MaxValue;
}
if (ts.TotalSeconds < int.MinValue)
{
return int.MinValue;
}
return (int) ts.TotalSeconds;
}

/// <summary>
/// 返回相差的分钟数
/// </summary>
/// <param name="time"></param>
/// <param name="minutes"></param>
/// <returns></returns>
public static int StrDateDiffMinutes(string time, int minutes)
{
if (string.IsNullOrEmpty(time))
return 1;
TimeSpan ts = DateTime.Now - DateTime.Parse(time).AddMinutes(minutes);
if (ts.TotalMinutes > int.MaxValue)
{
return int.MaxValue;
}
if (ts.TotalMinutes < int.MinValue)
{
return int.MinValue;
}
return (int) ts.TotalMinutes;
}

/// <summary>
/// 返回相差的小时数
/// </summary>
/// <param name="time"></param>
/// <param name="hours"></param>
/// <returns></returns>
public static int StrDateDiffHours(string time, int hours)
{
if (string.IsNullOrEmpty(time))
return 1;
TimeSpan ts = DateTime.Now - DateTime.Parse(time).AddHours(hours);
if (ts.TotalHours > int.MaxValue)
{
return int.MaxValue;
}
if (ts.TotalHours < int.MinValue)
{
return int.MinValue;
}
return (int) ts.TotalHours;
}

/// <summary>
/// 删除最后一个字符
/// </summary>
/// <param name="str"></param>
/// <returns></returns>
public static string ClearLastChar(string str)
{
return str == "" ? "" : str.Substring(0, str.Length - 1);
}

/// <summary>
/// 根据Url获得源文件内容
/// </summary>
/// <param name="url">合法的Url地址</param>
/// <returns></returns>
public static string GetSourceTextByUrl(string url)
{
WebRequest request = WebRequest.Create(url);
request.Timeout = 20000; //20秒超时
WebResponse response = request.GetResponse();

Stream resStream = response.GetResponseStream();
var sr = new StreamReader(resStream);
return sr.ReadToEnd();
}
}
}

下面是示例代码的源文件：
在使用这些代码之前，需要解压缩下载文件