Hibernuj samouczek adnotacji jeden do wielu

1. Wstęp

Ten krótki samouczek dotyczący Hibernacji poprowadzi nas przez przykład mapowania jeden do wielu przy użyciu adnotacji JPA, alternatywy dla XML.

Dowiemy się również, czym są relacje dwukierunkowe, jak mogą powodować niespójności i jak może pomóc idea własności.

2. Opis

Mówiąc najprościej, mapowanie jeden do wielu oznacza, że ​​jeden wiersz w tabeli jest mapowany na wiele wierszy w innej tabeli.

Przyjrzyjmy się poniższemu diagramowi relacji encji, aby zobaczyć skojarzenie jeden do wielu :

W tym przykładzie zaimplementujemy system koszyka, w którym mamy tabelę dla każdego koszyka i inną tabelę dla każdego przedmiotu. Jeden koszyk może mieć wiele elementów, więc mamy tutaj mapowanie jeden do wielu .

Sposób, w jaki to działa na poziomie bazy danych, polega na tym, że mamy cart_id jako klucz podstawowy w tabeli koszyka, a także cart_id jako klucz obcy w pozycjach .

Sposób, w jaki robimy to w kodzie, to @OneToMany .

Zmapujmy klasę Cart na obiekt Items w sposób odzwierciedlający relację w bazie danych:

public class Cart { //... @OneToMany(mappedBy="cart") private Set items; //... }

Możemy również dodać odniesienie do koszyka w przedmiotach za pomocą @ManyToOne , dzięki czemu jest to relacja dwukierunkowa. Dwukierunkowy oznacza, że jesteśmy w stanie uzyskać dostęp do pozycji z koszyków , a także do koszyków z pozycji .

Właściwość mappedBy jest tym, czego używamy, aby poinformować Hibernate, której zmiennej używamy do reprezentowania klasy nadrzędnej w naszej klasie potomnej .

Następujące technologie i biblioteki są używane w celu opracowania przykładowej aplikacji Hibernate, która implementuje asocjacje jeden do wielu :

  • JDK 1.8 lub nowszy
  • Hibernacja 5
  • Maven 3 lub nowszy
  • Baza danych H2

3. Konfiguracja

3.1. Konfiguracja bazy danych

Poniżej znajduje się nasz skrypt bazy danych dla tabel koszyka i pozycji . Używamy ograniczenia klucza obcego do mapowania jeden do wielu :

CREATE TABLE `Cart` ( `cart_id` int(11) unsigned NOT NULL AUTO_INCREMENT, PRIMARY KEY (`cart_id`) ) ENGINE=InnoDB AUTO_INCREMENT=5 DEFAULT CHARSET=utf8; CREATE TABLE `Items` ( `id` int(11) unsigned NOT NULL AUTO_INCREMENT, `cart_id` int(11) unsigned NOT NULL, PRIMARY KEY (`id`), KEY `cart_id` (`cart_id`), CONSTRAINT `items_ibfk_1` FOREIGN KEY (`cart_id`) REFERENCES `Cart` (`cart_id`) ) ENGINE=InnoDB AUTO_INCREMENT=7 DEFAULT CHARSET=utf8;

Nasza baza danych jest gotowa, więc przejdźmy do tworzenia przykładowego projektu Hibernate.

3.2. Zależności Mavena

Następnie dodamy zależności sterowników Hibernate i H2 do naszego pliku pom.xml . Zależność Hibernate używa rejestrowania JBoss i jest automatycznie dodawana jako zależności przechodnie:

  • Hibernacja w wersji 5 .2.7.Final
  • Sterownik H2 w wersji 1 .4.197

Odwiedź centralne repozytorium Maven, aby uzyskać najnowsze wersje Hibernate i zależności H2.

3.3. Konfiguracja hibernacji

Oto konfiguracja Hibernate:

  org.h2.Driver   jdbc:h2:mem:spring_hibernate_one_to_many sa org.hibernate.dialect.H2Dialect thread true  

3.4. Klasa HibernateAnnotationUtil

W przypadku klasy HibernateAnnotationUtil wystarczy odwołać się do nowego pliku konfiguracyjnego Hibernate:

private static SessionFactory sessionFactory; private SessionFactory buildSessionFactory() { ServiceRegistry serviceRegistry = new StandardServiceRegistryBuilder(). configure("hibernate-annotation.cfg.xml").build(); Metadata metadata = new MetadataSources(serviceRegistry).getMetadataBuilder().build(); SessionFactory sessionFactory = metadata.getSessionFactoryBuilder().build(); return sessionFactory; } public SessionFactory getSessionFactory() { if(sessionFactory == null) sessionFactory = buildSessionFactory(); return sessionFactory; }

4. Modele

Konfiguracje związane z mapowaniem zostaną wykonane przy użyciu adnotacji JPA w klasach modelu:

@Entity @Table(name="CART") public class Cart { //... @OneToMany(mappedBy="cart") private Set items; // getters and setters }

Należy pamiętać, że adnotacja @OneToMany służy do definiowania właściwości w klasie Items, która będzie używana do mapowania zmiennej mappedBy . Dlatego w klasie Items mamy właściwość o nazwie „ cart ” :

@Entity @Table(name="ITEMS") public class Items { //... @ManyToOne @JoinColumn(name="cart_id", nullable=false) private Cart cart; public Items() {} // getters and setters } 

Należy również zauważyć, że adnotacja @ManyToOne jest powiązana ze zmienną klasy Cart . Adnotacja @JoinColumn odwołuje się do zamapowanej kolumny.

5. W akcji

W programie testowym tworzymy klasę z metodą main () do uzyskiwania sesji Hibernate i zapisujemy obiekty modelu do bazy danych, implementując asocjację jeden do wielu :

sessionFactory = HibernateAnnotationUtil.getSessionFactory(); session = sessionFactory.getCurrentSession(); System.out.println("Session created"); tx = session.beginTransaction(); session.save(cart); session.save(item1); session.save(item2); tx.commit(); System.out.println("Cartitem1, Foreign Key Cartitem2, Foreign Key Cartmany-to-one">6. The @ManyToOne Annotation

As we have seen in section 2, we can specify a many-to-one relationship by using the @ManyToOne annotation. A many-to-one mapping means that many instances of this entity are mapped to one instance of another entity – many items in one cart.

The @ManyToOne annotation lets us create bidirectional relationships too. We'll cover this in detail in the next few subsections.

6.1. Inconsistencies and Ownership

Now, if Cart referenced Items, but Items didn't in turn reference Cart, our relationship would be unidirectional. The objects would also have a natural consistency.

In our case though, the relationship is bidirectional, bringing in the possibility of inconsistency.

Let's imagine a situation where a developer wants to add item1 to cart and item2 to cart2, but makes a mistake so that the references between cart2 and item2 become inconsistent:

Cart cart1 = new Cart(); Cart cart2 = new Cart(); Items item1 = new Items(cart1); Items item2 = new Items(cart2); Set itemsSet = new HashSet(); itemsSet.add(item1); itemsSet.add(item2); cart1.setItems(itemsSet); // wrong!

As shown above, item2 references cart2, whereas cart2 doesn't reference item2, and that's bad.

How should Hibernate save item2 to the database? Will item2 foreign key reference cart1 or cart2?

We resolve this ambiguity using the idea of an owning side of the relationship; references belonging to the owning side take precedence and are saved to the database.

6.2. Items as the Owning Side

As stated in the JPA specification under section 2.9, it's a good practice to mark many-to-one side as the owning side.

In other words, Items would be the owning side and Cart the inverse side, which is exactly what we did earlier.

So how did we achieve this?

By including the mappedBy attribute in the Cart class, we mark it as the inverse side.

At the same time, we also annotate the Items.cart field with @ManyToOne, making Items the owning side.

Going back to our “inconsistency” example, now Hibernate knows that the item2‘s reference is more important and will save item2‘s reference to the database.

Let's check the result:

item1 ID=1, Foreign Key Cart ID=1 item2 ID=2, Foreign Key Cart ID=2

Although cart references item2 in our snippet, item2‘s reference to cart2 is saved in the database.

6.3. Cart as the Owning Side

It's also possible to mark the one-to-many side as the owning side, and many-to-one side as the inverse side.

Although this is not a recommended practice, let's go ahead and give it a try.

The code snippet below shows the implementation of one-to-many side as the owning side:

public class ItemsOIO { // ... @ManyToOne @JoinColumn(name = "cart_id", insertable = false, updatable = false) private CartOIO cart; //.. } public class CartOIO { //.. @OneToMany @JoinColumn(name = "cart_id") // we need to duplicate the physical information private Set items; //.. } 

Notice how we removed the mappedBy element and set the many-to-one @JoinColumn as insertable and updatable to false.

If we run the same code, the result will be the opposite:

item1 ID=1, Foreign Key Cart ID=1 item2 ID=2, Foreign Key Cart ID=1

As shown above, now item2 belongs to cart.

7. Conclusion

We have seen how easy it is to implement the one-to-many relationship with the Hibernate ORM and H2 database using JPA annotations.

Additionally, we learned about bidirectional relationships and how to implement the notion of an owning side.

The source code in this article can be found over on GitHub.