Autorenarchiv

Transaktionssteuerung mit Spring AOP

Freitag, 24. April 2009

Spring bietet uns mit AOP die Möglichkeit innerhalb der Spring Konfiguration die Behandlung der Datenbanktransaktionen zu steuern. Hierfür benötigen wir lediglich eine AOP Konfiguration, die auf alle Methoden zeigt, die innerhalb einer Transaktion ablaufen sollen und den Spring Tag .

In diesem Beispiel gehen wir von zwei Service Klassen aus, deren Methoden von einer Transaktion umschlossen werden sollen.

applicationContext.xml:

<-- service beans -->
<bean id="fooService" class="a.b.service.FooService" />
<bean id="barService" class="a.b.service.BarService" />
 
<-- hibernate transaction manager -->
<bean id="txManager" class="org.springframework.orm.hibernate3.HibernateTransactionManager">
    <property name="sessionFactory" ref="sessionFactory" />
</bean>
 
<-- hibernate session factory -->
<bean id="sessionFactory" class="org.springframework.orm.hibernate3.annotation.AnnotationSessionFactoryBean">
    <property name="dataSource">
        <ref bean="dataSource" />
    </property>
    <property name="annotatedClasses">
        <list>....</list>
    </property>
    <property name="hibernateProperties">
        <props>
            <prop key="hibernate.dialect">org.hibernate.dialect.PostgreSQLDialect</prop>
        </props>
    </property>
</bean>

Innerhalb des tx:advice definieren wir das Verhalten für die einzelnen Methoden der Services. Für alle Methodenaufrufe werden die gleichen Isolation- und Propagation-Level benutzt. Für Methoden die mit „find“ oder „get“ beginnen setzen wir die Transaktion noch auf read-only. In diesem Methoden dürfen jetzt nur noch Datenbank SELECTs ausgeführt werden, anderenfalls würde es eine Exception geben. Die Datenbank kann so das Locking auf Zeilen, die von diesem Methodenaufrufen betroffen, sind optimieren.

applicationContext.xml:

<tx:advice id="defaultTranscationAdvice" transaction-manager="txManager">
    <tx:attributes>
        <tx:method name="*" isolation="READ_COMMITTED" propagation="REQUIRED" />
        <tx:method name="find*" read-only="true" />
        <tx:method name="get*" read-only="true" />
    </tx:attributes>
</tx:advice>

Als letztes brauchen wir jetzt noch die AOP Konfiguration, die das defaultTransactionAdvice mit den Service Klassen verbindet. Durch die Definition „a.b.service.*.*(..)“ wird um jede Methode in jeder Klasse innerhalb des Paketes a.b.service eine Transaktion gelegt. Es können so weitere Service Klassen hinzugefügt werden, ohne dass das Transaktion Handling angepasst werden muss.

applicationContext.xml:

<aop:config>
    <aop:pointcut id="allServiceMethods" expression="execution(* a.b.service.*.*(..))" />
    <aop:advisor advice-ref="defaultTranscationAdvice" pointcut-ref="allServiceMethods" />
</aop:config>

Innerhalb der Service Methoden brauchen wir uns nun keine Gedanken mehr um offene oder geschlossene Transaktionen machen. Wir bewegen uns in jedem Fall innerhalb einer Transaktion. Sollte es zu einem Fehler kommen, so wird ein Rollback auf allen Änderungen der Methode durchgeführt.
Erst beim Verlassen der Service Methode müssen wir berücksichtigen, dass Objekte ggf. nicht mehr an eine Session gebunden sind (hier kann es dann zu Problemen mit LazyLoading o.ä. kommen).


Felix Breske


XML <=> Objekt mit JAXB

Donnerstag, 12. Februar 2009

Gründe warum man Objekte direkt in XML umwandeln will (oder anders herum) gibt es viele. Mit JAXB steht im Java SDK 1.6 jetzt eine besonders einfache Möglichkeit zur Verfügung.

Für die Umwandlung eines einfachen Objektes reicht bereits eine Annotation an der Klasse sowie der Aufruf des JAXB Marschallers.

Eine einfache Klasse mit der @XmlRootElement annotation:

@XmlRootElement
public class Person {
    private String firstname;
    private String name;
 
    public Person() {
    }
 
    public String getFirstname() {
        return firstname;
    }
 
    public void setFirstname(final String firstname) {
        this.firstname = firstname;
    }
 
