Il processo di registrazione con Spring Security

Questo articolo fa parte di una serie: • Esercitazione sulla registrazione di Spring Security

• Il processo di registrazione con Spring Security (articolo attuale) • Registrazione - Attiva un nuovo account tramite e-mail

• Registrazione Spring Security - Invia di nuovo l'e-mail di verifica

• Registrazione con Spring Security - Codifica password

• L'API di registrazione diventa RESTful

• Spring Security - Reimposta la tua password

• Registrazione - Forza della password e regole

• Aggiornamento della password

1. Panoramica

In questo articolo, implementeremo un processo di registrazione di base con Spring Security. Questo si basa sui concetti esplorati nell'articolo precedente, in cui abbiamo esaminato il login.

L'obiettivo qui è aggiungere un processo di registrazione completo che consenta a un utente di registrarsi, convalidare e mantenere i dati utente.

2. La pagina di registrazione

Innanzitutto, implementiamo una semplice pagina di registrazione che visualizzi i seguenti campi :

  • nome ( nome e cognome)
  • e-mail
  • password (e campo di conferma password)

L'esempio seguente mostra una semplice pagina registration.html :

Esempio 2.1.

form

first

Validation error

last

Validation error

email

Validation error

password

Validation error

confirm submit login

3. L'oggetto DTO utente

Abbiamo bisogno di un oggetto di trasferimento dati per inviare tutte le informazioni di registrazione al nostro back-end Spring. L' oggetto DTO dovrebbe avere tutte le informazioni di cui avremo bisogno in seguito quando creeremo e popoleremo il nostro oggetto Utente :

public class UserDto { @NotNull @NotEmpty private String firstName; @NotNull @NotEmpty private String lastName; @NotNull @NotEmpty private String password; private String matchingPassword; @NotNull @NotEmpty private String email; // standard getters and setters }

Si noti che abbiamo utilizzato annotazioni javax.validation standard sui campi dell'oggetto DTO. In seguito, implementeremo anche le nostre annotazioni di convalida personalizzate per convalidare il formato dell'indirizzo e-mail e per la conferma della password. (vedi Sezione 5)

4. Il titolare della registrazione

A Sign-up link sulla login pagina sarà portare l'utente alla registrazione pagina. Questo back-end per quella pagina risiede nel controller di registrazione ed è mappato a "/ user / registration" :

Esempio 4.1. - Il metodo showRegistration

@GetMapping("/user/registration") public String showRegistrationForm(WebRequest request, Model model) { UserDto userDto = new UserDto(); model.addAttribute("user", userDto); return "registration"; }

Quando il controller riceve la richiesta "/ user / registration" , crea il nuovo oggetto UserDto che supporterà il modulo di registrazione , lo vincolerà e restituirà - abbastanza semplice.

5. Convalida dei dati di registrazione

Avanti: diamo un'occhiata alle convalide che il controller eseguirà durante la registrazione di un nuovo account:

  1. Tutti i campi obbligatori sono riempiti (nessun campo vuoto o nullo)
  2. L'indirizzo e-mail è valido (ben formato)
  3. Il campo di conferma della password corrisponde al campo della password
  4. L'account non esiste già

5.1. La convalida incorporata

Per i controlli semplici, utilizzeremo le annotazioni di convalida out of the box bean sull'oggetto DTO - annotazioni come @NotNull , @NotEmpty , ecc.

Per attivare il processo di convalida, annoteremo semplicemente l'oggetto nel livello del controller con l' annotazione @Valid :

public ModelAndView registerUserAccount( @ModelAttribute("user") @Valid UserDto userDto, HttpServletRequest request, Errors errors) { ... }

5.2. Convalida personalizzata per verificare la validità dell'email

Quindi, convalidiamo l'indirizzo e-mail e assicuriamoci che sia ben formato. Costruiremo un validatore personalizzato per questo, così come un'annotazione di convalida personalizzata - chiamiamola @ValidEmail .

Una breve nota a margine qui: stiamo inserendo la nostra annotazione personalizzata invece di @Email di Hibernate perché Hibernate considera valido il vecchio formato degli indirizzi intranet: [email protected] (vedi l'articolo Stackoverflow), il che non va bene.

Ecco l'annotazione di convalida dell'email e il validatore personalizzato:

Esempio 5.2.1. - L'annotazione personalizzata per la convalida della posta elettronica

@Target({TYPE, FIELD, ANNOTATION_TYPE}) @Retention(RUNTIME) @Constraint(validatedBy = EmailValidator.class) @Documented public @interface ValidEmail { String message() default "Invalid email"; Class[] groups() default {}; Class[] payload() default {}; }

Nota che abbiamo definito l'annotazione a livello di CAMPO , poiché è lì che si applica concettualmente.

Esempio 5.2.2. - L' email personalizzata Validato r:

public class EmailValidator implements ConstraintValidator { private Pattern pattern; private Matcher matcher; private static final String EMAIL_PATTERN = "^[_A-Za-z0-9-+]+ (.[_A-Za-z0-9-]+)*@" + "[A-Za-z0-9-]+(.[A-Za-z0-9]+)* (.[A-Za-z]{2,})$"; @Override public void initialize(ValidEmail constraintAnnotation) { } @Override public boolean isValid(String email, ConstraintValidatorContext context){ return (validateEmail(email)); } private boolean validateEmail(String email) { pattern = Pattern.compile(EMAIL_PATTERN); matcher = pattern.matcher(email); return matcher.matches(); } }

Usiamo ora la nuova annotazione sulla nostra implementazione UserDto :

@ValidEmail @NotNull @NotEmpty private String email;

5.3. Utilizzo della convalida personalizzata per la conferma della password

Abbiamo anche bisogno di un'annotazione e di un validatore personalizzati per assicurarci che i campi password e matchingPassword corrispondano:

Esempio 5.3.1. - L'annotazione personalizzata per la convalida della conferma della password

@Target({TYPE,ANNOTATION_TYPE}) @Retention(RUNTIME) @Constraint(validatedBy = PasswordMatchesValidator.class) @Documented public @interface PasswordMatches { String message() default "Passwords don't match"; Class[] groups() default {}; Class[] payload() default {}; }

Notice that the @Target annotation indicates that this is a TYPE level annotation. This is because we need the entire UserDto object to perform the validation.

The custom validator that will be called by this annotation is shown below:

Example 5.3.2. The PasswordMatchesValidator Custom Validator

public class PasswordMatchesValidator implements ConstraintValidator { @Override public void initialize(PasswordMatches constraintAnnotation) { } @Override public boolean isValid(Object obj, ConstraintValidatorContext context){ UserDto user = (UserDto) obj; return user.getPassword().equals(user.getMatchingPassword()); } }

Now, the @PasswordMatches annotation should be applied to our UserDto object:

@PasswordMatches public class UserDto { ... }

All custom validations are of course evaluated along with all standard annotations when the entire validation process runs.

5.4. Check That the Account Doesn't Already Exist

The fourth check we'll implement is verifying that the email account doesn't already exist in the database.

This is performed after the form has been validated and it's done with the help of the UserService implementation.

Example 5.4.1. – The Controller's createUserAccount Method Calls the UserService Object

@PostMapping("/user/registration") public ModelAndView registerUserAccount (@ModelAttribute("user") @Valid UserDto userDto, HttpServletRequest request, Errors errors) { try { User registered = userService.registerNewUserAccount(userDto); } catch (UserAlreadyExistException uaeEx) { mav.addObject("message", "An account for that username/email already exists."); return mav; } // rest of the implementation } 

Example 5.4.2. – UserService Checks for Duplicate Emails

@Service public class UserService implements IUserService { @Autowired private UserRepository repository; @Transactional @Override public User registerNewUserAccount(UserDto userDto) throws UserAlreadyExistException { if (emailExist(userDto.getEmail())) { throw new UserAlreadyExistException( "There is an account with that email address: " + userDto.getEmail()); } ... // the rest of the registration operation } private boolean emailExist(String email) { return userRepository.findByEmail(email) != null; } }

The UserService relies on the UserRepository class to check if a user with a given email address already exists in the database.

Now – the actual implementation of the UserRepository in the persistence layer isn't relevant for the current article. One quick way is, of course, to use Spring Data to generate the repository layer.

6. Persisting Data and Finishing-Up Form Processing

Finally – let's implement the registration logic in our controller layer:

Example 6.1.1. – The RegisterAccount Method in the Controller

@PostMapping("/user/registration") public ModelAndView registerUserAccount( @ModelAttribute("user") @Valid UserDto userDto, HttpServletRequest request, Errors errors) { try { User registered = userService.registerNewUserAccount(userDto); } catch (UserAlreadyExistException uaeEx) { mav.addObject("message", "An account for that username/email already exists."); return mav; } return new ModelAndView("successRegister", "user", userDto); } 

Things to notice in the code above:

  1. The controller is returning a ModelAndView object which is the convenient class for sending model data (user) tied to the view.
  2. The controller will redirect to the registration form if there are any errors set at validation time.

7.The UserService – Register Operation

Let's finish the implementation of the registration operation in the UserService:

Example 7.1. The IUserService Interface

public interface IUserService { User registerNewUserAccount(UserDto userDto) throws UserAlreadyExistException; }

Example 7.2. – The UserService Class

@Service public class UserService implements IUserService { @Autowired private UserRepository repository; @Transactional @Override public User registerNewUserAccount(UserDto userDto) throws UserAlreadyExistException { if (emailExists(userDto.getEmail())) { throw new UserAlreadyExistException( "There is an account with that email address: + userDto.getEmail()); } User user = new User(); user.setFirstName(userDto.getFirstName()); user.setLastName(userDto.getLastName()); user.setPassword(userDto.getPassword()); user.setEmail(userDto.getEmail()); user.setRoles(Arrays.asList("ROLE_USER")); return repository.save(user); } private boolean emailExists(String email) { return userRepository.findByEmail(email) != null; } }

8. Loading User Details for Security Login

In our previous article, login was using hard coded credentials. Let's change that and use the newly registered user information and credentials. We'll implement a custom UserDetailsService to check the credentials for login from the persistence layer.

8.1. The Custom UserDetailsService

Let's start with the custom user details service implementation:

@Service @Transactional public class MyUserDetailsService implements UserDetailsService { @Autowired private UserRepository userRepository; // public UserDetails loadUserByUsername(String email) throws UsernameNotFoundException { User user = userRepository.findByEmail(email); if (user == null) { throw new UsernameNotFoundException( "No user found with username: "+ email); } boolean enabled = true; boolean accountNonExpired = true; boolean credentialsNonExpired = true; boolean accountNonLocked = true; return new org.springframework.security.core.userdetails.User (user.getEmail(), user.getPassword().toLowerCase(), enabled, accountNonExpired, credentialsNonExpired, accountNonLocked, getAuthorities(user.getRoles())); } private static List getAuthorities (List roles) { List authorities = new ArrayList(); for (String role : roles) { authorities.add(new SimpleGrantedAuthority(role)); } return authorities; } }

8.2. Enable the New Authentication Provider

To enable the new user service in the Spring Security configuration – we simply need to add a reference to the UserDetailsService inside the authentication-manager element and add the UserDetailsService bean:

Example 8.2.- The Authentication Manager and the UserDetailsService

Or, via Java configuration:

@Autowired private MyUserDetailsService userDetailsService; @Override protected void configure(AuthenticationManagerBuilder auth) throws Exception { auth.userDetailsService(userDetailsService); }

9. Conclusion

And we're done – a complete and almost production ready registration process implemented with Spring Security and Spring MVC. Next, we're going to discuss the process of activating the newly registered account by verifying the email of the new user.

The implementation of this Spring Security REST Tutorial can be found in the GitHub project – this is an Eclipse based project, so it should be easy to import and run as it is.

Next » Registration – Activate a New Account by Email « Previous Spring Security Registration Tutorial