SpringBoot HttpServletResponse Header Cookie輸出問題


問題:

在一次Response寫入header和cookie的時候,發現部分信息沒有被輸出

工具類:

CookieUtils:

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import javax.annotation.PostConstruct;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

/**
 * Created by qhong on 2018/10/15 15:46
 **/
@Component
public class CookieUtils {

	public static final int COOKIE_MAX_AGE = 7 * 24 * 3600;
	public static final int COOKIE_HALF_HOUR = 30 * 60;


	private static HttpServletResponse response;

	@Autowired
	private HttpServletResponse response2;

	private static HttpServletRequest request;

	@Autowired
	private HttpServletRequest request2;

	@PostConstruct
	public void beforeInit() {
		request=request2;
		response=response2;
	}


	/**
	 * 根據Cookie名稱得到Cookie對象,不存在該對象則返回Null
	 *
	 * @param request
	 * @param name
	 * @return
	 */
	public static Cookie getCookie(String name) {
		Cookie[] cookies = request.getCookies();
		if (cookies==null||cookies.length<1) {
			return null;
		}
		Cookie cookie = null;
		for (Cookie c : cookies) {
			if (name.equals(c.getName())) {
				cookie = c;
				break;
			}
		}
		return cookie;
	}

	/**
	 * 根據Cookie名稱直接得到Cookie值
	 *
	 * @param request
	 * @param name
	 * @return
	 */
	public static String getCookieValue(String name) {
		Cookie cookie = getCookie(name);
		if(cookie != null){
			return cookie.getValue();
		}
		return null;
	}

	/**
	 * 移除cookie
	 * @param request
	 * @param response
	 * @param name 這個是名稱,不是值
	 */
	public static void removeCookie(String name) {
		if (null == name) {
			return;
		}
		Cookie cookie = getCookie(name);
		if(null != cookie){
			cookie.setPath("/");
			cookie.setValue("");
			cookie.setMaxAge(0);
			response.addCookie(cookie);
		}
	}

	/**
	 * 添加一條新的Cookie,可以指定過期時間(單位:秒)
	 *
	 * @param response
	 * @param name
	 * @param value
	 * @param maxValue
	 */
	public static void setCookie(String name,
								 String value, int maxValue) {
		if (StringUtils.isBlank(name)) {
			return;
		}
		if (null == value) {
			value = "";
		}
		Cookie cookie = new Cookie(name, value);
		cookie.setPath("/");
		if (maxValue != 0) {
			cookie.setMaxAge(maxValue);
		} else {
			cookie.setMaxAge(COOKIE_HALF_HOUR);
		}
		response.addCookie(cookie);
//		try {
//			response.flushBuffer();
//		} catch (IOException e) {
//			e.printStackTrace();
//		}
	}

	/**
	 * 添加一條新的Cookie,默認30分鍾過期時間
	 *
	 * @param response
	 * @param name
	 * @param value
	 */
	public static void setCookie(String name,
								 String value) {
		setCookie(name, value, COOKIE_HALF_HOUR);
	}

	/**
	 * 將cookie封裝到Map里面
	 * @param request
	 * @return
	 */
	public static Map<String,Cookie> getCookieMap(){
		Map<String,Cookie> cookieMap = new HashMap<>();
		Cookie[] cookies = request.getCookies();
		if(cookies!=null&&cookies.length>1){
			for(Cookie cookie : cookies){
				cookieMap.put(cookie.getName(), cookie);
			}
		}
		return cookieMap;
	}
}

SpringServletUtil:

import java.io.IOException;
import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

/**
 * Created by qhong on 2019/1/11 14:17
 **/
@Component
@Slf4j
public class SpringHttpUtil {

// /**
//  * 獲取請求體
//  * @return
//  */
// private HttpServletRequest getRequest(){
//    return ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
// }
//
// /**
//  * 獲取返回體
//  * @return
//  */
// private HttpServletResponse getResponse(){
//    return ((ServletRequestAttributes)RequestContextHolder.getRequestAttributes()).getResponse();
// }

   @Autowired
   private HttpServletResponse response;


   @Autowired
   private HttpServletRequest request;


   /**
    * 獲取用戶請求頭部或者cookie中的參數
    */
   public String getParams(String name) {
      String result = getHeader(name);
      //cookie
      if (StringUtils.isBlank(result)) {
         result = CookieUtils.getCookieValue(name);
      }
      return result;
   }

   public String getHeader(String name) {
      String result= request.getHeader(name);
      if(StringUtils.isBlank(result)){
         result=request.getParameter(name);
      }
      return result;
   }

   public void setHeader(Map<String, String> map) {
      if (map == null || map.isEmpty() || map.size() == 0)
         return;
      map.entrySet().stream().forEach(x -> {
         response.setHeader(x.getKey(), x.getValue());
      });

   }

   public void setCookie(Map<String, String> map) {
      if (map == null || map.isEmpty() || map.size() == 0)
         return;
      map.entrySet().stream().forEach(x -> {
         CookieUtils.setCookie(x.getKey(), x.getValue());
      });
   }
}

使用:

Map<String, String> map = new HashMap<>();
map.put("aaaaa","aaa");
map.put("bbbbb","bbb");
springHttpUtil.setHeader(map);
springHttpUtil.setCookie(map);

很簡單的測試使用 ,但是發現cookie只能輸出一個

查看源碼:

org\apache\tomcat\embed\tomcat-embed-core\8.5.15\tomcat-embed-core-8.5.15.jar

ResponseFacade:

@Override
public void addCookie(Cookie cookie) {

    if (isCommitted()) {
        return;
    }

    response.addCookie(cookie);

}

  @Override
    public void setHeader(String name, String value) {

        if (isCommitted()) {
            return;
        }

        response.setHeader(name, value);

    }


    @Override
    public void addHeader(String name, String value) {

        if (isCommitted()) {
            return;
        }

        response.addHeader(name, value);

    }

我也斷點調試了,發現除了第一次isCommitted是false,其他的true,所以其他的參數才沒有輸出

刷新輸出流

response內部的輸出流有8KB的緩沖區,如果緩沖區滿了的話,那么response會自動去提交,即把緩沖區內容輸出給客戶端。這時調用response的isCommited()方法返回的就是true,表示response已經提交過至少一次了。
也可以在緩沖區沒有裝滿時調用response.flushBuffer()方法刷新輸出流,把緩沖區中的數據發送到客戶端去。同樣,這也會導致response的isCommited()方法返回的就是true,表示response已經提交過至少一次了。
其實也可以調用response.getWirter().flush()方法達到與調用response.flushBuffer()相同的效果。這兩種方式基本相同!
一旦response的isCommited()方法返回true,這說明服務器已經至少把狀態碼、響應頭等數據發送給客戶端了,也就是說已經開始向客戶響應了。

錯誤原因:

錯誤的地方就是CookieUtils中被我注釋掉的地方,這里對response進行了flushBuffer,所以isCommitted為true,后面的參數才會無效。

response.flushBuffer最好是只對返回主體內容使用,對於頭部信息除非確定是最后了,否則不要使用,使用的話,后續對頭部信息的任何操作都無效。

參考:

HttpServletResponse的輸出問題


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM