venerdì 26 novembre 2010

Come abilitare lo shortcut di Eclipse "Search Occurrences in File" nell'ambiente Gnome

Come abilitare lo shortcut di Eclipse "Search Occurrences in File" nell'ambiente Gnome

Durante l'analisi del codice i comandi più utili messi a siposizione da Eclipse sono probabilemnte quelli di ricerca (sotto la voce di menù Search). Tra questi uno di quelli che uso più spesso è Search > Occurrences in File, che, come dice il nome, cerca le occorrenze dell'elemento selezionato all'interno del file aperto. La particolarità di questo comando è che, a differenza di altri comandi di ricerca come ad esempio Search > References, nella vista dei risultati della ricerca mostra proprio il contenuto delle righe in cui è presente il riferimento, permettendo di individuare in maniera molto semplice l'uso che viene fatto.

Esempio di Search References per la variabile "t":



Esempio di Search Occurrences in File per la variabile "t":




Il problema nell'usare questo comando nasce negli ambienti Gnome, in cui quello che è lo shortcut predefinito (SHIFT + CTRL + U) è associato all'inserimento dei caratteri unicode e quindi non funziona all'interno di Eclipse.
Per modificare la combinazione di tasti predefinita:

  • Aprire Window > Preferences
  • Selezionare General > Keys
  • Inserire nel filtro di ricerca la stringa occurrences
  • Selezionare la voce Shows the Occurrences in File quick menu in corrispondenza della quale la colonna "When" indica "In Windows"
  • Modificare il campo Binding inserendo la combinazione tasti desiderata
  • Cliccare su "OK" per uscere

La combinazione tasti che ho scelto nella mia configurazione è SHIFT + CTRL + Z, in quanto era libera ed è semplice da usare anche con una sola mano.

Vedi anche:

Eclipse Help - Searching the workbench
Eclipse Help - Java Search
Eclipse Help - Search Actions
Ubuntu Documentation > Community Documentation > ComposeKey > Unicode composition
Sinossi's Blog - Come inserire caratteri speciali in Linux

giovedì 18 novembre 2010

Merge tracking con Subversion 1.5

Una delle novità introdotte nella versione 1.5 di Subversion è la capacità di tenere traccia dei merge, ovvero include quelle funzionalità che prima venivano garantite da tool esterni come lo script python svnmerge.py.

La storia dei merge effettuati viene mantenuta tramite la proprietà svn:mergeinfo.

Supponiamo di avere nel trunk il ramo di sviluppo principale e di avere su un branch chiamato feature_dev gli sviluppi relativi ad una nuova funzionalità. Alla fine dello sviluppo il branch feature_dev dovrà essere riportato sul trunk.

I percorsi svn coinvolti sono:
  • https://svn.sinossi.it/svn/myproject/trunk
  • https://svn.sinossi.it/svn/myproject/branches/feature_dev
I comandi messi a disposizione da SVN per gestire il merge sono:
  • svn merge
  • svn mergeinfo

Il primo serve per effettuare il merge vero e proprio, il secondo mostra delle informazioni relative ai merge.

Poichè la destinazione del merge è il trunk usiamo questo come working copy. Vediamo lo stato attuale del merge
> svn co https://svn.sinossi.it/svn/myproject/trunk
> cd trunk
trunk> svn mergeinfo https://svn.sinossi.it/svn/myproject/branches/feature_dev
[nessun output]
trunk> svn mergeinfo --show-revs eligible https://svn.sinossi.it/svn/myproject/branches/feature_dev
r195
r196
r197
r198
r220
r221

Poichè ci interessa modificare il trunk usiamo quello come working copy, e come indirizzo di confronto quello del branch feature_dev, che è quello di rispetto a cui vogliamo conoscere lo stato dei merge fatti e/o da fare.
Il primo comando mostra l'elenco dei commit che sono stati riportati da feature_dev verso trunk (non essendo stato ancora effettuato nessun merge non è indicata nessuna revisione); il comando mergeinfo con l'opzione --show-revs eligible mostra i commit che sono stati effettuati su feature_dev e non sono ancora stati portati sul trunk.

