Siirry pääsisältöön

Tietojen validointi ja sidonta

Avaa ChatGPT:ssä

Sovelluksesi, jonka loit vaiheessa Observers and Route Parameters, voi käyttää FormView-näkymää olemassa olevien asiakastietojen muokkaamiseen. Tässä vaiheessa käytetään tietojen sidontaa, joka yhdistää käyttöliittymän komponentit suoraan tietomalliin ja synkronoi arvot automaattisesti. Tämä vähentää sovelluksesi toistuvaa koodia ja mahdollistaa validointitarkistusten lisäämisen Spring-entiteettiin Customer, jolloin käyttäjät antavat lomakkeita täyttäessään täydelliset ja oikeat tiedot. Tässä vaiheessa käsitellään seuraavia käsitteitä:

Tämän vaiheen suorittamalla luot version 5-validating-and-binding-data-projektista.

Sovelluksen suorittaminen​

Sovellusta kehittäessäsi voit käyttää vertailukohtana 5-validating-and-binding-data-projektia. Näet sovelluksen toiminnassa seuraavasti:

  1. Siirry ylimmän tason hakemistoon, jossa pom.xml-tiedosto sijaitsee. Jos seuraat GitHub-version ohjeita, kyseessä on hakemisto 5-validating-and-binding-data.

  2. Suorita Spring Boot -sovellus paikallisesti seuraavalla Maven-komennolla:

    mvn

Sovelluksen suorittaminen avaa automaattisesti uuden selaimen osoitteessa http://localhost:8080.

Validointisääntöjen määrittäminen​

Muokattavia tietoja käsittelevän sovelluksen kehittämiseen kuuluu validointi. Validointitarkistukset auttavat säilyttämään käyttäjien lähettämät tiedot mielekkäinä ja oikeina. Tarkistamatta jättäminen voi johtaa ongelmiin, joten on tärkeää havaita reaaliaikaisesti virheet, joita käyttäjät voivat tehdä lomaketta täyttäessään.

Koska ominaisuuden hyväksyttävät arvot voivat vaihdella, sinun on määritettävä kullekin ominaisuudelle kelvolliset arvot ja ilmoitettava käyttäjälle, jos jokin arvo ei kelpaa. Onneksi tämän voi tehdä helposti Jakarta Validationin avulla. Jakarta Validationin avulla voit lisätä ominaisuuksille rajoitteita annotaatioina.

Tässä tutoriaalissa käytetään kahta Jakarta-annotaatiota: @NotEmpty ja @Pattern. @NotEmpty tarkistaa, ettei arvo ole null tai tyhjä merkkijono, kun taas @Pattern tarkistaa, vastaako ominaisuuden arvo määrittämääsi säännöllistä lauseketta. Molempien annotaatioiden avulla voit lisätä viestin, joka näytetään, kun ominaisuuden arvo ei kelpaa.

Jos haluat vaatia, että sekä etu- että sukunimi ovat pakollisia ja sisältävät vain kirjaimia, mutta yrityksen nimi on valinnainen ja voi sisältää kirjaimia, numeroita ja välilyöntejä, lisää seuraavat annotaatiot Customer-entiteettiin:

Customer.java

@NotEmpty(message = "Customer first name is required")
@Pattern(regexp = "[a-zA-Z]*", message = "Invalid characters")
private String firstName = "";

@NotEmpty(message = "Customer last name is required")
@Pattern(regexp = "[a-zA-Z]*", message = "Invalid characters")
private String lastName = "";

@Pattern(regexp = "[a-zA-Z0-9 ]*", message = "Invalid characters")
private String company = "";

private Country country = Country.UNKNOWN;

public enum Country {
UNKNOWN,

Katso kaikki validoinnit Jakarta Bean Validationin rajoitteiden viiteoppaasta tai lue lisää webforJ:n Jakarta Validation -artikkelista.

Kenttien sitominen​

Jotta voit käyttää Customer-luokan validointitarkistuksia FormView-näkymän käyttöliittymässä, luot tietojen sidontaa varten BindingContext-olion. Ennen tietojen sidontaa jokainen FormView-näkymän kenttä vaati tapahtumakuuntelijan, joka synkronoi kentän arvon manuaalisesti Spring-entiteetin Customer kanssa. Kun luot FormView-näkymään BindingContext-olion, Customer-tietomalli sidotaan käyttöliittymän komponentteihin ja synkronoidaan niiden kanssa automaattisesti.

BindingContext-olion luominen​

BindingContext-olion luomiseen tarvitaan Spring-bean, jonka kanssa sidonnat synkronoidaan. Määritä FormView-näkymässä BindingContext, joka käyttää Customer-entiteettiä:

FormView.java
public class FormView extends Composite<Div> implements WillEnterObserver {
private final CustomerService customerService;

private BindingContext<Customer> context;

Customer customer = new Customer();

Voit sitoa käyttöliittymän komponentit automaattisesti beanin ominaisuuksiin niiden nimien perusteella käyttämällä BindingContext.of()-metodia seuraavin parametrein:

  • this : Aiemmin määritit context-muuttujan BindingContext-olioksi. Ensimmäinen parametri määrittää olion, joka sisältää sidottavat komponentit.
  • Customer.class : Toinen parametri on sidonnassa käytettävän beanin luokka.
  • true : Kolmas parametri ottaa käyttöön Jakarta-validoinnin, jolloin konteksti voi käyttää Customer-luokalle määrittämiäsi validointeja. Tämä muuttaa virheellisten komponenttien tyyliä ja näyttää määritetyt viestit.

Kokonaisuudessaan koodirivi näyttää tältä:

context = BindingContext.of(this, Customer.class, true);

Lomakkeen responsiivisuuden määrittäminen​

Tietojen sidonnan ansiosta sovelluksesi suorittaa nyt validointitarkistukset automaattisesti. Lisäämällä tarkistuksiin tapahtumakuuntelijan voit estää käyttäjiä lähettämästä virheellistä lomaketta. Lisää seuraava koodi, jotta lähetyspainike on aktiivinen vain lomakkeen ollessa kelvollinen:

context = BindingContext.of(this, Customer.class, true);
context.onValidate(e -> submit.setEnabled(e.isValid()));

Komponenttien tapahtumakuuntelijoiden poistaminen​

Kaikki käyttöliittymän muutokset synkronoidaan nyt automaattisesti BindingContext-olion kanssa. Voit siis poistaa kunkin kentän tapahtumakuuntelijat:

Ennen

FormView.java
// Without data binding
TextField firstName = new TextField("First Name", e -> customer.setFirstName(e.getValue()));
TextField lastName = new TextField("Last Name", e -> customer.setLastName(e.getValue()));
TextField company = new TextField("Company", e -> customer.setCompany(e.getValue()));
ChoiceBox country = new ChoiceBox("Country",
e -> customer.setCountry(Country.valueOf(e.getSelectedItem().getText())));

Jälkeen

FormView.java
// With data binding
TextField firstName = new TextField("First Name");
TextField lastName = new TextField("Last Name");
TextField company = new TextField("Company");
ChoiceBox country = new ChoiceBox("Country");

Sitominen ominaisuuksien nimien perusteella​

Koska kunkin komponentin nimi vastasi tietomallin ominaisuuden nimeä, webforJ käytti automaattista sidontaa. Jos nimet eivät vastaisi toisiaan, voisit yhdistää ne @UseProperty-annotaation avulla.

@UseProperty("firstName")
TextField firstNameField = new TextField("First Name");

Tietojen lukeminen fillForm()-metodissa​

Aiemmin alustusit fillForm()-metodissa kunkin komponentin arvon hakemalla tiedot manuaalisesti Customer-kopiosta. Nyt kun käytät BindingContext-oliota, voit käyttää read()-metodia. Tämä metodi täyttää kunkin sidotun komponentin arvolla, joka vastaa Customer-kopion tietoja.

Korvaa fillForm()-metodissa setValue()-metodit read()-metodilla:

FormView.java
public void fillForm(Long customerId) {
customer = customerService.getCustomerByKey(customerId);

// Removed each setValue() method for the UI components

context.read(customer);
}

Validoinnin lisääminen submitCustomer()-metodiin​

Tässä vaiheessa viimeinen FormView-näkymään tehtävä muutos on suojauksen lisääminen submitCustomer()-metodiin. Ennen muutosten tallentamista H2-tietokantaan sovellus suorittaa sidotun kontekstin tuloksille lopullisen validoinnin write()-metodilla.

write()-metodi päivittää beanin ominaisuudet käyttämällä BindingContext-olioon sidottuja käyttöliittymäkomponentteja ja palauttaa ValidationResult-olion.

Kirjoita write()-metodilla Customer-kopioon FormView-näkymään sidottujen komponenttien arvot. Jos palautettu ValidationResult on kelvollinen, päivitä H2-tietokanta kirjoitetuilla tiedoilla.

FormView.java
private void submitCustomer() {
ValidationResult results = context.write(customer);
if (results.isValid()) {
if (customerService.doesCustomerExist(customerId)) {
customerService.updateCustomer(customer);
} else {
customerService.createCustomer(customer);
}
navigateToMain();
}
}

Valmis FormView​

Näiden muutosten jälkeen FormView näyttää tältä. Sovellus tukee nyt tietojen sidontaa ja validointia Spring Bootin ja webforJ:n avulla. Lomakkeen syötteet synkronoidaan automaattisesti mallin kanssa ja tarkistetaan validointisääntöjä vasten.

FormView.java
@Route("customer/:id?<[0-9]+>")
@FrameTitle("Customer Form")
public class FormView extends Composite<Div> implements WillEnterObserver {
private final CustomerService customerService;
private BindingContext<Customer> context;
private Customer customer = new Customer();
private Long customerId = 0L;
private Div self = getBoundComponent();
private TextField firstName = new TextField("First Name");
private TextField lastName = new TextField("Last Name");
private TextField company = new TextField("Company");
private ChoiceBox country = new ChoiceBox("Country");
private Button submit = new Button("Submit", ButtonTheme.PRIMARY, e -> submitCustomer());
private Button cancel = new Button("Cancel", ButtonTheme.OUTLINED_PRIMARY, e -> navigateToMain());
private ColumnsLayout layout = new ColumnsLayout(

Seuraava vaihe​

Seuraavassa vaiheessa sovelluksen asettelun integrointi käsitellään AppLayout-komponentin käyttöä sivuvalikon lisäämiseen. Valikko on käyttäjien käytettävissä sekä asiakastaulukko- että asiakaslomakesivulla. Opit myös käyttämään toista asettelutyökalua, FlexLayout-komponenttia.

Jatka oppimista