Spring Starter Template

Projeto template com algumas configurações comuns já feitas e autenticação JWT implementada para ser usado como base em outros projetos

Requisitos Necessários 💻

• Java 21+
• Maven 3.9.6+

Como usar? ⚙️

1. No application.yml:
   1. Altere com o nome da aplicação e as credenciais do banco:

       spring:
           application:
               name: application-name
           datasource:
               url: url_db
               username: user_db
               password: password_db
               driver-class-name: driver_db

   2. Execute o script da pasta src/main/resources/db/migration para inicialização do banco de dados
   3. Altere o context-path para um relacionado ao da sua aplicação. Se necessário, altere também a porta:

      server:
        port: ${PORT:8080}
        servlet:
          context-path: ${CONTEXT_PATH:/base-url}

   4. Caso use anexo de arquivos, altere o tamanho dos arquivos anexados, se necessário:

   servlet:
      multipart:
      enabled: true
      max-request-size: 50MB
      max-file-size: 50MB

   5. Altere as configurações de email, caso queira utilizar, o JavaEmailSend. Se não usar, pode remover:

   mail:
    host: smtp.gmail.com
    port: 587
    username: noreply@email.com.br
    password: 12345
    protocol: smtp

   6. Lembrando que o valor do atributo ddl-auto está validate, ou seja, ele valida o mapeamento das entidades de acordo com o que está modelado no banco de dados, é possível alterar para update, create, create-drop, ou até mesmo none.

   hibernate:
    naming:
      physical-strategy: org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl
      implicit-strategy: org.hibernate.boot.model.naming.ImplicitNamingStrategyLegacyJpaImpl
    ddl-auto: validate

   7. Caso queira habilitar o Flyway altere o enabled para true e coloque os scripts de migração no caminho classpath:db/migration ou renomeie esse caminho para uma de sua preferência:

   flyway:
    enabled: false
    locations: classpath:db/migration

   Lembrando que no Flyway os scripts devem estar nomeados da seguinte forma: V1.01__sua_alteracao.sql. Exemplo: V1.01__update_table_usuario.sql.
2. Renomeie o package br.com.project.spring.starter.template.api para br.com.nomesuaaplicacao.api, tanto no /src/main/java quanto no /src/test/java
3. Renomeie o arquivo ProjectTemplateApiApplication e ProjectTemplateApiApplicationTests para NomeSuaAplicacaoApiApplication e NomeSuaAplicacaoApiApplicationTests
4. No pom.xml, altere o <groupId>, <name> e <description>, para algo correspondente a sua aplicação:

<?xml version="1.0" encoding="UTF-8"?>
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <groupId>br.com.project.spring.starter.template</groupId>
   <artifactId>api</artifactId>
   <version>0.0.1-SNAPSHOT</version>
   <name>spring-starter-template-api</name>
   <description>Spring Starter Template: Template Project</description>
</project>

Executando o Projeto ▶️

Depois de concluídas as configurações, rode o projeto com:

mvn clean install -DskipTests spring-boot:run

Checkstyle ✅

Você pode verificar o checkstyle e manter o padrão de formatação do seu código através do comando:

mvn checkstyle:check

Contribuições 🤝

Contribuições são bem-vindas! Sinta-se à vontade para abrir uma pull request para propor melhorias ou correções.

Read in Engish 🇬🇧

Click here to read in english