Tramite il comando
> svn log https://svn.sinossi.it/svn/myproject/branches/feature_dev
siamo in grado di capire quali commit debbano essere riportati sul trunk e quali no.

Supponiamo di voler riportare il commit 198, il comando sarà
trunk> svn merge -c 198 https://svn.sinossi.it/svn/myproject/branches/feature_dev
trunk> svn commit -m "rientro del branch feature_dev"

Questo applicherà sul trunk le mofiche relative al commit 198 effettuato sul branch feature_dev.
Le modifiche effettuate da svn merge sono locali, quindi per renderle effettive sarà necessario committare.

Se prima di committare si lancia il comando svn status si noterà che molte cartelle sono state modificate, più di quelle coinvolte nel commit 198, questo perchè è stata aggiunta la proprietà svn:mergeinfo che tiene appunto memeoria dei merge effettuati.

Se ora riproviamo ad esaminare lo stato dei merge avremo
trunk> svn mergeinfo https://svn.sinossi.it/svn/myproject/branches/feature_dev
r198
trunk> svn mergeinfo --show-revs eligible https://svn.sinossi.it/svn/myproject/branches/feature_dev
r195
r196
r197
r220
r221
Quindi il commit 198 risulta riportato sul trunk, gli altri sono ancora disponibili.
Supponiamo di sapere che i commit 195,196,197 non debbano essere portati, svn merge permette di considerare i commit come integrati anche senza riportare realmente sul trunk le modifiche, questo può essere fatto tramite l'opzione --record-only
trunk> svn merge --record-only -c 195,196,197 https://svn.sinossi.it/svn/myproject/branches/feature_dev
trunk> svn commit -m "rientro del branch feature_dev"
Il commit è necessario per aggiornare nel repository lo stato della proprietà svn:mergeinfo, ma con l'opzione --read-only non viene apportata nessuna modifica ai nostri file.
A questo punto lo stato è:
trunk> svn mergeinfo https://svn.sinossi.it/svn/myproject/branches/feature_dev
r195
r196
r197
r198
trunk> svn mergeinfo --show-revs eligible https://svn.sinossi.it/svn/myproject/branches/feature_dev
r220
r221
Ora le commit 195, 196 e 197 risultano integrate.


Come ulteriore esempio vediamo il caso in cui si voglia aggiornare un tag riportando un commit effettuato sul trunk.
I rami coinvolti sono
  • https://svn.sinossi.it/svn/myproject/trunk
  • https://svn.sinossi.it/svn/myproject/tags/1.0.3

Poichè la destinazione del merge è il tag usiamo questo come working copy un checkout del tag 1.0.3.
> svn co https://svn.sinossi.it/svn/myproject/tags/1.0.3
> cd 1.0.3
1.0.3> svn mergeinfo https://svn.sinossi.it/svn/myproject/trunk
[nessun output]
1.0.3> svn mergeinfo --show-revs eligible https://svn.sinossi.it/svn/myproject/trunk
r234
r237
r238
Il commit che si vuole riportare è il 238:
trunk> svn merge -c 238 https://svn.sinossi.it/svn/myproject/trunk
trunk> svn commit -m "aggiornamento del tag 1.0.3"
Lo stato del merge ora sarà:
1.0.3> svn mergeinfo https://svn.sinossi.it/svn/myproject/trunk
r238
1.0.3> svn mergeinfo --show-revs eligible https://svn.sinossi.it/svn/myproject/trunk
r234
r237


Per sfruttare al meglio le funzionalità introdotte con il tracking dei merge è stata aggiunta l'opzione -g (oppure --use-merge-history) ai comandi svn log e svn blame, ciò permette di utilizzare le informazioni relative ai merge nell'output di questi comandi.
Come ultima indicazione, per chi ha utilizzato lo script svnmerge.py per tracciare i merge, è disponibile lo script svnmerge-migrate-history.py che consente di migrare alla modalità di merge di Subversion 1.5 senza perdere lo storico delle informazioni di merge accumulate.


Per maggiorni informazioni vedere anche:

Subversion 1.5 release notes
svn merge
svn mergeinfo
svnmerge.py

martedì 16 novembre 2010

Top Level Class e Nested Class in Java

La Top Level Class è una classe la cui dichiarazione non risiede all'interno di un'altra classe o di un'interfaccia. Tutti i tipi che vengono dichiarati all'interno di una Top Level Class possono essere indicati con il termine nested.

Vi sono svariati modi in cui i tipi nested possono essere dichiarati all'interno di una Top Level Class. Ad esempio, tutti i tipi nested non static sono membri della classe contenitore. I tipi dichiarati static invece, non possono essere essere considerati membri della classe contenitore. La differenza fondamentale sta nel fatto che i membri sono instanziati al momento in cui viene istanziata la classe contenitore e sono fortemente accoppiati con essa. I tipi statici invece presentano un livello di accoppiamento più debole e non dipendono direttamente da un'istanza della classe contenitore, ma solo da un suo riferimento.

Fra i tipi permessi, vi è anche il tipo class. Infatti Java permette di dichiarare una classe all'interno di una Top Level Class. La classe dichiarata internamente è detta Nested Class. La Nested Class segue le regole di tutti gli altri tipi, infatti può essere dichiarata public, private, protected o package private e può essere static.

Una Static Nested Class può essere definita nel seguente modo:


public class OuterWithStaticNested {

private String outerField;

private static String OUTER_STATIC_FIELD = "Outer Static Field";

public OuterWithStaticNested(String outerField) {
this.outerField = outerField;
}

public String getOuterField() {
return outerField;
}

static class StaticInnerClass {

void print() {
System.out.println(OUTER_STATIC_FIELD);
System.out.println(new OuterWithStaticNested("Outer Field")
.getOuterField());
}

}

}

Dal punto di vista comportamentamentale la Static Nested Class è molto simile ad una Top Level Class. Non ha, infatti, accesso diretto a membri e metodi privati della classe che la contiene, e per utilizzarli, deve appoggiarsi ad un'istanza concreta della classe contenitore. Ha invece accesso diretto ai tipi statici, anche se privati. Questo implica un basso livello di accoppiamento fra la Top Level Class e la Static Nested Class, la quale può essere istanziata in maniera diretta, senza che ci sia bisogno di un'istanza della Top Level Class.

StaticNestedClass staticNestedClass = new OuterWithStaticNested.StaticNestedClass();

Le Inner Classes sono invece fortemente accoppiate con l Top Level Class in cui sono dichiarate. Hanno infatti accesso a tutti i membri e metodi privati della classe contenitore e possono essere a loro volta considerate come un membro di essa.


public class OuterWithInner {

private String outerField;

private static String OUTER_STATIC_FIELD = "Outer Static Field";

public OuterWithInner(String outerField) {
this.outerField = outerField;
}

class InnerClass {

void print() {
System.out.println(outerField);
System.out.println(OUTER_STATIC_FIELD);
}

}

}

A testimonianza di questo forte accoppiamento, la Inner Class può essere inizializzata esternamente alla Top Level Class solo a partire da una sua istanza concreta.

OuterWithInner outerClass = new OuterWithInner("Outer Field");
InnerClass innerClass = outerClass.new InnerClass();

Per questi motivi, una Inner Class non può contenere metodi o membri statici.

Fra le Nested Classes troviamo anche le Anonymous Inner Class, cioè classi che vengono dichiarate e istanziate nel punto in cui devono essere usate. Non hanno nome e non possono essere considerate come un membro della classe in cui sono dichiarate. Sono permesse in qualunque punto in cui è ammessa una espressione.