    public String getName() {
        return name;
    }
 
    public void setName(final String name) {
        this.name = name;
    }
}

Mit dem Marshaller wird aus einem Objekt eine XML Datei.

public class Test {
    public static void main(final String[] args) throws Exception {
        final Person person = new Person();
        person.setFirstname("Max");
        person.setName("Mustermann");
 
        //  JAXBContext erstellen mit
        final JAXBContext jc = JAXBContext.newInstance(Person.class);
 
        // Marshaller erstellen
        final Marshaller marshaller = jc.createMarshaller();
 
        // person objekt nach XML wandeln und in eine Datei schreiben.
        marshaller.marshal(person,new File("person.xml"));
    }
}

Unmarshalling einer XML Datei in ein Objekt:

public class Test {
    public static void main(final String[] args) throws Exception {
        //  JAXBContext erstellen mit
	final JAXBContext jc = JAXBContext.newInstance(Person.class);
 
        // Marshaller erstellen
        final Unmarshaller unmarshaller = jc.createUnmarshaller();
 
        // XML auslesen und person Objekt befuellen
        final Person person = (Person) unmarshaller.unmarshal(new File("person.xml"));
        System.out.println(person.getFirstname());
        System.out.println(person.getName());
    }
}

Um Einfluss auf die Struktur des erzeugten XMLs zu nehmen bietet sich ein Blick in das Paket javax.xml.bind.annotation an. Mit Hilfe dieser Annotations kann die Struktur des erstellten XML beeinflusst werden, bzw. die Klasse kann an ein bestehendes XML angepasst werden.

Wenn große XML Dateien eingelesen werden sollen, so ist dies in den seltensten Fällen mit einer passenden Klasse erledigt. Wenn aber viele kleine Klassen erstellt werden, muss man dem JAXBContext beim erstellen sehr viele Klassen bekannt machen. Einfacher ist es in das Paket neben die Klassen für die XML Umwandlung eine Datei jaxb.index zu legen. In dieser Datei werden alle Klassen aufgeführt werden die dem JAXBContext bekannt gemacht werden sollen. Beim erzeugen des JAXBContext brauchen nun keine Klassennamen mehr übergeben werden.


Felix Breske


Rest Services mit Spring und Restlet

Montag, 10. November 2008

Mit der Version 1.1 (aktuell RC2) bekommt das Restlet Framework eine Integration für Spring. Die Konfiguration erfolgt über Web- und Spring-Context der Anwendung. Hierfür stehen dem Entwickler die Klassen RestletFrameworkServlet und SpringRouter zur Verfügung.

Im Gegensatz zu Restlet 1.0 braucht der “Restlet Router” und die “Restlet Application” nicht mehr von dem Entwickler implementiert werden. Nach der Konfiguration in der web.xml und applicationContext.xml müssen nur noch die Anwendungsspezifischen Resources selbst umgesetzt werden. Das Mapping der Resource-URL auf die Restlets erfolgt dabei über die applicationContext.xml.

RestletFrameworkServlet
Das RestletFrameworkServlet stellt die Verbindung zwischen Web Context und Spring Konfiguration für Restlet da. Es nimmt die HTTP Anfragen entgegen und leitet sie an den konfigurierten Router um.

web.xml

<!-- Restlet -->
<servlet>
	<servlet-name>restlet</servlet-name>
	<servlet-class>com.noelios.restlet.ext.spring.RestletFrameworkServlet</servlet-class>
	<init-param>
		<param-name>contextConfigLocation</param-name>
		<param-value>/WEB-INF/applicationContext.xml</param-value>
	</init-param>
	<init-param>
		<param-name>targetRestletBeanName</param-name>
		<param-value>springRouter</param-value>
	</init-param>
	<load-on-startup>1</load-on-startup>
</servlet>
 
