Spring Boot Refresh Token with JWT example

In previous post, we’ve known how to build Token based Authentication & Authorization with Spring Security & JWT. This tutorial will continue to make JWT Refresh Token in the Java Spring Boot Application. You can know how to expire the JWT, then renew the Access Token with Refresh Token.

Related Posts:

Deployment: Deploy Spring Boot App on AWS – Elastic Beanstalk

The code in this post bases on previous article that you need to read first:
Spring Boot Token based Authentication with Spring Security & JWT

Overview of Spring Boot Refresh Token with JWT example

We already have a Spring Boot application in that:

  • User can signup new account, or login with username & password.
  • By User’s role (admin, moderator, user), we authorize the User to access resources

With APIs:

POST/api/auth/signupsignup new account
POST/api/auth/signinlogin an account
GET/api/test/allretrieve public content
GET/api/test/useraccess User’s content
GET/api/test/modaccess Moderator’s content
GET/api/test/adminaccess Admin’s content

For more details, please visit this post.

We’re gonna add Token Refresh to this Spring Boot – Spring Security Project.
The final result can be described with following requests/responses:

– Send /signin request, return response with refreshToken.


– Access resource successfully with accessToken.


– When the accessToken is expired, user cannot use it anymore.


– Send /refreshtoken request, return response with new accessToken.


– Access resource successfully with new accessToken.


– Send an expired Refresh Token.


– Send an inexistent Refresh Token.


Flow for Spring Boot Refresh Token with JWT

The diagram shows flow of how we implement Authentication process with Access Token and Refresh Token.


– A legal JWT must be added to HTTP Authorization Header if Client accesses protected resources.
– A refreshToken will be provided at the time user signs in.

How to Expire JWT Token in Spring Boot

The Refresh Token has different value and expiration time to the Access Token.
Regularly we configure the expiration time of Refresh Token larger than Access Token’s.

Open application.properties for configuring App properties:

# Spring Datasource, Spring Data...

# App Properties
bezkoder.app.jwtSecret= bezKoderSecretKey
bezkoder.app.jwtExpirationMs= 3600000
bezkoder.app.jwtRefreshExpirationMs= 86400000

## For test
#bezkoder.app.jwtExpirationMs= 60000
#bezkoder.app.jwtRefreshExpirationMs= 120000

Update JwtUtils class. Now it has 3 main funtions:

  • generate a JWT from username
  • get username from JWT
  • validate a JWT: JWT Access Token is expired with ExpiredJwtException


package com.bezkoder.spring.security.jwt.security.jwt;

import java.util.Date;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

import com.bezkoder.spring.security.jwt.security.services.UserDetailsImpl;

import io.jsonwebtoken.*;

public class JwtUtils {
  private static final Logger logger = LoggerFactory.getLogger(JwtUtils.class);

  private String jwtSecret;

  private int jwtExpirationMs;