Possono essere dichiarate sia in un contesto statico che non statico, ma non possono avere membri statici.

Uso comune delle Anonymous è la creazione di oggetti funzionali (cioè istanze di classi senza stato, i cui metodi operano solo sugli oggetti passati nella signature) “on the fly”. Un tipico esempio è l'utilizzo del metodo

java.util.Collections.sort(List, Comparator)

dove spesso si implementa un Comparator "al volo" per indicare la logica di ordinamento degli elementi.

public class OuterWithAnonymous {

private List outerFields;

public OuterWithAnonymous(List outerFields) {
this.outerFields = outerFields;
}

public void sortOuterFieldsByFieldLenghtAsc() {
Collections.sort(outerFields, new Comparator() {

@Override
public int compare(String field1, String field2) {
if (field1.length() > field2.length()) {
return 1;
} else if (field1.length() == field2.length()) {
return 0;
} else {
return -1;
}
}

});
}
}

Altro caso d'uso frequente è per la creazione di oggetti process come Runnable, Thread o TimerTask.

Infine, il tipo meno comune di Nested Class è la Local Class. Le Local Classes sono dichiarate all'interno di un metodo, allo stesso modo di una variabile locale, e obbediscono alla stessa politica di scope.

public class OuterWithLocal {

private List outerFields;

public OuterWithLocal(List outerFields) {
this.outerFields = outerFields;
}

public void sortOuterFieldsByFieldLenghtAsc() {
Comparator stringComparator = new Comparator() {

@Override
public int compare(String field1, String field2) {
if (field1.length() > field2.length()) {
return 1;
} else if (field1.length() == field2.length()) {
return 0;
} else {
return -1;
}
}

};
Collections.sort(outerFields, stringComparator);
}
}

Come le Inner Classes, hanno nome e possono essere utilizzate più volte.Come le Anonimous Inner Classes, non possono avere membri statici e hanno un riferimento alla classe contenitore solo se sono dichiarate in un contesto non statico.


Le quattro tipoligie di Nested Classes hanno tutte caratteristiche diverse, che possono tradursi in svantaggi se non sfruttate al meglio. Se la Nested Class non deve avere accesso diretto a metodi e membri della classe contenitore, allora è preferibile che sia dichiarata statica, in modo da evitare che ogni istanza della Nested Class necessiti di un'istanza concreta della Top Level Class.

Le Anonimous Inner Classes e le Local classes devono essere brevi e molto semplici, in modo da non diminuire troppo la leggibilità del codice. Le Anonimous sono da preferire alle Local quando devono essere istanziate una sola volta, nel punto in cui devono essere eseguite. Le Local sono da preferire alle Inner se devono essere usate più volte in un unico metodo.

lunedì 15 novembre 2010

Hibernate: differenza tra get e load

Il metodo get() sollecita immediatamente il database. Cio significa che, non appena avviene la chiamata la get(), Hibernate genera un'istruzione SQL per il database, nel tentativo di recuperare i dati (di solito una riga nel database) per ricostruire l'oggetto persistente richiesto.

Una chiamata load(), invece, non comporta una chiamata immediata al database. Il metodo load() implica la costruzione di un oggetto proxy che rapprensenta l'oggetto persistente. Solo dopo qualche passaggio l'oggetto proxy sollecita la generazione dell'istruzione SQL appropriata per il database e Hibernate costruisce il vero oggetto persistente.

Quando si usa get(), il metodo restituisce null se non viene trovato il dato richiesto.
Poiché il metodo load() non recupera immediatamente l'oggetto, se non viene trovato il dato viene generata una ObjectNotFoundException.
Quindi, se non si è sicuri dell'esistenza dell'oggetto, è preferibile usare la get().

martedì 2 novembre 2010

Monitoraggio e controllo delle applicazioni tramite JMX - Introduzione

