蚂蚁。覆盖属性。单目标中的可选执行

时间:2010-03-05 17:21:04

标签: javascript ant scripting immutability macrodef

我将发布一个问题,我已经看到其他地方的变种,但我还没有看到我想出的答案。我随后会发布我的回答。

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

1 个答案:

答案 0 :(得分:2)

注意我正在使用ant 1.7。有了Ant 1.8中的本地范围,还有一些额外的选项,因此不可变性不是一个很大的挑战,但其他一些提示仍然会有所帮助。

首先,关于根据宏中的uptodate结果可选地执行任务的问题 - 这意味着您不需要2个目标。 为此,请使用条件标记。 <或>如果第一个条件失败,tag将使它仅执行第二个条件。 < scriptcondition> tag允许使用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脚本中引用的派生值。如果您正在处理只涉及属性和字符串的连接,那么您可以在块中指定属性,并使用包含连接步骤的默认设置指定第二组属性。但是,如果您需要执行某些无法插入属性默认值的操作,则需要将其放在属性中。由于属性是不可变的,因此您需要采取一些额外步骤为您的属性提供唯一名称。 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>

在我提出上述解决方案之前,我提出了一种黑客风格的解决方案,用于覆盖具有新值的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脚本的主“逻辑”,从而有助于自我记录和可读性您的主要“逻辑”。事情不明显时使用评论。