Java EE過濾器優(yōu)先級控制的實例解讀

更新時間：2025年02月07日 08:46:52 作者：t0_54coder

通過使用@Priority注解,可以控制JavaEE應用中過濾器的執(zhí)行順序,在上面的示例中,我們通過設置不同的優(yōu)先級,實現(xiàn)了TimeFilter和LogFilter的執(zhí)行順序控制

Java EE過濾器優(yōu)先級控制實例解讀

在Java EE應用中，我們經(jīng)常需要對多個過濾器（Filters）進行排序執(zhí)行。

這可以通過使用@Priority注解來實現(xiàn)。

@Priority注解接受一個整數(shù)參數(shù)，用于指定過濾器的執(zhí)行順序。

數(shù)值越低，優(yōu)先級越高。

下面，我們將通過一個實例來詳細解析如何使用@Priority注解來控制過濾器的執(zhí)行順序。

實現(xiàn)過濾器

時間記錄過濾器（TimeFilter）

這個過濾器用于記錄執(zhí)行資源方法所花費的時間。通過@Priority(1)注解，我們將其優(yōu)先級設置為1。

@Priority(1)
@Provider
public class TimeFilter implements ContainerRequestFilter, ContainerResponseFilter {
    @Override
    public void filter(ContainerRequestContext reqContext) throws IOException {
        System.out.println("-- TimeFilter request --");
        reqContext.setProperty("start-time", System.currentTimeMillis());
    }
    @Override
    public void filter(ContainerRequestContext reqContext,
                       ContainerResponseContext resContext) throws IOException {
        System.out.println("-- TimeFilter response --");
        long startTime = (long) reqContext.getProperty("start-time");
        System.out.printf("Time taken for request %s:  %s milli secs%n",
                reqContext.getUriInfo().getPath(),
                System.currentTimeMillis() - startTime
        );
    }
}

日志記錄過濾器（LogFilter）

這個過濾器用于記錄請求和響應的頭部信息。通過@Priority(2)注解，我們將其優(yōu)先級設置為2。

@Priority(2)
@Provider
public class LogFilter implements ContainerRequestFilter, ContainerResponseFilter {
    @Override
    public void filter(ContainerRequestContext reqContext) throws IOException {
        System.out.println("-- req headers --");
        log(reqContext.getUriInfo(), reqContext.getHeaders());
    }
    @Override
    public void filter(ContainerRequestContext reqContext,
                       ContainerResponseContext resContext) throws IOException {
        System.out.println("-- res headers --");
        log(reqContext.getUriInfo(), resContext.getHeaders());
    }
    private void log(UriInfo uriInfo, MultivaluedMap<String, ?> headers) {
        System.out.println("Path: " + uriInfo.getPath());
        headers.entrySet().forEach(h -> System.out.println(h.getKey() + ": " + h.getValue()));
    }
}

JAX-RS資源

@Path("/")
public class MyResource {
    @GET
    @Path("{path:.*}")
    public String getResponse(@PathParam("path") String path) {
        System.out.printf("creating response for '%s'%n", path);
        return "dummy-response for " + path;
    }
}

運行示例

要運行這些示例，你需要在項目的pom.xml中配置嵌入式Tomcat，并使用以下命令啟動：

mvn tomcat7:run-war

輸出結果

使用HTTPie工具訪問資源，服務器控制臺的輸出如下：

-- TimeFilter request --
-- req headers --
Path: customers
host: [localhost:8080]
connection: [keep-alive]
accept-encoding: [gzip, deflate]
accept: [*/*]
user-agent: [HTTPie/0.9.9]
creating response for 'customers'
-- res headers --
Path: customers
Content-Type: [text/plain]
-- TimeFilter response --
Time taken for request customers: 13 milli secs

從輸出結果可以看出，TimeFilter在LogFilter之前執(zhí)行。如果我們交換這兩個過濾器的優(yōu)先級，它們的執(zhí)行順序也會相應改變。