Como criar um projeto Java usando Maven

Introdução

Neste tutorial, você aprenderá como criar um projeto Java usando Maven, uma poderosa ferramenta de automação e gerenciamento de dependências. O Apache Maven simplifica o processo de construção de projetos Java ao fornecer uma estrutura padrão e automatizar tarefas comuns, como compilação, empacotamento, teste e gerenciamento de bibliotecas externas.

Para compreender melhor um projeto Maven, é preciso entender que o Maven funciona sob o paradiga “Convenção sobre Configuração”. Um projeto Maven possui certas convenções que facilitam o desenvolvimento ao se evitar configurações. Sabemos, por exemplo, que todo arquivo em src/main será usado em produção, enquanto todo arquivo em src/test será usados para testes.

Outra funcionalidade do Maven é gerenciar as dependências do projeto. Assim, se você já teve dificuldades em gerenciar as dependências de um projeto manualmente ou deseja uma maneira eficiente de organizar e construir seu código, Maven é a solução ideal. Este guia passo a passo levará você desde a configuração inicial até a criação e execução de um projeto Java básico, utilizando o Maven.

Vamos começar criando a estrutura do projeto, em seguida, exploraremos como adicionar dependências e empacotar seu aplicativo para distribuição. Ao final deste tutorial, você terá uma base sólida para desenvolver e gerenciar seus projetos Java com eficiência usando Maven.

Preparado? Então, vamos lá!

vepo / tutorial-java-maven

Pré-requisitos

Java Development Kit (JDK): Certifique-se de ter o JDK instalado em sua máquina.
Apache Maven: Instale o Maven. Você pode baixar o Maven aqui e seguir as instruções de instalação.

Passo 1 - Crie a estrutura do projeto

Navegue até o diretório onde deseja criar seu projeto e execute o seguinte comando:

mvn archetype:generate -DgroupId=com.exemplo -DartifactId=meu-projeto -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

Isso criará um projeto Maven básico com a seguinte estrutura de diretórios:

meu-projeto
├── pom.xml
└── src
    ├── main
    │   └── java
    │       └── com
    │           └── exemplo
    │               └─── App.java
    └── test
        └── java
            └── com
                └── exemplo
                    └─── AppTest.java

Passo 2 - Entenda o arquivo `pom.xml`

O arquivo pom.xml (Project Object Model) é o coração do projeto Maven. Ele contém todas as informações sobre o projeto e as dependências necessárias. Aqui está um exemplo básico de um pom.xml:

<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>com.exemplo</groupId>
    <artifactId>meu-projeto</artifactId>
    <version>1.0-SNAPSHOT</version>
    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13.2</version>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>

Passo 3 - Adicione dependências

Para adicionar dependências ao seu projeto, você precisa editar o arquivo pom.xml e incluir as dependências necessárias dentro da tag <dependencies>. Por exemplo, para adicionar a biblioteca Jackson para manipulação de JSON adicione as Coordenadas Maven com.fasterxml.jackson.core:jackson-core:2.17.1.

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.17.1</version>
</dependency>

Coordenadas Maven

O Maven gerencia automaticamente as dependências do projeto. No pom.xml podemos definir uma sessão chamada dependencies onde todas as dependências podem ser definidas. Existem inúmeras bibliotecas disponíveis para serem usadas em projetos Java, muitas delas podem ser encontradas através do site mvnrepository.com.

Para identificar um artefato especifico, o Maven define o conceito de Coordenada Maven. Uma coordenada é definda por todos elementos necessáios para identificar um artefato, as principais são groupId, artifactId e version. Mas também podem ser definidos os elementos classifier e type.

groupId: Identificador de agroupamento, normalmente referindo-se a uma organização, uma empresa e pode incluir um tema básico para um ou mais projetos.

artifactId: Nome para o projeto. Entre os muitos projetos que existem no grupo, o artifactId pode identificar exclusivamente artefato.

version: Um identificador que rastreia builds exclusivas de um artefato. Uma versão é uma string construída pela equipe de desenvolvimento do projeto para identificar builds, diferenciado novos artefatos e catalogando alterações.

Para fazer busca por dependências, procure no site MVN Repository.

Vamos usar o Jackson databind para criar a classe Usuario.

public record Usuario(String nome, int idade, String email) {

    public static Usuario fromJson(String jsonContent) {
        var mapper = new ObjectMapper();
        try {
            return mapper.readValue(jsonContent, Usuario.class);
        } catch (Exception e) {
            throw new InvalidParameterException("Erro ao converter json para Usuario", e);
        }
    }
}

Passo 4 - Compile o projeto

Para compilar o projeto, navegue até o diretório do projeto (meu-projeto) e execute:

mvn compile

Isso irá compilar as classes Java no diretório src/main/java.

Passo 5 - Execute os testes

Antes de executar os testes, vamos atualizar o JUnit para a versão 5. O JUnit é um dos mais famosos frameworks de testes para Java. Com ele os testes podem ser criados e serão automaticamente identificados desde que tenha as anotações @Test.

Para atualizar a biblioteca, remova a antiga dependência e adicione a nova versão. Observe que além das coordenadas maven, ela define o escopo de utilização. Os escopos possíveis são compile, provided, runtime, test, system e import. O escopo padrão é o compile e quando definimos o escopo como test elá será usada apenas durante os testes da aplicação.

<dependency>
    <groupId>org.junit.jupiter</groupId>
    <artifactId>junit-jupiter</artifactId>
    <version>5.10.3</version>
    <scope>test</scope>
</dependency>

Agora vamos criar uma classe de testes a classe UsuarioTest em src/test/java/com/exemplo/UsuarioTest.java que deve ser automaticamente identificada pelo Maven.

package com.exemplo;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;

import org.junit.jupiter.api.Test;

class UsuarioTest {

    @Test
    public void parserTest() {
        var usuario = Usuario.fromJson("""
                                       {
                                         "nome": "John Doe",
                                         "idade": 30,
                                         "email": "john.doe@corp.com"
                                       }
                                       """);
        assertNotNull(usuario, "Usuário não pode ser nulo");
        assertEquals("John Doe", usuario.nome(), "Nome do usuário não confere");
        assertEquals(30, usuario.idade(), "Idade do usuário não confere");
        assertEquals("john.doe@corp.com", usuario.email(), "Email do usuário não confere");
    }
}

Para executar os testes, use o comando:

mvn test

Passo 6 - Execute o projeto

mvn clean compile exec:java -Dexec.mainClass="com.exemplo.App"

Isso irá compilar e executar as classes de teste localizadas em src/test/java.

Passo 7 - Empacote o projeto

Para criar um arquivo JAR do seu projeto, execute:

mvn package

Isso irá gerar um arquivo JAR dentro do diretório target.

Passo 8 - Execute o aplicativo

Para executar o aplicativo, use o seguinte comando:

java -cp target/meu-projeto-1.0-SNAPSHOT.jar com.exemplo.App

Conclusão

Você criou com sucesso um projeto Java básico usando Maven. A partir daqui, você pode adicionar mais dependências, configurar plugins e desenvolver sua aplicação conforme necessário. Maven oferece uma poderosa ferramenta de automação para gerenciamento de projetos, simplificando o processo de construção e gerenciamento de dependências.

Se precisar de mais ajuda ou tiver alguma dúvida, sinta-se à vontade para perguntar!