如何在自定义Maven插件中使用MavenSession安装远程依赖？

在开发Maven插件时，MavenSession本身并不直接提供依赖安装的方法，需要结合Maven核心组件（RepositorySystem、ArtifactInstaller等）来完成远程依赖的下载与本地安装，具体步骤如下：

1. 注入核心组件 #

在你的Mojo类中，通过Maven的依赖注入机制获取必要的组件和MavenSession上下文：

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.session.MavenSession;
import org.apache.maven.artifact.installer.ArtifactInstaller;
import org.apache.maven.artifact.repository.RepositorySystem;

public class YourPluginMojo extends AbstractMojo {

    @Parameter(defaultValue = "${session}", readonly = true)
    private MavenSession mavenSession;

    @Component
    private RepositorySystem repositorySystem;

    @Component
    private ArtifactInstaller artifactInstaller;

    @Override
    public void execute() throws MojoExecutionException {
        // 后续步骤写在这里
    }
}

2. 构建远程依赖的Artifact对象 #

明确要安装的远程依赖的坐标（groupId、artifactId、version、类型等），创建对应的Artifact实例：

import org.apache.maven.artifact.Artifact;

// 示例：构建一个jar类型的远程依赖
Artifact targetArtifact = repositorySystem.createArtifact(
    "com.example",    // groupId
    "example-library",// artifactId
    "1.0.0",         // version
    "compile",       // scope
    "jar"            // type
);

3. 解析远程依赖到本地 #

通过RepositorySystem将远程依赖下载到本地仓库，这里会自动复用MavenSession中配置的远程仓库和认证信息：

import org.apache.maven.artifact.resolver.ArtifactRequest;
import org.apache.maven.artifact.resolver.ArtifactResult;
import org.apache.maven.artifact.resolver.ArtifactResolutionException;

ArtifactRequest resolveRequest = new ArtifactRequest();
resolveRequest.setArtifact(targetArtifact);
// 使用当前项目配置的远程仓库
resolveRequest.setRepositories(mavenSession.getProject().getRemoteProjectRepositories());

try {
    ArtifactResult resolveResult = repositorySystem.resolveArtifact(
        mavenSession.getRepositorySession(), 
        resolveRequest
    );
    // 更新为已下载到本地的Artifact实例
    targetArtifact = resolveResult.getArtifact();
} catch (ArtifactResolutionException e) {
    throw new MojoExecutionException("远程依赖解析失败", e);
}

4. 将依赖安装到本地仓库 #

使用ArtifactInstaller将已下载的本地Artifact安装到本地仓库（默认是~/.m2/repository）：

import org.apache.maven.artifact.installer.ArtifactInstallationException;
import org.apache.maven.artifact.installer.ArtifactInstallationRequest;

try {
    artifactInstaller.install(
        mavenSession.getRepositorySession(),
        new ArtifactInstallationRequest()
            .setArtifact(targetArtifact)
            .setPomFile(null) // 无POM文件时传null，Maven会自动生成默认POM
    );
    getLog().info("依赖安装成功：" + targetArtifact);
} catch (ArtifactInstallationException e) {
    throw new MojoExecutionException("本地仓库安装失败", e);
}

关键注意事项 #

• 依赖配置：确保插件的pom.xml中引入了Maven核心API依赖（scope设为provided，因为Maven运行时会提供）：

<dependencies>
    <dependency>
        <groupId>org.apache.maven</groupId>
        <artifactId>maven-core</artifactId>
        <version>3.8.6</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>org.apache.maven</groupId>
        <artifactId>maven-artifact</artifactId>
        <version>3.8.6</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>org.apache.maven</groupId>
        <artifactId>maven-plugin-api</artifactId>
        <version>3.8.6</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

• 传递依赖处理：如果需要解析并安装目标依赖的所有传递依赖，需使用DependencyCollector来遍历依赖树，逐个处理每个Artifact。
• 仓库认证：MavenSession会自动读取settings.xml中的仓库认证信息，无需手动配置。

内容的提问来源于stack exchange，提问作者Kevin Nammour