Hướng dẫn sử dụng Interceptor trong Spring Boot

Trong bài viết này, chúng ta sẽ tìm hiểu cách sử dụng Interceptor trong Spring Boot và thực hiện các ví dụ thực tế để hiểu rõ hơn về cách thức hoạt động của nó.

Trong quá trình phát triển ứng dụng web, bảo mật và kiểm soát truy cập là những vấn đề quan trọng được đặt lên hàng đầu. Để giải quyết vấn đề này, Spring Boot cung cấp tính năng Interceptor, giúp cho việc kiểm soát truy cập và bảo mật trở nên dễ dàng hơn.

1. Giới thiệu

Spring Boot Interceptor

Spring Boot Interceptor là gì?

Giới thiệu về Spring Boot Interceptor:

Spring Boot Interceptor là một thành phần trong Spring Boot, giúp cho chúng ta có thể can thiệp vào quá trình xử lý các yêu cầu và trả về các kết quả từ phía người dùng. Nó cung cấp cho chúng ta khả năng kiểm soát truy cập, quản lý phiên, kiểm tra lỗi và ghi nhật ký.

Bài viết này được đăng tại [free tuts .net]

Spring Boot Interceptor là một phần của Spring MVC, được sử dụng để xử lý các yêu cầu HTTP trước khi chúng được xử lý bởi các controller. Interceptor được gọi trước khi phương thức của controller được gọi và có thể được sử dụng để kiểm soát truy cập vào các tài nguyên, quản lý phiên và ghi nhật ký.

Cách Spring Boot Interceptor hoạt động trong ứng dụng Spring Boot:

Spring Boot Interceptor hoạt động bằng cách can thiệp vào quá trình xử lý các yêu cầu và trả về các kết quả của ứng dụng Spring Boot. Cụ thể, khi một yêu cầu được gửi đến ứng dụng, nó sẽ trải qua một số bước xử lý trước khi được gửi đến các controller xử lý.

Trong quá trình này, Spring Boot Interceptor sẽ được gọi để kiểm tra các yêu cầu đó và có thể thực hiện các tác vụ như kiểm soát truy cập, quản lý phiên và ghi nhật ký. Interceptor sẽ được gọi trước khi phương thức của controller được gọi và có thể được sử dụng để kiểm soát truy cập vào các tài nguyên.

Để sử dụng Spring Boot Interceptor trong ứng dụng Spring Boot, chúng ta cần thực hiện các bước sau:

Bước 1: Tạo một lớp interceptor bằng cách triển khai interface HandlerInterceptor của Spring MVC. Lớp này sẽ chứa các phương thức để kiểm soát truy cập, quản lý phiên và ghi nhật ký.

Bước 2: Cấu hình interceptor trong ứng dụng bằng cách đăng ký nó với đối tượng InterceptorRegistry của Spring MVC. Điều này có thể được thực hiện bằng cách định cấu hình InterceptorRegistry trong phương thức addInterceptors của lớp WebMvcConfigurer.

Bước 3: Sử dụng interceptor trong ứng dụng bằng cách đăng ký các interceptor với các route tương ứng trong phương thức addInterceptors của lớp WebMvcConfigurer.

Sau khi các bước trên được thực hiện, interceptor sẽ được sử dụng để kiểm soát truy cập và bảo mật trong ứng dụng Spring Boot của chúng ta.

Lưu ý: Điều quan trọng cần lưu ý là Spring Boot Interceptor chỉ là một phần của Spring MVC và sẽ chỉ hoạt động đúng nếu chúng ta sử dụng nó trong cấu hình MVC của ứng dụng Spring Boot. Ngoài ra, chúng ta cũng cần biết cách sử dụng interceptor một cách hiệu quả để đảm bảo tính bảo mật và kiểm soát truy cập của ứng dụng.

Tại sao sử dụng Spring Boot Interceptor trong Spring Boot?

Các tính năng của Interceptor

Spring Boot Interceptor là một tính năng quan trọng của Spring Boot, nó cung cấp cho chúng ta khả năng can thiệp vào các yêu cầu được gửi đến ứng dụng của chúng ta và thực hiện các tác vụ như kiểm soát truy cập, quản lý phiên và ghi nhật ký. Dưới đây là một số tính năng chính của Spring Boot Interceptor:

1. Kiểm soát truy cập: Interceptor được sử dụng để kiểm soát truy cập vào các tài nguyên của ứng dụng. Nó kiểm tra xem người dùng đã được xác thực hay chưa và có quyền truy cập vào các tài nguyên đó hay không.

2. Quản lý phiên: Interceptor có thể được sử dụng để quản lý phiên của người dùng. Nó có thể tạo ra phiên mới khi người dùng đăng nhập và hủy phiên khi người dùng đăng xuất hoặc phiên hết hạn.

3. Ghi nhật ký: Interceptor có thể được sử dụng để ghi lại các hoạt động của người dùng. Chúng ta có thể sử dụng Interceptor để ghi lại các yêu cầu của người dùng và các hoạt động liên quan đến đăng nhập, đăng xuất và thay đổi mật khẩu.

4. Xử lý ngoại lệ: Interceptor cũng có thể được sử dụng để xử lý các ngoại lệ xảy ra trong quá trình xử lý yêu cầu của người dùng. Chúng ta có thể sử dụng Interceptor để bắt và xử lý các ngoại lệ, chẳng hạn như khi người dùng nhập sai thông tin đăng nhập hoặc yêu cầu không hợp lệ.

5. Tích hợp với các thư viện bên thứ ba: Interceptor cũng có thể tích hợp với các thư viện bên thứ ba để cung cấp các tính năng bảo mật và kiểm soát truy cập cao hơn. Ví dụ, chúng ta có thể sử dụng Interceptor để tích hợp với Spring Security và thực hiện các tác vụ như xác thực và phân quyền.

Lợi ích của Interceptor.

Spring Boot Interceptor là một tính năng quan trọng của Spring Boot, có nhiều lợi ích khi sử dụng trong ứng dụng của chúng ta. Dưới đây là một số lợi ích của Spring Boot Interceptor:

1. Kiểm soát truy cập: Interceptor cho phép chúng ta kiểm soát truy cập vào các tài nguyên của ứng dụng, đảm bảo rằng chỉ những người dùng được xác thực và có quyền truy cập mới có thể truy cập vào các tài nguyên đó.

2. Quản lý phiên: Interceptor có thể được sử dụng để quản lý phiên của người dùng, đảm bảo rằng người dùng không thể truy cập vào các tài nguyên sau khi phiên của họ đã kết thúc.

3. Ghi nhật ký: Interceptor có thể được sử dụng để ghi lại các hoạt động của người dùng, giúp chúng ta theo dõi các hoạt động của người dùng và xác định các vấn đề có thể xảy ra trong ứng dụng.

4. Tích hợp với các thư viện bảo mật: Interceptor có thể được tích hợp với các thư viện bảo mật như Spring Security, giúp chúng ta thực hiện các tác vụ như xác thực và phân quyền.

5. Xử lý ngoại lệ: Interceptor có thể được sử dụng để xử lý các ngoại lệ xảy ra trong quá trình xử lý yêu cầu của người dùng, giúp chúng ta giải quyết các vấn đề có thể xảy ra trong ứng dụng.

6. Tăng tính bảo mật: Sử dụng Interceptor có thể giúp chúng ta tăng tính bảo mật của ứng dụng bằng cách giảm thiểu các lỗ hổng bảo mật và các hành vi xâm nhập của người dùng.

2. Xây dựng Interceptor

Hướng dẫn cách xây dựng một Interceptor đơn giản.

Trước khi chúng ta bắt đầu sử dụng Interceptor, chúng ta cần phải hiểu cách xây dựng một Interceptor đơn giản.

Ví dụ về cách xây dựng một Interceptor đơn giản:

Bước 1: Đầu tiên, chúng ta sẽ tạo một lớp mới và kế thừa từ interface HandlerInterceptorAdapter của Spring Boot.

public class CustomInterceptor extends HandlerInterceptorAdapter {
    
}

Bước 2: Sau đó, chúng ta sẽ ghi đè phương thức preHandle và thực hiện các xử lý trước khi Controller xử lý yêu cầu.

@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    System.out.println("CustomInterceptor - preHandle");
    return true;
}

Trong ví dụ này, chúng ta chỉ đơn giản là in ra thông báo "CustomInterceptor - preHandle" trên console. Tuy nhiên, bạn có thể thực hiện các xử lý kiểm tra quyền truy cập, xác thực người dùng, ...

Bước 3: Tiếp theo, chúng ta sẽ ghi đè phương thức postHandle và thực hiện các xử lý sau khi Controller xử lý yêu cầu.

@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    System.out.println("CustomInterceptor - postHandle");
}

Trong ví dụ này, chúng ta chỉ đơn giản là in ra thông báo "CustomInterceptor - postHandle" trên console.

Các phương thức của Interceptor và cách chúng hoạt động.

Interceptor là một interface được Spring Boot cung cấp, có thể kế thừa từ Interceptor và cung cấp cho chúng ta các phương thức để kiểm soát truy cập và xử lý các yêu cầu từ phía người dùng.

Interceptor bao gồm hai phương thức chính là preHandle và postHandle.

Phương thức preHandle:

• Phương thức này được gọi trước khi một yêu cầu từ người dùng được xử lý bởi Controller.
• Đây là nơi bạn có thể kiểm tra và thực hiện các xử lý trước khi Controller xử lý yêu cầu.
• Nếu phương thức này trả về true, Controller sẽ tiếp tục xử lý yêu cầu.
• Nếu phương thức này trả về false, Controller sẽ không được gọi và người dùng sẽ nhận được một phản hồi lỗi.

Phương thức postHandle:

• Phương thức này được gọi sau khi Controller đã xử lý yêu cầu từ người dùng.
• Đây là nơi bạn có thể thực hiện các xử lý sau khi Controller đã xử lý yêu cầu.
• Phương thức này có thể sử dụng để thay đổi Model hoặc thêm các thuộc tính cho Model, chẳng hạn như để gửi các thông báo thành công hoặc thất bại cho người dùng.

3. Áp dụng Interceptor vào ứng dụng Spring Boot

Cách áp dụng Interceptor vào ứng dụng Spring Boot.

Sau khi xây dựng Interceptor, chúng ta cần áp dụng nó vào ứng dụng Spring Boot. Có hai cách để áp dụng Interceptor vào ứng dụng Spring Boot, đó là sử dụng annotation @Component hoặc @Configuration để tạo bean. Chúng ta sẽ tìm hiểu cách sử dụng cả hai cách này để áp dụng Interceptor vào ứng dụng.

Sử dụng annotation @Component Trong cách này, chúng ta sẽ đánh dấu lớp Interceptor là một bean bằng cách sử dụng annotation @Component. Spring Boot sẽ tự động quét các bean được đánh dấu bằng annotation này và áp dụng chúng vào ứng dụng.

Đầu tiên, chúng ta cần đánh dấu lớp Interceptor với annotation @Component để tạo ra một bean:

@Component
public class SimpleInterceptor implements HandlerInterceptor {
   // ...code...
}

Sau đó, chúng ta cần cấu hình Interceptor trong class WebMvcConfigurer của Spring Boot. Trong phương thức addInterceptors(), chúng ta sẽ đăng ký Interceptor:

@Configuration
public class AppConfig implements WebMvcConfigurer {

    @Autowired
    private SimpleInterceptor simpleInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(simpleInterceptor);
    }
}

Sử dụng annotation @Configuration Trong cách này, chúng ta sẽ tạo ra một class mới và đánh dấu nó là một bean với annotation @Configuration. Sau đó, chúng ta sẽ cấu hình Interceptor trong phương thức addInterceptors() của class WebMvcConfigurer.

Đầu tiên, chúng ta cần tạo ra một class mới và đánh dấu nó là một bean với annotation @Configuration:

@Configuration
public class InterceptorConfig {

    @Bean
    public SimpleInterceptor simpleInterceptor() {
        return new SimpleInterceptor();
    }
}

Sau đó, chúng ta sẽ cấu hình Interceptor trong phương thức addInterceptors() của class WebMvcConfigurer:

@Configuration
public class AppConfig implements WebMvcConfigurer {

    @Autowired
    private SimpleInterceptor simpleInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(simpleInterceptor);
    }
}

Lưu ý rằng, khi sử dụng cách này, chúng ta cần đánh dấu lớp Interceptor là một bean với annotation @Bean để Spring Boot có thể quản lý và áp dụng nó vào ứng dụng.

Cách sử dụng Interceptor để kiểm soát truy cập, bảo mật, quản lý phiên, kiểm tra lỗi và ghi nhật ký.

Interceptor có thể được sử dụng để kiểm soát truy cập, bảo mật, quản lý phiên, kiểm tra lỗi và ghi nhật ký trong ứng dụng Spring Boot. Sau đây là các cách sử dụng Interceptor để thực hiện các chức năng này:

Kiểm soát truy cập: Interceptor có thể được sử dụng để kiểm soát truy cập vào các tài nguyên của ứng dụng Spring Boot. Chẳng hạn, nếu chúng ta muốn ngăn người dùng truy cập vào các trang không được phép, chúng ta có thể sử dụng Interceptor để kiểm tra xem người dùng có quyền truy cập vào tài nguyên đó hay không.

