Programmieren II. Objekt-relationales Mapping. Vorlesung 12. Handout S. 1. Dr. Klaus Höppner. Hochschule Darmstadt Sommersemester 2009

Transkript

1 Programmieren II Dr. Klaus Höppner Hochschule Darmstadt Sommersemester / 35 2 / 35 Mit JDBC kann Java sich mit relationalen Datenbanken verbinden. Hierbei entsprechen jeder Datensatz einer Zeile in einer Datenbanktabelle und die Attribute eines Datensatzes den Tabellenspalten. Daher ist es prinzipiell möglich, eine Abbildung zwischen den Datensätzen in einer Tabelle und klassischen Java-Objekten (POJO plain old Java objects herzustellen. Eine solche Abbildung nennt man objekt-relationales Mapping (ORM). 3 / 35 Handout S. 1

2 Beispieltabelle: Customer Die folgende Tabelle beschreibt einen Kunden mit Adresse, wobei die ID des Kunden automatisch generiert wird (entsprechend des SQL-Dialektes für HSQLDB): CREATE TABLE CUSTOMER( ID INTEGER GENERATED BY DEFAULT AS IDENTITY(START WITH 0) NOT NULL PRIMARY KEY, FIRSTNAME VARCHAR(20), LASTNAME VARCHAR(20), STREET VARCHAR(20), CITY VARCHAR(20) ) 4 / 35 Korrespondierende Klasse Customer public class Customer { private Long id; private String firstname; private String lastname; private String street; private String city; // Getter und Setter public Integer getid() { return id; public void setid(integer id) { this.id = public String tostring() { return String.format("%s %s; %s; %s", getfirstname(), getlastname(),getstreet(), getcity()); 5 / 35 Verknüpfung DB-Tabelle Java-Objekt Nun sollen Java-Objekte persistent gemacht werden, indem Objekte vom Typ Customer mit der gleichnamigen DB-Tabelle synchronisiert werden können. Hierzu werden der Klasse Customer zwei neue Methoden hinzugefügt: fetch() Hier werden für eine Instanz von Customer (mit gültiger ID) die Werte der Attribute per SELECT aus der Tabelle geholt. update() Hier werden die Werte der Attribute in die Tabelle geschrieben, wobei bei leerer ID (null) ein neuer Datensatz per INSERT eingefügt, andernfalls die Feldwerte des existierenden Datensatzes per UPDATE aktualisiert werden. 6 / 35 Handout S. 2

3 Klasse DBConnection public class DBConnection { private static Connection con = null; public static Connection getconnection() { if (con==null) { try { Class.forName("org.hsqldb.jdbcDriver"); con = DriverManager.getConnection("jdbc:hsqldb:file:"+ "data/fibu;shutdown=true", "SA", ""); catch (ClassNotFoundException e) {e.printstacktrace(); catch (SQLException e) {e.printstacktrace(); return con; public static void disconnect() { if (con!=null) { try {con.close(); catch (SQLException e) {e.printstacktrace(); finally {con=null; Methode fetch() von Customer 7 / 35 public void fetch() { if (id==null) throw new RuntimeException("Object not persistent"); Connection con = DBConnection.getConnection(); try { PreparedStatement pst = con.preparestatement("select * from customer where id=?"); pst.setint(1, id.intvalue()); ResultSet res = pst.executequery(); if (res.next()) { setlastname(res.getstring("lastname")); setfirstname(res.getstring("firstname")); setstreet(res.getstring("street")); setcity(res.getstring("city")); else { setid(null); setlastname(null); setfirstname(null); setstreet(null); setcity(null); catch (SQLException e) {e.printstacktrace(); 8 / 35 Methode update() von Customer public void update() { Connection con = DBConnection.getConnection(); PreparedStatement pst = null; try { if (getid()==null) { pst = con.preparestatement("insert into customer "+ "(FIRSTNAME, LASTNAME, STREET, CITY) values (?,?,?,?)"); else { pst = con.preparestatement("update customer set "+ "FIRSTNAME=?, LASTNAME=?, STREET=?, CITY=? where id=?"); pst.setint(5, getid().intvalue()); pst.setstring(1, getfirstname()); pst.setstring(2, getlastname()); pst.setstring(3, getstreet()); pst.setstring(4, getcity()); pst.executeupdate(); pst.close(); 9 / 35 Handout S. 3

4 Methode update() (Forts.) if (getid()==null) { pst = con.preparestatement("call IDENTITY()"); ResultSet res = pst.executequery(); if (res!=null && res.next()) { setid(new Integer(res.getInt(1))); res.close(); catch (SQLException e) { e.printstacktrace(); finally { if (pst!=null) { try {pst.close(); catch (SQLException e) {e.printstacktrace(); 10 / 35 Exkurs: PreparedStatement In der Realisierung von fetch() und update() wurde statt Statement jeweils PreparedStatement benutzt. Bei PreparedStatement wird beim Anlegen das Statement bereits mit einem SQL-Befehl (i. A. mit Platzhaltern) vorbereitet. Dieser wird von der Datenbank vorkompiliert. Danach können die Platzhalter mit den realen Werte belegt werden. Vorteile: Bei mehrfacher Verwendung (z. B. in Schleifen) ergibt sich ein Laufzeitgewinn, da der Befehl schon vorkompiliert ist. Da die Gültigkeit der Parameter überprüft wird und SQL-Sonderzeichen (z. B. ) geschützt werden, werden so genannte SQL-Injections verhindert. 11 / 35 Zusammenfassung In diesem Abschnitt wurde anhand einer einfachen Tabelle demonstriert, wie ein objekt-relationales Mapping selber realisiert werden kann. Der Aufwand war aber recht hoch, da individuell für die Klasse die entsprechenden Methoden zur Synchronisation inkl. der entsprechenden SQL-Befehle implementiert wurden. Wegen verschiedener SQL-Dialekte der RDBMS ist die Implementierung auch DB-spezifisch. Der Aufwand wird noch höher, wenn Tabellen über Schlüssel miteinander verknüpft sind. Daher werden in der Praxis für ORM spezielle Frameworks benutzt. 12 / 35 Handout S. 4

5 Es existieren verschiedene Frameworks, die ein objekt-relationales Mapping realisieren. Eines der bekanntesten und häufig benutzten ist ( Was ist der Vorteil eines solchen Frameworks und ORM? Es verbindet die Vorteile der objektorientierten Programmierung mit den Vorteilen einer Datenbank, insbesondere der Persistenz (d. h. dass Datensätze in einem RDBMS nicht flüchtig sind). So kann man persistente Objekte realisieren, die sich weitgehend wie normale Java-Objekte verwenden lassen. 13 / 35 Geschichte wurde von der Firma JBoss entwickelt, die sich mit Open-Source-Software im Bereich Java-Middleware, -Applikationsservern und Message-Brokern beschäftigt. Mittlerweile wurde JBoss (nach einem Bieterkampf mit Oracle) von RedHat übernommen. 14 / 35 Architektur stellt in der einfachsten Benutzungsform dem Anwender eine Datenbank-Session zur Verfügung, die nach Konfiguration eines Datenbanktyps und der Datenbankparameter geöffnet wird. Objekte können sich in drei Zuständen befinden: transient Das Objekt ist noch nicht mit der Datenbank verknüpft, also flüchtig. persistent Das Objekt ist im aktuellen Kontext mit der Datenbank verknüpft. detached Das Objekt war mit der Datenbank verknüpft, der Kontext existiert aber nicht mehr. Daher ist das Objekt aktuell losgelöst. 15 / 35 Handout S. 5

6 Schaubild 16 / 35 Konfiguration einer -Anwendung Die Konfiguration von (Datenbank, Logging etc.) erfolgt über die Klasse org.hibernate.cfg.configuration. Hierbei gibt es die Möglichkeit, zur Konfiguration die Datei hibernate.cfg.xml im Source-Verzeichnis zu verwenden und anschließend eine Implementierung von org.hibernate.sessionfactory zu erzeugen: Configuration cfg = new Configuration().configure(); SessionFactory sessionfactory = cfg.buildsessionfactory(); Alternativ können Konfigurationsparameter mit der Methode setproperty gesetzt werden: Configuration cfg = new Configuration(); cfg.setproperty("hibernate.connection.username","sa"); / 35 Beispiel einer Konfigurationsdatei <?xml version= 1.0 encoding= utf-8?> <!DOCTYPE hibernate-configuration PUBLIC "-/// Configuration DTD 3.0//EN" " <hibernate-configuration> <session-factory> <!-- Database connection settings --> <property name="connection.driver_class">org.hsqldb.jdbcdriver</property> <property name="connection.url">jdbc:hsqldb:file:data/fibu;shutdown=true</property> <property name="connection.username">sa</property> <property name="connection.password"></property> <!-- JDBC connection pool (use the built-in) --> <property name="connection.pool_size">1</property> <!-- SQL dialect --> <property name="dialect">org.hibernate.dialect.hsqldialect</property> <!-- Enable automatic session context management --> <property name="current_session_context_class">thread</property> <!-- Disable the second-level cache --> <property name="cache.provider_class">org.hibernate.cache.nocacheprovider</property> <!-- Echo all executed SQL to stdout --> <property name="show_sql">true</property> <!-- Drop and re-create the database schema on startup --> <property name="hbm2ddl.auto">create</property> <mapping resource="fibu/customer.hbm.xml"/> </session-factory> </hibernate-configuration> 18 / 35 Handout S. 6

7 Grundlagen von ORM Durch ORM werden Klassen mit Tabellen und Instanzen der Klassen mit Datensätzen innerhalb der Tabelle verknüpft. Damit Instanzen eindeutig Datensätzen zugeordnet werden können, muss die Datenbanktabelle einen eindeutigen Primärschlüssel besitzen. Dieser wird dann als WHERE-Ausdruck in den abgesetzten SQL-Anweisungen verwendet. Weiterhin dient die Existenz einer Primär-ID im Objekt der Unterscheidung, ob ein nicht persistentes Objekt transient oder detached ist. 19 / 35 Faustregeln Im Allgemeinen wird eine Tabelle der Datenbank einer Java-Klasse zugeordnet. Diese Klasse muss einen Standardkonstruktor besitzen. Die Attribute der Tabelle werden auf entsprechende Attribute der Klasse abgebildet. In der Klasse werden dann Getter und Setter für diese Attribute definiert. Die eigentliche Zuordnung zwischen Klasse und Tabelle erfolgt dann über eine XML-Datei, die insbesondere den Primärschlüssel angibt, der zur Identifikation von Elementen verwendet wird, sowie die Namen von Tabellenspalten den Attributen der Klasse zuordnet. 20 / 35 Beispiel: Datenbank Fibu Hier nun ein Datenbankschema für eine Buchhaltung: Invoice ID : INTEGER CUSTOMERID : INTEGER TOTAL : DECIMAL(10,2) Customer ID : INTEGER FIRSTNAME : VARCHAR(20) LASTNAME : VARCHAR(20) Item ITEM : INTEGER INVOICEID : INTEGER PRODUCTID : INTEGER QUANTITY : INTEGER COST : DECIMAL(10,2) PRODUCT ID : INTEGER NAME : VARCHAR(20) PRICE : DECIMAL(10,2) 21 / 35 Handout S. 7

8 Erster Ansatz: Klasse Invoice public class Invoice { private Long id; private Long customerid; private Double total; public Invoice() { public Long getid() { return id; public void setid(long id) { this.id = id; public Long getcustomerid() { return customerid; public void setcustomerid(long customerid) { this.customerid = customerid; public Double gettotal() { return total; public void settotal(double total) { this.total = total; 22 / 35 Mapping Das eigentliche Mapping erfolgt dann über die Datei Invoice.hbm.xml: <?xml version="1.0"?> <!DOCTYPE hibernate-mapping PUBLIC "-/// Mapping DTD 3.0//EN" " <hibernate-mapping package="fibu"> <class name="invoice" table="invoice"> <id name="id" column="id"> <generator class="native"></generator> </id> <property name="customerid"></property> <property name="total"></property> </class> </hibernate-mapping> 23 / 35 Analyse Die gezeigte XML-Datei enthält folgende Definitionen: Das Mapping wird für Klassen innerhalb des Pakets fibu durchgeführt. Für jede abzubildende Klasse gibt es ein Element class, in diesem Fall für die Klasse Invoice, gleichzeitig wird erklärt, welcher Tabelle die Klasse zugeordnet ist. In diesem Fall wird für den Primärschlüssel das Attribut id der Java-Klasse mit dem gleichnamigen Attribut der Tabelle verknüpft. Weiterhin erfolgen die Abbildungen für customerid und total. 24 / 35 Handout S. 8

9 Zweiter Ansatz für Invoice In Wirklichkeit möchte man in der Klasse Invoice statt der reinen Kundennr. lieber direkt eine Referenz auf den Kunden haben: public class Invoice { private Long id; private Customer customer; private Double total; public Invoice() { // Getter und Setter 25 / 35 Mapping Dies ist ein Fall einer Zuordnung many-to-one: Mehrere Rechnungen können für denselben Kunden ausgestellt sein. <?xml version="1.0"?> <!DOCTYPE hibernate-mapping PUBLIC "-/// Mapping DTD 3.0//EN" " <hibernate-mapping package="fibu"> <class name="invoice" table="invoice"> <id name="id" column="id"> <generator class="native"></generator> </id> <property name="total"></property> <many-to-one name="customer"> <column name="customerid"></column> </many-to-one> </class> 26 / 35 Mapping (Forts.) <class name="customer" table="customer"> <id name="id" column="id"> <generator class="native"></generator> </id> <property name="firstname"></property> <property name="lastname"></property> <property name="street"></property> <property name="city"></property> </class> </hibernate-mapping> Die Zuordnung des Kunden zur Rechnung erfolgt dabei durch die Angabe der Spalte in der Tabelle Invoice, in der sich der Primärschlüssel des betreffenden Kunden befindet. 27 / 35 Handout S. 9

10 Mapping der Rechnungspositionen Einer Rechnung sind in der Regel viele Rechnungsposten zugeordnet. Die Zuordnung erfolgt durch die Spalte invoiceid in der Tabelle Item. Hierfür wird in der Klasse Invoice nun eine Liste von Item neu hinzugefügt, die auf den Mapping-Typ list abgebildet wird. Hierbei wird in der Abbildung die Spalte invoiceid als key verwendet, anhand dessen die passenden Rechnungsposten ausgewählt werden. Zusätzlich wird direkt die Tabelle Product anhand der Produktnr. des Rechnunsposten in die Klasse Item abgebildet. 28 / 35 Klasse Invoice public class Invoice { private Long id; private Customer customer; private List items = new ArrayList(); private Double total; public Invoice() { // Getter und Setter... public List getitems() { return items; public void setitems(list items) { this.items = items; 29 / 35 Klasse Item public class Item { private Product product; private Double cost; private Long quantity; public Item() { // Getter und Setter public Product getproduct() { return product; public void setproduct(product product) { this.product = product; / 35 Handout S. 10

11 public class Customer { private Long id; private String firstname; private String lastname; private String street; private String city; Klasse Customer public Customer() { // Getter und public String tostring() { return String.format("%s %s; %s; %s", getfirstname(), getlastname(), getstreet(), getcity()); Klasse Product 31 / 35 public class Product { private Long id; private String name; private Double price; public Product() { // Getter und Setter public Long getid() { return id; public void setid(long id) { this.id = id; / 35 Mapping <hibernate-mapping package="fibu"> <class name="invoice" table="invoice"> <id name="id" column="id"> <generator class="native"></generator> </id> <property name="total"></property> <many-to-one name="customer"> <column name="customerid"></column> </many-to-one> <list name="items" table="item"> <key column="invoiceid"></key> <list-index column="item"></list-index> <composite-element class="item"> <property name="quantity"></property> <property name="cost"></property> <many-to-one name="product" column="productid"/> </composite-element> </list> </class> 33 / 35 Handout S. 11

12 Mapping (Forts.) <class name="customer" table="customer"> <id name="id" column="id"> <generator class="native"></generator> </id> <property name="firstname"></property> <property name="lastname"></property> <property name="street"></property> <property name="city"></property> </class> <class name="product" table="product"> <id name="id"></id> <property name="name"></property> <property name="price"></property> </class> </hibernate-mapping> 34 / 35 Anwendung Session session = Util.getSessionFactory().getCurrentSession(); session.begintransaction(); Invoice i = (Invoice) session.get(invoice.class, 3L); System.out.println(i.getCustomer()); for (Object o : i.getitems()) { final Item it = (Item) o; System.out.println(it.getCost()); System.out.println(it.getProduct().getName()); Customer c = (Customer) session.get(customer.class, 6L); i.setcustomer(c); final Item it = (Item) i.getitems().get(0); it.setquantity(5l); session.gettransaction().commit(); 35 / 35 Handout S. 12