<servlet-mapping>
	<servlet-name>restlet</servlet-name>
	<url-pattern>/*</url-pattern>
</servlet-mapping>

SpringRouter
Der Spring Router verteilt die eingehenden Anfragen an die konfigurierten Rest Resources. Im Spring Context wird dabei ein Mapping von URLs auf Restlet Beans vorgenommen. Also Beispiel wird hier eine Klasse Note verwendet die eine Id und einen Text beinhaltet.

applicationContext.xml

 
<!-- restlet -->
<bean id="springRouter" class="org.restlet.ext.spring.SpringRouter">
	<property name="attachments">
		<map>
			<entry key="/notes/{id}">
				<bean class="org.restlet.ext.spring.SpringFinder">
					<lookup-method name="createResource" bean="noteResource" />
				</bean>
			</entry>
			<entry key="/notes">
				<bean class="org.restlet.ext.spring.SpringFinder">
					<lookup-method name="createResource" bean="notesResource" />
				</bean>
			</entry>
		</map>
	</property>
</bean>
 
<!-- restlet resources -->
<bean id="notesResource" name="notesResource" class="org.example.NotesResource" scope="prototype">
	<property name="noteService" ref="noteService" />
</bean>
 
<bean id="noteResource" name="noteResource" class="org.example.NoteResource" scope="prototype">
	<property name="noteService" ref="noteService" />
</bean>

Jetzt fehlen nur noch die Implementierung der Resource Beans. Hier muss lediglich beachtet werden, dass die Resources einen parameterlosen Konstruktor haben und die Context spezifischen Parameter über die init() Methode übergeben werden.

NoteResource.java

public class NoteResource extends Resource {
	private Note note;
	private NoteDAO noteDAO;
 
	public NoteResource() {
	}
 
	public void setNoteDAO(final NoteDAO noteDAO) {
		this.noteDAO = noteDAO;
	}
 
	@Override
	public void init(final Context context, final Request request, final Response response) {
		super.init(context, request, response);
		final Integer noteId = Integer.parseInt((String) getRequest().getAttributes().get("id"));
		note = noteDAO.findById(noteId);
		if (note != null) {
			getVariants().add(new Variant(MediaType.TEXT_XML));
		}
	}
 
	@Override
	public Representation getRepresentation(final Variant variant) {
		if (MediaType.TEXT_XML.equals(variant.getMediaType())) {
			try {
				final DomRepresentation representation = new DomRepresentation(MediaType.TEXT_XML);
				final Document document = representation.getDocument();
 
				final Element eltItem = document.createElement("note");
				document.appendChild(eltItem);
				final Element idElement = document.createElement("id");
				idElement.appendChild(document.createTextNode(Integer.toString(note.getId())));
				eltItem.appendChild(idElement);
 
				final Element textElement = document.createElement("text");
				textElement.appendChild(document.createTextNode(note.getText()));
				eltItem.appendChild(textElement);
 
				document.normalizeDocument();
 
				return representation;
			} catch (final IOException e) {
				e.printStackTrace();
			}
		}
		return null;
	}
}

NotesResource.java

public class NotesResource extends Resource {
	private List<Note> notes;
	private NoteDAO noteDAO;
 
	public NotesResource() {
	}
 
	public void setNoteDAO(final NoteDAO noteDAO) {
		this.noteDAO = noteDAO;
	}
 
	@Override
	public void init(final Context context, final Request request, final Response response) {
		super.init(context, request, response);
		notes = noteDAO.getAllNotes();
		getVariants().add(new Variant(MediaType.TEXT_XML));
	}
 
	@Override
	public Representation getRepresentation(final Variant variant) {
		if (MediaType.TEXT_XML.equals(variant.getMediaType())) {
			try {
				final DomRepresentation representation = new DomRepresentation(MediaType.TEXT_XML);
				final Document document = representation.getDocument();
				final Element root = document.createElement("notes");
				d.appendChild(root);
				for (final Note note : notes) {
					final Element eltItem = document.createElement("note");
					final Element idElement = document.createElement("id");
					idElement.appendChild(document.createTextNode(Integer.toString(note.getId())));
					eltItem.appendChild(idElement);
 
					final Element textElement = document.createElement("text");
					textElement.appendChild(document.createTextNode(note.getText()));
					eltItem.appendChild(textElement);
 
					root.appendChild(eltItem);
				}
				document.normalizeDocument();
				return representation;
			} catch (final IOException e) {
				e.printStackTrace();
			}
		}
		return null;
	}
}

Wird nun die URL /notes (innerhalb der Webanwendung) aufgerufen wird eine Liste aller Einträge angezeigt; mit /notes/0 kann dann direkt auf einen Eintrag zugegriffen werden.

Für schreibende Zugriffe auf die Resources lohnt sich ein Blick in Dokumentation der Resource Klasse und in das Restlet Tutorial auf restlet.org.


Felix Breske