Как добавить проверку на ввод в spring boot application?

Question

[Leo Sobolev]

Добрый день, Хабр! У меня возникла проблема при разработке приложения на практику в университете. Делаю приложение для работы с базой данных (удаление, добавление, редактирование, просмотр). В приложение нужно добавить проверки на ввод ( когда допустим добавляю пользователя, если неправильно ввел имя(использовал цифры, больше знаков, чем прописано в БД и тд.). Но при гуглении не нашел ничего толкового и решил обратиться к вам.
СУБД: PostgreSQL
Spring Boot
Maven
Mustache

Вот для примера сущность клиента:

package com.example.karakum.persist.entity;

import com.sun.istack.NotNull;
import lombok.Getter;
import lombok.Setter;

import javax.persistence.*;
import java.io.Serializable;
import java.util.List;

@Getter
@Setter
@Entity
@Table(name="Client")
public class ClientEntity implements Serializable {
private static final long serialVersionUID = 4364632587002683208L;

@Id
@GeneratedValue(strategy = GenerationType.SEQUENCE)
@Basic(optional = false)
@Column(name = "Client_id", unique = true, nullable = false)
private Integer clientId;

@Column(name = "client_fn")
@NotNull
private String clientFn;

@Column(name = "client_passport")
private String clientPassport;

@Column(name = "client_bank")
private String clientBank;

@Column(name = "client_banknum")
private String clientBankNum;

@Column(name = "client_sign")
private String clientSign;

/* @OneToMany(mappedBy = "client")
private List contracts;
*/
public ClientEntity() {
}

public ClientEntity(String clientFn, String clientPassport, String clientBank, String clientBankNum, String clientSign) {
this.clientFn = clientFn;
this.clientPassport = clientPassport;
this.clientBank = clientBank;
this.clientBankNum = clientBankNum;
this.clientSign = clientSign;
}
}

Вот добавление клиента в контроллер классе:

@GetMapping(value = {"/clients/add"})
public String clientAdd(Model model) {
return "clientadd";
}

@PostMapping({"/clients/add"})
public String clientEntityAdd(@RequestParam String clientfn, @RequestParam String clientpassport, @RequestParam String clientbank, @RequestParam String clientbanknum, @RequestParam String clientsign, Model model) {
ClientEntity clientEntity = new ClientEntity(clientfn, clientpassport, clientbank, clientbanknum, clientsign);
clientRepository.save(clientEntity);
return "clientadd";
}

Вот так выглядит страница добавления клиента мне нужно чтобы выдавались ошибки при неверном вводе

Заранее спасибо за помощь!

Answer 1

[Орхан Гасанлы]

Добрый день!
Обычно принято делать следующим образом:
1) Добавьте либу spring boot validation - https://www.baeldung.com/spring-boot-bean-validation

2) Создайте DTO. Например, если у вас есть entity User, то также создайте UserRequestDto.
Например,

UserRequestDto {
@NotBlank(message = "Name is mandatory")
String username;

@NotBlank(message = "Email is mandatory")
String email;
}

3) Валидируйте отправленные в бекенд данные (dto) при помощи вышеуказанной библиотеки и если что-то не так выбрасывайте исключение MethodArgumentNotValidException

например,

//@RestController
@Controller 
UserController {

public ResponseEntity<User> addUser( @Valid UserDto user ) {
// конвертируем UserDto -> User и в передаем в сервисный класс для сохранения
}

}

Также валидацию можно сделать на клиентской стороне средствами JavaScript или HTML.
Средствами html можно для инпутов добавить required, указать тип инпута например, <input type="email" />

P.S. Кстати, у вас в entity NotNull импортирован import com.sun.istack.NotNull;, а должно быть hibernate validator.

Comments

[Leo Sobolev]

Спасибо за то, что натолкнули на разгадку! Но у меня остались некоторые вопросы. Я создал класс ClientDto

package com.example.karakum.dto;

import lombok.AllArgsConstructor;
import lombok.Data;

import javax.validation.constraints.NotBlank;

@Data
@AllArgsConstructor
public class ClientDto {

@NotBlank(message = "Input correct name")
private String clientFn;

@NotBlank(message = "Input correct passport data")
private String clientPassport;

@NotBlank(message = "Input correct bank name")
private String clientBank;

@NotBlank(message = "Input correct bank number")
private String clientBankNum;

@NotBlank(message = "Input correct client sign")
private String clientSign;
}

Но при гуглении, мне говорят, что нужно создать так называемый RestController
То есть мне больше не нужен класс Lada Controller?
Вот кстати сам LadaController:

[Leo Sobolev]

package com.example.karakum;

import ch.qos.logback.core.net.server.Client;
import com.example.karakum.persist.entity.*;
import com.example.karakum.repo.*;
import com.example.karakum.service.*;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestParam;

import java.text.ParseException;
import java.util.ArrayList;
import java.util.Map;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Optional;

@Controller
public class LadaController {

private final ICarService carService;
private final IClientService clientService;
private final IConsultantService consultantService;
private final IBranchService branchService;
private final IContractService contractService;

@Autowired
public LadaController(ICarService carService, IClientService clientService, IConsultantService consultantService, IBranchService branchService, IContractService contractService, IContractCompositionServices contractCompositionServices) {
this.carService = carService;
this.clientService = clientService;
this.consultantService = consultantService;
this.branchService = branchService;
this.contractService = contractService;
}

@Autowired
private ClientRepository clientRepository;
@Autowired
private ConsultantRepository consultantRepository;
@Autowired
private BranchRepository branchRepository;
@Autowired
private CarRepository carRepository;
@Autowired
private ContractRepository contractRepository;

@GetMapping(value = "/clients")
public String getClient(Map model) {
model.put("clients", clientService.getAllClients());
return "client";
}

@GetMapping(value = "/cars")
public String getCars(Map model) {
model.put("cars", carService.getAllCars());
return "cars";
}

@GetMapping(value = "/consultants")
public String getConsultants(Map model) {
model.put("consultants", consultantService.getAllConsultants());
return "consultant";
}

@GetMapping(value = "/branches")
public String getBranches(Map model) {
model.put("branches", branchService.getAllBranches());
return "branch";
}

@GetMapping(value = "/contracts")
public String getContracts(Map model) {
model.put("contracts", contractService.getAllContracts());
return "contract";
}

/*
@GetMapping(value = "/compositions")
public String getCompositions(Map model){
model.put("compositions", contractService.getAllContracts());
return "composition";
}
*/
@Value("Lada Service")
private String title;

@GetMapping(value = {"/", "/index"})
public String index(Model model) {
model.addAttribute("title", title);
return "index";
}

@GetMapping(value = {"/clients/add"})
public String clientAdd(Model model) {
return "clientadd";
}

@PostMapping({"/clients/add"})
public String clientEntityAdd(@RequestParam String clientfn, @RequestParam String clientpassport, @RequestParam String clientbank, @RequestParam String clientbanknum, @RequestParam String clientsign, Model model) {
ClientEntity clientEntity = new ClientEntity(clientfn, clientpassport, clientbank, clientbanknum, clientsign);
clientRepository.save(clientEntity);
return "clientadd";
}

@GetMapping(value = "/consultants/add")
public String consultantAdd(Model model) {
return "consultantadd";
}

@PostMapping(value = "/consultants/add")
public String consultantEntityAdd(@RequestParam String consultantFullName, @RequestParam String consultantDateOfBirth, @RequestParam Integer consultantBranchId, Model model) throws ParseException {
Date date1 = new SimpleDateFormat("yyyy-MM-dd").parse(String.valueOf(consultantDateOfBirth));
ConsultantEntity consultantEntity = new ConsultantEntity(consultantFullName, date1, consultantBranchId);

consultantRepository.save(consultantEntity);
return "consultantadd";
}

@GetMapping(value = "/branches/add")
public String branchAdd(Model model) {
return "branchadd";
}

@PostMapping(value = "/branches/add")
public String branchEntityAdd(@RequestParam String branchName,
@RequestParam String branchInn,
@RequestParam String branchComandor,
@RequestParam Integer branchParking,
@RequestParam String branchAdress,
@RequestParam String branchPhone,
Model model) {
BranchEntity branchEntity = new BranchEntity(branchName, branchInn, branchComandor, branchParking, branchAdress, branchPhone);
branchRepository.save(branchEntity);
return "branchadd";
}

@GetMapping(value = "/cars/add")
public String carAdd(Model model) {
return "caradd";
}

@PostMapping(value = "/cars/add")
public String carEntityAdd(@RequestParam String carBrand,
@RequestParam String carModel,
@RequestParam Integer carBodyNum,
@RequestParam Integer carEngineNum,
@RequestParam String carBodyModel,
@RequestParam Integer carEngineVolume,
@RequestParam Integer carEnginePower,
@RequestParam String carWheel,
@RequestParam String carDriveBool,
@RequestParam Double carPrice,
@RequestParam String carType,
@RequestParam Integer carYear,
@RequestParam Integer carMileage,
@RequestParam String carBodyType,
Model model) {
CarEntity carEntity = new CarEntity(carBrand, carModel, carBodyNum, carEngineNum, carBodyModel, carEngineVolume, carEnginePower, carWheel, carDriveBool, carPrice, carType, carYear, carMileage, carBodyType);
carRepository.save(carEntity);
return "caradd";
}

@GetMapping(value = "/contracts/add")
public String contractAdd(Model model) {
return "contractadd";
}

@PostMapping(value = "/contracts/add")
public String contractEntityAdd(@RequestParam Integer contractBranchId, @RequestParam Integer contactConsultantId, @RequestParam Integer contractClientId, Model model) {
ContractEntity contractEntity = new ContractEntity(contractBranchId, contactConsultantId, contractClientId);
contractRepository.save(contractEntity);
return "contractadd";
}

/*EXPERIMENT*/
/* @PostMapping(value = "/client/{clientId}")
public String clientDetails(@PathVariable(value = "clientId") Integer clientId, Model model){
Optional client= clientRepository.findById(clientId);
model.addAttribute("client", client);
return "client-details";
} */

@GetMapping(value = "/clients/{clientId}")
public String clientDetails(Model model, @PathVariable Integer clientId) {
Optional client = null;
try {
client = clientRepository.findById(clientId);
model.addAttribute("allowDelete", false);
} catch (Exception ex) {
model.addAttribute("errorMessage", ex.getMessage());
}
model.addAttribute("client", client);
return "client-details";
}

}

