9. Arquitetura em camadas e acesso a dados
Os exemplos anteriores armazenavam seus dados em memória. Uma aplicação real os armazena em um banco de dados e é organizada em camadas (veja o diagrama na introdução):
- a camada web (controllers, views): lê a requisição, chama a camada de negócio, seleciona a view;
- a camada de negócio: regras de negócio;
- a camada DAO ([Data Access Object]): consultas ao banco de dados.
Cada camada conhece apenas a camada imediatamente abaixo dela, e o mínimo possível de detalhes sobre ela: a camada web desconhece o SQL, e a camada de negócio desconhece o HTML. Essa separação torna cada camada mais fácil de entender, testar e evoluir. O exemplo 28 aplica isso ao gerenciamento de uma lista de pessoas: é, em escala menor, o gerenciamento de médicos e clientes do estudo de caso.
Em [Java], o acesso ao banco de dados é organizado em várias camadas:
- [JDBC] ([Java Database Connectivity]) é a interface padrão para que [Java] envie comandos SQL a um banco de dados. Cada SGBD fornece um driver [JDBC]: para o [MySQL], a biblioteca [mysql-connector-j]. Abrir uma conexão consome muitos recursos: [Spring Boot] usa um pool de conexões ([HikariCP]), que mantém algumas conexões abertas e as empresta às requisições;
- [JPA] ([Jakarta Persistence API]) é o padrão do [Java] para ORM ([Object-Relational Mapper]): ele mapeia as classes [Java] (entidades) para tabelas do banco de dados e transforma as linhas lidas em objetos. [JPA] é apenas um padrão, composto por interfaces e anotações; o ORM que o implementa é, neste caso, o [Hibernate];
- [Spring Data JPA] é acrescentado sobre isso: basta declarar uma interface DAO, e o [Spring Data JPA] escreve a implementação sozinho quando a aplicação é iniciada, inclusive as consultas, que ele deduz dos nomes dos métodos.
Tudo isso é fornecido pelo starter [spring-boot-starter-data-jpa].
9.1. Exemplo 28: um sistema de gerenciamento de pessoal em três camadas
9.1.1. O banco de dados
O banco de dados [dbpersons] é criado por um script SQL. Usando o [Laragon], você pode executá-lo, por exemplo, na ferramenta [HeidiSQL] (menu Arquivo / Executar arquivo SQL), ou pela linha de comando, a partir da pasta do exemplo:
O arquivo [database/dbpersons.sql]:
- Linha 3: o script é escrito em UTF-8; isso é informado ao servidor para que os acentos dos dados ([Pélissier]) permaneçam intactos;
- linha 5: o conjunto de caracteres [utf8mb4] aceita todos os caracteres (acentos, emojis etc.). A collation [utf8mb4_unicode_ci] compara strings sem distinguir letras maiúsculas de minúsculas nem acentos: para o [MySQL], [pelissier] e [Pélissier] são iguais;
- linha 11: um número de versão, incrementado a cada modificação da linha (veja “bloqueio otimista”, adiante);
- linha 17: uma restrição de unicidade nomeada: o banco de dados não permite duas pessoas com o mesmo nome e sobrenome. O nome da restrição será usado para identificar o erro.
9.1.2. A configuração
O arquivo [pom.xml]:
- Linhas 20–23: validação de dados (veja o Capítulo 3);
- linhas 25–28: [Spring Data JPA], junto com o [Hibernate], o [HikariCP] e o gerenciamento de transações do [Spring];
- linhas 29–33: o driver [JDBC] do [MySQL]. O escopo [runtime] indica que o código da aplicação não o usa diretamente (ele só conhece o [JPA]): o driver é necessário apenas em tempo de execução. Ele também funciona com o [MariaDB].
O arquivo [application.properties]:
- linha 6: as mensagens de sucesso são enviadas como atributos flash (veja o exemplo 20), armazenados na sessão: o cookie de sessão é suficiente para recuperá-los, sem que o ID da sessão seja adicionado à URL;
- Linhas 9–11: a conexão com o banco de dados para a fonte de dados ([DataSource]) que o [Spring Boot] cria usando o [HikariCP]: URL [JDBC] (driver, servidor, porta, banco de dados), o nome de usuário e a senha. Esses são os valores padrão do [Laragon] (usuário [root], sem senha). Não é preciso especificar o tipo de banco de dados (nem sua versão): o [Hibernate] solicita essa informação ao servidor na primeira conexão e ajusta o SQL que gera de acordo com ela;
- linha 13: o [Hibernate] é capaz de criar ou modificar tabelas com base nas entidades; isso é proibido ([none]): o banco de dados é criado pelo script SQL, que serve como referência;
- linha 15: por padrão, o [Spring Boot] mantém a sessão [JPA] (e sua conexão com o banco de dados) aberta até que a view seja totalmente gerada ([Open Session In View]): uma view poderia então disparar consultas SQL sem que o desenvolvedor percebesse. Esse comportamento é desativado: todas as leituras são feitas pela camada de negócio antes da view. Quando essa propriedade não é especificada, o [Spring Boot] informa isso na inicialização com um aviso ([spring.jpa.open-in-view is enabled by default...]);
- Linha 17: [true] exibe no console cada comando SQL enviado pelo [Hibernate] (veja a execução abaixo).
O arquivo [messages.properties] contém uma mensagem de erro de conversão (uma idade [abc]), como no exemplo 19. A classe [config/WebConfig.java] serve o [Bootstrap], como nos exemplos anteriores.
9.1.3. A entidade Person
O arquivo [entities/Person.java]:
- Linha 12: [@Entity] cria uma entidade [JPA] a partir da classe [Person]: cada linha da tabela será um objeto [Person]. As anotações vêm do pacote [jakarta.persistence]: são as do padrão [JPA], e não as do [Hibernate];
- linha 13: a tabela correspondente (por padrão, seria [Person]);
- Linhas 18–21: a chave primária ([@Id]). [@GeneratedValue(strategy = GenerationType.IDENTITY)] indica que seu valor é atribuído pelo banco de dados ([AUTO_INCREMENT]): o [Hibernate] lê o valor atribuído após cada [INSERT]. O tipo [Integer], e não [int], permite o valor [null]: uma pessoa que ainda não foi cadastrada não tem ID. [@Column] especifica o nome da coluna correspondente a cada campo;
- linhas 25–27: a coluna de versão. [@Version] atribui o bloqueio otimista ao [Hibernate]: ele define a versão como 0 durante o [INSERT], aumenta-a em 1 a cada [UPDATE] e adiciona a condição [AND version = <value read>] a cada [UPDATE] (e a cada [DELETE]). Veremos mais adiante para que isso serve;
- linhas 29–36: as demais colunas. [length] especifica a largura da coluna: só seria relevante se o [Hibernate] criasse a tabela por conta própria, o que não é o caso aqui (veja [ddl-auto]);
- linhas 39–40: o [JPA] exige um construtor sem parâmetros: é o que o [Hibernate] usa para criar um objeto a partir de uma linha lida, antes de preencher seus campos;
- linhas 48–59: os acessores (métodos [getX] e [setX]): a entidade é um JavaBean. Não há [setId] nem [setVersion]: esses dois valores são escritos apenas pelo [Hibernate], que acessa os campos diretamente.
9.1.4. A camada DAO
O arquivo [dao/PersonsDao.java]:
Esta é toda a camada DAO: uma interface, sem uma única linha de código executável.
- Linha 13: a interface herda de [JpaRepository<Person, Integer>] (uma entidade [Person], cuja chave é um [Integer]). Na inicialização, o [Spring Data JPA] cria uma classe que implementa essa interface e a transforma em um bean, que é então injetado. [JpaRepository] já fornece os métodos padrão: [findById] (leitura pela chave, resultado em um [Optional]), [findAll], [save] ([INSERT] ou [UPDATE]), [saveAndFlush], [deleteById], [count]... ;
- Linha 17: uma consulta derivada: [Spring Data JPA] analisa o nome do método e deriva a consulta a partir dele. [findAll]: todas as pessoas; [By]: sem condições, já que nada o segue; [OrderByLastNameAscFirstNameAsc]: ordenadas por sobrenome e depois por nome, em ordem crescente;
- linha 21: [findFirst]: a primeira pessoa encontrada ([LIMIT 1]), ou um [Optional] vazio; [ByFirstNameAndLastNameAndIdNot]: cujo nome e sobrenome correspondem aos fornecidos como parâmetros e cujo ID é diferente do terceiro parâmetro. Isso é útil ao modificar um registro, que não deve entrar em conflito consigo mesmo. A comparação é feita pelo [MySQL] e, portanto, segue as regras de collation do banco de dados: ignora maiúsculas e acentos.
Um erro em um nome de método ([findAllByOrderByLastNamee]) é detectado na inicialização: a aplicação se recusa a iniciar, informando uma propriedade desconhecida. Uma consulta complexa demais para um nome de método é escrita na linguagem [JPQL] ([Jakarta Persistence Query Language], um SQL que se refere a entidades e seus campos, e não a tabelas), em uma anotação [@Query]: o estudo de caso usa algumas delas.
9.1.5. A camada de negócio
O arquivo [business/BusinessException.java]:
Uma [BusinessException] indica que uma regra de negócio está rejeitando uma operação. Não se trata de um erro de programa: sua mensagem se destina ao usuário. Ela herda de [RuntimeException]: é uma exceção não verificada (unchecked), que um método pode lançar sem declará-la ([throws]). Veremos que essa escolha também se aplica às transações.
O arquivo [business/PersonData.java]:
Os dados de uma pessoa, como transmitidos pela camada web: a camada de negócio não conhece a classe do formulário.
O arquivo [business/PersonsBusiness.java]:
Vamos comentar este código:
- linha 18: a camada de negócio é um bean de serviço;
- linha 19: [@Transactional], associada à classe, aplica-se a cada um de seus métodos públicos: o método é executado dentro de uma transação que é aberta ([START TRANSACTION]) antes de sua chamada, confirmada ([COMMIT]) no retorno e desfeita ([ROLLBACK]) se lançar uma exceção não verificada. Como acontece com [@PreAuthorize] (exemplo 26), o [Spring] envolve o bean em um proxy, que abre e fecha a transação em torno da chamada. Tudo o que o método faz, inclusive as chamadas ao DAO, ocorre dentro da mesma transação e na mesma conexão;
- linhas 32–35: [readOnly = true]: uma transação somente leitura, que dispensa o [Hibernate] de verificar, no final, se há entidades modificadas;
- linhas 37–40: uma pessoa ausente é uma [BusinessException]. [orElseThrow] retorna o conteúdo do [Optional] ou lança a exceção gerada pela lambda se ele estiver vazio;
- linhas 42–48: a inclusão. Regra: não pode haver duas pessoas com o mesmo nome e sobrenome. Isso é verificado antes da gravação, para exibir uma mensagem clara. Nenhuma pessoa tem o ID 0: [IdNot] não exclui ninguém da busca aqui;
- linhas 50–64: a atualização. Regra adicional: o bloqueio otimista (linhas 53–55). O formulário de atualização usa a versão do registro como ela era quando o formulário foi aberto. Se ela mudou nesse meio-tempo (outro usuário editou o mesmo registro), a atualização é rejeitada em vez de sobrescrever silenciosamente o trabalho desse usuário. [Objects.equals] compara duas [Integer] instâncias aceitando [null];
- Linha 51: a chamada a [read] é uma chamada interna à classe: ela não passa pelo proxy, e o seu [readOnly] não se aplica. [read] simplesmente é executado dentro da transação de [edit];
- linhas 60–63: a entidade lida na transação é acompanhada pelo [Hibernate] (diz-se que ela é “gerenciada”): basta modificar seus campos; o [Hibernate] detecta as alterações e gera um [UPDATE] para as colunas da tabela;
- Linhas 66–70: a exclusão. A pessoa é lida primeiro, para verificar que ela existe e para que o controller possa mencionar seu nome;
- Linhas 74–87: a gravação. Normalmente, o [Hibernate] envia os comandos [INSERT] e [UPDATE] ao banco de dados apenas no fim da transação, no [COMMIT], ou seja, depois de sair do método: um erro do banco de dados não poderia mais ser interceptado aqui. [saveAndFlush] salva a entidade e envia imediatamente ([flush]) os comandos SQL pendentes;
- Linhas 77–79: a verificação de versão mencionada antes nem sempre é suficiente: dois usuários podem salvar o mesmo registro ao mesmo tempo, e ambos passam na verificação. O [UPDATE ... WHERE id = ? AND version = ?] do segundo usuário então não modifica nenhuma linha; o [Hibernate] detecta isso, e o [Spring] lança uma [ObjectOptimisticLockingFailureException], que se torna a mesma [BusinessException];
- linhas 80–85: da mesma forma, duas inclusões simultâneas da mesma pessoa passam pela verificação de homônimos, mas a restrição de unicidade do banco de dados não permite que ambas sejam aceitas. O [Spring] traduz as exceções dos diversos bancos de dados e dos diversos ORMs em uma hierarquia comum de exceções: uma violação de restrição se torna uma [DataIntegrityViolationException]. [getMostSpecificCause()] retorna a exceção original, a do driver do [MySQL], cuja mensagem especifica o nome da restrição ([Duplicate entry '...' for key 'unq_persons_first_name_last_name']). Qualquer outra violação de restrição segue adiante (linha 85): trata-se de uma anomalia.
Em todos os casos em que uma exceção sai de um método de [PersonsBusiness] (inclusive [BusinessException], já que ela herda de [RuntimeException]), o proxy desfaz a transação: nenhuma das ações do método é mantida. Observação: por padrão, uma exceção verificada (checked, que herda de [Exception] sem herdar de [RuntimeException]) não provoca um rollback.
Verificamos esse último caso enviando 30 requisições para adicionar a mesma pessoa ao mesmo tempo: apenas uma foi aceita; para as demais, o banco de dados rejeitou o [INSERT] (erro [MySQL] nº 1062, que o [Hibernate] informa no console como um aviso [HHH000247]), e o usuário recebeu a mensagem de "homônimo", e não um erro 500.
9.1.6. A camada web
O arquivo [models/PersonForm.java]:
O formulário e suas restrições de validação (veja o exemplo 19), com a versão do registro (linha 26) transmitida por um campo oculto. A idade é um [Integer] e não um [int]: um campo vazio resulta em [null], o que é indicado por [@NotNull].
O arquivo [controllers/PersonsController.java]:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 | |
Vamos analisar este código:
- linhas 26–30: o controller conhece apenas a camada de negócio;
- linhas 33–36: as strings recebidas têm os espaços iniciais e finais removidos, e uma string vazia se torna [null] (veja o exemplo 19);
- linhas 38–41: a raiz do site redireciona para a lista;
- linhas 54–68: a inclusão, em três etapas: validação do formulário (erros: recarrega), chamada à camada de negócio (sucesso: mensagem flash e redirecionamento; veja o exemplo 20), [BusinessException] (recarrega com a mensagem no final da página). Qualquer outra exceção não é capturada: trata-se de uma anomalia que resultará em um erro 500;
- Linha 70: [{id:\\d+}]: uma variável de caminho restringida por uma expressão regular (veja o exemplo 02): [\d+] designa uma sequência de dígitos (a barra invertida é duplicada na string [Java]). [/persons/abc/edit] não corresponde a nenhuma ação: erro 404;
- linhas 70–84: o formulário de atualização, preenchido previamente com o registro lido do banco de dados, inclusive sua versão;
- linhas 86–101: mesma estrutura da inclusão; a versão devolvida pelo formulário é transmitida à camada de negócio;
- linhas 103–113: a exclusão. Não há formulário a reexibir: os eventuais erros também são transmitidos por meio do atributo flash;
- linhas 116–122: o template da view do formulário, usado tanto para incluir quanto para modificar registros: título e endereço de envio diferentes, valores do formulário e erro da camada de negócio.
O arquivo [templates/persons/form.html]:
- Linha 6: [th:object] identifica o objeto do formulário; [th:action] recebe o endereço de envio fornecido pelo controller;
- linha 8: o campo oculto que transporta a versão do registro: [th:field="*{version}"] gera seus atributos [name] e [value] (veja o exemplo 19);
- Linhas 9–11: os três campos gerados pelo fragmento [field] do exemplo 19.
O arquivo [templates/layout.html]:
- linha 12: a mensagem de sucesso, no topo da página;
- linha 15: a mensagem de erro no final da página: ou a da requisição atual (colocada no template por [form]) ou a armazenada como atributo flash antes de um redirecionamento. Em ambos os casos, trata-se de um atributo [error] do template da view;
- linhas 17–18: a janela de confirmação e seu script (veja o exemplo 21).
A view [persons/list.html] tem a mesma estrutura da lista de contatos do exemplo 21: para cada pessoa, um link para o formulário de edição e um formulário de exclusão POST, cujo envio é confirmado. O fragmento [fragments/field.html] é o mesmo do exemplo 19, enquanto a janela [fragments/confirmation.html] e o script [static/js/app.js] são os mesmos do exemplo 21, sem alterações.
9.1.7. Execução
Se os valores de [application.properties] não forem adequados (uma senha para [root], por exemplo), eles podem ser substituídos, sem modificar o arquivo, por variáveis de ambiente: o nome da propriedade é escrito em maiúsculas, com os pontos substituídos por sublinhados. No [Windows] ([PowerShell]):
Na inicialização, com o [MariaDB], o [Hibernate] exibe um aviso:
Isso não tem consequências: o [MariaDB] se apresenta ao driver do [MySQL] com o número de versão “5.5.5”, que o [Hibernate] interpreta como um [MySQL] muito antigo. Com o [MySQL] 8, ele não aparece.
A lista, na URLhttp://localhost:5000/:

Um formulário inválido:

Um homônimo: a regra de negócio o detecta. [MySQL], ao comparar usando a collation do banco de dados, rejeita também [marie pelissier], escrito em minúsculas e sem acentos. Aqui, a entrada [Marie Pélissier]:

Uma inclusão bem-sucedida:

Com [spring.jpa.show-sql=true] em [application.properties] (ou, sem modificar o arquivo, [../mvnw spring-boot:run -Dspring-boot.run.arguments=--spring.jpa.show-sql=true]), o console exibe cada comando SQL enviado pelo [Hibernate]. Para adicionar uma pessoa e depois exibir a lista após o redirecionamento:
Aqui vemos a busca por um homônimo (a consulta derivada do nome [findFirstByFirstNameAndLastNameAndIdNot]), o [INSERT] e, em seguida, a leitura da lista ([findAllByOrderByLastNameAscFirstNameAsc]). Os valores são passados separadamente como parâmetros (os [?]): é isso que protege contra injeções de SQL. Os comandos de transação ([START TRANSACTION], [COMMIT]) não são exibidos. Para modificar um registro:
[UPDATE] grava a nova versão e verifica a antiga ([where id=? and version=?]): este é o bloqueio otimista. E para uma exclusão:
[deleteById] não releu o registro: ele já era acompanhado na transação desde a chamada a [read].
O bloqueio otimista: dois formulários estão abertos sobre o mesmo registro; o primeiro é salvo (a versão passa de 0 para 1); o segundo, que ainda tem a versão 0, é rejeitado:

Exclusão, com confirmação:

