Specify invocation order of filters in Spring Boot

This post will discuss how to specify the invocation order of filters in a Spring Boot application.

In the previous post, we have discussed how to create a filter in Spring Boot by implementing the Filter interface. This post will discuss how to specify the invocation order of filters in a Spring Boot application.

Let’s consider two filter class – FirstFilter and SecondFilter. Both classes implement the Filter interface and are defined as a bean with the @Component annotation. To specify the invocation order of filters, we need to use the @Order annotation. This is demonstrated below:

FirstFilter.java

import org.springframework.core.annotation.Order;

import org.springframework.stereotype.Component;

import javax.servlet.*;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import java.io.IOException;

@Component

@Order(0)

public class FirstFilter implements Filter {

@Override

public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)

throws IOException, ServletException

{

HttpServletRequest req = (HttpServletRequest) request;

HttpServletResponse res = (HttpServletResponse) response;

System.out.println("Request URI is: " + req.getRequestURI());

chain.doFilter(request, response);

System.out.println("Response Status Code is: " + res.getStatus());

}

SecondFilter.java

import org.springframework.core.annotation.Order;

import org.springframework.stereotype.Component;

import javax.servlet.*;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import java.io.IOException;

@Component

@Order(1)

public class SecondFilter implements Filter {

@Override

public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)

throws IOException, ServletException {

HttpServletRequest req = (HttpServletRequest) request;

HttpServletResponse res = (HttpServletResponse) response;

System.out.println("Request Query String is: " + req.getQueryString());

chain.doFilter(request, response);

System.out.println("Response Content Type is: " + res.getContentType());

}

Controller.java

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RestController;

@RestController

public class Controller {

@RequestMapping("/execute")

String execute() {

return "SUCCESS";

}

Now when any HTTP request is made, the filters are invoked in the desired order, as shown below:

Request URI is: /execute
Request Query String is: null
Response Content Type is: text/html;charset=UTF-8
Response Status Code is: 200

That’s all about specifying the invocation order of filters in Spring Boot.

Specify invocation order of filters in Spring Boot

Share this: