-
Notifications
You must be signed in to change notification settings - Fork 54.2k
Bael 8585 #18643
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Bael 8585 #18643
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
package com.baeldung.bindcustomvalidationmessage; | ||
|
||
import java.util.HashMap; | ||
import java.util.Map; | ||
import org.springframework.http.ResponseEntity; | ||
import org.springframework.web.bind.MethodArgumentNotValidException; | ||
import org.springframework.web.bind.annotation.ControllerAdvice; | ||
import org.springframework.web.bind.annotation.ExceptionHandler; | ||
|
||
@ControllerAdvice | ||
public class GlobalExceptionHandler { | ||
@ExceptionHandler(MethodArgumentNotValidException.class) | ||
public ResponseEntity<Map<String, String>> handleValidationErrors( | ||
MethodArgumentNotValidException ex) { | ||
Map<String, String> errors = new HashMap<>(); | ||
|
||
ex.getBindingResult() | ||
.getFieldErrors() | ||
.forEach(error -> errors.put(error.getField(), error.getDefaultMessage())); | ||
|
||
return ResponseEntity.badRequest().body(errors); | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
package com.baeldung.bindcustomvalidationmessage; | ||
|
||
import com.baeldung.bindcustomvalidationmessage.externalfilevalidation.UserDTO; | ||
import jakarta.validation.Valid; | ||
import org.springframework.http.ResponseEntity; | ||
import org.springframework.web.bind.annotation.PostMapping; | ||
import org.springframework.web.bind.annotation.RequestBody; | ||
import org.springframework.web.bind.annotation.RequestMapping; | ||
import org.springframework.web.bind.annotation.RestController; | ||
|
||
@RestController | ||
@RequestMapping("/users") | ||
public class UserController { | ||
@PostMapping | ||
public ResponseEntity<String> createUser(@Valid @RequestBody UserDTO user) { | ||
return ResponseEntity.ok("User created successfully"); | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
package com.baeldung.bindcustomvalidationmessage.customvalidator; | ||
|
||
import lombok.AllArgsConstructor; | ||
import lombok.Data; | ||
|
||
@Data | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We have a convention to avoid using Lombok except on articles that explicitly cover it - please remove the Lombok dependency for that reason and use plain Java for this |
||
@AllArgsConstructor | ||
public class PasswordDTO { | ||
@ValidPassword | ||
private String password; | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
package com.baeldung.bindcustomvalidationmessage.customvalidator; | ||
|
||
import jakarta.validation.ConstraintValidator; | ||
import jakarta.validation.ConstraintValidatorContext; | ||
|
||
public class PasswordValidator implements ConstraintValidator<ValidPassword, String> { | ||
@Override | ||
public boolean isValid(String password, ConstraintValidatorContext context) { | ||
return password != null && password.length() >= 8 && password.matches(".*\\d.*"); | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
package com.baeldung.bindcustomvalidationmessage.customvalidator; | ||
|
||
import jakarta.validation.Constraint; | ||
import jakarta.validation.Payload; | ||
|
||
import java.lang.annotation.*; | ||
|
||
@Documented | ||
@Constraint(validatedBy = PasswordValidator.class) | ||
@Target({ElementType.FIELD}) | ||
@Retention(RetentionPolicy.RUNTIME) | ||
public @interface ValidPassword { | ||
String message() default "{user.password.invalid}"; | ||
|
||
Class<?>[] groups() default {}; | ||
|
||
Class<? extends Payload>[] payload() default {}; | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
package com.baeldung.bindcustomvalidationmessage.externalfilevalidation; | ||
|
||
import jakarta.validation.constraints.Email; | ||
import jakarta.validation.constraints.NotNull; | ||
import jakarta.validation.constraints.Size; | ||
import lombok.Data; | ||
|
||
@Data | ||
public class UserDTO { | ||
@NotNull(message = "{user.name.notnull}") | ||
@Size(min = 2, message = "{user.name.size}") | ||
private String name; | ||
|
||
@NotNull(message = "{user.email.notnull}") | ||
@Email(message = "{user.email.invalid}") | ||
private String email; | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
package com.baeldung.bindcustomvalidationmessage.inlinevalidation; | ||
|
||
import jakarta.validation.constraints.Email; | ||
import jakarta.validation.constraints.NotNull; | ||
import jakarta.validation.constraints.Size; | ||
import lombok.Data; | ||
|
||
@Data | ||
public class UserDTO { | ||
@NotNull(message = "User name must not be null") | ||
@Size(min = 2, message = "User name must be at least 2 characters long") | ||
private String name; | ||
|
||
@NotNull(message = "Email is required") | ||
@Email(message = "Please provide a valid email") | ||
private String email; | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
user.name.notnull=User name must not be null | ||
user.name.size=User name must be at least 2 characters long | ||
user.email.notnull=Email is required | ||
user.email.invalid=Please provide a valid email | ||
user.password.invalid=Password must be at least 8 characters and contain a number | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
package com.baeldung.bindcustomvalidationmessage.customvalidation; | ||
|
||
import static org.assertj.core.api.Assertions.assertThat; | ||
|
||
import com.baeldung.bindcustomvalidationmessage.customvalidator.PasswordDTO; | ||
import jakarta.validation.ConstraintViolation; | ||
import jakarta.validation.Validation; | ||
import jakarta.validation.Validator; | ||
import jakarta.validation.ValidatorFactory; | ||
import java.util.Set; | ||
import org.junit.jupiter.api.BeforeEach; | ||
import org.junit.jupiter.api.Test; | ||
|
||
public class ValidPasswordValidatorTest { | ||
private Validator validator; | ||
|
||
@BeforeEach | ||
void setUp() { | ||
ValidatorFactory factory = Validation.buildDefaultValidatorFactory(); | ||
validator = factory.getValidator(); | ||
} | ||
|
||
@Test | ||
void whenPasswordIsValid_thenNoViolations() { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Across all the unit tests there is the same minor BDD naming convention issue. BDD syntax has 3 parts:
In this example, instead of |
||
PasswordDTO dto = new PasswordDTO("Str0ngP@ssword123"); | ||
|
||
Set<ConstraintViolation<PasswordDTO>> violations = validator.validate(dto); | ||
|
||
assertThat(violations).isEmpty(); | ||
} | ||
|
||
@Test | ||
void whenPasswordLacksDigitsOrSpecials_thenValidationFails() { | ||
PasswordDTO dto = new PasswordDTO("password"); | ||
|
||
Set<ConstraintViolation<PasswordDTO>> violations = validator.validate(dto); | ||
|
||
assertThat(violations).hasSize(1); | ||
} | ||
|
||
@Test | ||
void whenPasswordIsNull_thenValidationFails() { | ||
PasswordDTO dto = new PasswordDTO(null); | ||
|
||
Set<ConstraintViolation<PasswordDTO>> violations = validator.validate(dto); | ||
|
||
assertThat(violations).hasSize(1); | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
package com.baeldung.bindcustomvalidationmessage.externalfilevalidation; | ||
|
||
import static org.assertj.core.api.Assertions.assertThat; | ||
|
||
import jakarta.validation.ConstraintViolation; | ||
import jakarta.validation.Validation; | ||
import jakarta.validation.Validator; | ||
import jakarta.validation.ValidatorFactory; | ||
import java.util.Set; | ||
import org.junit.jupiter.api.BeforeEach; | ||
import org.junit.jupiter.api.Test; | ||
|
||
class UserDTOExtValidationTest { | ||
private Validator validator; | ||
|
||
@BeforeEach | ||
void setUp() { | ||
ValidatorFactory factory = Validation.buildDefaultValidatorFactory(); | ||
validator = factory.getValidator(); | ||
} | ||
|
||
@Test | ||
void whenAllFieldsValid_thenNoValidationErrors() { | ||
UserDTO user = new UserDTO(); | ||
user.setName("John"); | ||
user.setEmail("john@example.com"); | ||
|
||
Set<ConstraintViolation<UserDTO>> violations = validator.validate(user); | ||
assertThat(violations).isEmpty(); | ||
} | ||
|
||
@Test | ||
void whenNameIsNull_thenValidationFails() { | ||
UserDTO user = new UserDTO(); | ||
user.setName(null); | ||
user.setEmail("john@example.com"); | ||
|
||
Set<ConstraintViolation<UserDTO>> violations = validator.validate(user); | ||
assertThat(violations).hasSize(1); | ||
|
||
ConstraintViolation<UserDTO> violation = violations.iterator().next(); | ||
assertThat(violation.getPropertyPath().toString()).isEqualTo("name"); | ||
assertThat(violation.getMessage()).isEqualTo("User name must not be null"); | ||
} | ||
|
||
@Test | ||
void whenNameTooShort_thenValidationFails() { | ||
UserDTO user = new UserDTO(); | ||
user.setName("A"); | ||
user.setEmail("john@example.com"); | ||
|
||
Set<ConstraintViolation<UserDTO>> violations = validator.validate(user); | ||
assertThat(violations).hasSize(1); | ||
|
||
ConstraintViolation<UserDTO> violation = violations.iterator().next(); | ||
assertThat(violation.getPropertyPath().toString()).isEqualTo("name"); | ||
assertThat(violation.getMessage()).isEqualTo("User name must be at least 2 characters long"); | ||
} | ||
|
||
@Test | ||
void whenEmailIsInvalid_thenValidationFails() { | ||
UserDTO user = new UserDTO(); | ||
user.setName("John"); | ||
user.setEmail("invalid-email"); | ||
|
||
Set<ConstraintViolation<UserDTO>> violations = validator.validate(user); | ||
assertThat(violations).hasSize(1); | ||
|
||
ConstraintViolation<UserDTO> violation = violations.iterator().next(); | ||
assertThat(violation.getPropertyPath().toString()).isEqualTo("email"); | ||
assertThat(violation.getMessage()).isEqualTo("Please provide a valid email"); | ||
} | ||
|
||
@Test | ||
void whenEmailIsNull_thenValidationFails() { | ||
UserDTO user = new UserDTO(); | ||
user.setName("John"); | ||
user.setEmail(null); | ||
|
||
Set<ConstraintViolation<UserDTO>> violations = validator.validate(user); | ||
assertThat(violations).hasSize(1); | ||
|
||
ConstraintViolation<UserDTO> violation = violations.iterator().next(); | ||
assertThat(violation.getPropertyPath().toString()).isEqualTo("email"); | ||
assertThat(violation.getMessage()).isEqualTo("Email is required"); | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
package com.baeldung.bindcustomvalidationmessage.inlinevalidation; | ||
|
||
import static org.assertj.core.api.Assertions.assertThat; | ||
|
||
import jakarta.validation.ConstraintViolation; | ||
import jakarta.validation.Validation; | ||
import jakarta.validation.Validator; | ||
import jakarta.validation.ValidatorFactory; | ||
import java.util.Set; | ||
import org.junit.jupiter.api.BeforeEach; | ||
import org.junit.jupiter.api.Test; | ||
|
||
class UserDTOInlineValidationTest { | ||
private Validator validator; | ||
|
||
@BeforeEach | ||
void setUp() { | ||
ValidatorFactory factory = Validation.buildDefaultValidatorFactory(); | ||
validator = factory.getValidator(); | ||
} | ||
|
||
@Test | ||
void whenAllFieldsValid_thenNoValidationErrors() { | ||
UserDTO user = new UserDTO(); | ||
user.setName("John"); | ||
user.setEmail("john@example.com"); | ||
|
||
Set<ConstraintViolation<UserDTO>> violations = validator.validate(user); | ||
assertThat(violations).isEmpty(); | ||
} | ||
|
||
@Test | ||
void whenNameIsNull_thenValidationFails() { | ||
UserDTO user = new UserDTO(); | ||
user.setName(null); | ||
user.setEmail("john@example.com"); | ||
|
||
Set<ConstraintViolation<UserDTO>> violations = validator.validate(user); | ||
assertThat(violations).hasSize(1); | ||
|
||
ConstraintViolation<UserDTO> violation = violations.iterator().next(); | ||
assertThat(violation.getPropertyPath().toString()).isEqualTo("name"); | ||
assertThat(violation.getMessage()).isEqualTo("User name must not be null"); | ||
} | ||
|
||
@Test | ||
void whenNameTooShort_thenValidationFails() { | ||
UserDTO user = new UserDTO(); | ||
user.setName("A"); | ||
user.setEmail("john@example.com"); | ||
|
||
Set<ConstraintViolation<UserDTO>> violations = validator.validate(user); | ||
assertThat(violations).hasSize(1); | ||
|
||
ConstraintViolation<UserDTO> violation = violations.iterator().next(); | ||
assertThat(violation.getPropertyPath().toString()).isEqualTo("name"); | ||
assertThat(violation.getMessage()).isEqualTo("User name must be at least 2 characters long"); | ||
} | ||
|
||
@Test | ||
void whenEmailIsInvalid_thenValidationFails() { | ||
UserDTO user = new UserDTO(); | ||
user.setName("John"); | ||
user.setEmail("invalid-email"); | ||
|
||
Set<ConstraintViolation<UserDTO>> violations = validator.validate(user); | ||
assertThat(violations).hasSize(1); | ||
|
||
ConstraintViolation<UserDTO> violation = violations.iterator().next(); | ||
assertThat(violation.getPropertyPath().toString()).isEqualTo("email"); | ||
assertThat(violation.getMessage()).isEqualTo("Please provide a valid email"); | ||
} | ||
|
||
@Test | ||
void whenEmailIsNull_thenValidationFails() { | ||
UserDTO user = new UserDTO(); | ||
user.setName("John"); | ||
user.setEmail(null); | ||
|
||
Set<ConstraintViolation<UserDTO>> violations = validator.validate(user); | ||
assertThat(violations).hasSize(1); | ||
|
||
ConstraintViolation<UserDTO> violation = violations.iterator().next(); | ||
assertThat(violation.getPropertyPath().toString()).isEqualTo("email"); | ||
assertThat(violation.getMessage()).isEqualTo("Email is required"); | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have a convention to extract properties for version numbers. Also check if any of these versions are already specified in the parent pom (e.g. AssertJ might be, we use it in lots of articles)