Java tutorial
/* * Copyright (C) 2008 feilong * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.sunchenbin.store.feilong.servlet.http.builder; import java.util.Enumeration; import java.util.LinkedHashMap; import java.util.Map; import java.util.TreeMap; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpSession; import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.builder.Builder; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import com.sunchenbin.store.feilong.core.lang.CharsetType; import com.sunchenbin.store.feilong.core.net.HttpMethodType; import com.sunchenbin.store.feilong.core.net.ParamUtil; import com.sunchenbin.store.feilong.core.tools.slf4j.Slf4jUtil; import com.sunchenbin.store.feilong.core.util.MapUtil; import com.sunchenbin.store.feilong.core.util.Validator; import com.sunchenbin.store.feilong.servlet.http.CookieUtil; import com.sunchenbin.store.feilong.servlet.http.RequestUtil; import com.sunchenbin.store.feilong.servlet.http.entity.RequestAttributes; /** * The Class RequestLogBuilder. * * @author feilong * @version 1.4.0 201584 ?11:45:03 * @see org.apache.commons.lang3.builder.Builder * @see org.apache.commons.lang3.builder.HashCodeBuilder * @since 1.4.0 */ public class RequestLogBuilder implements Builder<Map<String, Object>> { /** The Constant log. */ private static final Logger LOGGER = LoggerFactory.getLogger(RequestLogBuilder.class); /** The request. */ private final HttpServletRequest request; /** The request log switch. */ private final RequestLogSwitch requestLogSwitch; /** * The Constructor. * * @param request * the request * @param requestLogSwitch * the request log switch */ public RequestLogBuilder(HttpServletRequest request, RequestLogSwitch requestLogSwitch) { super(); this.request = request; this.requestLogSwitch = requestLogSwitch; } /** * request ??json? log(?log). * * the request log switch * * @return the request string for log */ public Map<String, Object> build() { RequestLogSwitch opRequestLogSwitch = null == this.requestLogSwitch ? RequestLogSwitch.NORMAL : this.requestLogSwitch; Map<String, Object> map = new LinkedHashMap<String, Object>(); // requestFullURL if (opRequestLogSwitch.getShowFullURL()) { map.put("requestFullURL", RequestUtil.getRequestFullURL(request, CharsetType.UTF8)); } // Method if (opRequestLogSwitch.getShowMethod()) { map.put("request.getMethod", request.getMethod()); } // _parameterMap if (opRequestLogSwitch.getShowParams()) { // 3.0 Map<String, String[]> getParameterMap // The keys in the parameter map are of type String. // The values in the parameter map are of type String array. Map<String, String[]> parameterMap = RequestUtil.getParameterMap(request); if (Validator.isNotNullOrEmpty(parameterMap)) { map.put("_parameterMap", parameterMap); } } //RequestIdentity if (opRequestLogSwitch.getShowIdentity()) { RequestIdentity requestIdentity = new RequestIdentity(); requestIdentity.setClientIP(RequestUtil.getClientIp(request)); requestIdentity.setUserAgent(RequestUtil.getHeaderUserAgent(request)); requestIdentity.setSessionId(getSessionId()); map.put("requestIdentity", requestIdentity); } // _headerMap if (opRequestLogSwitch.getShowHeaders()) { map.put("_headerInfoMap", getHeaderMap()); } // _cookieMap if (opRequestLogSwitch.getShowCookies()) { Map<String, String> cookieMap = CookieUtil.getCookieMap(request); if (Validator.isNotNullOrEmpty(cookieMap)) { map.put("_cookieInfoMap", cookieMap); } } // aboutURLMap if (opRequestLogSwitch.getShowURLs()) { Map<String, String> aboutURLMap = getAboutURLMapForLog(); map.put("about URL Info Map", aboutURLMap); } // aboutElseMap if (opRequestLogSwitch.getShowElses()) { Map<String, Object> aboutElseMap = new LinkedHashMap<String, Object>(); //Returns the name of the scheme used to make this request, for example, http, https, or ftp. Different schemes have different rules for constructing URLs, as noted in RFC 1738. aboutElseMap.put("request.getScheme()", request.getScheme()); //Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1. For HTTP servlets, the value returned is the same as the value of the CGI variable SERVER_PROTOCOL. aboutElseMap.put("request.getProtocol()", request.getProtocol()); //Returns the name of the authentication scheme used to protect the servlet. //All servlet containers support basic, form and client certificate authentication, and may additionally support digest authentication. If the servlet is not authenticated null is returned. //Same as the value of the CGI variable AUTH_TYPE. aboutElseMap.put("request.getAuthType()", request.getAuthType()); //Returns the name of the character encoding used in the body of this request. //This method returns null if the request does not specify a character encoding aboutElseMap.put("request.getCharacterEncoding()", request.getCharacterEncoding()); //Returns the MIME type of the body of the request, or null if the type is not known. //For HTTP servlets, same as the value of the CGI variable CONTENT_TYPE. aboutElseMap.put("request.getContentType()", "" + request.getContentType()); //Returns the length, in bytes, of the request body and made available by the input stream, //or -1 if the length is not known. //For HTTP servlets, same as the value of the CGI variable CONTENT_LENGTH. aboutElseMap.put("request.getContentLength()", "" + request.getContentLength()); //Returns the preferred Locale that the client will accept content in, based on the Accept-Language header. If the client request doesn't provide an Accept-Language header, this method returns the default locale for the server. aboutElseMap.put("request.getLocale()", "" + request.getLocale()); //Returns the host name of the Internet Protocol (IP) interface on which the request was received. //2.4 aboutElseMap.put("request.getLocalName()", request.getLocalName()); //Returns the login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated. Whether the user name is sent with each subsequent request depends on the browser and type of authentication. Same as the value of the CGI variable REMOTE_USER. aboutElseMap.put("request.getRemoteUser()", request.getRemoteUser()); //Returns the session ID specified by the client. This may not be the same as the ID of the current valid session for this request. If the client did not specify a session ID, this method returns null. aboutElseMap.put("request.getRequestedSessionId()", request.getRequestedSessionId()); //Checks whether the requested session ID came in as a cookie. aboutElseMap.put("request.isRequestedSessionIdFromCookie()", request.isRequestedSessionIdFromCookie()); //The method isRequestedSessionIdFromUrl() from the type HttpServletRequest is deprecated aboutElseMap.put("request.isRequestedSessionIdFromUrl()", request.isRequestedSessionIdFromUrl()); //Checks whether the requested session ID came in as part of the request URL. aboutElseMap.put("request.isRequestedSessionIdFromURL()", request.isRequestedSessionIdFromURL()); //Checks whether the requested session ID is still valid. If the client did not specify any session ID, this method returns false. aboutElseMap.put("request.isRequestedSessionIdValid()", request.isRequestedSessionIdValid()); //Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS. aboutElseMap.put("request.isSecure()", request.isSecure()); //Returns a java.security.Principal object containing the name of the current authenticated user. If the user has not been authenticated, the method returns null. aboutElseMap.put("request.getUserPrincipal()", request.getUserPrincipal()); // aboutElseMap.put("request.isUserInRole(role)", request.isUserInRole(role)); map.put("about Else Map", aboutElseMap); } // aboutIPMap if (opRequestLogSwitch.getShowIPs()) { Map<String, String> aboutIPMap = new TreeMap<String, String>(); //Returns the Internet Protocol (IP) address of the interface on which the request was received. aboutIPMap.put("request.getLocalAddr()", request.getLocalAddr()); //Returns the fully qualified name of the client or the last proxy that sent the request. If the engine cannot or chooses not to resolve the hostname (to improve performance), this method returns the dotted-string form of the IP address. For HTTP servlets, same as the value of the CGI variable REMOTE_HOST. aboutIPMap.put("request.getRemoteAddr()", request.getRemoteAddr()); //Returns the fully qualified name of the client or the last proxy that sent the request. If the engine cannot or chooses not to resolve the hostname (to improve performance), this method returns the dotted-string form of the IP address. For HTTP servlets, same as the value of the CGI variable REMOTE_HOST. aboutIPMap.put("request.getRemoteHost()", request.getRemoteHost()); //Returns the host name of the server to which the request was sent. It is the value of the part before ":" in the Host header value, if any, or the resolved server name, or the server IP address. aboutIPMap.put("request.getServerName()", request.getServerName()); aboutIPMap.put("getClientIp", RequestUtil.getClientIp(request)); map.put("about IP Info Map", aboutIPMap); } // aboutPortMap if (opRequestLogSwitch.getShowPorts()) { Map<String, String> aboutPortMap = new TreeMap<String, String>(); //Returns the Internet Protocol (IP) port number of the interface on which the request was received. aboutPortMap.put("request.getLocalPort()", "" + request.getLocalPort()); //Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request. aboutPortMap.put("request.getRemotePort()", "" + request.getRemotePort()); //Returns the port number to which the request was sent. It is the value of the part after ":" in the Host header value, if any, or the server port where the client connection was accepted on. aboutPortMap.put("request.getServerPort()", "" + request.getServerPort()); map.put("about Port Info Map", aboutPortMap); } // _errorInfos if (opRequestLogSwitch.getShowErrors()) { Map<String, String> errorMap = getErrorMap(); if (Validator.isNotNullOrEmpty(errorMap)) { map.put("_errorInfos", errorMap); } } // _forwardInfos if (opRequestLogSwitch.getShowForwardInfos()) { Map<String, String> forwardMap = getForwardMap(); if (Validator.isNotNullOrEmpty(forwardMap)) { map.put("_forwardInfos", forwardMap); } } // _includeInfos if (opRequestLogSwitch.getShowIncludeInfos()) { Map<String, String> includeMap = getIncludeMap(); if (Validator.isNotNullOrEmpty(includeMap)) { map.put("_includeInfos", includeMap); } } // ??json? key // attribute ? log , ? getAttributeMap(request) // map.put("_attributeKeys", getAttributeMap(request).keySet()); return map; } /** * ?. * * <p> * ?log, Cannot create a session after the response has been committed <br> * * </p> * * <p> * I have learnt that maybe my 8K buffer gets full in some cases (as you said, my contect is dynamic and sometimes could be large). <br> * * In that case, I have understanded that a full buffer triggers a commit, and when that happens the JSP error page can not do its job * and then "java.lang.IllegalStateException: Cannot create a session after the response has been committed" happens. <br> * * OK, but is there any other possible reason for the early commit? <br> * My session is created early enough, and in fact the JSP page creates it if necessary, by default. * </p> * * @return the session id,, {@link java.lang.Throwable#getMessage()} * @since 1.4.1 */ private String getSessionId() { try { HttpSession session = request.getSession(false); return null == session ? StringUtils.EMPTY : session.getId(); } catch (IllegalStateException e) {//Cannot create a session after the response has been committed String msg = Slf4jUtil.formatMessage("uri:[{}],paramMap:{}", request.getRequestURI(), request.getParameterMap()); LOGGER.error(msg, e); return e.getMessage(); } } /** * forward map. * * @return the forward map */ public Map<String, String> getForwardMap() { Map<String, String> map = new LinkedHashMap<String, String>(); putAttributeNameAndValueIfValueNotNull(map, request, RequestAttributes.FORWARD_CONTEXT_PATH); putAttributeNameAndValueIfValueNotNull(map, request, RequestAttributes.FORWARD_REQUEST_URI); putAttributeNameAndValueIfValueNotNull(map, request, RequestAttributes.FORWARD_SERVLET_PATH); putAttributeNameAndValueIfValueNotNull(map, request, RequestAttributes.FORWARD_PATH_INFO); putAttributeNameAndValueIfValueNotNull(map, request, RequestAttributes.FORWARD_QUERY_STRING); return map; } /** * include map. * * @return the include map */ public Map<String, String> getIncludeMap() { Map<String, String> map = new LinkedHashMap<String, String>(); putAttributeNameAndValueIfValueNotNull(map, request, RequestAttributes.INCLUDE_CONTEXT_PATH); putAttributeNameAndValueIfValueNotNull(map, request, RequestAttributes.INCLUDE_PATH_INFO); putAttributeNameAndValueIfValueNotNull(map, request, RequestAttributes.INCLUDE_QUERY_STRING); putAttributeNameAndValueIfValueNotNull(map, request, RequestAttributes.INCLUDE_REQUEST_URI); putAttributeNameAndValueIfValueNotNull(map, request, RequestAttributes.INCLUDE_SERVLET_PATH); return map; } // ******************************************************************************************** /** * request error ? map. * * @return request {@link RequestAttributes#ERROR_STATUS_CODE},error ?map,<br> * request {@link RequestAttributes#ERROR_STATUS_CODE},null */ public Map<String, String> getErrorMap() { Map<String, String> map = new LinkedHashMap<String, String>(); putAttributeNameAndValueIfValueNotNull(map, request, RequestAttributes.ERROR_STATUS_CODE); putAttributeNameAndValueIfValueNotNull(map, request, RequestAttributes.ERROR_REQUEST_URI); putAttributeNameAndValueIfValueNotNull(map, request, RequestAttributes.ERROR_EXCEPTION); putAttributeNameAndValueIfValueNotNull(map, request, RequestAttributes.ERROR_EXCEPTION_TYPE); putAttributeNameAndValueIfValueNotNull(map, request, RequestAttributes.ERROR_MESSAGE); putAttributeNameAndValueIfValueNotNull(map, request, RequestAttributes.ERROR_SERVLET_NAME); return map; } /** * about url map. * * <h3>requesturl</h3> * * <blockquote> * * <ol> * <li>getServletContext().getRealPath("/") ???windows"\"linux"/"getPathInfo()"/"</li> * <li>getPathInfo()getPathTranslated()servleturl-pattern/*/aa/*pattern?null</li> * <li>servleturl-pattern*.xxpatterngetServletPath()getRequestURI()??ContextPath</li> * </ol> * * <table border="1" cellspacing="0" cellpadding="4"> * <tr style="background-color:#ccccff"> * <th align="left"></th> * <th align="left"></th> * </tr> * <tr valign="top"> * <td>request.getContextPath()</td> * <td>request.getContextPath()</td> * </tr> * <tr valign="top" style="background-color:#eeeeff"> * <td>request.getPathInfo()</td> * <td>Returns any extra path information associated with the URL the client sent when it made this request. <br> * Servlet?QueryString?</td> * </tr> * <tr valign="top"> * <td>request.getServletPath()</td> * <td>web.xmlServlet</td> * </tr> * <tr valign="top" style="background-color:#eeeeff"> * <td>request.getPathTranslated()</td> * <td>getServletContext().getRealPath("/") + getPathInfo()</td> * </tr> * <tr valign="top"> * <td>request.getRequestURI()</td> * <td>getContextPath() + getServletPath() + getPathInfo()</td> * </tr> * <tr valign="top"> * <td>request.getRequestURL()</td> * <td>getScheme() + "://" + getServerName() + ":" + getServerPort() + getRequestURI()</td> * </tr> * <tr valign="top" style="background-color:#eeeeff"> * <td>request.getQueryString()</td> * <td>&?GET?<br> * Returns the query string that is contained in the request URL after the path. <br> * This method returns null if the URL does not have a query string. <br> * Same as the value of the CGI variable QUERY_STRING.</td> * </tr> * </table> * </blockquote> * * @return the about url map * @since 1.0.9 */ private Map<String, String> getAboutURLMapForLog() { // 1.getServletContext().getRealPath("/") ???windows"\"linux"/"getPathInfo()"/" // 2.getPathInfo()getPathTranslated()servleturl-pattern/*/aa/*pattern?null // 3.servleturl-pattern*.xxpatterngetServletPath()getRequestURI()??ContextPath Map<String, String> aboutURLMap = new LinkedHashMap<String, String>(); aboutURLMap.put("request.getContextPath()", request.getContextPath()); // Returns any extra path information associated with the URL the client sent when it made this request. // Servlet?QueryString? aboutURLMap.put("request.getPathInfo()", request.getPathInfo()); // web.xmlServlet aboutURLMap.put("request.getServletPath()", request.getServletPath()); // getServletContext().getRealPath("/") + getPathInfo() aboutURLMap.put("request.getPathTranslated()", request.getPathTranslated()); // *********************************************************************** aboutURLMap.put("getQueryStringLog", getQueryStringLog()); // &?GET? //Returns the query string that is contained in the request URL after the path. //This method returns null if the URL does not have a query string. //Same as the value of the CGI variable QUERY_STRING. aboutURLMap.put("request.getQueryString()", request.getQueryString()); // *********************************************************************** // getContextPath() + getServletPath() + getPathInfo() aboutURLMap.put("request.getRequestURI()", request.getRequestURI()); // getScheme() + "://" + getServerName() + ":" + getServerPort() + getRequestURI() aboutURLMap.put("request.getRequestURL()", "" + request.getRequestURL()); return aboutURLMap; } /** * ??requestheader debug. * <p> * request header name value ?map. * </p> * * @return the header map */ public Map<String, String> getHeaderMap() { Map<String, String> map = new TreeMap<String, String>(); @SuppressWarnings("unchecked") Enumeration<String> headerNames = request.getHeaderNames(); while (headerNames.hasMoreElements()) { String name = headerNames.nextElement(); String value = request.getHeader(name); map.put(name, value); } return map; } /** * attributeNamekey,request,map({@code null != map && null != value} ?key/value putmap). * * @param map * the map * @param request * the request * @param attributeName * the attribute name * @since 1.4.0 */ private static void putAttributeNameAndValueIfValueNotNull(Map<String, String> map, HttpServletRequest request, String attributeName) { MapUtil.putIfValueNotNull(map, attributeName, (String) RequestUtil.getAttribute(request, attributeName)); } /** * ?queryString ? post/get. * * @return the query string * @see javax.servlet.http.HttpServletRequest#getMethod() * @see ParamUtil#toSafeQueryString(Map, String) */ private String getQueryStringLog() { // Returns the name of the HTTP method with which this request was made, // for example, GET, POST, or PUT. // Same as the value of the CGI variable REQUEST_METHOD. String method = request.getMethod(); if (HttpMethodType.POST.getMethod().equalsIgnoreCase(method)) { Map<String, String[]> map = RequestUtil.getParameterMap(request); if (Validator.isNotNullOrEmpty(map)) { return ParamUtil.toSafeQueryString(map, null); } } // Returns the query string that is contained in the request URL after the path. // This method returns null if the URL does not have a query string. // Same as the value of the CGI variable QUERY_STRING. // ?get? return request.getQueryString(); } }