Usando Maven Archetype WebApps Module

Olá Pessoal, 

 

O post de hoje é mais uma contribuição. Quero compartilhar com vocês um archetype maven que criamos aqui na empresa e deixamos no github. A seguir resumo o que já vem nele.  Veja também como criar seu archetype.

 

Lets go… 

webapps-module archetype maven 

Esse archetype nasceu com o objetivo de ter um template com a base da maioria dos projetos aqui na empresa e evitar trabalho repetitivo sempre que formos criar um novo projeto. Este é baseado em modules. Sabemos que no catalogs do maven há uma pilha de archetypes, mas alguns que tentamos usar para o nosso cenário aqui sempre estavam com erros muito chatos para resolver, dai vamos fazer o nosso.

Vou fazer uma pequena apresentação desse archetype.

Github 

https://github.com/camilolopes/archetype-webapps-module

O readme.md tem as informações mais pontuais, sem muito detalhe.

A divisão em módulos 

O archetype foi dividido em módulos. Quando você cria vai ter:

1.  módulo principal: terá o nome da app que você informar na criação;
2. webapps-core: é o nome default. Esse módulo cuida de todo back-end da aplicação. Aqui tem os testes unitários, persistência com hibernate etc;
3. webapps-web: é o nome default, mas pode ser alterado e esse cara cuida de todo front-end da aplicação e tem uma dependência do modulo webapps-core.

Note: quando você cria o projeto baseado no archetype, este vem com configurações default. Você precisa customizar de acordo ao seu projeto, portanto:

1. Remova a dependencia de webapps-core no projeto webapps-web. E adicione a dependência webapps-core do seu projeto. Importe o projeto webapps-core para IDE antes;

Qual a vantagem de usar esse archetype? 

• Todos os módulos já vem prontos para uso, com as configurações feitas para Spring, Hibernate, teste em memória com HSQLDB usando o DBUnit;
• Spring core configurado;
• Hibernate configurado;
• DBunit configurado e usando uma estrutura que desenvolvi para evitar repetição de setup;
• Há um arquivo chamado its-dataset.xml que é para o dbunit, mas você pode alterar o nome do arquivo e atualizar a classe DBUnitConfiguration.java para o nome correspondente;
• Jersey configurado. Se você precisar, o arquivo web.xml já está ok. Caso não precise, pode remover;

Criando projeto baseado no archetype 

Passo 1 

Vou assumir que você baixou o archetype no github e seguiu os passos no arquivo readme, ok?

Passo 2 

Após ter instalado o archetype localmente, vá no Eclipse (e considerando que você tem o plugin do maven)

crie um novo projeto maven project.

Passo 3 

Agora vamos procurar pelo archetype. Escolha all catalogs.

Observe que ele apareceu. Escolha e clique em next.

Passo 4 

Preencha com as informações do seu projeto.

Clique em finish e aguarde o projeto ser criado

Passo 5 

Observe que temos dois módulos:

 

Pronto. Preciso mudar mais alguma coisa?

Sim. Como todo template ele vem vazio, com informações de banco de dados. Os packages usados pelo spring são

o default do archetype, e você precisa informar o seu. Então aqui vai um checklist do que você precisa alterar:

•  app-context.xml
•  test-context.xml
• parent/pom.xml: se você for usar o plugin flyway informe aqui as configurações do banco de dados. Não é requerido fazer essa alteração.

Você pode renomear o diretório (algo como myapps-core) ou manter como está. Os packages do projeto também podem ser renomeados, mas fique atento porque se você mudar o nome do package apenas precisa informar isso no arquivo app-context.xml  e test-context.xml do Spring. Não se assuste, porque a mudança é bem pequena e simples.

Espero que tenham gostado e sugestões são bem vindas. Essa é a primeira versão do archetype e estamos criando outros para cenários bem comuns de projetos Java. Archetype sempre baseado em módulos. Temos que fazer algumas configurações mais pontuais, mas o tempo gasto é menor do que criar tudo manualmente sempre que tem um novo projeto.

Eu te recomendo testar o archetype com as configurações default, ver se atende ao que precisa e depois gerar um novo projeto customizado para o que vai desenvolver.

Abracos. See ya!!