SQuirreL SQL Hibernate plugin

SQuirreL SQL jest moim ulubionym klientem SQL. Umożliwia on również, wykonywanie zapytań HQL. Wtyczka udostępniające tę funkcjonalność dostępna jest w wersji 0.01, ale działa całkiem przyzwoicie. Podpowiada nazwy obiektów oraz ich właściwości. Umożliwia tłumaczenie zapytania HQL na zapytanie SQL oraz jego wykonanie.

Ponieważ sporo trudności przedstawia jej konfiguracja, opisze ją na przykładzie aplikacji wykorzystującej Spring Framework. Zakładam, że połączenie SQuirreL SQLa do bazy danych jest już skonfigurowane.

Wtyczka dystrybuowana jest wraz z instalacyjną wersją klienta SQuirreL SQL. Fakt jej zainstalowania można zweryfikować w menu Plugins/Summary.


Zgodnie z dokumentacją w pliku plugins/hibernate/readme.html wtyczce musimy dostarczyć obiekt klasy SessionFactoryImpl wskazując metodę o sygnaturze
public org.hibernate.impl.SessionFactoryImpl getSessionFactoryImpl()
która go udostępni.

Ponieważ moja aplikacja korzysta ze Springa, obiekt SessionFactoryImpl najlepiej pobrać z jego kontekstu. Klasa implementująca powyższą metodę wygląda zatem:

package pl.matt.hibernate;

import org.hibernate.impl.SessionFactoryImpl;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.FileSystemXmlApplicationContext;

public class SessionFactoryProvider {

 public org.hibernate.impl.SessionFactoryImpl getSessionFactoryImpl() {
  try {
   ApplicationContext ac = new FileSystemXmlApplicationContext("//home/mateusz/priv/workspace/blog/resources/application-context.xml");
   SessionFactoryImpl out = (SessionFactoryImpl) ac.getBean("sessionFactory");
   return out;
  } catch (Exception e) {
   e.printStackTrace();
  }
  return null;
 }
 
}

Blok try-catch jest zbędny, ale ułatwia diagnozowanie problemów przy uruchamianiu wtyczki pod warunkiem uruchomienia klienta SQuirreL SQL z wiersza poleceń.
Ścieżka do pliku ze Springowym kontekstem aplikacji poprzedzona jest podwójnym ukośnikiem, gdyż pierwszy z nich jest wycinany przez Springa.

To tyle jeżeli chodzi o kodowanie. Czas na wskazanie powyższej klasy we właściwościach SQuirreL SQLa. Otwieram zakładkę Hibernate z menu File/Global Preferencess, gdzie tworzę nową konfigurację przyciskiem New.

Wpisuję jej nazwę a następnie konfiguruję ścieżkę klas przyciskiem Add classpath entry. Wskazana ścieżka musi zawierać zarówno skompilowane klasy aplikacji jak i wymagane przez nią biblioteki.

Następnie zaznaczam opcję: Invoke the user defined provider method below i wskazuję napisaną niedawno klasę.


To tyle. Po naciśnięciu przycisku connect na zakładce Hibernate możemy już wykonywać zapytania HQL. Polecam zaznaczenie opcji Always format (formatowanie wynikowego SQLa) oraz Execute SQL (bez niej HQL zostanie jedynie przetłumaczony do SQLa) i można się już mierzyć z HQLem.

Hibernate NamingStrategy

Na jednym z ostatnich spotkań WJUGa pożaliłem się odrobinie osobie siedzącej po mojej prawej stronie na Hibernate. Były to żale bardziej estetyczne niż funkcjonalne a dotyczyły nazw generowanych przez to właśnie narzędzie ORM. Nie podobały mi się ani nazwy tabel ani kolumn ani kluczy obcych jakie nadaje Hibernate podczas tworzenia schematu bazy danych. Osoba słuchająca moich marudzeń powiedziała krótko i fachowo: "Obczaj naming strategy". Obczaiłem.

Domyślnie Hibernate tworzy nazwę tabeli taką samą jak nazwa klasy - encji, natomiast nazwę kolumny taką samą jak nazwa pola. Nazwy kluczy obcych generowane są w sposób nieokreślony: np. 'FK2F894B2DC512614D'.

Ja chciałbym, aby nazwy kolumn i tabel utrzymane były w konwencji z podkreśleniem (czyli np. user_data, default_color), nazwy tabel występowały w liczbie mnogiej, a nazwy kluczy obcych były jakkolwiek zrozumiałe (np. FK_EMP_COM dla klucza łączącego tabelę EMPLOYEES z COMPANIES).

Pierwsze spojrzenie na interfejs NamingStrategy pozbawiło mnie złudzeń. O czytelnych nazwach kluczy obcych mogę sobie pomarzyć. Wybrana strategia stosowana jest tylko do nazw kolumn i tabel. Dobre i to.

Szybki przegląd implementacji:

DefaultNamingStrategy
EJB3NamingStratefy
DefaultComponentSafeNamingStratefy
ImprovedNamingStrategy

wykazał, że trzy pierwsze odpadają w przedbiegach. Konwencja wielbłądzia zachowana. Z klasy UserData.java tworzy się tabela UserData.

Cała nadzieja w ImprovedNamingStrategy. Konwertuje ona nazwy na konwencję z podkreśleniem... i tyle. O liczbie mnogiej mogę póki co pomarzyć. Nie tylko z resztą ja więc chyba skończy się na napisaniu swojej implementacji.

Nazwy kluczy obcych pozostają nie ruszone. Nawet nie nagryzione. Jeżeli wiesz, jak można je zmienić, daj koniecznie znać.