Bảo mật: Interceptor có thể được sử dụng để thực hiện các chức năng bảo mật trong ứng dụng Spring Boot, chẳng hạn như xác thực và phân quyền. Chúng ta có thể sử dụng Interceptor để kiểm tra thông tin đăng nhập của người dùng và kiểm tra xem họ có quyền truy cập vào các tài nguyên được yêu cầu hay không.

Quản lý phiên: Interceptor có thể được sử dụng để quản lý phiên trong ứng dụng Spring Boot. Chúng ta có thể sử dụng Interceptor để kiểm tra xem người dùng đã đăng nhập hay chưa và giữ phiên đăng nhập của họ trong suốt quá trình sử dụng ứng dụng.

Kiểm tra lỗi: Interceptor có thể được sử dụng để kiểm tra lỗi trong ứng dụng Spring Boot. Chúng ta có thể sử dụng Interceptor để kiểm tra xem có lỗi nào xảy ra trong quá trình xử lý yêu cầu và xử lý lỗi đó.

Ghi nhật ký: Interceptor có thể được sử dụng để ghi nhật ký trong ứng dụng Spring Boot. Chúng ta có thể sử dụng Interceptor để ghi lại các thông tin quan trọng, chẳng hạn như thời gian xử lý yêu cầu và các tham số yêu cầu.

4. Ví dụ sử dụng Interceptor trong ứng dụng Spring Boot

Ví dụ sử dụng Interceptor để kiểm soát truy cập và bảo mật.

Giả sử chúng ta có một ứng dụng web Spring Boot với nhiều URL khác nhau và muốn kiểm soát truy cập và bảo mật cho một số URL. Ta sẽ sử dụng Interceptor để làm điều này.

Trước tiên, ta sẽ xây dựng một Interceptor đơn giản để kiểm soát truy cập và bảo mật:

@Component
public class AuthInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        String requestURI = request.getRequestURI();
        if (requestURI.startsWith("/admin")) {
            HttpSession session = request.getSession();
            if (session == null || session.getAttribute("user") == null) {
                response.sendRedirect("/login");
                return false;
            }
        }
        return true;
    }
}

Trong ví dụ trên, AuthInterceptor kiểm tra xem URL của yêu cầu có bắt đầu bằng "/admin" hay không. Nếu có, nó sẽ kiểm tra xem người dùng đã đăng nhập hay chưa bằng cách kiểm tra xem có phiên đăng nhập được tạo ra hay không. Nếu không, nó sẽ chuyển hướng người dùng đến trang đăng nhập.

Tiếp theo, chúng ta sẽ áp dụng Interceptor này vào ứng dụng bằng cách sử dụng annotation @Configuration để tạo bean:

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Autowired
    private AuthInterceptor authInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(authInterceptor).addPathPatterns("/admin/**");
    }
}

Trong ví dụ trên, WebMvcConfig được sử dụng để cấu hình các Interceptor. Chúng ta tạo một bean AuthInterceptor và áp dụng nó vào URL bắt đầu bằng "/admin". Bây giờ, khi một yêu cầu được gửi đến một URL bắt đầu bằng "/admin", AuthInterceptor sẽ được gọi để kiểm tra xem người dùng đã đăng nhập hay chưa.

Ví dụ sử dụng Interceptor để quản lý phiên.

Chúng ta có thể sử dụng Interceptor để quản lý phiên bằng cách lưu trữ thông tin phiên vào đối tượng HttpSession. Dưới đây là một ví dụ đơn giản về cách sử dụng Interceptor để kiểm tra xem phiên đăng nhập của người dùng có hết hạn hay không:

@Component
public class SessionInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        HttpSession session = request.getSession();
        if (session == null || session.getAttribute("user") == null) {
            response.sendRedirect("/login");
            return false;
        }

Trong lớp SessionInterceptor này, chúng ta sử dụng phương thức preHandle () để kiểm tra xem phiên của người dùng đã được tạo hay chưa. Nếu phiên không tồn tại hoặc người dùng chưa đăng nhập, chúng ta sẽ chuyển hướng người dùng đến trang đăng nhập. Nếu phiên tồn tại và người dùng đã đăng nhập, chúng ta cho phép yêu cầu tiếp tục được xử lý.

Sau đó, chúng ta cần đăng ký Interceptor trong lớp WebMvcConfigurer để sử dụng trong ứng dụng Spring Boot:

@Configuration
public class AppConfig implements WebMvcConfigurer {
 
    @Autowired
    private SessionInterceptor sessionInterceptor;
 
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(sessionInterceptor).addPathPatterns("/**").excludePathPatterns("/login", "/logout");
    }
 
}

