Como obter acesso à hierarquia de dependência do Maven em um plugin

Question

No meu plug -in, preciso processar a hierarquia de dependência e obter informações (groupID, ArtifactID, versão etc.) sobre cada dependência e se foi excluída. Qual é a melhor maneira de fazer isso?

Answer 1

O plugin de dependência tem o Objetivo da árvore Isso faz a maior parte desse trabalho. Processos a MavenProject usando o DependencyTreeBuilder, isso retorna um DependencyNode com informações hierárquicas sobre as dependências resolvidas (e suas dependências transitivas).

Você pode copiar grande parte do código diretamente do Treemojo. Ele usa o CollectingDependencyNodeVisitor para atravessar a árvore e produzir um List de todos os nós.

Você pode acessar o Artifact para o nó ligando getArtifact(), obtenha as informações do artefato conforme necessário. Para obter o motivo de exclusão, DependencyNode tem um getState() Método que retorna um INT indicando se a dependência foi incluída, ou se não o motivo para omiti -lo (existem constantes na classe DependencyNode para verificar o valor de retorno contra)

//All components need this annotation, omitted for brevity

/**
 * @component
 * @required
 * @readonly
 */
private ArtifactFactory artifactFactory;
private ArtifactMetadataSource artifactMetadataSource;
private ArtifactCollector artifactCollector;
private DependencyTreeBuilder treeBuilder;
private ArtifactRepository localRepository;
private MavenProject project;

public void execute() throws MojoExecutionException, MojoFailureException {
    try {
        ArtifactFilter artifactFilter = new ScopeArtifactFilter(null);

        DependencyNode rootNode = treeBuilder.buildDependencyTree(project,
                localRepository, artifactFactory, artifactMetadataSource,
                artifactFilter, artifactCollector);

        CollectingDependencyNodeVisitor visitor = 
            new CollectingDependencyNodeVisitor();

        rootNode.accept(visitor);

        List<DependencyNode> nodes = visitor.getNodes();
        for (DependencyNode dependencyNode : nodes) {
            int state = dependencyNode.getState();
            Artifact artifact = dependencyNode.getArtifact();
            if(state == DependencyNode.INCLUDED) {                    
                //...
            } 
        }
    } catch (DependencyTreeBuilderException e) {
        // TODO handle exception
        e.printStackTrace();
    }
}

Answer 2

Você poderia usar MavenProject#getDependencyArtifacts () ou MavenProject#getDependências () (O posterior retorna também dependências transitivas).

/**
 * Test Mojo
 *
 * @goal test
 * @requiresDependencyResolution compile
 */
public class TestMojo extends AbstractMojo {

    /**
     * The Maven Project.
     *
     * @parameter expression="${project}"
     * @required
     * @readonly
     */
    private MavenProject project = null;

    /**
     * Execute Mojo.
     *
     * @throws MojoExecutionException If an error occurs.
     * @throws MojoFailureException If an error occurs.
     */
    public void execute() throws MojoExecutionException,
MojoFailureException {

        ...

        Set dependencies = project.getDependencies();

       ...
    }

}

Não tenho muita certeza, mas acho que os dois métodos retornam uma coleção de Artefato implementações que expõem Getters para GroupID, ArtifactId, versão, etc.

Answer 3

Aqui está um exemplo atualizado, o MAVEN3 sobre como obter todas as dependências (incluindo transitivas) e ter acesso aos próprios arquivos (se você, por exemplo, precisar adicionar os caminhos a um caminho de classe).

// Default phase is not necessarily important.
// Both requiresDependencyCollection and requiresDependencyResolution are extremely important however!
@Mojo(name = "simple", defaultPhase = LifecyclePhase.PROCESS_RESOURCES, requiresDependencyCollection = ResolutionScope.COMPILE_PLUS_RUNTIME, requiresDependencyResolution = ResolutionScope.COMPILE_PLUS_RUNTIME)
public class SimpleMojo extends AbstractMojo {
  @Parameter(defaultValue = "${project}", readonly = true)
  private MavenProject mavenProject;