Извините за глупые вопросы, просто хочется правда понять данную тему и быть свободным в этом вопросе!
Заранее спасибо <3

[Орхан Гасанлы]

Лев Соболев,
Не бывает глупых вопросов. Я сам когда-то был начинающим разработчиком и довольно часто задавался аналогичными вопросами.

RestController и Controller это разные вещи.

RestController это специфичная форма Controller, которая включает в себя Controller & ResponseBody
Но при необходимости Controller можно превратить в RestController
Например, указанные ниже 2 контроллера идентичны. Так как к методу из класса UserController добавлена аннотация @ResponseBody

Controller

@Controller
public class UserController {

public @ResponseBody String usersList() {}

}

REST Controller

@RestController
public class UserController {

public String usersList() {}

}

Соответственно, если вы пишете REST сервис, то используйте RestController. Если пишете MVC приложение (т.е. есть некий шаблонизатор - mustache, thymeleaf и др). Тут на самом деле все зависит от вашей фантазии. Например, вы можете писать MVC приложение, но иметь RestController, на который будет аяксом (ajax) приходить заполненные данные (без перезагрузки страницы). А дальше результат валидации в формате json уходить на клиент, а средствами js распарсить ответ и добавить их в html.

Кстати, тут может быть проблема, так как у вас есть AllArgsConstructor, но default конструктора нет. Если не ошибаюсь, то скорее всего будет выброшено исключение при попытке забайндить.

@Data
@AllArgsConstructor
public class ClientDto {}

Обычно, если у вас много однотипных параметров, то лучше собирать их в dto. Например, CarDto или CarRequest

public String carEntityAdd(@RequestParam String carBrand,
@RequestParam String carModel,
@RequestParam Integer carBodyNum,
@RequestParam Integer carEngineNum,
@RequestParam String carBodyModel,
@RequestParam Integer carEngineVolume,
@RequestParam Integer carEnginePower,
@RequestParam String carWheel,
@RequestParam String carDriveBool,
@RequestParam Double carPrice,
@RequestParam String carType,
@RequestParam Integer carYear,
@RequestParam Integer carMileage,
@RequestParam String carBodyType,
Model model)

