Introduzione a Vaadin

1. Panoramica

Vaadin è un framework Java lato server per la creazione di interfacce utente web. Usandolo, possiamo creare il nostro front-end utilizzando le funzionalità Java.

2. Dipendenze e installazione di Maven

Cominciamo aggiungendo le seguenti dipendenze al nostro pom.xml :

 com.vaadin vaadin-server   com.vaadin vaadin-client-compiled   com.vaadin vaadin-themes  

Le ultime versioni delle dipendenze possono essere trovate qui: vaadin-server, vaadin-client-compilato, vaadin-themes.

  • pacchetto vaadin-server : include classi per la gestione di tutti i dettagli del server come sessioni, comunicazioni client, ecc.
  • vaadin-client-compiled - si basa su GWT e include i pacchetti necessari per compilare il client
  • vaadin-themes : include alcuni temi predefiniti e tutte le utilità per creare i nostri temi

Per compilare i nostri widget Vaadin, dobbiamo configurare il plugin maven-war, il plugin vaadin-maven e il plugin maven-clean. Per il pom completo, assicurati di controllare il file pom nel codice sorgente - alla fine del tutorial.

Inoltre, dobbiamo anche aggiungere il repository Vaadin e la gestione delle dipendenze:

  vaadin-addons //maven.vaadin.com/vaadin-addons      com.vaadin vaadin-bom 13.0.9 pom import   

Il tag DependencyManagement controlla le versioni di tutte le dipendenze Vaadin .

Per eseguire rapidamente l'applicazione, utilizzeremo il plug-in Jetty:

 org.eclipse.jetty jetty-maven-plugin 9.3.9.v20160517  2 true  

L'ultima versione del plugin può essere trovata qui: jetty-maven-plugin.

Con questo plugin possiamo eseguire il nostro progetto utilizzando il comando:

mvn jetty:run

3. Che cos'è Vaadin?

In poche parole, Vaadin è un framework Java per la creazione di interfacce utente , con temi e componenti e molte opzioni di estensibilità.

Il framework copre anche il lato server , il che significa che ogni modifica apportata all'interfaccia utente viene immediatamente inviata al server, quindi in ogni momento l'applicazione backend sa cosa sta succedendo nel front-end.

Vaadin è costituito da un lato client e server, con il lato client costruito sul noto framework di Google Widget Toolkit e il lato server gestito da VaadinServlet .

4. Il Servlet

Di solito, un'applicazione Vaadin non utilizza un file web.xml ; invece, definisce il suo servlet usando le annotazioni:

@WebServlet(urlPatterns = "/VAADIN/*", name = "MyUIServlet", asyncSupported = true) @VaadinServletConfiguration(ui = VaadinUI.class, productionMode = false) public static class MyUIServlet extends VaadinServlet {}

In questo caso, questo servlet fornisce il contenuto dal percorso / VAADIN .

5. La classe principale

La classe VaadinUI a cui si fa riferimento nel servlet deve estendere la classe UI dal framework e deve sovrascrivere il metodo init per completare il bootstrap dell'applicazione con Vaadin abilitato.

Il passaggio successivo consiste nel creare un layout e aggiungerlo a un layout principale dell'applicazione:

