Hibernate One to Many Annotation Tutorial

1. Introduktion

Denna snabba Hibernate-handledning tar oss igenom ett exempel på en -till-många- kartläggning med JPA-kommentarer, ett alternativ till XML.

Vi lär oss också vad tvåriktade relationer är, hur de kan skapa inkonsekvenser och hur idéen om ägande kan hjälpa till.

2. Beskrivning

Enkelt uttryckt betyder en-till-många- kartläggning att en rad i en tabell mappas till flera rader i en annan tabell.

Låt oss titta på följande enhetsrelationsdiagram för att se en en-till-många- förening:

I det här exemplet implementerar vi ett vagnsystem där vi har en tabell för varje vagn och en annan tabell för varje artikel. En vagn kan ha många artiklar, så här har vi en en-till-många- kartläggning.

Så här detta fungerar på databasenivå är att vi har en cart_id som en primär nyckel i vagnen och också en cart_id som en främmande nyckel i artiklar .

Hur vi gör det i kod är med @OneToMany .

Låt oss kartlägga varukorgsklassen till objektobjektet på ett sätt som återspeglar förhållandet i databasen:

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

Vi kan också lägga till en hänvisning till kundvagnen i artiklar med @ManyToOne , vilket gör detta till en dubbelriktad relation. Dubbelriktad betyder att vi kan komma åt föremål från vagnar och även vagnar från föremål .

Den mappedBy Fastigheten är vad vi använder för att berätta Hibernate som variabel vi använder för att representera den överordnade klassen i vår barnklass.

Följande tekniker och bibliotek används för att utveckla ett exempel på en viloläge-applikation som implementerar en-till-många- associering:

  • JDK 1.8 eller senare
  • Viloläge 5
  • Maven 3 eller senare
  • H2-databas

3. Inställning

3.1. Databasinställning

Nedan finns vårt databasskript för vagn- och artiklarstabeller . Vi använder begränsningen för främmande nycklar för en-till-många- kartläggning:

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;

Vår databasinställning är klar, så låt oss gå vidare till att skapa exemplet Hibernate-exempel.

3.2. Maven Beroenden

Vi lägger sedan till beroendeberoendet för viloläge och H2 i vår pom.xml- fil. Hibernate-beroendet använder JBoss-loggning och det läggs automatiskt till som övergående beroenden:

  • Viloläge version 5 .2.7.Slut
  • H2-drivrutin version 1 .4.197

Besök Mavens centrala arkiv för de senaste versionerna av Hibernate och H2-beroenden.

3.3. Viloläge-konfiguration

Här är konfigurationen av Hibernate:

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

3.4. HibernateAnnotationUtil Class

Med klassen HibernateAnnotationUtil behöver vi bara referera till den nya Hibernate-konfigurationsfilen:

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. Modellerna

Mappningsrelaterade konfigurationer kommer att göras med JPA-anteckningar i modellklasserna:

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

Observera att @OneToMany- anteckningen används för att definiera egenskapen i objektklassen som kommer att användas för att mappa variabeln mappedBy . Det är därför vi har en egenskap som heter " vagn " i klassen Items :

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

Det är också viktigt att notera att @ManyToOne- anteckningen är associerad med Cart- variabeln. @JoinColumn- kommentar refererar till den mappade kolumnen.

5. I aktion

I testprogrammet skapar vi en klass med en huvudmetod () för att få Hibernate Session och spara modellobjekten i databasen genom att implementera en-till-många- föreningen:

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.