Как да се справя с изключение при добавяне на дублирано потребителско име към база данни в spring mvc приложение

Вие обработвате само MySQLIntegrityConstraintViolationException, а не други изключения:NestedServletException и DuplicateKeyException и следователно получавате stacktrace и вашият try/catch не работи.

Между другото, защо просто не създадете допълнителен метод, за да проверите дали потребителското име вече присъства и ако да, тогава да покажете съобщение за грешка, в противен случай добавете потребител.

class UserRepositoryImpl implements UserRepository{
    //.....
    public int isUsernameExist(String username){
        String sql = "SELECT COUNT(*) FROM users WHERE username=?";
        return jdbcTemplate.queryForObject(sql, new Object[] { username }, String.class);
    }
    //....
}

@RequestMapping(value="/register", method=RequestMethod.POST)
public String processRegisterUser(@ModelAttribute("user") User user, BindingResult result){
    int status = userRepository.isUserExist(user.getUsername());
    if(status==1){
        //Username exist... redirect and display error msg.
    } else {
        userRepository.addUser(user);
    }
    //.....
}