Maven：以编程方式获取所有依赖项

Question

如何以编程方式在Maven执行环境之外获取Maven模块的所有依赖关系？

到目前为止，我有：

通过maven-core：

Path pomPath = ...;
MavenXpp3Reader reader = new MavenXpp3Reader();
try (InputStream is = Files.newInputStream(pomPath)) {
    Model model = reader.read(is);
    this.mavenProject = new MavenProject(model);
}

并通过jcabi-aether：

File localRepo = Paths.get(System.getProperty("user.home"), ".m2").toFile();
new Classpath(mavenProject, localRepo, "runtime")

到目前为止，这通常正确吗？

现在的问题是，我得到了NullPointerException：

Caused by: java.lang.NullPointerException
    at com.jcabi.aether.Aether.mrepos(Aether.java:197)
    at com.jcabi.aether.Aether.<init>(Aether.java:140)
    at com.jcabi.aether.Classpath.<init>(Classpath.java:125)

因为mavenProject.getRemoteProjectRepositories（）返回null。

如何在考虑settings.xml文件（镜像，代理，存储库等）的情况下初始化MavenProject以包含配置的远程存储库？

Answer 1

在Maven插件之外，对工件进行操作的方法是通过Aether。该团队有一个示例项目，以获取名为的给定工件的传递依赖ResolveTransitiveDependencies。设置以太依赖项后（如此处所示），您可以简单地进行以下操作：

public static void main(final String[] args) throws Exception {
    DefaultServiceLocator locator = MavenRepositorySystemUtils.newServiceLocator();
    RepositorySystem system = newRepositorySystem(locator);
    RepositorySystemSession session = newSession(system);

    RemoteRepository central = new RemoteRepository.Builder("central", "default", "http://repo1.maven.org/maven2/").build();

    Artifact artifact = new DefaultArtifact("group.id:artifact.id:version");

    CollectRequest collectRequest = new CollectRequest(new Dependency(artifact, JavaScopes.COMPILE), Arrays.asList(central));
    DependencyFilter filter = DependencyFilterUtils.classpathFilter(JavaScopes.COMPILE);
    DependencyRequest request = new DependencyRequest(collectRequest, filter);
    DependencyResult result = system.resolveDependencies(session, request);

    for (ArtifactResult artifactResult : result.getArtifactResults()) {
        System.out.println(artifactResult.getArtifact().getFile());
    }
}

private static RepositorySystem newRepositorySystem(DefaultServiceLocator locator) {
    locator.addService(RepositoryConnectorFactory.class, BasicRepositoryConnectorFactory.class);
    locator.addService(TransporterFactory.class, FileTransporterFactory.class);
    locator.addService(TransporterFactory.class, HttpTransporterFactory.class);
    return locator.getService(RepositorySystem.class);
}

private static RepositorySystemSession newSession(RepositorySystem system) {
    DefaultRepositorySystemSession session = MavenRepositorySystemUtils.newSession();
    LocalRepository localRepo = new LocalRepository("target/local-repo");
    session.setLocalRepositoryManager(system.newLocalRepositoryManager(session, localRepo));
    return session;
}

它将下载工件并将其放入"target/local-repo"。

请注意，您可以在系统会话上使用DefaultProxySelector和配置代理和镜像DefaultMirrorSelector。可以读取Maven设置文件并使用它来填充会话，但是事情变得非常难看而且非常快…

当您想要访问MOM并希望将设置考虑在内而希望与Maven本身紧密结合时，以编程方式直接调用Maven会容易得多。在这种情况下，您会对给定POM文件的每个依赖项（包括传递性依赖项）的路径感兴趣。对于该dependency:list目标，以设置在一起outputAbsoluteArtifactFilename来true，会给（几乎）正是这样。

要以编程方式调用Maven，可以使用Invoker API。将依赖项添加到您的项目中：

<dependency>
  <groupId>org.apache.maven.shared</groupId>
  <artifactId>maven-invoker</artifactId>
  <version>2.2</version>
</dependency>

你可以有：

InvocationRequest request = new DefaultInvocationRequest();
request.setPomFile(new File(pomPath));
request.setGoals(Arrays.asList("dependency:list"));
Properties properties = new Properties();
properties.setProperty("outputFile", "dependencies.txt"); // redirect output to a file
properties.setProperty("outputAbsoluteArtifactFilename", "true"); // with paths
properties.setProperty("includeScope", "runtime"); // only runtime (scope compile + runtime)
// if only interested in scope runtime, you may replace with excludeScope = compile
request.setProperties(properties);

Invoker invoker = new DefaultInvoker();
// the Maven home can be omitted if the "maven.home" system property is set
invoker.setMavenHome(new File("/path/to/maven/home"));
invoker.setOutputHandler(null); // not interested in Maven output itself
InvocationResult result = invoker.execute(request);
if (result.getExitCode() != 0) {
    throw new IllegalStateException("Build failed.");
}

Pattern pattern = Pattern.compile("(?:compile|runtime):(.*)");
try (BufferedReader reader = Files.newBufferedReader(Paths.get("dependencies.txt"))) {
    while (!"The following files have been resolved:".equals(reader.readLine()));
    String line;
    while ((line = reader.readLine()) != null && !line.isEmpty()) {
        Matcher matcher = pattern.matcher(line);
        if (matcher.find()) {
            // group 1 contains the path to the file
            System.out.println(matcher.group(1));
        }
    }
}

这将创建一个调用请求，该请求包含：调用目标和系统属性，就像mvn dependency:list -Dprop=value在命令行上启动一样。使用设置的路径将默认为的标准位置"${user.home}/settings.xml"，但也可以使用request.setUserSettingsFile(...)和来指定设置的路径request.setGlobalSettingsFile(...)。仅在"maven.home"未设置系统属性的情况下，才需要将调用者设置为Maven主目录（即安装目录）。

调用的结果dependency:list被重定向到文件，该文件随后进行后处理。该目标的输出包括以下格式的依赖项列表（如果没有分类器，则分类器可能不存在）：

group.id:artifact.id:type[:classifier]:version:scope:pathname

没有一种方法只能输出已解析工件的文件的路径，并且分类器可能不存在的事实使解析变得有些复杂（:由于路径可能包含:..
，因此我们无法进行限制分割））。首先，已解析的工件"The following files have been resolved:"在输出文件中的行下方，然后，由于所需作用域仅是compileor
runtime，我们可以使用简单的正则表达式获取工件文件的路径，该正则表达式接受compile:或之后的所有内容runtime:。该路径然后可以直接用作new File。

如果后处理过程中的箍圈看起来太脆弱，我想您可以创建自己的插件，该插件仅输出已解析工件的文件名。