JMX (Java Management Extensions) è una tecnologia introdotta nella versione 5.0 di Java che permette il monitoraggio ed il controllo delle applicazioni in maniera standardizzata.

Ogni applicazione, tramite gli MBean (Managed Beans) può esporre all'esterno sia delle proprietà (che possono essere monitorate) che delle operazioni (che si possono eseguire per modificare il comportamento dell'applicazione in runtime). L'applicazione che espone gli MBean può essere vista come un server a cui i client JMX (come, ad esempio, il tool jconsole) possono collegarsi.


La tecnologia JMX offre una maniera semplice e standardizzata per gestire le applicazioni. Il vantaggio per lo sviluppatore è che consente di implementare solo la parte strettamente legata all'applicazione da controllare, mentre fornisce tutta l'infrastruttura per esporre all'esterno le interfacce, gestendo in maniera (quasi) trasparente tutta la parte relativa alla comunicazione tra server e client.

Questa tecnologia è utilizzata anche all'interno della stessa JRE, ad esempio per permettere di controllare l'occupazione della memoria o per invocare su richiesta il garbage collector.


Vediamo un esempio di utilizzo di JMX per il controllo di una semplice applicazione, supponiamo di avere un semplice oggetto Printer che modella la scrittura periodica di una stampa su console:

package it.sinossi.poc.mbeanpoc;

public class Printer {

 private String text;

 private boolean printEnabled = true;

 private int sleepTime = 500;

 private boolean stop = false;

 public Printer(String text) {
  this.text = text;
 }

 public String getText() {
  return text;
 }

 public void setText(String text) {
  if (text != null && !text.isEmpty()) {
   this.text = text;
  } else {
   throw new IllegalArgumentException("text cannot be null or empty");
  }
 }

 public boolean isPrintEnabled() {
  return printEnabled;
 }

 public void setPrintEnabled(boolean printEnabled) {
  this.printEnabled = printEnabled;
 }

 public int getSleepTime() {
  return sleepTime;
 }

 public void setSleepTime(int sleepTime) {
  if (sleepTime >= 100 && sleepTime <= 1000) {
   this.sleepTime = sleepTime;
  } else {
   throw new IllegalArgumentException(Integer.toString(sleepTime) + " is not in range [100, 1000]");
  }
 }

 public void stop() {
  stop = true;
 }

 public boolean shouldStop() {
  return stop;
 }

 public void print() {
  System.out.println(text);
 }

}

La classe permette di modificare alcuni parametri come il testo ed il tempo di attesa, in più si possono eseguire le azioni di pausa, ripresa e stop, notare che i metodi setText e setSleepTime lanciano delle eccezioni nel caso in cui siano invocate con argomenti non validi. Sottolineo come non sia presente in nessuna parte di codice relativa a JMX.

Scriviamo un semplice main che permetta di vedere il codice all'opera

package it.sinossi.poc.mbeanpoc;

public class Main {

 public static void main(String[] args) throws Exception {

  Printer p = new Printer("Ciao");

  int counter = 0;

  while (!p.shouldStop()) {
   if (p.isPrintEnabled()) {
    System.out.print(Integer.toString(counter) + "  ");
    p.print();
   }
   counter++;
   Thread.sleep(p.getSleepTime());
  }
  System.out.println("Exiting");
 }

}

Avviando la classe Main si vedrà in console la stampa periodica della scritta "Ciao".


A questo punto si deve introdurre la componente fondamentale della tecnologia JMX: gli MBean. Gli MBean sono delle normali classi, simili ai java bean, che però devono implementare una interfaccia che sarà appunto quella che definisce i metodi di monitoraggio e controllo esposti all'esterno. Nel nostro caso l'interfaccia si chiamerà PrinterControlMBean e l'implementazione PrinterControl (questo tipo di nomenclatura è obbligatoria, l'interfaccia deve chiamarsi MBean e la relativa implementazione deve chiamarsi ).


