2 de jun de 2011

Qual é a estrutura padrão de diretórios e arquivos no Maven?

O uso de diretórios pré-configurados pelo Maven permite que novos usuários se familiarizem imediatamente com um novo projeto Maven.

Podemos dizer que é análogo a uma mudança aparência de um site onde conhecemos a sua estrutura e sabemos como usá-lo, mesmo após mudando apenas o modelo(template).

Irei informar os diretórios e em quais contextos os mesmos se aplicam dentro da estrutura do projeto.

  • src/main/java -    Diretório onde está o código fonte Java da Aplicação e/ou Biblioteca
  • src/main/resources - Arquivos de configuração e outros arquivos devem ficar nesta pasta
  • src/main/filters - Pasta onde contém arquivos que podem ser configurados conforme o ambiente e/ou profile usado
  • src/main/assembly - Pasta que possui arquivos descritores de configuração da construção de um determinado artefato
  • src/main/config - Arquivos de configuração
  • src/main/webapp - Pasta para conteúdo Web. Aqui se encontra todos os arquivos fonte da parte web.
  • src/test/java - Pasta que contém os arquivos de testes unitários
  • src/test/resources - Pasta com arquivos que serão utilizados pelas classes de testes unitários
  • src/test/filters - Análogo ao diretório src/main/filters só que usado apenas para testes.
  • src/site - Diretório onde está a configuração do site de documentação do projeto.
  • LICENSE.txt    Arquivo de licença do projeto
  • NOTICE.txt    Avisos e atribuições necessárias para uso de bibliotecas as quais o projeto depende.
  • README.txt    Arquivo Leia-me do projeto.


Na pasta raiz do projeto inicialmente existe apenas o pom.xml assim como arquivos secundários tais como propriedades, build.xml(caso esteja também usando o Ant) e os diretórios src e target(este último será gerado apenas após a execução de alguns comandos tais como mvn compile, mvn package, mvn install etc).

Conforme descrito o src é onde está todo o código fonte necessário para o projeto. A pasta target é o local onde todos os artefatos necessários para a criação dos pacotes do projeto serão gerados. Nunca versione(CVS,SVN,Clearcase etc) esta pasta. Ela pode ser apagada sem problemas e o Maven também pode fazer isto(mvn clean).


Usamos como base um projeto com códigos fonte Java porém podem existir outras pastas de arquivo fonte tais como Antlr(src/main/antlr) e Groovy(src/main/groovy).

Sugiro que use as configurações conforme especificado acima e será possível, como exemplo, criar a seguinte estrutura de projeto para um projeto war(vamos dizer que seu projeto esteja na pasta F:\projetos\maven.default):

<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/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>br.com.maven3.tutorial</groupId>
  <artifactId>maven.default</artifactId>
  <version>1.0</version>
  <packaging>war</packaging>
</project>

O comando mvn help:effective-pom exibe uma versão extendida do arquivo pom.xml como o Maven realmente entende. Isto irá ajudar no entendimento do que realmente é configurado automaticamente pelo Maven para você. Perceba que apenas como 7 linhas do pom.xml se transformam em mais de 237 linhas!

