如何外部化 Maven 构建文件片段？
https://stackoverflow.com/questions/495208
-
20-08-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
Russian题
我遇到了如何以 XML 格式对配置文件进行版本控制的问题。最简单的方法是编写 XSLT 更新。应用程序的每个版本都有其自己的 XSLT 更新。所有这些更新文件都足够小，可以由 IDE 管理，尤其是其 差分法 工具。
由于该项目已经开发为 Maven2 Java 逻辑解决方案是通过 Maven 构建文件触发这些更新。
这是应用一组更新的部分现在的样子：
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>xml-maven-plugin</artifactId>
<executions>
<execution>
<phase>compile</phase>
<goals>
<goal>transform</goal>
</goals>
</execution>
</executions>
<configuration>
<transformationSets>
<transformationSet>
<dir>config/xsltUpdates/input</dir>
<stylesheet>config/xsltUpdates/update1-8-3.xsl</stylesheet>
<outputDir>config/xsltUpdates/update1-8-3</outputDir>
</transformationSet>
<transformationSet>
<dir>config/xsltUpdates/update1-8-3</dir>
<stylesheet>config/xsltUpdates/update1-8-9.xsl</stylesheet>
<outputDir>config/xsltUpdates/update1-8-9</outputDir>
</transformationSet>
<transformationSet>
<dir>config/xsltUpdates/update1-8-9</dir>
<stylesheet>config/xsltUpdates/update1-9-0.xsl</stylesheet>
<outputDir>config/xsltUpdates/update1-9-0</outputDir>
</transformationSet>
<transformationSet>
<dir>config/xsltUpdates/update1-9-0</dir>
<stylesheet>config/xsltUpdates/update1-10-0.xsl</stylesheet>
<outputDir>config/xsltUpdates/update1-10-0</outputDir>
</transformationSet>
<transformationSet>
<dir>config/xsltUpdates/update1-10-0</dir>
<stylesheet>config/xsltUpdates/update1-10-0-1.xsl</stylesheet>
<outputDir>config/xsltUpdates/update1-10-0-1</outputDir>
</transformationSet>
<transformationSet>
<dir>config/xsltUpdates/update1-10-0-1</dir>
<stylesheet>config/xsltUpdates/update1-10-0-2.xsl</stylesheet>
<outputDir>config/xsltUpdates/update1-10-0-2</outputDir>
</transformationSet>
<transformationSet>
<dir>config/xsltUpdates/update1-10-0-2</dir>
<stylesheet>config/xsltUpdates/updateCurrent.xsl</stylesheet>
<outputDir>config/xsltUpdates/output</outputDir>
</transformationSet>
</transformationSets>
</configuration>
<dependencies>
<dependency>
<groupId>net.sf.saxon</groupId>
<artifactId>saxon</artifactId>
<version>8.7</version>
</dependency>
</dependencies>
</plugin>
我想在某些properties/xml 文件导入中外部化有关transformationSet 的信息。我的 pom.xml 文件将更加清晰，并且外部化信息更易于维护。
我怎样才能做到这一点？
我可以在构建文件中使用一些迭代控制语句吗？有没有办法从外部文件导入数据？
解决方案
有些插件允许您使用外部描述符（例如 maven 组件插件）。不幸的是 xml-maven-plugin 还不是其中之一。
一种选择是从 xml-maven-plugin 复制相关目标，并将 maven-shared-io 的处理硬塞到目标中。我一直在寻找自己做这件事，以期向各种插件提出使用描述符文件和 LocatorStrategy 方法来查找描述符的请求。以下是一些修改 xml-maven-plugin 以允许使用描述符的处理。请注意，几乎没有对所涉及的文件进行验证，因此它有点脆弱，但它确实有效。
1) 创建一个新的 maven-plugin 项目（假设名为 xml-ext-maven-plugin），具有以下依赖项：
<dependencies>
<dependency>
<groupId>org.codehaus.mojo</groupId>
<artifactId>xml-maven-plugin</artifactId>
<version>1.0-beta-2</version>
</dependency>
<dependency>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
<version>2.2-beta-2</version>
</dependency>
</dependencies>
2) 从 xml-maven-plugin 复制 TransformMojo 和 AbstractXmlMojo .java 文件（您需要父 mojo 从其 javadoc 继承属性）。
3）添加一个 描述符 TransformMojo 的属性：
/**
* A list of descriptor files to obtain the transformation sets from
*
* @parameter
*/
private String[] descriptors;
4) 修改execute()方法来读取transformationSets的描述符
public void execute() throws MojoExecutionException, MojoFailureException {
//insert at start of method to resolve transformationSets fronm descriptors
if (descriptors != null && descriptors.length > 0) {
transformationSets = readDescriptors(descriptors);
}
...
5）实施 读取描述符() 允许您在类路径上或项目内定位描述符（读取器处理很大程度上是从程序集插件的 DefaultAssemblyReader 中提升的）。请注意，此实现中几乎没有验证，适当的插件会检查是否设置了值等。
private TransformationSet[] readDescriptors(String[] descriptors)
throws MojoExecutionException {
List descriptorSets = new ArrayList();
// add all the existing transformationSets
if (transformationSets != null && transformationSets.length != 0) {
descriptorSets.addAll(Arrays.asList(transformationSets));
}
for (int i = 0; i < descriptors.length; i++) {
getLog().info(
"Reading transformation descriptor: " + descriptors[i]);
Location location = getLocation(descriptors[i]);
Reader reader = null;
try {
reader = new InputStreamReader(location.getInputStream(),
"UTF-8");
Xpp3Dom dom = Xpp3DomBuilder.build(reader);
descriptorSets.addAll(parseTransformationSets(dom));
} catch (IOException e) {
throw new MojoExecutionException(
"Error reading transformation descriptor: "
+ descriptors[i], e);
} catch (XmlPullParserException e) {
throw new MojoExecutionException(
"Error parsing transformation descriptor: "
+ descriptors[i], e);
} finally {
IOUtil.close(reader);
}
}
return (TransformationSet[]) descriptorSets
.toArray(new TransformationSet[descriptorSets.size()]);
}
/**
* Create transformationSets from the Xpp3Dom.
* TODO use plexus utilities to resolve these elegantly?
*/
private List parseTransformationSets(Xpp3Dom dom) {
// TODO validation of the input files!
Xpp3Dom[] setDoms = dom.getChildren("transformationSet");
List sets = new ArrayList();
for (int i = 0; i < setDoms.length; i++) {
TransformationSet set = new TransformationSet();
set.setDir(new File(setDoms[i].getChild("dir").getValue()));
set.setStylesheet(new File(setDoms[i].getChild("stylesheet")
.getValue()));
Xpp3Dom outDom = setDoms[i].getChild("outputDir");
if (outDom != null) {
set.setOutputDir(new File(outDom.getValue()));
}
sets.add(set);
}
return sets;
}
6）实施 获取位置() 使用各种策略以相对路径、url 或类路径的形式发现文件。
private Location getLocation(String path) {
List strategies = new ArrayList();
strategies.add(new RelativeFileLocatorStrategy(getBasedir()));
strategies.add(new ClasspathResourceLocatorStrategy());
strategies.add(new FileLocatorStrategy());
strategies.add(new URLLocatorStrategy());
List refStrategies = new ArrayList();
refStrategies.add(classpathStrategy);
Locator locator = new Locator();
locator.setStrategies(strategies);
Location location = locator.resolve(path);
return location;
}
7) 覆盖 asAbsoluteFile() 使用定位器策略解析文件（也允许我们在描述符项目中定义 xsl 文件）。
protected File asAbsoluteFile(File f) {
String path = f.getPath();
// ensure we're getting a path in the form that URL can handle
if (path != null) {
path = path.replaceAll("\\\\", "/");
}
Location location = getLocation(path);
if (location == null) {
//can't find the file, let the parent implementation have a try
return super.asAbsoluteFile(f);
}
try {
return location.getFile();
} catch (IOException e) {
throw new RuntimeException("unable to read file " + f.getPath(), e);
}
}
8) 将插件安装到您的存储库。
9) 创建一个新的 Maven 项目来托管您的转换集（例如名为 xml-ext-test-descriptor）。该过程与 共享描述符 组装插件的，即创建一个项目，在src/main/resources下添加一些xml文件，然后安装该项目。xml 文件采用标准 conversionSets 配置的形式。例如，将几个转换放入 src/main/resources/transformations1.xml 中：
<transformationSets>
<transformationSet>
<!--the config directory is in the root of the project -->
<dir>config/xsltUpdates/input</dir>
<!-- the stylesheet can be in the descriptor project-->
<stylesheet>/stylesheets/update1-8-3.xsl</stylesheet>
<outputDir>config/xsltUpdates/update1-8-3</outputDir>
</transformationSet>
<transformationSet>
<dir>config/xsltUpdates/update1-8-3</dir>
<stylesheet>/stylesheets/update1-8-9.xsl</stylesheet>
<outputDir>config/xsltUpdates/update1-8-9</outputDir>
</transformationSet>
</transformationSets>
10) 将您的 xsl 文件放入描述符项目中，例如src/main/resources/stylesheets/update1-8-3.xsl
11) 在项目中配置新插件以引用描述符项目作为依赖项，并将 xml 文件引用为描述符：
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>xml-maven-plugin</artifactId>
<executions>
<execution>
<phase>compile</phase>
<goals>
<goal>transform</goal>
</goals>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>name.seller.rich</groupId>
<artifactId>xml-ext-test-descriptor</artifactId>
<version>0.0.1</version>
</dependency>
</dependencies>
<configuration>
<descriptors>
<!-- will be resolved from xml-ext-test-descriptor -->
<descriptor>/transformationSet1.xml</descriptor>
</descriptors>
</plugin>
如果上述所有步骤均有效，则执行时自定义插件将从 xml-ext-test-descriptor 依赖项解析 conversionSet1.xml 和您的 xsl 文件，并正常处理它们。
其他提示
有可能通过其他方式来做到这一点，但您可以在 pluginManagement 部分一个父POM。
pluginManagement：是沿着侧看到的插件的元件。插件管理包含了几乎相同的方式，插件元素除了不是配置插件为这个特定的项目建设信息，它的目的是配置项目的基础，从这个继承。然而，这仅会配置在孩子们的插件元素中实际引用的插件。孩子们有充分的覆盖pluginManagement定义权。
例如：
父项目POM（需要MVN运行安装，以确保这是看到你的孩子的项目）
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.nkl</groupId>
<artifactId>parent</artifactId>
<packaging>pom</packaging>
<version>0.0.1-SNAPSHOT</version>
<build>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>xml-maven-plugin</artifactId>
<executions>
<execution>
<phase>compile</phase>
<goals>
<goal>transform</goal>
</goals>
</execution>
</executions>
<configuration>
<transformationSets>
<transformationSet>
<dir>config/xsltUpdates/input</dir>
<stylesheet>config/xsltUpdates/update1-8-3.xsl</stylesheet>
<outputDir>config/xsltUpdates/update1-8-3</outputDir>
</transformationSet>
<transformationSet>
<dir>config/xsltUpdates/update1-8-3</dir>
<stylesheet>config/xsltUpdates/update1-8-9.xsl</stylesheet>
<outputDir>config/xsltUpdates/update1-8-9</outputDir>
</transformationSet>
<transformationSet>
<dir>config/xsltUpdates/update1-8-9</dir>
<stylesheet>config/xsltUpdates/update1-9-0.xsl</stylesheet>
<outputDir>config/xsltUpdates/update1-9-0</outputDir>
</transformationSet>
<transformationSet>
<dir>config/xsltUpdates/update1-9-0</dir>
<stylesheet>config/xsltUpdates/update1-10-0.xsl</stylesheet>
<outputDir>config/xsltUpdates/update1-10-0</outputDir>
</transformationSet>
<transformationSet>
<dir>config/xsltUpdates/update1-10-0</dir>
<stylesheet>config/xsltUpdates/update1-10-0-1.xsl</stylesheet>
<outputDir>config/xsltUpdates/update1-10-0-1</outputDir>
</transformationSet>
<transformationSet>
<dir>config/xsltUpdates/update1-10-0-1</dir>
<stylesheet>config/xsltUpdates/update1-10-0-2.xsl</stylesheet>
<outputDir>config/xsltUpdates/update1-10-0-2</outputDir>
</transformationSet>
<transformationSet>
<dir>config/xsltUpdates/update1-10-0-2</dir>
<stylesheet>config/xsltUpdates/updateCurrent.xsl</stylesheet>
<outputDir>config/xsltUpdates/output</outputDir>
</transformationSet>
</transformationSets>
</configuration>
<dependencies>
<dependency>
<groupId>net.sf.saxon</groupId>
<artifactId>saxon</artifactId>
<version>8.7</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</pluginManagement>
</build>
</project>
儿童项目POM
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/maven-v4_0_0.xsd">
<parent>
<artifactId>parent</artifactId>
<groupId>org.nkl</groupId>
<version>0.0.1-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<groupId>org.nkl</groupId>
<artifactId>child</artifactId>
<version>0.0.1-SNAPSHOT</version>
<build>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>xml-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
不隶属于 StackOverflow
