Учебное пособие по Hibernate One to Many Annotation

1. Введение

В этом кратком руководстве по Hibernate мы рассмотрим пример сопоставления « один ко многим» с использованием аннотаций JPA, альтернативы XML.

Мы также узнаем, что такое двунаправленные отношения, как они могут создавать несоответствия и как идея владения может помочь.

2. Описание

Проще говоря, сопоставление « один ко многим» означает, что одна строка в таблице отображается на несколько строк в другой таблице.

Давайте посмотрим на следующую диаграмму отношений сущностей, чтобы увидеть связь " один ко многим" :

В этом примере мы реализуем систему корзины, в которой у нас есть таблица для каждой корзины и другая таблица для каждого элемента. В одной тележке может быть много товаров, поэтому здесь у нас есть отображение « один ко многим» .

На уровне базы данных это работает так: у нас есть cart_id в качестве первичного ключа в таблице корзины, а также cart_id в качестве внешнего ключа в items .

В коде мы делаем это с помощью @OneToMany .

Давайте сопоставим класс Cart с объектом Items таким образом, чтобы отразить отношения в базе данных:

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

Мы можем также добавить ссылку на корзину в пунктах с использованием @ManyToOne , делая это двунаправленные отношения. Двунаправленный означает, что мы можем получить доступ к элементам из тележек , а также тележек из предметов .

Свойство mappedBy - это то, что мы используем, чтобы сообщить Hibernate, какую переменную мы используем для представления родительского класса в нашем дочернем классе.

Следующие технологии и библиотеки используются для разработки примера приложения Hibernate, которое реализует ассоциацию « один ко многим» :

  • JDK 1.8 или новее
  • Спящий режим 5
  • Maven 3 или новее
  • База данных H2

3. Настройка

3.1. Настройка базы данных

Ниже представлен сценарий нашей базы данных для таблиц Cart и Items . Мы используем ограничение внешнего ключа для сопоставления один-ко-многим :

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;

Настройка нашей базы данных готова, поэтому перейдем к созданию примера проекта Hibernate.

3.2. Зависимости Maven

Затем мы добавим зависимости драйвера Hibernate и H2 в наш файл pom.xml . Зависимость Hibernate использует ведение журнала JBoss и автоматически добавляется как транзитивные зависимости:

  • Гибернация версии 5 .2.7.Final
  • Драйвер H2 версии 1.4.197

Посетите центральный репозиторий Maven для получения последних версий Hibernate и зависимостей H2.

3.3. Конфигурация гибернации

Вот конфигурация Hibernate:

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

3.4. Класс HibernateAnnotationUtil

С классом HibernateAnnotationUtil нам просто нужно сослаться на новый файл конфигурации 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. Модели

Конфигурации, связанные с отображением, будут выполнены с использованием аннотаций JPA в классах модели:

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

Обратите внимание, что аннотация @OneToMany используется для определения свойства в классе Items, которое будет использоваться для сопоставления переменной mappedBy . Вот почему у нас есть свойство с именем « cart » в классе Items :

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

Также важно отметить, что аннотация @ManyToOne связана с переменной класса Cart . Аннотация @JoinColumn ссылается на сопоставленный столбец.

5. В действии

В тестовой программе мы создаем класс с методом main () для получения сеанса Hibernate и сохраняем объекты модели в базе данных, реализующей связь один-ко-многим :

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.