<?xml version="1.0"?>
<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <modelVersion>4.0.0</modelVersion>
  <groupId>br.com.maven3.tutorial</groupId>
  <artifactId>maven.default</artifactId>
  <version>1.0</version>
  <packaging>war</packaging>
  
  <repositories>
    <repository>
      <id>Codehaus Snapshots</id>
      <url>nexus.codehaus.org</url>
    </repository>
    <repository>
      <snapshots>
        <enabled>false</enabled>
      </snapshots>
      <id>central</id>
      <name>Maven Repository Switchboard</name>
      <url>http://repo1.maven.org/maven2</url>
    </repository>
  </repositories>
  <pluginRepositories>
    <pluginRepository>
      <id>Codehaus Snapshots</id>
      <url>nexus.codehaus.org</url>
    </pluginRepository>
    <pluginRepository>
      <releases>
        <updatePolicy>never</updatePolicy>
      </releases>
      <snapshots>
        <enabled>false</enabled>
      </snapshots>
      <id>central</id>
      <name>Maven Plugin Repository</name>
      <url>http://repo1.maven.org/maven2</url>
    </pluginRepository>
  </pluginRepositories>
  <build>
    <sourceDirectory>F:\projetos\maven.default\src\main\java</sourceDirectory>
    <scriptSourceDirectory>F:\projetos\maven.default\src\main\scripts</scriptSourceDirectory>
    <testSourceDirectory>F:\projetos\maven.default\src\test\java</testSourceDirectory>
    <outputDirectory>F:\projetos\maven.default\target\classes</outputDirectory>
    <testOutputDirectory>F:\projetos\maven.default\target\test-classes</testOutputDirectory>
    <resources>
      <resource>
        <directory>F:\projetos\maven.default\src\main\resources</directory>
      </resource>
    </resources>
    <testResources>
      <testResource>
        <directory>F:\projetos\maven.default\src\test\resources</directory>
      </testResource>
    </testResources>
    <directory>F:\projetos\maven.default\target</directory>
    <finalName>maven.default-1.0</finalName>
    <pluginManagement>
      <plugins>
        <plugin>
          <artifactId>maven-antrun-plugin</artifactId>
          <version>1.3</version>
        </plugin>
        <plugin>
          <artifactId>maven-assembly-plugin</artifactId>
          <version>2.2-beta-5</version>
        </plugin>
        <plugin>
          <artifactId>maven-dependency-plugin</artifactId>
          <version>2.1</version>
        </plugin>
        <plugin>
          <artifactId>maven-release-plugin</artifactId>
          <version>2.0</version>
        </plugin>
      </plugins>
    </pluginManagement>
    <plugins>
      <plugin>
        <artifactId>maven-clean-plugin</artifactId>
        <version>2.4.1</version>
        <executions>
          <execution>
            <id>default-clean</id>
            <phase>clean</phase>
            <goals>
              <goal>clean</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
      <plugin>
        <artifactId>maven-install-plugin</artifactId>
        <version>2.3.1</version>
        <executions>
          <execution>
            <id>default-install</id>
            <phase>install</phase>
            <goals>
              <goal>install</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
      <plugin>
        <artifactId>maven-resources-plugin</artifactId>
        <version>2.4.3</version>
        <executions>
          <execution>
            <id>default-resources</id>
            <phase>process-resources</phase>
            <goals>
              <goal>resources</goal>
            </goals>
          </execution>
          <execution>
            <id>default-testResources</id>
            <phase>process-test-resources</phase>
            <goals>
              <goal>testResources</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
      <plugin>
        <artifactId>maven-surefire-plugin</artifactId>
        <version>2.7.1</version>
        <executions>
          <execution>
            <id>default-test</id>
            <phase>test</phase>
            <goals>
              <goal>test</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
      <plugin>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>2.3.2</version>
        <executions>
          <execution>
            <id>default-testCompile</id>
            <phase>test-compile</phase>
            <goals>
              <goal>testCompile</goal>
            </goals>
          </execution>
          <execution>
            <id>default-compile</id>
            <phase>compile</phase>
            <goals>
              <goal>compile</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
      <plugin>
        <artifactId>maven-war-plugin</artifactId>
        <version>2.1.1</version>
        <executions>
          <execution>
            <id>default-war</id>
            <phase>package</phase>
            <goals>
              <goal>war</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
      <plugin>
        <artifactId>maven-deploy-plugin</artifactId>
        <version>2.5</version>
        <executions>
          <execution>
            <id>default-deploy</id>
            <phase>deploy</phase>
            <goals>
              <goal>deploy</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
      <plugin>
        <artifactId>maven-site-plugin</artifactId>
        <version>2.0.1</version>
        <executions>
          <execution>
            <id>default-site</id>
            <phase>site</phase>
            <goals>
              <goal>site</goal>
            </goals>
            <configuration>
              <outputDirectory>F:\projetos\maven.default\target\site</outputDirectory>
              <reportPlugins>
                <reportPlugin>
                  <groupId>org.apache.maven.plugins</groupId>
                  <artifactId>maven-project-info-reports-plugin</artifactId>
                </reportPlugin>
              </reportPlugins>
            </configuration>
          </execution>
          <execution>
            <id>default-deploy</id>
            <phase>site-deploy</phase>
            <goals>
              <goal>deploy</goal>
            </goals>
            <configuration>
              <outputDirectory>F:\projetos\maven.default\target\site</outputDirectory>
              <reportPlugins>
                <reportPlugin>
                  <groupId>org.apache.maven.plugins</groupId>
                  <artifactId>maven-project-info-reports-plugin</artifactId>
                </reportPlugin>
              </reportPlugins>
            </configuration>
          </execution>
        </executions>
        <configuration>
          <outputDirectory>F:\projetos\maven.default\target\site</outputDirectory>
          <reportPlugins>
            <reportPlugin>
              <groupId>org.apache.maven.plugins</groupId>
              <artifactId>maven-project-info-reports-plugin</artifactId>
            </reportPlugin>
          </reportPlugins>
        </configuration>
      </plugin>
    </plugins>
  </build>
  <reporting>
    <outputDirectory>F:\projetos\maven.default\target\site</outputDirectory>
  </reporting>
</project>

Após este trecho posso dizer que o Maven realmente é muito “habilidoso” e que é uma ferramenta construída para facilitar a nossa vida.

Pesquisa personalizada

0 comentários:

Postar um comentário

Leia as regras:
Todos os comentários são lidos e moderados previamente.
Apenas os que respeitam as regras abaixo serão publicados:
- o comentário deve estar relacionado ao assunto do post
- não serão aceitos palavrões e ofensas ao redator do blog ou a terceiros
- não inclua links desnecessários no conteúdo do comentário
- se quiser deixar sua url, comente com a opção OpenId
Obs.: os comentários dos leitores não refletem a opnião do blog.