在.Net中使用msxsl:script脚本块扩展XSLT的具体实践与应用

一概述

XSLT可以用于将XML格式的数据转换为其它格式，在数据和展示分开以及数据相互转换中可以得到广泛的应用，比较典型的是以前的动网论坛模板系统以及动易的标签系统。掌握好XSLT可以灵活的处理XML，同时运用在Web应用程序中也非常的方便，不过缺点是使用者需要掌握大量的XPath、XSLT、XML等相关知识。

在XSLT中，可以直接使用脚本语言如Javascript输出到Html中，进行相关的客户端操作，由于一些限制，XSLT提供的函数可能不能达到一些复杂的数据处理效果，这个时候就需要使用扩展脚本块的功能，这样就可以使用C#等强类型的语言进行相关的数据处理工作。

在.Net中可以进行XSLT转换功能的类是XslCompiledTransform ，具体参考msdn.microsoft.com/zh-tw/library/system.xml.xsl.xslcompiledtransform(zh-cn).aspx

关于本文叙述的内容可以参考http://msdn.microsoft.com/zh-tw/library/wxaw5z5e(zh-cn).aspx

关于Xslt以及XPath可在网上参考相关文档。

二实现msxsl:script的功能

下面举一个例子实现该功能

1，新建一Web应用程序项目

2，在项目中添加一个Xml文件News.xml，内容如下：

1. <?xml version="1.0" encoding="utf-8" ?> 
2. <AllNews> 
3. <News Author="Raymond"> 
4.     <Title>测试新闻标题1test test</Title> 
5.     <Content>这里是新闻的内容</Content> 
6. </News> 
7. <News Author="Jack"> 
8.     <Title>测试新闻标题2 test test test</Title> 
9.     <Content>这里是新闻的内容</Content> 
10. </News> 
11. <News Author="Tom"> 
12.     <Title>测试新闻标题3 test test test test</Title> 
13.     <Content>这里是新闻的内容</Content> 
14. </News> 
15. </AllNews> 

3，新建一个Xslt文件News.xslt，用于将Xml转换为Html内容如下：

