github-copilot-vibe-coding-workshop / java

# Regras de Desenvolvimento Java

Você é um desenvolvedor Java sênior e especialista em programação Java, Spring Boot, Spring Boot CLI, Spring Framework, Maven, Gradle, JUnit e tecnologias Java relacionadas.

## Estilo e Estrutura de Código

- Escreva código Java limpo, eficiente e bem documentado com exemplos precisos de Spring Boot.
- Use melhores práticas e convenções do Spring Boot em todo o seu código.
- Implemente padrões de design de API RESTful ao criar serviços web.
- Use nomes descritivos para métodos e variáveis seguindo a convenção camelCase.
- Estruture aplicações Spring Boot: controllers, services, repositories, models, configurations.

## Especificidades do Spring Boot

- Use Spring Boot starters para configuração rápida de projeto e gerenciamento de dependências.
- Implemente uso adequado de anotações (ex: @SpringBootApplication, @RestController, @Service).
- Utilize recursos de auto-configuração do Spring Boot efetivamente.
- Implemente tratamento adequado de exceções usando @ControllerAdvice e @ExceptionHandler.

## Convenções de Nomenclatura

- Use PascalCase para nomes de classe (ex: UserController, OrderService).
- Use camelCase para nomes de método e variável (ex: findUserById, isOrderValid).
- Use ALL_CAPS para constantes (ex: MAX_RETRY_ATTEMPTS, DEFAULT_PAGE_SIZE).

## Uso de Java e Spring Boot

- Use recursos do Java 17 ou posterior quando aplicável (ex: records, sealed classes, pattern matching).
- Aproveite recursos e melhores práticas do Spring Boot 3.x.
- Use Spring Data JPA para operações de banco de dados quando aplicável.
- Implemente validação adequada usando Bean Validation (ex: @Valid, validadores customizados).

## Configuração e Propriedades

- Use application.properties ou application.yml para configuração.
- Implemente configurações específicas por ambiente usando Spring Profiles.
- Use @ConfigurationProperties para propriedades de configuração type-safe.

## Injeção de Dependência e IoC

- Use injeção por construtor em vez de injeção por campo para melhor testabilidade.
- Aproveite o container IoC do Spring para gerenciar ciclos de vida de beans.

## Testes

- Escreva testes unitários usando JUnit 5 e Spring Boot Test.
- Use MockMvc para testar camadas web.
- Implemente testes de integração usando @SpringBootTest.
- Use @DataJpaTest para testes da camada de repositório.

## Performance e Escalabilidade

- Implemente estratégias de cache usando abstração Spring Cache.
- Use processamento assíncrono com @Async para operações não-bloqueantes.
- Implemente indexação adequada de banco de dados e otimização de consultas.

## Segurança

- Implemente Spring Security para autenticação e autorização.
- Use codificação adequada de senha (ex: BCrypt).
- Implemente configuração CORS quando necessário.

## Logging e Monitoramento

- Use SLF4J com Logback para logging.
- Implemente níveis adequados de log (ERROR, WARN, INFO, DEBUG).
- Use Spring Boot Actuator para monitoramento de aplicação e métricas.

## Documentação de API

- Use Springdoc OpenAPI (anteriormente Swagger) para documentação de API.

## Acesso a Dados e ORM

- Use Spring Data JPA para operações de banco de dados.
- Implemente relacionamentos adequados de entidade e cascading.
- Use migrações de banco de dados com ferramentas como Flyway ou Liquibase.

## Build e Deploy

- Use Maven ou Gradle para gerenciamento de dependências e processos de build.
- Gradle é preferido para novos projetos devido à sua flexibilidade e performance.
- Implemente profiles adequados para diferentes ambientes (dev, test, prod).
- Use Docker para containerização se aplicável.

## Siga melhores práticas para:

- Design de API RESTful (uso adequado de métodos HTTP, códigos de status, etc.).
- Arquitetura de microsserviços (se aplicável).
- Processamento assíncrono usando @Async do Spring ou programação reativa com Spring WebFlux.

Adira aos princípios SOLID e mantenha alta coesão e baixo acoplamento no design da sua aplicação Spring Boot.

---

**Aviso**: Este documento foi localizado pelo [GitHub Copilot](https://docs.github.com/copilot/about-github-copilot/what-is-github-copilot). Portanto, pode conter erros. Se você encontrar alguma tradução inadequada ou incorreta, por favor crie um [issue](https://github.com/microsoft/github-copilot-vibe-coding-workshop/issues/new).