【问题标题】:How to find dead code in XSLT legacy codebase如何在 XSLT 遗留代码库中查找死代码
【发布时间】:2023-03-23 22:23:01
【问题描述】:

我从一个 BaseX v9 XQuery 脚本开始,它可以帮助我分析 XSLT 遗留代码库。有大约 100 个 XSL v1.0 文件,这些年来有点乱。

代码需要清理。第一步是找到未使用的代码(模板、变量等)。

我的问题是关于寻找不再使用的匹配模板:

 <xsl:template match="blabla">...</xsl:template>

一般来说,找到永远不会执行的匹配模板(有或没有模式属性)的最佳方法是什么?

【问题讨论】:

  • 没有“最好”的方法,但可以执行一些转换来分析代码库并找到排除的候选对象

标签: xml xslt xquery legacy basex


【解决方案1】:

一个模板规则可能永远不会被执行的原因有两个:要么有另一个模板规则总是被优先选择,要么没有可以想象的源文档的节点与其模式匹配。通过样式表的静态分析来检测这两种情况都不太实际。最好的办法是动态地进行一些代码覆盖率分析,使用具有代表性的源文档样本(以及其他输入条件,例如样式表参数的值)。

值得在谷歌上搜索“代码覆盖 XSLT”,尽管它给您的问题多于答案。 XSpec 进行代码覆盖,但前提是您拥有一套全面的 XSpec 测试,这似乎不太可能。 Saxon 有一个工具 (-TP:profile.html) 可以输出每个模板规则执行的频率,但遗憾的是,它忽略了那些计数为零的规则。将这些数据与一些源代码分析结合起来以找到未出现在列表中的模板规则并不难(而且,将多次运行的输出与不同的源文档结合起来。)

对许多源文档实际执行样式表的替代方法是将匹配模式提取到合成样式表中,该样式表针对每个匹配模式测试每个输入节点。您可以为每个匹配输出一个元素,然后对输出进行后处理以查找输出中缺少的模式:

第一:

<xsl:template match="... a sample pattern... ">
  <match id="654321"/>
  <xsl:apply-templates select="@*|node()"/>
</xsl:template>
(repeated for each pattern in the original stylesheet)

然后进行分析:

<xsl:variable name="data" select="."/>
<xsl:key name="k" match="match" use="@id"/>
<xsl:for-each select="1 to max(//match/@id)[not(key('k', ., $data))]">
  No matches for pattern id="{.}"
</xsl:for-each>

但是,对于可能由 xsl:apply-importsxsl:next-match 指令触发的模板规则,或者匹配多个模板规则(可能在不同模式下)的节点,这会给您错误的“不匹配”结果。我相信这个想法可以改进。

【讨论】:

  • 有一些有用的静态分析示例,它们易于编码和执行,可以提供帮助我们查找和消除死 XSLT 代码的结果。
  • 可能有一些这样的例子,但我怀疑大多数死模板规则的出现仅仅是因为它们匹配的 XML 结构已不再使用。
  • @MichaelKay 对我来说对许多源文档执行样式表(在我们的例子中是少数但很大的源)是一种很好的概率方法。它有助于找到不再使用的规则的候选者。我可以编写一个XQuery 脚本来检测代码并使分析变得容易。不需要其他工具支持。 将匹配模式提取到合成样式表中更复杂,因为在我们的例子中,经常使用具有未知模式的临时 xml 树 [...],并找出规则适用于什么类型的节点因为很难。
  • 让我们警告读者,如果正在研究的样式表集实现了多遍处理,则第二种方法将不会给我们提供具有代表性的结果。更准确地说,匹配中间处理过程中的节点但不匹配原始输入中的任何节点的模板将被错误地标记为“不匹配”
【解决方案2】:

代码需要清理。第一步是找到未使用的代码 (模板、变量等)。

我的问题是关于寻找不再使用的匹配模板:

好消息是,事情并不像我在另一个答案中看到的那么理论化(而且几乎没有希望)。仅通过静态分析就可以获得很多有用的信息。

最近我做了类似的事情。这个简单的转换发现在 530 个 .xsl 或 .xslt 文件中,有 180 个是“主要”文件(未导入或包含在任何其他样式表中)。

然后逐一查看“主要”样式表并确定它是否曾经用作主要(独立)转换,从而可以排除大量此类 XSLT 文件。

