Filter trong Servlet

Servlet Filter là các lớp trong Java có thể được sử dụng trong lập trình Servlet cho các mục đích sau:

• Để chặn các yêu cầu từ một Client trước khi chúng truy cập một nguồn tại backend.
• Để thao tác các phản hồi từ Server trước khi chúng được gửi trở lại tới Client.

Sau đây chúng tôi đề nghị một số loại Filter sau:

• Authentication Filters − Các Filter xác nhận
• Data compression Filters − Các Filter nén dữ liệu
• Encryption Filters − Các Filter mật mã hóa
• Các Filter mà kích hoạt các sự kiện truy cập nguồn
• Image Conversion Filters − Các Filter biến đổi hình ảnh
• Logging and Auditing Filters − Các Filter kiểm tra log và thống kê
• MIME-TYPE Chain Filters.
• Tokenizing Filters .
• XSL/T Filter − Các Filter biến đổi nội dung XML

Các Filter được triển khai trong web.xml file và sau đó map tới hoặc các tên Servlet hoặc các URL pattern.

Các phương thức Servlet Filter

Về cơ bản, một Filter là một lớp Java mà triển khai javax.servlet.Filter Interface. Interface này định nghĩa 3 phương thức:

Ví dụ về Servlet Filter

Ví dụ sau về Servlet Filter sẽ in địa chỉ IP và thời gian hiện tại của Client. Ví dụ này sẽ giúp bạn hiểu cơ bản về Servlet Filter, nhưng bạn cũng có thể viết các ứng dụng Filter phức tạp hơn bởi sử dụng cùng khái niệm này.

// Import required java libraries
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
import java.util.*;


// Implements Filter class
public class LogFilter implements Filter  {
   public void  init(FilterConfig config) 
                         throws ServletException{
      // Get init parameter 
      String testParam = config.getInitParameter("test-param"); 


      //Print the init parameter 
      System.out.println("Test Param: " + testParam); 
   }
   public void  doFilter(ServletRequest request, 
                 ServletResponse response,
                 FilterChain chain) 
                 throws java.io.IOException, ServletException {


      // Get the IP address of client machine.   
      String ipAddress = request.getRemoteAddr();


      // Log the IP address and current timestamp.
      System.out.println("IP "+ ipAddress + ", Time "
                                       + new Date().toString());


      // Pass request back down the filter chain
      chain.doFilter(request,response);
   }
   public void destroy( ){
      /* Called before the Filter instance is removed 
      from service by the web container*/
   }
}

Biên dịch LogFilter.java theo cách thông thường và đặt class file trong <Tomcat-installation-directory>/webapps/ROOT/WEB-INF/classes.

Ánh xạ Servlet Filter trong Web.xml

Các Filter được định nghĩa và sau đó được ánh xạ tới URL hoặc Servlet, theo cách giống như khi Servlet được định nghĩa và sau đó được ánh xạ tới một URL pattern. Tạo entry sau cho Filter trong web.xml file.

<filter>
   <filter-name>LogFilter</filter-name>
   <filter-class>LogFilter</filter-class>
   <init-param>
      <param-name>test-param</param-name>
      <param-value>Initialization Paramter</param-value>
   </init-param>
</filter>
<filter-mapping>
   <filter-name>LogFilter</filter-name>
   <url-pattern>/*</url-pattern>
</filter-mapping>

Filter trên sẽ áp dụng cho tất cả Servlet bởi vì chúng ta xác định /* trong cấu hình. Bạn có thể xác định một Servlet path cụ thể nếu bạn chỉ muốn áp dụng Filter trên một số Servlet nào đó.

Sử dụng nhiều Filter trong Servlet

Ứng dụng web của bạn có thể định nghĩa một vài Filter cho một mục đích nào đó. Giả sử bạn định nghĩa hai Filter là AuthenFilter và LogFilter. Phần còn lại của tiến trình sẽ giống như ví dụ trên, ngoại trừ việc bạn cần tạo một ánh xạ khác như dưới đây:

<filter>
   <filter-name>LogFilter</filter-name>
   <filter-class>LogFilter</filter-class>
   <init-param>
      <param-name>test-param</param-name>
      <param-value>Initialization Paramter</param-value>
   </init-param>
</filter>


<filter>
   <filter-name>AuthenFilter</filter-name>
   <filter-class>AuthenFilter</filter-class>
   <init-param>
      <param-name>test-param</param-name>
      <param-value>Initialization Paramter</param-value>
   </init-param>
</filter>


<filter-mapping>
   <filter-name>LogFilter</filter-name>
   <url-pattern>/*</url-pattern>
</filter-mapping>


<filter-mapping>
   <filter-name>AuthenFilter</filter-name>
   <url-pattern>/*</url-pattern>
</filter-mapping>

Thứ bậc của các Filter

Bậc của Filter trong web.xml quyết định thứ tự mà Web container áp dụng Filter tới các Servlet. Để đảo ngược thứ tự của Filter, bạn chỉ cần đảo ngược các phần tử ánh xạ Filter trong web.xml.

Trong ví dụ trên, LogFilter sẽ được áp dụng đầu tiên và sau đó áp dụng AuthenFilter tới bất kỳ Servlet nào. Nhưng trong ví dụ sau, thứ tự này sẽ bị đảo ngược.

<filter-mapping>
   <filter-name>AuthenFilter</filter-name>
   <url-pattern>/*</url-pattern>
</filter-mapping>


<filter-mapping>
   <filter-name>LogFilter</filter-name>
   <url-pattern>/*</url-pattern>
</filter-mapping>