Ở đây, chúng ta sử dụng phương thức addInterceptors () để đăng ký Interceptor và áp dụng nó cho tất cả các yêu cầu (/**). Tuy nhiên, chúng ta đã loại bỏ hai đường dẫn "/login" và "/logout" để đảm bảo rằng người dùng có thể truy cập vào trang đăng nhập và đăng xuất mà không cần phải đăng nhập.

Ví dụ sử dụng Interceptor để kiểm tra lỗi và ghi nhật ký.

Trong ví dụ này, chúng ta sẽ sử dụng Interceptor để kiểm tra lỗi và ghi nhật ký các yêu cầu tới ứng dụng Spring Boot. Đầu tiên, chúng ta cần tạo một lớp ErrorLoggingInterceptor, kế thừa từ HandlerInterceptorAdapter.

@Component
public class ErrorLoggingInterceptor extends HandlerInterceptorAdapter {

    private static final Logger logger = LoggerFactory.getLogger(ErrorLoggingInterceptor.class);

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        if (ex != null) {
            logger.error("Exception occurred in request: {} with handler {}.", request.getRequestURL(), handler);
        }
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        if (response.getStatus() == HttpServletResponse.SC_INTERNAL_SERVER_ERROR) {
            logger.error("Internal server error occurred in request: {} with handler {}.", request.getRequestURL(), handler);
        }
    }

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        logger.info("Received request: {} with handler {}.", request.getRequestURL(), handler);

        Map<String, String> pathVariables = (Map<String, String>) request.getAttribute(HandlerMapping.URI_TEMPLATE_VARIABLES_ATTRIBUTE);
        if (pathVariables != null && !pathVariables.isEmpty()) {
            logger.info("Path variables: {}.", pathVariables);
        }

        return true;
    }
}

Sau khi tạo lớp ErrorLoggingInterceptor, chúng ta cần đăng ký Interceptor này trong ứng dụng Spring Boot bằng cách sử dụng phương thức addInterceptors() của lớp WebMvcConfigurer.

@Configuration
public class AppConfig implements WebMvcConfigurer {

    @Autowired
    LoggingInterceptor loggingInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(loggingInterceptor);
    }
}

Ở ví dụ trên, chúng ta đã tạo một lớp AppConfig, đánh dấu là @Configuration để đánh dấu đây là một lớp cấu hình của ứng dụng Spring Boot. Chúng ta cũng đã sử dụng phương thức addInterceptors() để đăng ký Interceptor LoggingInterceptor vào ứng dụng Spring Boot.

Sau khi đã đăng ký Interceptor, chúng ta có thể kiểm tra việc hoạt động của Interceptor bằng cách truy cập vào các URL trong ứng dụng. Nếu Interceptor được áp dụng thành công, các thông tin về yêu cầu và phản hồi của mỗi truy cập sẽ được ghi nhật ký vào tệp tin log.

Sau khi hoàn thành các phần trên bạn có thể chạy chương trình và kiểm tra kết quả nhé!!!!

5. Các câu hỏi thường gặp

Interceptor khác gì với Filter trong Spring Boot?

Interceptor và Filter là hai tính năng khác nhau trong Spring Boot. Filter hoạt động trên mức Servlet của ứng dụng web, trong khi Interceptor hoạt động trên mức Spring MVC. Filter có thể được sử dụng để thực hiện các chức năng tương tự như Interceptor, nhưng Interceptor cung cấp cho chúng ta nhiều tính năng hơn và được tích hợp tốt hơn với Spring Boot.

Interceptor có thể được sử dụng cho mục đích nào?

Interceptor có thể được sử dụng để thực hiện nhiều chức năng khác nhau, bao gồm kiểm soát truy cập, bảo mật, quản lý phiên, kiểm tra lỗi và ghi nhật ký.

Làm thế nào để xác định thứ tự của các Interceptor?

Spring Boot cung cấp cho chúng ta một cơ chế để xác định thứ tự của các Interceptor. Chúng ta có thể sử dụng phương thức order() của Interface Ordered hoặc có thể sử dụng Annotation @Order.

6. Kết bài viết

Qua bài viết này chúng ta đã đi qua một chuyến hành trình khám phá về Spring Boot Interceptor. Từ những khái niệm cơ bản đến cách áp dụng và sử dụng Interceptor trong ứng dụng Spring Boot. Hy vọng rằng bài viết này đã giúp các bạn hiểu rõ hơn về tính năng và lợi ích của Interceptor trong ứng dụng Spring Boot. Nếu bạn có bất kỳ câu hỏi hoặc ý kiến gì về chủ đề này, xin hãy để lại bình luận bên dưới nhé!!