具有外部 JS 依赖的 Maven 项目中的 RequireJS 编译

Question

我有一个使用 Maven 构建的 Web 项目，我试图找出使用 RequireJS 编译器编译 JavaScript 文件的最佳方法（这个问题也适用于任何编译器/压缩器）。

我有一个有效的设置，但需要改进：

我已经打包了第 3 方 JavaScript 库，它们作为依赖项下载，然后使用 WAR Overlay 插件添加。

我有一个 Exec 插件任务，它在目标目录内运行 RequireJS 编译器。目前，我在包目标运行后手动运行 exec:exec（因此 WAR 内容放置在目标目录中）。

我想要的是让 JS 编译成为主（Java）编译的一部分。 JS 编译器本身 (Require JS) 在编译后发生的 WAR 覆盖阶段作为依赖项下载。因此，我需要下载并解压 Require JS 文件，并且需要在 Java 编译之前/期间/之后使用这些文件运行 JS 编译。

我确信可以通过多种方法来实现这一目标。我正在寻找最优雅的解决方案。

---

更新：现有的 POM 片段

我有 JavaScript 依赖项，我已将其压缩并添加到我们的存储库管理器中：

    <dependency>
        <groupId>org.requirejs</groupId>
        <artifactId>requirejs</artifactId>
        <version>0.22.0</version>
        <classifier>repackaged</classifier>
        <type>zip</type>
        <scope>runtime</scope>
    </dependency>
    <dependency>
        <groupId>com.jqueryui</groupId>
        <artifactId>jquery-ui</artifactId>
        <version>1.8.7</version>
        <classifier>repackaged</classifier>
        <type>zip</type>
        <scope>runtime</scope>
    </dependency>

请注意，RequireJS 本身（编译其余库所需的）也作为外部依赖。因此，第一件事是，我需要先下载并解压此依赖项，然后才能开始 RequireJS 编译。

