Dopo aver sinteticamente introdotto il framework nell’articolo Primi Passi con BeanIO (parte 1), procediamo trattando alcuni aspetti avanzati della libreria, che sono di sicuro interesse per lo sviluppatore.
Gestione delle Collection
La prima caratteristica che affrontiamo è come mappare le proprietà dei bean di tipo array o collection. Aggiorniamo la classe Customer inserendo la proprietà someNumbers di tipo List:
|
1 2 3 4 5 |
public class Customer { ... List<Integer> someNumbers; ... } |
Il mapping nel file customer-mapping.xml si realizza inserendo un nuovo tag <field> associato alla proprietà:
|
1 2 3 4 5 6 7 |
<stream name="customerFile" format="csv"> <record name="customer" class="it.javaboss.bean.Customer"> ... <field name="someNumbers" collection="list" minOccurs="10" maxOccurs="unbounded"/> .... </record> </stream> |
L’elemento chiave per il mapping è l’attributo collection che può essere impostato col nome completo della classe che implementa l’interfaccia java.util.Collection o con uno degli alias previsti dal framework che sono: collection, list, set o array. E’ possibile inoltre dichiarare il numero di occorrenze della proprietà da riportare nello stream utilizzando gli attributi del campo minOccurs e maxOccurs. Se non dichiarato, minOccurs assume il valore 1, mentre maxOccurs assume il valore minOccurs o 1, a seconda di quale dei due è maggiore.
Tornando all’esempio, supponiamo che la proprietà someNumbers di Customer assuma il valore [1, 2, 3, 4, 5]. Si noti che il numero di valori è inferiore a minOccurs che è 10, quindi lo stream cvs prodotto sarà del tipo:
|
1 |
Jennifer,Jones,06/02/2019,44 West 29th Street,New York,NY,10001,1,2,3,4,5,,,,, |
Nel caso in cui esistano diverse proprietà di tipo collection nel bean, il mapping dovrà essere fatto in modo che il risultato della serializzazione renda comunque riconoscibile, dalla posizione di un valore, a quale proprietà appartiene. Ad esempio se inseriamo la proprietà someOtherNumbers:
|
1 2 3 4 5 |
public class Customer { ... List<Integer> someNumbers; List<Integer> someOtherNumbers; } |
|
1 2 3 4 5 6 7 8 |
<stream name="customerFile" format="csv"> <record name="customer" class="it.javaboss.bean.Customer"> ... <field name="someNumbers" collection="list" minOccurs="10" maxOccurs="unbounded"/> <field name="someOtherNumbers" collection="list" minOccurs="0" maxOccurs="unbounded" /> .... </record> </stream> |
org.beanio.BeanIOConfigurationException: Cannot determine field position, field is preceded by another component with indeterminate occurrences
Per evitarla è necessario fissare il numero di occorrenze previste per la proprietà someNumbers, ad esempio assegnando a maxOccurs il valore 10. In questo caso nello stream avremo sempre 10 posizioni per someNumbers e le restanti apparterranno sicuramente a someOtherNumbers. Ad esempio se someOtherNumbers assume il valore [6,7,8,9,10], la serializzazione in cvs sarà:
|
1 |
Jennifer,Jones,06/02/2019,44 West 29th Street,New York,NY,10001,1,2,3,4,5,,,,,,6,7,8,9,10 |
Record Multipli
Accade molto spesso nell’esportazione di dati (massivi) che i record esportati appartengano a bean di tipo differente. Ad esempio il file prodotto potrebbe prevedere un header ed un trailer. Il primo che riporta la data di generazione del file, mentre la seconda che riporta il numero di record esportati. Per farlo introduciamo i bean Header e Trailer, che non riporto data la loro semplicità, e vediamo come sia possibile mapparli nell’xml:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
<stream name="customerFile" format="csv"> <record name="header" class="it.javaboss.bean.Header" order="1"> <field name="fileDate" format="dd/MM/yyyy"/> </record> <record name="customer" class="it.javaboss.bean.Customer" order="2"> ... </record> <record name="trailer" class="it.javaboss.bean.Trailer" order="3"> <field name="recordNumbers"/> </record> </stream> |
Innanzitutto nella definizione dello stream customerFile abbiamo inserito due nuove definizioni di record, una per l’header ed una per il trailer, ed inoltre abbiamo utilizzato l’attributo order. Questo attributo può assumere valori interi maggiori o uguali a zero, ed indica la posizione del record nello stream. Quindi l’header sarà sempre il primo record mentre il trailer sarà sempre l’ultimo. tale ordine dovrà essere rispettato anche in fase di scrittura dello stream altrimenti sarà sollevata una eccezione. Per cui la classe CustomerWriter dovrà essere modificata nel seguente modo:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
public class CustomerWriter { public static void main(String[] args) throws Exception { // create a StreamFactory StreamFactory factory = StreamFactory.newInstance(); // load the mapping file factory.load( new File( CustomerReader.class.getClassLoader() .getResource("customer-mapping.xml").getFile() ) ); // use a StreamFactory to create a BeanWriter BeanWriter out = factory.createWriter("customerFile", new File( "src/main/resources/customers.csv") ); // Header out.write( new Header() ); // write an Customer object directly to the BeanWriter for ( Customer customer : CustomerUtils.CUSTOMERS ) { out.write( customer ); } // Trailer out.write( new Trailer( CustomerUtils.CUSTOMERS.size() ) ); out.flush(); out.close(); } } |
|
1 2 3 4 |
06/02/2019 Jennifer,Jones,06/02/2019,44 West 29th Street,New York,NY,10001,1,2,3,4,5,,,,,,6,7,8,9,10 Paul,Adams,06/02/2019,29 West 44th Street,New York,NY,10001,10,20,30,40,50,,,,,,60,70,80,90,100 2 |
Sfortunatamente la modifica della classe CustomerReader non è altrettanto semplice. In quanto al framework non abbiamo indicato quanti header aspettarsi nel file csv da parsare. Quello che accade è che la libreria dopo aver letto l’header si aspetta ancora un nuovo header e quindi solleva l’eccezione:
org.beanio.InvalidRecordException: Invalid 'header' record at line 2
Proviamo a risolvere valorizzando gli attributi minOccurs=1 e maxOccurs=1 nel tag <record> associato all’header. Ancora una volta avremo l’eccezione:
org.beanio.InvalidRecordException: Invalid 'customer' record at line 4
perchè a questo punto è il trailer che non viene, giustamente, riconosciuto come un record di tipo Customer. Se ci trovassimo nella situazione di conoscere esattamente quanti record di tipo customer sono esportati, e tale valore non cambia mai, potremmo ancora valorizzare opportunamente gli attributi minOccurs e maxOccurs sul tag <record> di customer, nel nostro caso ad esempio dovrebbero essere valorizzati a 2, e tutto funzionerebbe.
Sfortunatamente questa è una situazione abbastanza improbabile, quindi è necessario utilizzare il framework in modo differente. Innanzitutto inseriamo nella definizione di ciascun record un tag <field> che fittiziamente definisce una proprietà recordType non presente nei bean e che assumono un valore costante. Ad esempio per il record header sarà del tipo:
|
1 |
<field name="recordType" rid="true" literal="Header" ignore="true"/> |
- l’attributo
ridindica che il campo è utilizzato come record identifier; - l’attributo
literaldefinisce la costante utilizzata per riconoscere il tipo di record; - l’attributo
ignoreindica che il campo non è mappato in una proprietà del bean.
Con questa nuova definizione il csv prodotto sarà del tipo:
|
1 2 3 4 |
Header,06/02/2019 Customer,Jennifer,Jones,06/02/2019,44 West 29th Street,New York,NY,10001,1,2,3,4,5,,,,,,6,7,8,9,10 Customer,Paul,Adams,06/02/2019,29 West 44th Street,New York,NY,10001,10,20,30,40,50,,,,,,60,70,80,90,100 Trailer,2 |
A questo punto riconoscere il record associato a ciascuna riga è abbastanza semplice poichè è indicato dal primo campo di ciascuna riga che assumerà i valori: Header, Customer e Trailer.
La meccanismo che mette in campo BeanIO per consentirci di riconoscere il tipo di record letto consiste nell’utilizzare il metodo getRecordName() della classe BeanReader. Tale metodo restituisce il nome del record che è stato riconosciuto dal framework e che è definito nell’attributo name di ciascun tag <record>. In ragione di ciò la classe CustomerReader può essere modificata nel seguente modo:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
public class CustomerReader { public static void main(String[] args) throws Exception { // create a StreamFactory StreamFactory factory = StreamFactory.newInstance(); // load the mapping file factory.load( new File( CustomerReader.class.getClassLoader().getResource("customer-mapping.xml").getFile() ) ); // use a StreamFactory to create a BeanReader BeanReader in = factory.createReader("customerFile", new File( CustomerReader.class.getClassLoader().getResource("customers.csv").getFile() ) ); Object record = null; // read records from imput while ((record = in.read()) != null) { // process each record if ("header".equals(in.getRecordName())) { System.out.println(((Header)record).getFileDate()); } else if ("customer".equals(in.getRecordName())) { Customer customer = (Customer) record; System.out.println( customer.getFirstName() + " " + customer.getLastName() ); } else if ("trailer".equals(in.getRecordName())) { System.out.println(((Trailer)record).getRecordNumbers()); } } in.close(); } } |
Codice Sorgente
Il codice sorgente con l’esempio presentato è scaricabile qui bean-io.