public class VaadinUI extends UI { @Override protected void init(VaadinRequest vaadinRequest) { VerticalLayout verticalLayout = new VerticalLayout(); verticalLayout.setSpacing(true); verticalLayout.setMargin(true); setContent(verticalLayout); }

6. Gestori di layout Vaadin

Il framework viene fornito con una serie di gestori di layout predefiniti.

6.1. VerticalLayout

Impila i componenti su una colonna in cui il primo aggiunto è in alto e l'ultimo in basso:

VerticalLayout verticalLayout = new VerticalLayout(); verticalLayout.setSpacing(true); verticalLayout.setMargin(true); setContent(verticalLayout);

Nota come le proprietà qui sono vagamente prese in prestito dalla tipica terminologia CSS.

6.2. HorizontalLayout

Questo layout posiziona ogni componente fianco a fianco da sinistra a destra è simile al layout verticale:

HorizontalLayout horizontalLayout = new HorizontalLayout();

6.3. Layout della griglia

Questo layout posiziona ogni widget in una griglia, è necessario passare come parametro le colonne e le righe della griglia:

GridLayout gridLayout = new GridLayout(3, 2);

6.4. FormLayout

Il layout del modulo inserisce la didascalia e il componente in due colonne diverse e può avere indicatori opzionali per i campi obbligatori:

FormLayout formLayout = new FormLayout();

7. Componenti Vaadin

Ora che il layout è gestito, diamo uno sguardo ad alcuni dei componenti più comuni per costruire la nostra interfaccia utente.

7.1. Etichetta

L'etichetta è, ovviamente, ben nota e usata semplicemente per visualizzare il testo:

Label label = new Label(); label.setId("LabelID"); label.setValue("Label Value"); label.setCaption("Label"); gridLayout.addComponent(label);

Dopo aver creato il componente, nota il passaggio critico di aggiungerlo al layout.

7.2. Link

Il widget di collegamento è essenzialmente un collegamento ipertestuale di base:

Link link = new Link("Baeldung", new ExternalResource("//www.baeldung.com/")); link.setTargetName("_blank");

Nota come i valori HTML tipici di un file elemento sono tutti qui.

7.3. Campo di testo

This widget is used to input text:

TextField textField = new TextField(); textField.setIcon(VaadinIcons.USER);

We can further customize the elements; for example, we can quickly add images to the widgets via the setIcon() API.

Also, note that Font Awesome is shipped out of the box with the framework; it's defined as an Enum, and we can easily make use of it.

7.4. TextArea

As you'd expect, TextArea is available next to the rest of the traditional HTML elements:

TextArea textArea = new TextArea();

7.5. DateField and InlineDateField

This powerful component is used to pick dates; the date parameter is the current date to be selected in the widget:

DateField dateField = new DateField("DateField", LocalDate.ofEpochDay(0));

We can go further and nest it inside a combo box control to save space:

InlineDateField inlineDateField = new InlineDateField();

7.6. PasswordField

This is the standard masked password input:

PasswordField passwordField = new PasswordField();

7.7. RichTextArea

With this component, we can show formatted text, and it provides an interface to manipulate such text with buttons to control the fonts, size, alignment, etc.are:

RichTextArea richTextArea = new RichTextArea(); richTextArea.setCaption("Rich Text Area"); richTextArea.setValue(""); richTextArea.setSizeFull(); Panel richTextPanel = new Panel(); richTextPanel.setContent(richTextArea);

7.8. Button

Buttons are used for capturing user input and come in a variety of sizes and colors.

To create a button we instantiate the widget class as usual:

Button normalButton = new Button("Normal Button");

Changing the style we can have some different buttons:

tinyButton.addStyleName("tiny"); smallButton.addStyleName("small"); largeButton.addStyleName("large"); hugeButton.addStyleName("huge"); dangerButton.addStyleName("danger"); friendlyButton.addStyleName("friendly"); primaryButton.addStyleName("primary"); borderlessButton.addStyleName("borderless"); linkButton.addStyleName("link"); quietButton.addStyleName("quiet");

We can create a disabled button:

Button disabledButton = new Button("Disabled Button"); disabledButton.setDescription("This button cannot be clicked"); disabledButton.setEnabled(false); buttonLayout.addComponent(disabledButton);

A native button that uses the browser's look:

NativeButton nativeButton = new NativeButton("Native Button"); buttonLayout.addComponent(nativeButton);

And a button with an icon:

Button iconButton = new Button("Icon Button"); iconButton.setIcon(VaadinIcons.ALIGN_LEFT); buttonLayout.addComponent(iconButton);

7.9. CheckBox

The check box is a change state element, is checked or is unchecked:

CheckBox checkbox = new CheckBox("CheckBox"); checkbox.setValue(true); checkbox.addValueChangeListener(e -> checkbox.setValue(!checkbox.getValue())); formLayout.addComponent(checkbox);

7.10. Lists

Vaadin has some useful widgets to handle lists.

First, we create a list of our items to be placed in the widget:

List numbers = new ArrayList(); numbers.add("One"); numbers.add("Ten"); numbers.add("Eleven");

The ComboBox is a drop down list:

ComboBox comboBox = new ComboBox("ComboBox"); comboBox.addItems(numbers); formLayout.addComponent(comboBox);

The ListSelect vertically places items and uses a scroll bar in case of overflow:

ListSelect listSelect = new ListSelect("ListSelect"); listSelect.addItems(numbers); listSelect.setRows(2); formLayout.addComponent(listSelect);

The NativeSelect is like the ComboBox but have the browser look and feel:

NativeSelect nativeSelect = new NativeSelect("NativeSelect"); nativeSelect.addItems(numbers); formLayout.addComponent(nativeSelect);

The TwinColSelect is a dual list where we can change the items between these two panes; each item can only live in one of the panes at a time:

TwinColSelect twinColSelect = new TwinColSelect("TwinColSelect"); twinColSelect.addItems(numbers);

7.11. Grid

The grid is used to show data in a rectangular way; you have rows and columns, can define header and foot for the data:

Grid grid = new Grid(Row.class); grid.setColumns("column1", "column2", "column3"); Row row1 = new Row("Item1", "Item2", "Item3"); Row row2 = new Row("Item4", "Item5", "Item6"); List rows = new ArrayList(); rows.add(row1); rows.add(row2); grid.setItems(rows);

The Row class above is a simple POJO we've added to represent a row:

public class Row { private String column1; private String column2; private String column3; // constructors, getters, setters }

8. Server Push

Another interesting feature is an ability to send messages from the server to the UI.

To use server push, we need to add the following dependency to our pom.xml:

 com.vaadin vaadin-push 8.8.5 

The latest version of the dependency can be found here: vaadin-push.

Also, we need to add the @Push annotation to our class representing UI:

@Push @Theme("mytheme") public class VaadinUI extends UI {...}

We create a label to capture the server push message:

private Label currentTime;

We then create a ScheduledExecutorService that sends the time from the server to the label:

ScheduledExecutorService scheduleExecutor = Executors.newScheduledThreadPool(1); Runnable task = () -> { currentTime.setValue("Current Time : " + Instant.now()); }; scheduleExecutor.scheduleWithFixedDelay(task, 0, 1, TimeUnit.SECONDS);

The ScheduledExecutorService is running on the server side of the application and every time it runs, the user interface gets updated.

9. Data Binding

We can bind our user interface to our business classes.

First, we create a Java class:

public class BindData { private String bindName; public BindData(String bindName){ this.bindName = bindName; } // getter & setter }

Then we bind our class that has a single field to a TextField in our user interface:

Binder binder = new Binder(); BindData bindData = new BindData("BindData"); binder.readBean(bindData); TextField bindedTextField = new TextField(); binder.forField(bindedTextField).bind(BindData::getBindName, BindData::setBindName);

First, we create a BindData object using the class we created before, then the Binder binds the field to the TextField.

10. Validators

We can create Validators to validate the data in our input fields. To do that, we attach the validator to the field we want to validate:

BindData stringValidatorBindData = new BindData(""); TextField stringValidator = new TextField(); Binder stringValidatorBinder = new Binder(); stringValidatorBinder.setBean(stringValidatorBindData); stringValidatorBinder.forField(stringValidator) .withValidator(new StringLengthValidator("String must have 2-5 characters lenght", 2, 5)) .bind(BindData::getBindName, BindData::setBindName);

Then we validate our data before we use it:

Button buttonStringValidator = new Button("Validate String"); buttonStringValidator.addClickListener(e -> stringValidatorBinder.validate());

In this case, we are using the StringLengthValidator that validates the length of a String but Vaadin provides other useful validators and also allows us to create our custom validators.

11. Summary

Of course, this quick writeup barely scratched the surface; the framework is much more than user interface widgets, Vaadin provides all you need for creating modern web applications using Java.

E, come sempre, il codice può essere trovato su Github.