<xsl:stylesheet version="2.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
 xmlns:xs="http://www.w3.org/2001/XMLSchema">
 <xsl:output omit-xml-declaration="yes" indent="yes"/>
 <xsl:variable name="vBaseFileUrl" select="'file:///C:/TheDirectoryPathToTheXSLTCode'"/>

 <xsl:variable name="vStyleSheets" select=
 "collection(concat($vBaseFileUrl, '?select=*.xsl;recurse=yes'))
 |
  collection(concat($vBaseFileUrl, '?select=*.xslt;recurse=yes'))"/>


  <xsl:template match="/">
    Number of *.xsl | *.xslt stylesheets: <xsl:value-of select="count($vStyleSheets)"/>

    Document URIs:
    <xsl:variable name="vdocURIs" select="$vStyleSheets/document-uri(.)"/>
    <xsl:value-of select="$vdocURIs" separator="&#xA;"/>

    <xsl:variable name="vDistinctFilenames" select=
    "distinct-values($vStyleSheets/tokenize(document-uri(.), '/')[last()])"/>

    <xsl:value-of select="'&#xA;','&#xA;',
                          'Distinctly named stylesheets: ', count($vDistinctFilenames)"/>

<xsl:variable name="vMainFilenames" select=
"$vDistinctFilenames
    [not(. = $vStyleSheets/*/(xsl:import | xsl:include)/tokenize(@href, '/')[last()])]"/>

<xsl:value-of select="'&#xA;','&#xA;','Main filenames: ', count($vMainFilenames)"/>

<xsl:variable name="vMainStylesheets" select=
"$vStyleSheets[tokenize(document-uri(.), '/')[last()] = $vMainFilenames]
"/>

  <xsl:value-of select="'&#xA;','&#xA;','Main stylesheets: ', count($vMainStylesheets)"/>

==========================================
    Document URIs grouped by name: <xsl:text/>
    <xsl:for-each-group select="$vdocURIs" group-by="tokenize(., '/')[last()]">
      <xsl:sort select="current-grouping-key()"/>
      <xsl:variable name="vStylesheetFilename" select="current-grouping-key()"/>
      <xsl:variable name="vImportedOrIncluded" select=
      "$vStyleSheets[/*/(xsl:import | xsl:include)[tokenize(@href, '/')[last()] 
                     eq $vStylesheetFilename]][1]"/>

      <xsl:value-of select="'&#xA;', '&#xA;', 
                            $vStylesheetFilename, 
                            if(empty($vImportedOrIncluded)) then ' Main ' else (), ':'"/>
==========================================
<xsl:text/>

      <xsl:variable name="vUrisInGroup" as="xs:string*">
        <xsl:perform-sort select="current-group()">
          <xsl:sort select="."/>
        </xsl:perform-sort>
      </xsl:variable>

      <xsl:for-each select="$vUrisInGroup">
        <xsl:value-of select=
           "substring-after(., substring-before(., 'nameOfRootDir')), '&#xA;'"/>
      </xsl:for-each>
    </xsl:for-each-group>
  </xsl:template>
</xsl:stylesheet> 

在匹配模板的层面上:

让我们来:

<xsl:template match="possiblySomepath/someName[PossiblySomePredicate]/possibleTailPath">

我们分析了一组可能的源 XML 文档,并确定它们从不包含名为“someName”的元素——或者在更好的情况下,我们有一个可用的源 XML Schema,从中我们可以看到没有名为“ someName”包含在文档中。然后我们可以安全地删除该模板。

至于“主”样式表,在我们排除了明显的这些之后,我们可以通过类似的方式调查并找到没有匹配&lt;xsl:call-template&gt; 指令的命名模板——和摆脱所有这些。

代码将是这样的:

==========================================
    <xsl:variable name="vTemplateNamesDistinct" 
      select="distinct-values($vStyleSheets/*/xsl:template/@name)"/>
    <xsl:value-of select=
    "'&#xA;','&#xA;','Distinct template names: ', count($vTemplateNamesDistinct)"/>

    <xsl:variable name="vnamedTemplatesNeverCalled" select=
   "distinct-values($vStyleSheets/*/xsl:template/@name
                     [not(. = $vStyleSheets//xsl:call-template/@name)])"/>
    <xsl:value-of select=
       "'&#xA;','&#xA;','Template names never called: ', count($vnamedTemplatesNeverCalled)"/>

    <xsl:value-of select="$vnamedTemplatesNeverCalled" separator="&#xA;"/>
==========================================

在我的例子中,大约有 400 个命名模板。其中 40 多个命名模板未被调用。

【讨论】:

  • 感谢您分享想法和代码。我猜您的代码所做的事情类似于我链接的 XQuery 脚本。但我正在理解中:) 稍后会回来。
  • @MarkusSchmid 理解这个转换的最佳方式(我强烈推荐它)是运行它并查看结果——这些都是不言自明的。
  • 它是否在开源 Saxon-HE 9 下运行? (目前我在 XSLT/XPath v1.0 堆栈上)
  • 应该运行 -- 我使用旧版本运行它 -- Saxon 9.1 -- 不使用任何 XSLT 3.0 特性 -- 只有 2.0
猜你喜欢
  • 2011-01-23
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2010-11-18
  • 1970-01-01
  • 1970-01-01
  • 2011-06-11
  • 2017-05-20
相关资源
最近更新 更多