package it.sinossi.poc.mbeanpoc;

public interface PrinterControlMBean {

 String getText();

 void setText(String text);

 int getSleepTime();

 void setSleepTime(int millis);

 void pause();

 void resume();

 public void stop();

}


package it.sinossi.poc.mbeanpoc;

public class PrinterControl implements PrinterControlMBean {

 private Printer printer;

 public PrinterControl(Printer printer) {
  this.printer = printer;
 }

 public String getText() {
  return printer.getText();
 }

 public void pause() {
  printer.setPrintEnabled(false);
 }

 public void resume() {
  printer.setPrintEnabled(true);
 }

 public void stop() {
  printer.stop();
 }

 public void setText(String text) {
  printer.setText(text);
 }

 public int getSleepTime() {
  return printer.getSleepTime();
 }

 public void setSleepTime(int millis) {
  printer.setSleepTime(millis);
 }

}

L'interfaccia PrinterControlMBean definisce le funzionalità della nostra classe Printer che vogliamo siano controllabili dall'esterno, in questo caso l'implementazione di questa interfaccia è molto semplice in quanto tutti i metodi delegano all'oggetto Printer, passato nel costruttore. Ancora una volta non è presente codice relativo alle API JMX.

Ora che abbiamo una classe che vogliamo sia gestita dall'esterno (Printer) e l'MBean che determina le funzionalità esposte all'esterno (PrinterControlMBean, PrinterControl), dobbiamo completare con la registrazione sul sistema del nostro MBean in modo che questo venga esposto all'esterno.

Questo verrà fatto nella classe Main, in cui viene istanziato l'MBean e viene registrato nell'MBean Server, che è il componente fornito dal sistema che si occupa di esporre all'esterno gli MBean.

public class Main {

 public static void main(String[] args) throws Exception {

  Printer p = new Printer("Ciao");

  registerMBean(p);

  int counter = 0;

  [...]
 }

 private static void registerMBean(Printer p) throws Exception {
  PrinterControl mbean = new PrinterControl(p);
  ObjectName objectName = new ObjectName("printercontrol:type=printer,name=console_printer");
  MBeanServer server = ManagementFactory.getPlatformMBeanServer();
  server.registerMBean(mbean, objectName);
 }

}

Ogni MBean viene registrato in associazione ad un'istanza di ObjectName, questo permette l'identificazione univoca della risorsa gestita dall'MBean. L'ObjectName è costruito con una stringa che codifica un dominio (in questo caso il dominio è "printercontrol") più delle coppie chiave=valore (type = printer, name = console_printer); gli spazi presenti nella stringa non vengono eliminati, quindi meglio che non ce ne siano.

A questo punto non resta che far pratire l'applicazione e successivamente avviamo jconsole.





Connettiamoci alla JVM relativa al nostro progetto.
Dal tab MBeans si possono vedere e controllare tutti gli MBeans registrati sul sistema, il nostro si trova sotto il dominio it.sinossi.
Jconsole permette di vedere e modificare gli attributi e di invocare i metodi esposti.



Proviamo a mettere in pausa, modificare la stringa che viene stampata, riattivare la stampa e poi stoppare il programma. Nella console si può vedere come le azioni svolte si ripercuotono sul comportamento del programma.


Ricordiamo che la classe Printer permette di impostare uno sleepTime compreso tra 100 e 1000 millisecondi, nel caso in cui si inserisca un valore non valido viene lanciata un'eccezione. Per vedere come si comporta il sistema proviamo ad impostare il valore 10. Il risultato è quello che si vede in figura: l'eccezione impedisce di impostare il valore non corretto, questo senza influire sul regolare funzionamento dell'applicazione che continua a girare senza accorgersi di niente.



See also:
Sorgenti del progetto su github
JMX Home Pape
Java Tutorial on JMX
JMX Best Practices
Java theory and practice: Instrumenting applications with JMX