1. <?xml version="1.0" encoding="utf-8"?> 
2. <xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" 
3.     xmlns:msxsl="urn:schemas-microsoft-com:xslt" exclude-result-prefixes="msxsl" 
4. > 
5.     <xsl:output method="html" indent="yes"/> 
6.  
7.     <xsl:template match="/"> 
8.       <xsl:call-template name="style"/> 
9.       <xsl:call-template name="showNews"> 
10.         <xsl:with-param name="news" select="AllNews/News"/> 
11.       </xsl:call-template> 
12.     </xsl:template> 
13.  
14. <xsl:template name="style"> 
15.     <style> 
16.       .title{font-size:14px;font-weight:bold;color:White;background-color:#000000;} 
17.       div.newsBlock{border:1px dashed #000000;padding:5px;margin-bottom:10px;background-color:Gray;} 
18.       div.content{text-indent:2em;} 
19.     </style> 
20. </xsl:template> 
21.  
22. <!--展示新闻--> 
23. <xsl:template name="showNews"> 
24.     <xsl:param name="news"/> 
25.     <xsl:for-each select="$news"> 
26.       <div class="newsBlock"> 
27.         <div class="title"> 
28.           <xsl:value-of select="Title"/> 
29.         </div> 
30.         <div class="content"> 
31.           <xsl:value-of select="Content"/>(<xsl:value-of select="@Author"/>) 
32.         </div> 
33.       </div> 
34.     </xsl:for-each> 
35. </xsl:template> 
36. </xsl:stylesheet> 

4，在Web项目的Default.aspx.cs中添加解析Xml的代码并且输出：

添加代码如下：

1. protected void Page_Load(object sender, EventArgs e) 
2.         { 
3.             this.ShowNews(); 
4.         } 
5.  
6.         /// <summary> 
7.         /// 转换Xml并且显示新闻 
8.         /// </summary> 
9.         private void ShowNews() 
10.         { 
11.             //实例化 
12.             XslCompiledTransform transform = new XslCompiledTransform(); 
13.             //加载样式表 
14.             transform.Load(Server.MapPath("News.xslt")); 
15.             //转换并且输出 
16.             transform.Transform(Server.MapPath("News.xml"), null, Response.OutputStream); 
17.         } 

浏览Default.aspx 我们可以看到效果如下：

这样数据就正确的显示出来了

5，添加脚本块

我们试想一种情况，Xml中的一些数据可能通过xslt的函数无法处理那么这个时候我们需要借助于其他语言进行处理，这个时候我们可以考虑使用扩展脚本块来实现。

这里举一个例子，我们将新闻的标题仅显示前边7个字符，我们通过扩展的C#函数来处理（当然直接通过xslt的substring可以直接处理，这里仅举例而已，在一些情况下xslt自带函数无法实现很多跟业务逻辑层、数据层等相关的操作的情况下可以使用此方法）。

5.1，新建一个类库项目AssemblyTest

添加类XsltTest

1. using System; 
2. using System.Collections.Generic; 
3. using System.Linq; 
4. using System.Text; 
5.  
6. namespace AssemblyTest 
7. { 
8.     public class XsltTest 
9.     { 
10.         /// <summary> 
11.         /// 返回缩减的标题 
12.         /// </summary> 
13.         /// <param name="title"></param> 
14.         /// <returns></returns> 
15.         public static string GetTitle(string title) 
16.         { 
17.             return title.Substring(0, 7); 
18.         } 
19.     } 
20. } 

5.2在Web应用程序中添加对AssemblyTest类库项目的引用

5.3修改News.xslt内容为

1. <?xml version="1.0" encoding="utf-8"?> 
2. <xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" 
3.     xmlns:msxsl="urn:schemas-microsoft-com:xslt" exclude-result-prefixes="msxsl" 
4. xmlns:pl="http://www.polarlight.net/xslt/example"> 
5.  
6. <msxsl:script language="C#" implements-prefix="pl"> 
7.     <msxsl:assembly name="AssemblyTest"/> 
8.     <msxsl:using namespace="AssemblyTest"/> 
9.     <![CDATA[ 
10. public static string GetTitle(string title) 
11.         { 
12.             return AssemblyTest.XsltTest.GetTitle(title); 
13.         } 
14. ]]> 
15. </msxsl:script> 
16.  
17. <xsl:output method="html" indent="yes"/> 
18.  
19. <xsl:template match="/"> 
20.     <xsl:call-template name="style"/> 
21.     <xsl:call-template name="showNews"> 
22.       <xsl:with-param name="news" select="AllNews/News"/> 
23.     </xsl:call-template> 
24. </xsl:template> 
25.  
26. <xsl:template name="style"> 
27.     <style> 
28.       .title{font-size:14px;font-weight:bold;color:White;background-color:#000000;} 
29.       div.newsBlock{border:1px dashed #000000;padding:5px;margin-bottom:10px;background-color:Gray;} 
30.       div.content{text-indent:2em;} 
31.     </style> 
32. </xsl:template> 
33.  
34. <!--展示新闻--> 
35. <xsl:template name="showNews"> 
36.     <xsl:param name="news"/> 
37.     <xsl:for-each select="$news"> 
38.       <div class="newsBlock"> 
39.         <div class="title"> 
40.           <xsl:value-of select="pl:GetTitle(Title)"/> 
41.         </div> 
42.         <div class="content"> 
43.           <xsl:value-of select="Content"/>(<xsl:value-of select="@Author"/>) 
44.         </div> 
45.       </div> 
46.     </xsl:for-each> 
47. </xsl:template> 
48. </xsl:stylesheet> 

请大家留意上面红色部分，并思考为什么要这样做

5.4再次打开Default.aspx，这个时候我们可以看到也没抛出以下异常：

禁止执行脚本。使用 XsltSettings.EnableScript 属性可以启用。 D:\Users\Administrator\Documents\Visual Studio 2008\Projects\ConsoleTest\WebApplicationTest\News.xslt(40,11) 处出错

这个时候我们还需要对Default.aspx.cs的内容，允许执行脚本

5.5修改Default.aspx.cs的ShowNews方法为：

1. /// <summary> 
2.         /// 转换Xml并且显示新闻 
3.         /// </summary> 
4.         private void ShowNews() 
5.         { 
6.             //实例化 
7.             XslCompiledTransform transform = new XslCompiledTransform(); 
8.             //加载样式表 new XsltSettings(false, true)第二个参数允许执行脚本 
9.             transform.Load(Server.MapPath("News.xslt"), new XsltSettings(false, true), null); 
10.  
11.             //转换并且输出 
12.             transform.Transform(Server.MapPath("News.xml"), null, Response.OutputStream); 
13.         } 

5.6重新生成项目，这个时候浏览Default.aspx就可以看到如下效果：

三延伸扩展

通过以上例子我们可以看到配合msxsl:script我们可以用强类型的语言如C#来处理xml数据。动易的标签系统如pe:GetNode等其实就是通过这种方法来实现的，并没有任何复杂的技术。

1，使用.Net的控件通过xslt转换xml为html

除了上述方法以外，我们可以使用.Net自带的控件来显示Xml数据，如XmlDataSource

在Default.aspx中添加相关控件

1. <asp:XmlDataSource ID="XmlDataSource1" runat="server" DataFile="~/News.xml" XPath="/AllNews/News"></asp:XmlDataSource> 
2.         <br /> 
3.         <style> 
4.             .title 
5.             { 
6.                 font-size: 14px; 
7.                 font-weight: bold; 
8.                 color: White; 
9.                 background-color: #000000; 
10.             } 
11.             div.newsBlock 
12.             { 
13.                 border: 1px dashed #000000; 
14.                 padding: 5px; 
15.                 margin-bottom: 10px; 
16.                 background-color: Gray; 
17.             } 
18.             div.content 
19.             { 
20.                 text-indent: 2em; 
21.             } 
22.         </style> 
23.         <asp:Repeater ID="Repeater1" runat="server" DataSourceID="XmlDataSource1"> 
24.             <HeaderTemplate> 
25.                 通过控件直接显示: 
26.             </HeaderTemplate> 
27.             <ItemTemplate> 
28.                 <div class="newsBlock"> 
29.                     <div class="title"> 
30.                         <%#XPath("Title") %> 
31.                     </div> 
32.                     <div class="content"> 
33.                         <%#XPath("Content") %> 
34.                         (<%#XPath("@Author") %>) 
35.                     </div> 
36.                 </div> 
37.             </ItemTemplate> 
38.         </asp:Repeater> 

再次打开Default.aspx页面我们可以看到同样的效果：

2，通过xslt转换Xml为Html只是一种转换方式，还可以转换为其它格式的Xml或者文本，这在一个xml用于不同程序不同xml架构中尤其有用。

3，利用xslt+xml可以实现一些扩展性很强、灵活性强的应用，缺点就是需要掌握Xpath和Xml相关知识。

4，允许执行脚本块会带来一定的安全风险比如被黑客篡改脚本块C#的内容，执行一些非法操作，所以在使用的时候应小心谨慎。

5，Xslt中的数据类型与CLR对应关系：

为函数提供的参数和返回值可以是任意类型。 因为 W3C XPath 类型是公共语言运行库 (CLR) 类型的子集，所以，对不属于 XPath 类型的类型进行类型转换。 下表显示相应的 W3C 类型和等效的 CLR 类型。

CLR 数字类型转换为 Double。 DateTime 类型转换为 String。IXPathNavigable 类型转换为 XPathNavigator。 XPathNavigator 转换为 XPathNodeIterator。

所有其他类型均将引发错误。