这些依赖项正在使用 WAR Overlay 插件添加到 WAR 中：

        <plugin>
            <artifactId>maven-war-plugin</artifactId>
            <configuration>
                <overlays>
                    <overlay>
                        <groupId>org.requirejs</groupId>
                        <artifactId>requirejs</artifactId>
                        <classifier>repackaged</classifier>
                        <type>zip</type>
                        <targetPath>lib</targetPath>
                        <includes>
                            <include>requirejs/require.js</include>
                            <include>requirejs/require/*</include>
                            <include>requirejs/build/**</include>
                        </includes>
                    </overlay>
                    <overlay>
                        <groupId>com.jqueryui</groupId>
                        <artifactId>jquery-ui</artifactId>
                        <classifier>repackaged</classifier>
                        <type>zip</type>
                        <targetPath>lib</targetPath>
                    </overlay>
                </overlays>
            </configuration>
        </plugin>

尽管我不需要 requirejs/build/** 来结束 WAR，但我将其作为覆盖来获取解压的 RequireJS 构建脚本，只是因为我还没有找到更好的方法。

然后我有一个执行编译的 Exec 插件任务。但请注意，此任务尚未添加到正常的编译工作流程中：我必须在 WAR 打包完成后使用 mvn exec:exec 手动调用它：

        <plugin>
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>exec-maven-plugin</artifactId>
            <version>1.1</version>
            <executions>
                <execution>
                    <goals>
                        <goal>exec</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <executable>lib/requirejs/build/build.bat</executable>
                <workingDirectory>${project.build.directory}/${project.artifactId}</workingDirectory>
                <arguments>
                    <argument>name=bootstrap</argument>
                    <argument>out=combined.js</argument>
                    <argument>baseUrl=scripts</argument>
                    <argument>optimize=closure</argument>
                    <argument>excludeShallow=plugins/manifest</argument>
                </arguments>
            </configuration>
        </plugin>

所以，一些问题是：

1. 如何提取单个压缩依赖项的不同部分以进行编译和 WAR 打包步骤？或者我是否必须创建两个 zip 文件，一个仅包含运行时内容，另一个用于编译脚本？
2. 我希望在编译期间触发 exec:exec ，或者如果没有，则在 WAR 打包之前触发。我该怎么做？

我实际上已经尝试了很多东西但没有成功，所以我希望我不会显得懒惰地发布大量代码并等待答案:)只是我还没有完全理解 Maven 的目标/阶段等等工作还没有。

Answer 1

https://github.com/jakewins/requirejs-maven

Answer 2

有一个专门针对 RequireJS 优化的 Maven 插件：

https://github.com/mcheely/requirejs- maven-plugin

它应该始终附带最新版本的 RequireJS，并且通过向项目添加不同版本并在插件配置中指定它的路径来覆盖它非常容易。

完全披露：我写了这个插件。

Answer 3

我提出了以下适合我的解决方案：

我不依赖 WAR 覆盖来解包 RequireJS 文件，而是使用 Dependency 插件显式解包它们：

  <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-dependency-plugin</artifactId>
    <executions>
      <execution>
        <phase>compile</phase>
        <goals>
          <goal>unpack</goal>
        </goals>
        <configuration>
          <artifactItems>
            <artifactItem>
              <groupId>org.requirejs</groupId>
              <artifactId>requirejs</artifactId>
              <version>0.22.0</version>
              <type>zip</type>
              <classifier>repackaged</classifier>
              <overWrite>true</overWrite>
            </artifactItem>
          </artifactItems>
        </configuration>
      </execution>
    </executions>
  </plugin>

阶段设置为“编译”。这允许我在编译期间将 RequireJS 包的全部内容放在“dependency”文件夹下。所以，我要做的下一件事是：

      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>exec-maven-plugin</artifactId>
        <version>1.1</version>
        <executions>
          <execution>
            <phase>compile</phase>
            <goals>
              <goal>exec</goal>
            </goals>
            <configuration>
              <executable>
              ${project.build.directory}/dependency/requirejs/build/build.bat</executable>
              <workingDirectory>
              ${basedir}/src/main/webapp</workingDirectory>
              <arguments>
                <argument>name=bootstrap</argument>
                <argument>out=scripts/compiled.js</argument>
                <argument>baseUrl=scripts</argument>
                <argument>optimize=closure</argument>
                <argument>
                excludeShallow=plugins/manifest</argument>
              </arguments>
            </configuration>
          </execution>
        </executions>
      </plugin>

这会触发“dependency”文件夹内的 RequireJS 编译，而不会触及我的源目录或 WAR 目录。然后，我继续使用 WAR 覆盖插件来挑选想要进入 WAR 的 RequireJS 文件。

更新

自从编写此解决方案以来，我已改用“java”目标而不是“exec”，因为我在通过 Hudson 使用 RequireJS 编译器的 shell 脚本 + 批处理文件时遇到了问题。我基本上正在运行最终的 Java 命令（由脚本生成），该命令通过 Rhino 运行编译器。 Node 解决方案会略有不同。对于 RequireJS 0.23.0，它是这样的：

<plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>exec-maven-plugin</artifactId>
    <version>1.1</version>
    <executions>
        <execution>
            <id>compile-js</id>
            <phase>compile</phase>
            <goals>
                <goal>exec</goal>
            </goals>
            <configuration>
                <executable>java</executable>
                <workingDirectory>${basedir}/src/main/webapp</workingDirectory>
                <arguments>
                    <argument>-classpath</argument>
                    <!--argument>${project.build.directory}/dependency/requirejs/build/lib/rhino/js.jar${path.separator}${project.build.directory}/dependency/requirejs/build/lib/closure/compiler.jar</argument -->
                    <argument>${project.build.directory}/dependency/requirejs/build/lib/rhino/js.jar</argument>
                    <argument>org.mozilla.javascript.tools.shell.Main</argument>
                    <argument>${project.build.directory}/dependency/requirejs/bin/x.js</argument>
                    <argument>${project.build.directory}/dependency/requirejs/bin/</argument>
                    <argument>${project.build.directory}/dependency/requirejs/build/build.js</argument>
                    <argument>name=bootstrap</argument>
                    <argument>out=scripts/compiled.js</argument>
                    <argument>baseUrl=scripts</argument>
                    <argument>optimize=none</argument>
                </arguments>
            </configuration>
        </execution>
    </executions>
</plugin>