Programmieren II. Objekt-relationales Mapping. Vorlesung 08. Handout S. 1. Martin Schultheiß. Hochschule Darmstadt Sommersemester 2011

Transkript

1 Programmieren II Martin Schultheiß Hochschule Darmstadt Sommersemester / 39 2 / 39 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 / 39 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( 2 0 ), LASTNAME VARCHAR( 2 0 ), STREET VARCHAR( 2 0 ), CITY VARCHAR( 2 0 ) ) 4 / 39 Korrespondierende Klasse Customer p u b l i c c l a s s Customer { p r i v a t e I n t e g e r i d ; p r i v a t e S t r i n g f i r s t n a m e ; p r i v a t e S t r i n g lastname ; p r i v a t e S t r i n g s t r e e t ; p r i v a t e S t r i n g c i t y ; p u b l i c I n t e g e r g e t I d ( ) { r e t u r n i d ; p u b l i c void s e t I d ( I n t e g e r id ) { t h i s. id = i d ; 5 / 39 Korrespondierende Klasse Customer (Forts.) p u b l i c S t r i n g getfirstname ( ) { r e t u r n f i r s t n a m e ; p u b l i c void setfirstname ( S t r i n g f i r s t n a m e ) { t h i s. f i r s t n a m e = f i r s t n a m e ; // Weitere Getter und S e t t e r p u b l i c S t r i n g t o S t r i n g ( ) { r e t u r n S t r i n g. format ( "%s %s, %s, %s ", firstname, lastname, s t r e e t, c i t y ) ; 6 / 39 Handout S. 2

3 Klasse DBConnection Das Laden des JDBC-Treibers und der Aufbau der Verbindung wird in eine eigene Klasse ausgelagert: p u b l i c c l a s s DBManager { p r i v a t e Connection conn ; p u b l i c DBManager ( ) { t r y { Class. forname ( " org. hsqldb. j dbcdriver " ) ; conn = DriverManager. getconnection ( " jdbc : hsqldb : f i l e : data / f i b u ; shutdown=t r u e ", "SA", "" ) ; catch ( Exception e ) { e. printstacktrace ( ) ; 7 / 39 Klasse DBConnection (Forts.) p u b l i c void c l o s e ( ) { i f ( conn!= n u l l ) { t r y { conn. c l o s e ( ) ; catch ( SQLException e ) { e. printstacktrace ( ) ; f i n a l l y { conn = n u l l ; 8 / 39 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 DBManager zwei neue Methoden hinzugefügt: Customer load(integer id) Hier werden für eine ID die Werte der Attribute per SELECT aus der Tabelle geholt und eine neue Instanz von Customer erzeugt. void persist(customer c) Hier werden die Werte der Attribute von c 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. 9 / 39 Handout S. 3

4 Methode load von DBManager p u b l i c Customer load ( I n t e g e r i d ) { Customer c = n u l l ; t r y { PreparedStatement s t = conn. preparestatement ( " s e l e c t * from CUSTOMER where i d=?" ) ; s t. s e t I n t ( 1, i d ) ; R e s u l t S e t r e s = s t. executequery ( ) ; i f ( r e s. next ( ) ) { c = new Customer ( ) ; c. s e t I d ( r e s. g e t I n t ( "ID" ) ) ; c. s e t F i r s t n a m e ( r e s. g e t S t r i n g ( "FIRSTNAME" ) ) ; c. setlastname ( r e s. g e t S t r i n g ( "LASTNAME" ) ) ; c. s e t S t r e e t ( r e s. g e t S t r i n g ( "STREET" ) ) ; c. s e t C i t y ( r e s. g e t S t r i n g ( "CITY" ) ) ; r e s. c l o s e ( ) ; catch ( SQLException e ) { e. p r i n t S t a c k T r a c e ( ) ; r e t u r n c ; 10 / 39 Methode persist von DBManager p u b l i c void p e r s i s t ( Customer c ) { PreparedStatement s t ; t r y { i f ( c. g e t I d ()== n u l l ) { s t = conn. preparestatement ( " i n s e r t i n t o CUSTOMER"+ " (FIRSTNAME,LASTNAME,STREET, CITY) v a l u e s (?,?,?,? ) " ) ; e l s e { s t = conn. preparestatement ( " update CUSTOMER s e t "+ "FIRSTNAME=?, LASTNAME=?, STREET=?, CITY=? where i d=?" ) ; s t. s e t I n t ( 5, c. g e t I d ( ) ) ; s t. s e t S t r i n g ( 1, c. getfirstname ( ) ) ; s t. s e t S t r i n g ( 2, c. getlastname ( ) ) ; s t. s e t S t r i n g ( 3, c. g e t S t r e e t ( ) ) ; s t. s e t S t r i n g ( 4, c. g e t C i t y ( ) ) ; s t. executeupdate ( ) ; 11 / 39 Methode persist von DBManager (Forts.) i f ( c. g e t I d ()== n u l l ) { s t = conn. preparestatement ( " c a l l i d e n t i t y ( ) " ) ; R e s u l t S e t r e s = s t. executequery ( ) ; r e s. next ( ) ; c. s e t I d ( new I n t e g e r ( r e s. g e t I n t ( 1 ) ) ) ; r e s. c l o s e ( ) ; catch ( SQLException e ) { e. p r i n t S t a c k T r a c e ( ) ; 12 / 39 Handout S. 4

5 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. 13 / 39 Kleiner Cartoon Quelle: 14 / 39 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. 15 / 39 Handout S. 5

6 Hibernate Es existieren verschiedene Frameworks, die ein objekt-relationales Mapping realisieren, mittlerweile standadisiert über die Java Persistence API JPA. Eines der bekanntesten und häufig benutzten ist Hibernate ( 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. 16 / 39 Geschichte Hibernate 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 von RedHat übernommen. 17 / 39 Architektur Hibernate 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. 18 / 39 Handout S. 6

7 Schaubild 19 / 39 Konfiguration einer Hibernate-Anwendung In der Java-SE verwendet man i. A. mit Hibernate einen Entity-Manager, der aus einer so genannten Persistence Unit erzeugt wird. Hierbei erfolgt die Konfiguration der Persistence Unit in der Datei META-INF/persistence.xml: <?xml version=" 1. 0 " encoding=" utf -8 "?> <p e r s i s t e n c e xmlns=" h t t p : // java. sun. com/xml/ ns / p e r s i s t e n c e " xmlns: xsi=" http: //www. w3. org /2001/XMLSchema- instance " x s i : s c h e m a L o c a t i o n=" h t t p : // java. sun. com/xml/ ns / p e r s i s t e n c e h t t p : // j a va. sun. com/xml/ ns / p e r s i s t e n c e / persistence_2_0. xsd " v e r s i o n=" 2. 0 "> <persistence - unit name=" manager1 " transaction - type="resource_local"> <property name=" hibernate. max_fetch_depth" value="3"/> </ persistence - unit> 20 / 39 Anlegen des Entity-Managers import javax. p e r s i s t e n c e. * ; p u b l i c c l a s s Anwendung { p u b l i c s t a t i c void main ( S t r i n g [ ] a r g s ) { EntityManagerFactory emf = P e r s i s t e n c e. createentitymanagerfactory ( "manager1" ) ; EntityManager em = emf. createentitymanager ( ) ; // Arbeiten mit p e r s i s t e n t e n Objekten em. c l o s e ( ) ; emf. c l o s e ( ) ; 21 / 39 Handout S. 7

8 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. 22 / 39 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. Durch Annotationen können besondere Zuordnungen (Primärschlüssel, Abbildungen n:m, unterschiedlicher Name von Attribut und Tabellenspalte) definiert werden. 23 / 39 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) 24 / 39 Handout S. 8

9 Erster Ansatz: Klasse Invoice import javax. p e r s i s t e n c e. * p u b l i c c l a s s I n v o i c e { p r i v a t e I n t e g e r i d ; p r i v a t e I n t e g e r customerid ; p r i v a t e Double t o t a ( s t r a t e g y=generationtype.auto) p u b l i c I n t e g e r g e t I d ( ) { r e t u r n i d ; p u b l i c void s e t I d ( I n t e g e r id ) { t h i s. id = i d ; 25 / 39 Erster Ansatz: Klasse Invoice (Forts.) p u b l i c I n t e g e r getcustomerid ( ) { r e t u r n customerid ; p u b l i c void setcustomerid ( I n t e g e r customerid ) { t h i s. customerid = customerid ; p u b l i c Double gettotal ( ) { r e t u r n t o t a l ; p u b l i c void s e t T o t a l ( Double t o t a l ) { t h i s. t o t a l = t o t a l ; 26 / 39 Mapping Während in Hibernate das ORM ursprünglich über XML-Dateien erfolgte, geht dies nun über Annotationen: Die Klasse Invoice wird über Annotation als Entität gekennzeichnet, wobei per Default angenommen wird, dass die Datenbanktabelle den selben Namen hat. Dann wird das Attribut id der Java-Klasse als Primärschlüssel markiert. Alle weiteren Attribute der Klasse werden automatisch auf die Datenbankspalte gleichen Namens abgebildet. 27 / 39 Handout S. 9

10 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 p u b l i c c l a s s I n v o i c e {... p r i v a t e Customer ( name="customerid" ) p u b l i c Customer getcustomer ( ) { r e t u r n customer ; p u b l i c void setcustomer ( Customer customer ) { t h i s. customer = customer ; 28 / 39 Mapping Dies ist ein Fall einer Zuordnung many-to-one: Mehrere Rechnungen können für denselben Kunden ausgestellt sein. Diese Abbildung erfolgt über die wobei der Name der Tabellenspalte mit dem Fremdschlüssel angegeben werden muss, wenn diese Spalte nicht einfach FKTAB_ID heißt, wobei FKTAB der Name der verknüpften Tabelle ist. Die Klasse Customer muss natürlich auch entsprechend mit Annotationen für JPA versehen sein. 29 / 39 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 Collection von Item neu hinzugefügt, die eine Abbildung vom Typ one-to-many ist. Hierbei wird für die Zuordnung die Spalte invoiceid aus Item als foreign key verwendet, anhand dessen die passenden Rechnungsposten ausgewählt werden. Zusätzlich wird direkt die Tabelle Product anhand der Produktnr. des Rechnungsposten in die Klasse Item abgebildet. 30 / 39 Handout S. 10

11 Klasse p u b l i c c l a s s I n v o i c e { p r i v a t e C o l l e c t i o n <Item> items i n v o i c e " ) p u b l i c C o l l e c t i o n <Item> getitems ( ) { r e t u r n items ; p u b l i c void s e t I t e m s ( C o l l e c t i o n <Item> items ) { t h i s. items = items ; 31 / 39 Klasse p u b l i c c l a s s Item { p r i v a t e I n t e g e r i d ; p r i v a t e I n v o i c e i n v o i c e ; p r i v a t e Product product ; p r i v a t e I n t e g e r name="item" ( s t r a t e g y=generationtype.auto) p u b l i c I n t e g e r g e t I d ( ) { r e t u r n i d ; p u b l i c void s e t I d ( I n t e g e r id ) { t h i s. id = i d ; 32 / 39 Klasse ( name="invoiceid" ) p u b l i c I n v o i c e g e t I n v o i c e ( ) { r e t u r n i n v o i c e ; p u b l i c void s e t I n v o i c e ( I n v o i c e i n v o i c e ) { t h i s. i n v o i c e = i n v o i c ( name="productid" ) p u b l i c Product getproduct ( ) { r e t u r n product ; p u b l i c void setproduct ( Product product ) { t h i s. product = product ; 33 / 39 Handout S. 11

12 Klasse Item (Forts.) p u b l i c I n t e g e r getquantity ( ) { r e t u r n quantity ; p u b l i c void setquantity ( I n t e g e r quantity ) { t h i s. quantity = quantity ; 34 / 39 Klasse p u b l i c c l a s s Product { p r i v a t e I n t e g e r i d ; p r i v a t e S t r i n g name ; p r i v a t e Double p r i c e p u b l i c I n t e g e r g e t I d ( ) { r e t u r n i d ; p u b l i c void s e t I d ( I n t e g e r id ) { t h i s. id = i d ; 35 / 39 Klasse Product (Forts.) p u b l i c S t r i n g getname ( ) { r e t u r n name ; p u b l i c void setname ( S t r i n g name) { t h i s. name = name ; p u b l i c Double g e t P r i c e ( ) { r e t u r n p r i c e ; p u b l i c void s e t P r i c e ( Double p r i c e ) { t h i s. p r i c e = p r i c e ; 36 / 39 Handout S. 12

13 Anwendung p u b l i c c l a s s Anwendung { p u b l i c s t a t i c void main ( S t r i n g [ ] a r g s ) { EntityManagerFactory emf = P e r s i s t e n c e. createentitymanagerfactory ( "manager1" ) ; EntityManager em = emf. createentitymanager ( ) ; EntityTransaction tx = em. g e t Transaction ( ) ; tx. begin ( ) ; Customer c = em. f i n d ( Customer. c l a s s, new I n t e g e r ( 5 ) ) ; System. out. p r i n t l n ( c ) ; c. s e t C i t y ( " Frankfurt " ) ; tx. commit ( ) ; 37 / 39 Anwendung (Forts.) tx. begin ( ) ; c = new Customer ( ) ; c. setfirstname ( " Karl " ) ; c. setlastname ( " Meier " ) ; c. s e t S t r e e t ( "Ahornweg" ) ; c. s e t C i t y ( "Köln" ) ; em. p e r s i s t ( c ) ; tx. commit ( ) ; System. out. p r i n t l n ( c. g e t I d ( ) ) ; 38 / 39 Anwendung (Forts.) I n v o i c e inv = em. f i n d ( I n v o i c e. c l a s s, new I n t e g e r ( 2 ) ) ; System. out. p r i n t l n ( inv. getcustomer ( ) ) ; f o r ( Item item : inv. getitems ( ) ) { System. out. format ( "%d mal %s \n", item. getquantity ( ), item. getproduct ( ). getname ( ) ) ; em. c l o s e ( ) ; emf. c l o s e ( ) ; 39 / 39 Handout S. 13