  public String generateJwtToken(UserDetailsImpl userPrincipal) {
    return generateTokenFromUsername(userPrincipal.getUsername());

  public String generateTokenFromUsername(String username) {
    return Jwts.builder().setSubject(username).setIssuedAt(new Date())
        .setExpiration(new Date((new Date()).getTime() + jwtExpirationMs)).signWith(SignatureAlgorithm.HS512, jwtSecret)

  public String getUserNameFromJwtToken(String token) {
    return Jwts.parser().setSigningKey(jwtSecret).parseClaimsJws(token).getBody().getSubject();

  public boolean validateJwtToken(String authToken) {
    try {
      return true;
    } catch (SignatureException e) {
      logger.error("Invalid JWT signature: {}", e.getMessage());
    } catch (MalformedJwtException e) {
      logger.error("Invalid JWT token: {}", e.getMessage());
    } catch (ExpiredJwtException e) {
      logger.error("JWT token is expired: {}", e.getMessage());
    } catch (UnsupportedJwtException e) {
      logger.error("JWT token is unsupported: {}", e.getMessage());
    } catch (IllegalArgumentException e) {
      logger.error("JWT claims string is empty: {}", e.getMessage());

    return false;


Refresh Token Request and Response

Update the payloads for our RestAPIs:
– Requests:

  • TokenRefreshRequest: { refreshToken }

– Responses:

  • JwtResponse: { token, type, refreshToken, id, username, email, roles }
  • MessageResponse: { message }


package com.bezkoder.spring.security.jwt.payload.request;

import javax.validation.constraints.NotBlank;

public class TokenRefreshRequest {
  private String refreshToken;

  public String getRefreshToken() {
    return refreshToken;

  public void setRefreshToken(String refreshToken) {
    this.refreshToken = refreshToken;


package com.bezkoder.spring.security.jwt.payload.response;

import java.util.List;

public class JwtResponse {
	private String token;
	private String type = "Bearer";
	private String refreshToken;
	private Long id;
	private String username;
	private String email;
	private List<String> roles;

	public JwtResponse(String accessToken, String refreshToken, Long id, String username, String email, List<String> roles) {
		this.token = accessToken;
		this.refreshToken = refreshToken;
		this.id = id;
		this.username = username;
		this.email = email;
		this.roles = roles;

	// getters and setters


package com.bezkoder.spring.security.jwt.payload.response;

public class TokenRefreshResponse {
  private String token;
  private String refreshToken;
  private String tokenType = "Bearer";

  public TokenRefreshResponse(String token, String refreshToken) {
    this.token = token;
    this.refreshToken = refreshToken;

  // getters and setters

Renew JWT Token in Spring Boot

In the AuthController class, we:

  • update the method for /signin endpoint with Refresh Token
  • expose the POST API for creating new Access Token from received Refresh Token


public class AuthController {
  AuthenticationManager authenticationManager;

  JwtUtils jwtUtils;

  RefreshTokenService refreshTokenService;

  public ResponseEntity<?> authenticateUser(@Valid @RequestBody LoginRequest loginRequest) {

    Authentication authentication = authenticationManager
        .authenticate(new UsernamePasswordAuthenticationToken(loginRequest.getUsername(), loginRequest.getPassword()));


    UserDetailsImpl userDetails = (UserDetailsImpl) authentication.getPrincipal();

    String jwt = jwtUtils.generateJwtToken(userDetails);

    List<String> roles = userDetails.getAuthorities().stream().map(item -> item.getAuthority())

    RefreshToken refreshToken = refreshTokenService.createRefreshToken(userDetails.getId());

    return ResponseEntity.ok(new JwtResponse(jwt, refreshToken.getToken(), userDetails.getId(),
        userDetails.getUsername(), userDetails.getEmail(), roles));

  public ResponseEntity<?> refreshtoken(@Valid @RequestBody TokenRefreshRequest request) {
    String requestRefreshToken = request.getRefreshToken();

    return refreshTokenService.findByToken(requestRefreshToken)
        .map(user -> {
          String token = jwtUtils.generateTokenFromUsername(user.getUsername());
          return ResponseEntity.ok(new TokenRefreshResponse(token, requestRefreshToken));
        .orElseThrow(() -> new TokenRefreshException(requestRefreshToken,
            "Refresh token is not in database!"));

In refreshtoken() method:

  • Firstly, we get the Refresh Token from request data
  • Next, get the RefreshToken object {id, user, token, expiryDate} from raw Token using RefreshTokenService
  • We verify the token (expired or not) basing on expiryDate field
  • Continue to use user field of RefreshToken object as parameter to generate new Access Token using JwtUtils
  • Return TokenRefreshResponse if everything is done
  • Or else, throw TokenRefreshException

Create Refresh Token Service

Refresh Token class

This class has one-to-one relationship with User class.


package com.bezkoder.spring.security.jwt.models;

import java.time.Instant;

import javax.persistence.*;

@Entity(name = "refreshtoken")
public class RefreshToken {
  @GeneratedValue(strategy = GenerationType.AUTO)
  private long id;

  @JoinColumn(name = "user_id", referencedColumnName = "id")
  private User user;

  @Column(nullable = false, unique = true)
  private String token;

  @Column(nullable = false)
  private Instant expiryDate;

  //getters and setters


Refresh Token Repository

Before creating the service, we need RefreshTokenRepository with finder methods:


package com.accolite.pru.health.AuthApp.repository;

import com.accolite.pru.health.AuthApp.model.token.RefreshToken;
import org.springframework.data.jpa.repository.JpaRepository;

import java.util.Optional;

public interface RefreshTokenRepository extends JpaRepository<RefreshToken, Long> {

    Optional<RefreshToken> findById(Long id);

    Optional<RefreshToken> findByToken(String token);


Refresh Token Service

After that, we have the RefreshTokenService service which uses RefreshTokenRepository above for providing several useful methods:

  • findByToken(): Find a RefreshToken based on the natural id i.e the token itself
  • createRefreshToken(): Create and return a new Refresh Token
  • verifyExpiration(): Verify whether the token provided has expired or not. If the token was expired, delete it from database and throw TokenRefreshException


package com.bezkoder.spring.security.jwt.security.services;

import java.time.Instant;
import java.util.Optional;
import java.util.UUID;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

import com.bezkoder.spring.security.jwt.exception.TokenRefreshException;
import com.bezkoder.spring.security.jwt.models.RefreshToken;
import com.bezkoder.spring.security.jwt.repository.RefreshTokenRepository;
import com.bezkoder.spring.security.jwt.repository.UserRepository;

public class RefreshTokenService {
  private Long refreshTokenDurationMs;

  private RefreshTokenRepository refreshTokenRepository;

  private UserRepository userRepository;

  public Optional<RefreshToken> findByToken(String token) {
    return refreshTokenRepository.findByToken(token);

  public RefreshToken createRefreshToken(Long userId) {
    RefreshToken refreshToken = new RefreshToken();


    refreshToken = refreshTokenRepository.save(refreshToken);
    return refreshToken;

  public RefreshToken verifyExpiration(RefreshToken token) {
    if (token.getExpiryDate().compareTo(Instant.now()) < 0) {
      throw new TokenRefreshException(token.getToken(), "Refresh token was expired. Please make a new signin request");

    return token;

  public int deleteByUserId(Long userId) {
    return refreshTokenRepository.deleteByUser(userRepository.findById(userId).get());

Handle Token Refresh Exception

Now we need to create TokenRefreshException class that extends RuntimeException.


package com.bezkoder.spring.security.jwt.exception;

import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ResponseStatus;

public class TokenRefreshException extends RuntimeException {

  private static final long serialVersionUID = 1L;

  public TokenRefreshException(String token, String message) {
    super(String.format("Failed for [%s]: %s", token, message));

Let’s do the final step. We’re gonna create a RestControllerAdvice.


package com.bezkoder.spring.security.jwt.advice;

import java.util.Date;

import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.context.request.WebRequest;

import com.bezkoder.spring.security.jwt.exception.TokenRefreshException;

public class TokenControllerAdvice {

  @ExceptionHandler(value = TokenRefreshException.class)
  public ErrorMessage handleTokenRefreshException(TokenRefreshException ex, WebRequest request) {
    return new ErrorMessage(
        new Date(),

For more details about RestControllerAdvice, please visit:
@RestControllerAdvice example in Spring Boot



Today we’ve learned a more interesting thing about JWT Refresh Token in a Spring Boot example.
Despite we wrote a lot of code, I hope you will understand the overall idea of the application, and apply it in your project at ease.

The code in this post bases on previous article that you need to read first:
Spring Boot Token based Authentication with Spring Security & JWT

For understanding the architecture deeply and grasp the overview more easier:
Spring Boot Architecture for JWT with Spring Security

You can also know how to deploy Spring Boot App on AWS (for free) with this tutorial.

Happy learning! See you again.

Further Reading

More Practices:

Fullstack CRUD App:
Spring Boot + Vue.js example
Angular 8 + Spring Boot example
Angular 10 + Spring Boot example
Angular 11 + Spring Boot example
React + Spring Boot example

Source Code

You can find the complete source code for this tutorial on Github.

5 thoughts to “Spring Boot Refresh Token with JWT example”

  1. Thank you!
    This post is great, I’ve learned a lot from your posts, but can you write a post to share how vue handles jwt refresh?

  2. If I refresh the Token many times, I will get multiple Tokens, and these Tokens are different but it can be all authentic. Does this need to delete the old Token or not? If needed, how can I delete it?

    1. Hi, I don’t think that Client implements the refresh Token that way :). Client should refresh it only when the access Token is expired.

Leave a Reply

Your email address will not be published. Required fields are marked *