  @Override
  public void execute() throws MojoExecutionException, MojoFailureException {
    for (final Artifact artifact : mavenProject.getArtifacts()) {
      // Do whatever you need here.
      // If having the actual file (artifact.getFile()) is not important, you do not need requiresDependencyResolution.
    }
  }
}

Alterar os parâmetros no mojo é uma peça muito importante que eu estava faltando. Sem ele, linhas como as seguintes:

@Parameter(defaultValue = "${project.compileClasspathElements}", readonly = true, required = true)
private List<String> compilePath;

Retornará apenas o diretório de classes, não o caminho que você espera.

Alterar o requerDependEncyCollection e requer dependences de solução para valores diferentes permitirá que você altere o escopo do que deseja pegar. o Documentação do MAVEN pode fornecer mais detalhes.

Answer 4

Tente usar Aether classe de utilidade de JCABI-AETHER Para obter uma lista de todas as dependências de qualquer artefato:

File repo = this.session.getLocalRepository().getBasedir();
Collection<Artifact> deps = new Aether(this.getProject(), repo).resolve(
  new DefaultArtifact("junit", "junit-dep", "", "jar", "4.10"),
  JavaScopes.RUNTIME
);

Answer 5

Por que não apenas recuperar todas as dependências (diretas e transitivas) e verificar a exclusão?

@Parameter(property = "project", required = true, readonly = true)
private MavenProject project;

public void execute() throws MojoExecutionException
{
  for (Artifact a : project.getArtifacts()) {
    if( a.getScope().equals(Artifact.SCOPE_TEST) ) { ... }
    if( a.getScope().equals(Artifact.SCOPE_PROVIDED) ) { ... }
    if( a.getScope().equals(Artifact.SCOPE_RUNTIME) ) { ... }
  }
}

Answer 6

MAVEN 3 Use Aether, há amostra aqui:https://docs.sonatype.org/display/aether/home

Answer 7

Para o Maven 3, você pode usar dependencygraphbuilder. Faz praticamente a mesma coisa que a dependenceTreeBuilder.

Aqui está o exemplo

    import org.apache.maven.artifact.resolver.filter.ArtifactFilter;
    import org.apache.maven.artifact.resolver.filter.IncludesArtifactFilter;
    import org.apache.maven.execution.MavenSession;
    import org.apache.maven.model.Dependency;
    import org.apache.maven.plugins.annotations.ResolutionScope;
    import org.apache.maven.plugins.annotations.LifecyclePhase;
    import org.apache.maven.shared.dependency.graph.DependencyGraphBuilder;

    import org.apache.maven.shared.dependency.graph.DependencyNode;
    import org.apache.maven.shared.dependency.graph.traversal.CollectingDependencyNodeVisitor;

    public class AnanlyzeTransitiveDependencyMojo extends AbstractMojo{

        @Parameter(defaultValue = "${project}", readonly = true, required = true)
        private MavenProject project;

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

        @Component(hint="maven3")
        private DependencyGraphBuilder dependencyGraphBuilder;

        @Override
        public void execute() throws MojoExecutionException, MojoFailureException {
    // If you want to filter out certain dependencies.
             ArtifactFilter artifactFilter = new IncludesArtifactFilter("groupId:artifactId:version");
             ProjectBuildingRequest buildingRequest = new DefaultProjectBuildingRequest(session.getProjectBuildingRequest());
             buildingRequest.setProject(project);
            try{
               DependencyNode depenGraphRootNode = dependencyGraphBuilder.buildDependencyGraph(buildingRequest, artifactFilter);
               CollectingDependencyNodeVisitor visitor = new  CollectingDependencyNodeVisitor();
               depenGraphRootNode.accept(visitor);
               List<DependencyNode> children = visitor.getNodes();

               getLog().info("CHILDREN ARE :");
               for(DependencyNode node : children) {
                   Artifact atf = node.getArtifact();
            }
}catch(Exception e) {
    e.printStackTrace();
}