S01L07 - Configurando classe de entidade do Hibernate

html

Índice

Introdução
Compreendendo as Classes de Entidade do Hibernate
Configurando a Classe de Entidade

Convenções de Nomenclatura
Definindo Propriedades da Classe


Usando Anotações no Hibernate

Anotação @Entity
Anotação @Table
Anotações @Id e @Column


Gerando Getters, Setters e Construtores
Exemplo Completo de Classe de Entidade
Conclusão
Recursos Adicionais


Introdução
No reino das aplicações baseadas em Java, frameworks de Mapeamento Objeto-Relacional (ORM) como o Hibernate desempenham um papel fundamental ao preencher a lacuna entre programação orientada a objetos e bancos de dados relacionais. No cerne da funcionalidade do Hibernate está o conceito de Entity Classes. Essas classes são instrumentais no mapeamento de objetos Java para tabelas de banco de dados, garantindo manipulação e recuperação de dados sem interrupções.
Este eBook explora as complexidades de configurar uma classe de entidade do Hibernate. Seja você um iniciante aventurando-se no Hibernate ou um desenvolvedor buscando refinar suas habilidades em ORM, este guia oferece uma visão abrangente, instruções passo a passo e melhores práticas para dominar a criação de classes de entidade.

Compreendendo as Classes de Entidade do Hibernate
O Hibernate simplifica as interações com o banco de dados permitindo que os desenvolvedores trabalhem com objetos Java em vez de escrever consultas SQL complexas. Central para essa abstração estão as Entity Classes, que servem como modelos para tabelas de banco de dados. Cada classe de entidade corresponde a uma tabela no banco de dados, e cada instância da classe representa uma linha dentro dessa tabela.
Pontos Principais:

Framework ORM: O Hibernate gerencia a conversão entre objetos Java e tabelas de banco de dados.
Entity Class: Uma classe Java anotada para representar uma tabela no banco de dados.
Primary Key: Cada entidade deve ter uma chave primária para identificar registros de forma única.


Configurando a Classe de Entidade
Criar uma classe de entidade do Hibernate envolve várias etapas críticas, desde convenções de nomenclatura até a definição de propriedades. Vamos explorar cada componente em detalhe.
Convenções de Nomenclatura
Adotar convenções de nomenclatura consistentes garante clareza e reduz confusões. Tipicamente:

Nomes de Classe: Começam com letra maiúscula e seguem o CamelCase (por exemplo, Users).
Nomes de Propriedade: Usam letras minúsculas com palavras separadas por sublinhados se necessário (por exemplo, user_id).

Exemplo:




		
		
			
			
Java
			
			
public class Users {
    // Corpo da classe
}

			
				
					
				
					1
2
3
4
5
				
						 
public class Users {
    // Corpo da classe
}
 
					
				
			
		


Definindo Propriedades da Classe
Cada propriedade na classe de entidade corresponde a uma coluna na tabela do banco de dados. É essencial corresponder os tipos de dados e nomes com precisão.

Tipos de Dados: Assegure-se de que o tipo de dado Java corresponda ao tipo de dado SQL (por exemplo, int para IDs numéricos, String para dados textuais).
Nomes de Propriedade: Devem refletir os nomes das colunas do banco de dados, possivelmente usando sublinhados para melhor legibilidade.

Exemplo:




		
		
			
			
Java
			
			
private int user_id;
private String username;
private String password;
private String first_name;
private String last_name;

			
				
					
				
					1
2
3
4
5
6
7
				
						 
private int user_id;
private String username;
private String password;
private String first_name;
private String last_name;
 
					
				
			
		



Usando Anotações no Hibernate
Anotações são a forma do Java de adicionar metadados a classes, métodos e variáveis. No Hibernate, as anotações desempenham um papel crucial na definição de como as classes Java mapeiam para tabelas de banco de dados.
Anotação @Entity
A anotação @Entity marca uma classe como uma entidade do Hibernate. Ela significa que a classe está mapeada para uma tabela no banco de dados.
Sintaxe:




		
		
			
			
Java
			
			
import javax.persistence.Entity;

@Entity(name = "users")
public class Users {
    // Corpo da classe
}

			
				
					
				
					1
2
3
4
5
6
7
8
				
						 
import javax.persistence.Entity;
 
@Entity(name = "users")
public class Users {
    // Corpo da classe
}
 
					
				
			
		



Atributo name: Especifica o nome da entidade, útil para logging e consultas.

Anotação @Table
A anotação @Table fornece informações adicionais sobre a tabela do banco de dados que a entidade mapeia para, como o nome da tabela.
Sintaxe:




		
		
			
			
Java
			
			
import javax.persistence.Table;

@Entity(name = "users")
@Table(name = "users")
public class Users {
    // Corpo da classe
}

			
				
					
				
					1
2
3
4
5
6
7
8
9
				
						 
import javax.persistence.Table;
 
@Entity(name = "users")
@Table(name = "users")
public class Users {
    // Corpo da classe
}
 
					
				
			
		



Atributo name: Especifica o nome exato da tabela no banco de dados, garantindo clareza especialmente quando os nomes das classes e das tabelas diferem.

Anotações @Id e @Column
A anotação @Id designa a chave primária da entidade, enquanto a anotação @Column especifica os detalhes da coluna.
Sintaxe:




		
		
			
			
Java
			
			
import javax.persistence.Id;
import javax.persistence.Column;

@Id
@Column(name = "user_id")
private int user_id;

@Column(name = "username")
private String username;

// Similarmente para outras propriedades

			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
				
						 
import javax.persistence.Id;
import javax.persistence.Column;
 
@Id
@Column(name = "user_id")
private int user_id;
 
@Column(name = "username")
private String username;
 
// Similarmente para outras propriedades
 
					
				
			
		



@Id: Marca a chave primária.
@Column: Mapeia a propriedade da classe para a coluna específica na tabela do banco de dados.
Diferenças de Nomenclatura: Mesmo que os nomes das propriedades diferem dos nomes das colunas (por exemplo, firstName vs. first_name), a anotação @Column garante o mapeamento preciso.


Gerando Getters, Setters e Construtores
Para facilitar a manipulação de dados, as classes de entidade devem ter métodos getter e setter para cada propriedade. Além disso, construtores permitem a criação de instâncias de objeto com valores específicos de propriedades.
Getters e Setters
Esses métodos permitem acesso e modificação controlados das propriedades privadas da classe.
Exemplo:




		
		
			
			
Java
			
			
public int getUser_id() {
    return user_id;
}

public void setUser_id(int user_id) {
    this.user_id = user_id;
}

// Similarmente para outras propriedades

			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
				
						 
public int getUser_id() {
    return user_id;
}
 
public void setUser_id(int user_id) {
    this.user_id = user_id;
}
 
// Similarmente para outras propriedades
 
					
				
			
		


Construtores
Construtores inicializam novas instâncias da classe de entidade. É comum gerar um construtor sem argumentos e um construtor parametrizado excluindo a chave primária se ela for autogerada.
Exemplo:




		
		
			
			
Java
			
			
public Users() {
    // Construtor sem argumentos
}

public Users(String username, String password, String first_name, String last_name) {
    this.username = username;
    this.password = password;
    this.first_name = first_name;
    this.last_name = last_name;
}

			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
				
						 
public Users() {
    // Construtor sem argumentos
}
 
public Users(String username, String password, String first_name, String last_name) {
    this.username = username;
    this.password = password;
    this.first_name = first_name;
    this.last_name = last_name;
}
 
					
				
			
		



Exemplo Completo de Classe de Entidade
Juntando todos os componentes discutidos, aqui está um exemplo completo de uma classe de entidade do Hibernate com base no transcript fornecido.




		
		
			
			
Java
			
			
package org.studyeasy.entity;

import javax.persistence.Entity;
import javax.persistence.Table;
import javax.persistence.Id;
import javax.persistence.Column;

@Entity(name = "users")
@Table(name = "users")
public class Users {

    @Id
    @Column(name = "user_id")
    private int user_id;

    @Column(name = "username")
    private String username;

    @Column(name = "password")
    private String password;

    @Column(name = "first_name")
    private String first_name;

    @Column(name = "last_name")
    private String last_name;

    // Construtor sem argumentos
    public Users() {
    }

    // Construtor parametrizado (excluindo user_id)
    public Users(String username, String password, String first_name, String last_name) {
        this.username = username;
        this.password = password;
        this.first_name = first_name;
        this.last_name = last_name;
    }

    // Métodos Getter e Setter
    public int getUser_id() {
        return user_id;
    }

    public void setUser_id(int user_id) {
        this.user_id = user_id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public String getFirst_name() {
        return first_name;
    }

    public void setFirst_name(String first_name) {
        this.first_name = first_name;
    }

    public String getLast_name() {
        return last_name;
    }

    public void setLast_name(String last_name) {
        this.last_name = last_name;
    }
}

			
				
					
				
					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
				
						 
package org.studyeasy.entity;
 
import javax.persistence.Entity;
import javax.persistence.Table;
import javax.persistence.Id;
import javax.persistence.Column;
 
@Entity(name = "users")
@Table(name = "users")
public class Users {
 
    @Id
    @Column(name = "user_id")
    private int user_id;
 
    @Column(name = "username")
    private String username;
 
    @Column(name = "password")
    private String password;
 
    @Column(name = "first_name")
    private String first_name;
 
    @Column(name = "last_name")
    private String last_name;
 
    // Construtor sem argumentos
    public Users() {
    }
 
    // Construtor parametrizado (excluindo user_id)
    public Users(String username, String password, String first_name, String last_name) {
        this.username = username;
        this.password = password;
        this.first_name = first_name;
        this.last_name = last_name;
    }
 
    // Métodos Getter e Setter
    public int getUser_id() {
        return user_id;
    }
 
    public void setUser_id(int user_id) {
        this.user_id = user_id;
    }
 
    public String getUsername() {
        return username;
    }
 
    public void setUsername(String username) {
        this.username = username;
    }
 
    public String getPassword() {
        return password;
    }
 
    public void setPassword(String password) {
        this.password = password;
    }
 
    public String getFirst_name() {
        return first_name;
    }
 
    public void setFirst_name(String first_name) {
        this.first_name = first_name;
    }
 
    public String getLast_name() {
        return last_name;
    }
 
    public void setLast_name(String last_name) {
        this.last_name = last_name;
    }
}
 
					
				
			
		


Explicação do Código

Declaração de Pacote:

    



		
		
			
			
Java
			
			
package org.studyeasy.entity;

			
				
					
				
					1
2
3
				
						 
package org.studyeasy.entity;
 
					
				
			
		



    Define o namespace para a classe Users.
  
Imports:

    



		
		
			
			
Java
			
			
import javax.persistence.Entity;
import javax.persistence.Table;
import javax.persistence.Id;
import javax.persistence.Column;

			
				
					
				
					1
2
3
4
5
6
				
						 
import javax.persistence.Entity;
import javax.persistence.Table;
import javax.persistence.Id;
import javax.persistence.Column;
 
					
				
			
		



    Importa as anotações necessárias da API de Persistência Java (JPA).
  
Anotação @Entity e @Table:

    



		
		
			
			
Java
			
			
@Entity(name = "users")
@Table(name = "users")

			
				
					
				
					1
2
3
4
				
						 
@Entity(name = "users")
@Table(name = "users")
 
					
				
			
		



@Entity: Marca a classe como uma entidade do Hibernate com o nome "users".
@Table: Especifica o nome da tabela do banco de dados "users" que esta entidade mapeia.


Definição da Classe:

    



		
		
			
			
Java
			
			
public class Users {
    // Propriedades e métodos da classe
}

			
				
					
				
					1
2
3
4
5
				
						 
public class Users {
    // Propriedades e métodos da classe
}
 
					
				
			
		



    Define a classe Users que representa a tabela "users" no banco de dados.
  
Definição das Propriedades com Anotações:

    



		
		
			
			
Java
			
			
@Id
@Column(name = "user_id")
private int user_id;

@Column(name = "username")
private String username;

@Column(name = "password")
private String password;

@Column(name = "first_name")
private String first_name;

@Column(name = "last_name")
private String last_name;

			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
				
						 
@Id
@Column(name = "user_id")
private int user_id;
 
@Column(name = "username")
private String username;
 
@Column(name = "password")
private String password;
 
@Column(name = "first_name")
private String first_name;
 
@Column(name = "last_name")
private String last_name;
 
					
				
			
		



Cada propriedade corresponde a uma coluna na tabela "users".
@Id: Denota user_id como a chave primária.
@Column: Mapeia a propriedade para o nome específico da coluna na tabela.


Construtores:

    



		
		
			
			
Java
			
			
public Users() {
}

public Users(String username, String password, String first_name, String last_name) {
    this.username = username;
    this.password = password;
    this.first_name = first_name;
    this.last_name = last_name;
}

			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
				
						 
public Users() {
}
 
public Users(String username, String password, String first_name, String last_name) {
    this.username = username;
    this.password = password;
    this.first_name = first_name;
    this.last_name = last_name;
}
 
					
				
			
		



    Fornece um construtor sem argumentos e um construtor parametrizado (excluindo o user_id autogerado).
  
Métodos Getter e Setter:

    



		
		
			
			
Java
			
			
public int getUser_id() { return user_id; }
public void setUser_id(int user_id) { this.user_id = user_id; }
// Similarmente para outras propriedades

			
				
					
				
					1
2
3
4
5
				
						 
public int getUser_id() { return user_id; }
public void setUser_id(int user_id) { this.user_id = user_id; }
// Similarmente para outras propriedades
 
					
				
			
		



    Permite acesso controlado às propriedades da classe.
  


Conclusão
Criar uma classe de entidade do Hibernate bem estruturada é fundamental para um ORM eficaz em aplicações Java. Ao aderir a convenções de nomenclatura, utilizar anotações e garantir mapeamentos precisos de propriedades, os desenvolvedores podem integrar objetos Java com bancos de dados relacionais de forma fluida. Este eBook delineou as etapas essenciais e as melhores práticas para configurar uma classe de entidade, proporcionando uma base sólida para exploração e domínio adicional do Hibernate.
Este artigo foi gerado por IA.