web-dev-qa-db-ja.com

ServletFilterのServletResponseからHTTPステータスコードを取得するにはどうすればよいですか？

Webappから返されるすべてのHTTPステータスコードについてレポートしようとしています。ただし、ServletResponseを介して、またはHttpServletResponseにキャストしても、ステータスコードにアクセスできないようです。 ServletFilter内でこの値にアクセスする方法はありますか？

javaservletsservlet-filtershttp-status-codes
60
Seth Weiner

まず、アクセス可能な場所にステータスコードを保存する必要があります。応答を実装でラップして保持するのが最善です：

public class StatusExposingServletResponse extends HttpServletResponseWrapper {

    private int httpStatus;

    public StatusExposingServletResponse(HttpServletResponse response) {
        super(response);
    }

    @Override
    public void sendError(int sc) throws IOException {
        httpStatus = sc;
        super.sendError(sc);
    }

    @Override
    public void sendError(int sc, String msg) throws IOException {
        httpStatus = sc;
        super.sendError(sc, msg);
    }


    @Override
    public void setStatus(int sc) {
        httpStatus = sc;
        super.setStatus(sc);
    }

    public int getStatus() {
        return httpStatus;
    }

}

このラッパーを使用するには、レポートを実行できる場合、サーブレットフィルターを追加する必要があります。

public class StatusReportingFilter implements Filter {

    public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException {
        StatusExposingServletResponse response = new StatusExposingServletResponse((HttpServletResponse)res);
        chain.doFilter(req, response);
        int status = response.getStatus();
        // report
    }

    public void init(FilterConfig config) throws ServletException {
        //empty
    }

    public void destroy() {
        // empty
    }

}
86
David Rabinowitz

Servlet 3.0以降、 HttpServletResponse#getStatus() があります。

したがって、アップグレードの余地がある場合は、サーブレット3.0（Tomcat 7、Glassfish 3、JBoss AS 6など）にアップグレードすれば、ラッパーは必要ありません。

chain.doFilter(request, response);
int status = ((HttpServletResponse) response).getStatus();
63
BalusC

#sendRedirectのラッパーも含める必要があり、ステータスを「0」ではなく「200」に初期化することをお勧めします

private int httpStatus = SC_OK;

...

@Override
public void sendRedirect(String location) throws IOException {
    httpStatus = SC_MOVED_TEMPORARILY;
    super.sendRedirect(location);
}
17
Joel Hockey

上記のDavidの回答から欠けていることの1つは、sendErrorの他の形式もオーバーライドする必要があることです。

@Override
public void sendError(int sc, String msg) throws IOException {
    httpStatus = sc;
    super.sendError(sc, msg);
}
12
William Rose

Davidの答えに加えて、resetメソッドをオーバーライドすることもできます。

@Override
public void reset() {
    super.reset();
    this.httpStatus = SC_OK;
}

...および非推奨のsetStatus（int、String）

@Override
public void setStatus(int status, String string) {
    super.setStatus(status, string);
    this.httpStatus = status;
}
8
Grégory Joseph

HttpServletResponseWrapperを記述し、すべてのログを記録するために、すべてのsetStatus（）、sendError（）、およびsendRedirect（）メソッドをオーバーライドします。リクエストごとに応答オブジェクトのラッパーを交換するフィルターを作成します。

6
Licky Lindsay

古いコンテナにこだわっている場合、実際のステータスコードを使用するDavid Rabinowitzの代替ソリューション（ラッパーを使用して設定した後に変更する場合）は次のとおりです。

public class StatusExposingServletResponse extends HttpServletResponseWrapper {

    public StatusExposingServletResponse(HttpServletResponse response) {
        super(response);
    }

    @Override
    public void sendError(int sc) throws IOException {
        super.sendError(sc);
    }

    @Override
    public void sendError(int sc, String msg) throws IOException {
        super.sendError(sc, msg);
    }

    @Override
    public void setStatus(int sc) {
        super.setStatus(sc);
    }

    public int getStatus() {
        try {
            ServletResponse object = super.getResponse();

            // call the private method 'getResponse'
            Method method1 = object.getClass().getMethod("getResponse");
            Object servletResponse = method1.invoke(object, new Object[] {});

            // call the parents private method 'getResponse'
            Method method2 = servletResponse.getClass().getMethod("getResponse");
            Object parentResponse = method2.invoke(servletResponse, new Object[] {});

            // call the parents private method 'getResponse'
            Method method3 = parentResponse.getClass().getMethod("getStatus");
            int httpStatus = (Integer) method3.invoke(parentResponse, new Object[] {});

            return httpStatus;
        }
        catch (Exception e) {
            e.printStackTrace();
            return HttpServletResponse.SC_ACCEPTED;
        }
    }

    public String getMessage() {
        try {
            ServletResponse object = super.getResponse();

            // call the private method 'getResponse'
            Method method1 = object.getClass().getMethod("getResponse");
            Object servletResponse = method1.invoke(object, new Object[] {});

            // call the parents private method 'getResponse'
            Method method2 = servletResponse.getClass().getMethod("getResponse");
            Object parentResponse = method2.invoke(servletResponse, new Object[] {});

            // call the parents private method 'getResponse'
            Method method3 = parentResponse.getClass().getMethod("getReason");
            String httpStatusMessage = (String) method3.invoke(parentResponse, new Object[] {});

            if (httpStatusMessage == null) {
                int status = getStatus();
                Java.lang.reflect.Field[] fields = HttpServletResponse.class.getFields();

                for (Java.lang.reflect.Field field : fields) {
                    if (status == field.getInt(servletResponse)) {
                        httpStatusMessage = field.getName();
                        httpStatusMessage = httpStatusMessage.replace("SC_", "");
                        if (!"OK".equals(httpStatusMessage)) {
                            httpStatusMessage = httpStatusMessage.toLowerCase();
                            httpStatusMessage = httpStatusMessage.replace("_", " ");
                            httpStatusMessage = capitalizeFirstLetters(httpStatusMessage);
                        }

                        break;
                    }
                }
            }

            return httpStatusMessage;
        }
        catch (Exception e) {
            e.printStackTrace();
            return "";
        }
    }

    private static String capitalizeFirstLetters(String s) {

        for (int i = 0; i < s.length(); i++) {
            if (i == 0) {
                // Capitalize the first letter of the string.
                s = String.format("%s%s", Character.toUpperCase(s.charAt(0)), s.substring(1));
            }

            if (!Character.isLetterOrDigit(s.charAt(i))) {
                if (i + 1 < s.length()) {
                    s = String.format("%s%s%s", s.subSequence(0, i + 1), 
                            Character.toUpperCase(s.charAt(i + 1)), 
                            s.substring(i + 2));
                }
            }
        }

        return s;

    }

    @Override
    public String toString() {
        return this.getMessage() + " " + this.getStatus();
    }

}

警告：卑劣なリフレクションとイントロスペクションを使用してプライベートデータ値を取得するときのクラス階層の多くの仮定。

0
John Johnson