javascript - Ant 。覆盖属性。单个目标中的可选执行

Question

我将发布一个问题，我在其他地方看到了变体，但我还没有完全看到我想出的答案。我随后会发布我的答案。

为了使用宏模块化我的构建脚本，我想将 updatetask 和我想执行的任务(如果它不是最新的)放在同一个宏中。
我该怎么做 - 使用脚本标签是可以的 - 如果传入的唯一唯一属性是包含反斜杠的路径，并且我需要能够在不同的调用中将不同的值传递给脚本标签。我需要避免涉及反斜杠时字符串文字可能发生的任何问题。使用 unique 属性，我需要解决 ant 不可变属性行为，并解决通常使用 2 个目标来处理最新处理决策的 ant 模式，并且需要解决字符串文字中反斜杠的 javascript 处理。

Answer 1

注意我正在使用 ant 1.7。通过 Ant 1.8 中的本地作用域，有一些额外的选项，因此不可变性不是一个很大的挑战，但其中一些其他技巧仍然会有帮助。

首先，关于根据宏中更新的结果选择性地执行任务的问题——这意味着您不需要 2 个目标。为此，请使用条件标签。 标签将使其仅在第一个条件失败时才执行第二个条件。 <scriptcondition> 标签允许使用 javascript 执行其他 ant 任务。下面是一个例子(@标签表示 macrodef 属性):

<condition property="whatever" value="false">
  <or>
    <uptodate>
      <srcfiles dir="@{srcdir}" includes="@{srcincludes}" excludes="@{srcexcludes}"/>
      <mapper><chainedmapper>
        <flattenmapper/><!-- use any mappers you need to match source to target files-->
        <globmapper from="*.jxw" to="@{targetdir}\*W.java"/>
      </chainedmapper></mapper>
    </uptodate>
    <!-- w/ java 1.6 or later, you get a rhino javascript interpreter included w/ java-->
    <scriptcondition language="javascript" value="true">
      self.setValue(true);
      echo = project.createTask("echo");
      myArg1="@{myArg1}";
      myArg2="@{myArg2}";
      // need to create a reference from a classpath refid
      myReference = new org.apache.tools.ant.types.Reference(project,"@{my.classpath.id.string}");
      // get a handle to the ant java task, which we will use to execute a java program
      javaTask = project.createTask("java");
      javaTask.setFork(true);
      javaTask.setFailonerror(true);
      javaTask.setClassname("com.mycompany.mypackage.MySpecialClass");
      javaTask.setClasspathRef(myReference);
      javaTask.createArg().setValue(myArg1);
      javaTask.createArg().setValue(myArg2);

      //output the command line to standard out, for reference
      echo.setMessage(javaTask.getCommandLine());
      echo.perform();
      javaTask.perform();
    </scriptcondition>
  </or>
</condition>

现在，如果您像我一样，可能想要对作为您的 macrodef 输入的属性进行一些处理，并生成一些可以在您的 macrodef 脚本中引用的派生值。如果您正在处理仅涉及属性和字符串的连接，您可以在 block 中执行此操作，如果您指定属性是指定第二组属性，默认设置包含连接步骤。但是，如果您需要做一些您不能插入属性默认值的事情，则需要将其放入属性中。因为属性是不可变的，所以您需要采取一些额外的步骤来为您的属性赋予唯一的名称。 tstamp 可以派上用场来帮助解决这个问题。通常，传递给宏的参数的某些组合是唯一的，但如果此唯一组合包含反斜杠，则您需要使用 tstamp 标记派生第二个唯一标识符，这样您就不会在 javascript 中遇到反斜杠问题你想使用这些派生属性。以下是如何创建您可以在脚本中轻松引用的独特属性。

<macrodef name="public.macro.example">
  <attribute name="srcpath"/>
    <sequential>
      <tstamp prefix="@{srcpath}"><format pattern="ddhhmmssSSS" property="time"/></tstamp>
      <private.macro.example srcpath="@{srcpath}" propertyPrefix="prop${@{srcpath}.time}"/>
    </sequential>
</macrodef>

<macrodef name="private.macro.example">
  <attribute name="srcpath"/>
  <attribute name="prefix"/>
  <sequential>
    <pathconvert property="@{prefix}.src"/>
    <!-- now you can do special things with ${@{prefix}.src}, even in javascript -->
    <script language="javascript">
      self.setValue(true);
      echo = project.createTask("echo");
      myPrefix="@{prefix}";
      mySpecialPropertyKey=myPrefix+".src";
      //if your special property contains backslashes or other special js characters
      // you need to use project.getProperty instead of a string literal to get the value
      mySpecialPropertyVal=project.getProperty(mySpecialPropertyKey);
      // do something with this derived value in javascript
      echo.setMessage("my special property = "+mySpecialPropertyVal);
      echo.perform();
    </script>
  </sequential>
</macrodef>

在我想出上述解决方案之前，我想出了一种 hack 风格的解决方案，用于用新值覆盖 ant 属性。虽然您可能会发现这对覆盖属性很有用，因为我正在直接调用 ant 类，但存在这样的风险，即这在未来的 ant 版本中可能无法正常工作。因为这看起来更像是 hack，所以我的意图是尽可能使用上面列出的 2 macrodef 方法而不是这种方法。请注意，此特定变体不支持反斜杠字符，因为属性是在 javascript 字符串文字中直接引用的。我最初使用这个简单的变体来创建我的唯一前缀，这避免了使用 2 macrodef 方法来解决属性不可变性的需要。但是，您可以调整此 macrodef 以使用第二个 macrodef 和唯一前缀，以便使用 project.getProperty 命令将“@{value}”获取到 javascript 中。

<macrodef name="public.canova.setproperty">
  <attribute name="name"/>
  <attribute name="value"/>
  <sequential>
    <script language="javascript">
      project.setUserProperty("@{name}","@{value}");
    </script>
  <sequential>
</macrodef>

乍一看，其中一些可能看起来有点复杂，但如果您正确地执行 macrodef 工作并构建组件样式的宏(即不要将意大利面条代码放入宏中)，您的 ant 脚本实际上应该变得更短，更容易理解和维护，日志也更容易跟踪。提示 - 只在必要时使用 javascript，当你使用它时，最好在宏中使用它，这样它就被封装并隐藏在你的 ant 脚本的主要“逻辑”之外，从而有助于 self 记录和可读性你的主要“逻辑”。当事情不明显时使用注释。