Optional является параметризованным классом. лучше использовать его возможности.
Например, вместо:

Optional client= clientRepository.findById(clientId);

использовать:

Optionzal<User> client = clientRepository.findById(clientId).orElseThrow(UserNotFoundException::new);

Т.е. если пользователь по id не будет найден, то будет выброшено исключение UserNotFoundException

[Leo Sobolev]

Орхан Гасанлы, Спасибо вам большое за подробный развернутый ответ!

[Leo Sobolev]

Орхан Гасанлы, ещё одни вопрос :( (извините пожалуйста) я делаю MVC приложение, создам контролеры для каждой сущности, а что собственно писать в этих контроллерах? Мне нужно перенести добавление туда ?

[Орхан Гасанлы]

Лев Соболев,

Спасибо вам большое за подробный развернутый ответ!

Рад помочь.

Раз вы пишете MVC приложение, то допустим, что для отображения шаблона вам нужен GET запрос. Т.е. есть некий метод, который обрабатывает GET запрос и выдает шаблон. Далее если на странице есть некая форма (например, форма регистрации или контактная форма), то для получения данных отправленных из формы вам нужно написать POST методы. В общем, рекомендую прочитать про HTTP METHOD (GET, POST, PUT, DELETE и т.д.). Так как вы работаете в рамках html и скорее всего без js, то пока вам понадобится GET & POST.

Приведу простой псевдокод, чтобы вы могли примерно понять логику. А дальше для получения большей информации рекомендую погуглить и прочитать соответствующие статьи. Хороший ресурс - baeldung.com

Допустим у вас есть:
- контроллер для обработки запросов

@Controller
@RequestMapping("/users")
public class UserController {

@Autowired
private UserService userService;

@GetMapping
public ModelAndView usersList(){
ModelAndView modelAndView = new ModelAndView("НАЗВАНИЕ_ШАБЛОНА");
modelAndView.addObject("users", userService.findAll());
return modelAndView;
}

@PostMapping("/add")
public RedirectView addUser(
@Valid UserRequest userRequest
){
userService.addUser(userRequest);
return new RedirectView("/users");
}

}

Далее у нас есть entity User

public class User {
long id;
String username;
String password;
}

а также есть dto UserRequest, где мы валидируем данные

class UserRequest {
@NotBlank(message="Username can't be empty")
String username;
@NotBlank(message="Password can't be empty")
String password;
}

Далее вам понадобится конвертер UserRequest -> User. Можно подключить либу ModelMapper или MapStruct, но можно обойтись и без них. Например,

@Component
public class UserConverter extends Converter<UserRequest, User> {
    @Override
    public User convert(UserRequest userRequest) {
       User user = new User();
       user.setUsername(userRequest.getUsername());
       user.setPassword(userRequest.getPassword());
    }
}

И конечно же у нас есть UserService, где указана бизнес логика. Например,

@Service
public class UserService {

@Autowired UserRepository userRepository;
@Autowired UserConverter userConverter;

public List<User> usersList() {
return userRepository.findAll();
}

public void addUser(UserRequest userRequest) {
User user = userConverter.convert(userRequest);
userRepository.save(user);
}

}

Я привел довольно простой пример. Конечно же можно обработать исключения и т.д. Но думаю, общий смысл будет вам понятен

Полезные ссылки:
https://www.baeldung.com/spring-mvc-model-model-ma...
https://www.baeldung.com/spring-redirect-and-forward
https://www.baeldung.com/spring-type-conversions

[Степан]

Орхан Гасанлы, подскажите, а DTO (в данном случае UserRequest) нужен в случае получения данных от пользователя? Или перед отправкой ответа Entity (User) также нужно конвертировать в DTO? То есть нужен ещё один конвертер?

[Орхан Гасанлы]

Степан,
Да, нужен и UserRequestDTO & UserResponseDTO.
Вообще, лучше не отдавать на клиент всю структуру вашей БД. Для этих целей используется доп. прослойка Data To Object.
Например, вам нужно вернуть список пользователей, но некоторые данные о пользователях хранимые в БД не нужны. В этом случае используется паттерн DTO.

Для удобства работы с DTO (для маппинга) можно использовать ModelMapper || MapStruct. Ну или же интерфейс Converter<FROM, TO> самого спринга