1. 程式人生 > 程式設計 >完美解決request請求流只能讀取一次的問題

完美解決request請求流只能讀取一次的問題

解決request請求流只能讀取一次的問題

實際開發碰到的問題

解決request請求流中的資料二次或多次使用問題

實際開發碰到的問題

springboot專案中,為了防止sql注入,採用Filter攔截器對所有請求流中的json資料進行校驗,請求資料沒問題則繼續向下執行,在後邊的程式碼中應用到請求引數值時,發現request中的json資料為空;

除上邊描述的情況,嘗試過兩次從request中獲取json資料,第二次同樣是獲取不到的。

解決request請求流中的資料二次或多次使用問題

繼承HttpServletRequestWrapper,將請求體中的流copy一份,覆寫getInputStream()和getReader()方法供外部使用。每次呼叫覆寫後的getInputStream()方法都是從複製出來的二進位制陣列中進行獲取,這個二進位制陣列在物件存在期間一直存在,這樣就實現了流的重複讀取。

//增強類
public class BodyReaderHttpServletRequestWrapper extends HttpServletRequestWrapper {
  //儲存流
  private byte[] requestBody = null;
 
  public BodyReaderHttpServletRequestWrapper(HttpServletRequest request) throws IOException {
    super(request);
    requestBody = StreamUtils.copyToByteArray(request.getInputStream());
  }
 
  @Override
  public ServletInputStream getInputStream() throws IOException {
 
    final ByteArrayInputStream bais = new ByteArrayInputStream(requestBody);
 
    return new ServletInputStream() {
 
      @Override
      public int read() throws IOException {
        return bais.read();
      }
 
      @Override
      public boolean isFinished() {
        return false;
      }
 
      @Override
      public boolean isReady() {
        return false;
      }
 
      @Override
      public void setReadListener(ReadListener readListener) {
 
      }
    };
  }
 
  @Override
  public BufferedReader getReader() throws IOException{
    return new BufferedReader(new InputStreamReader(getInputStream()));
  }
} 
 
//過濾器
@Component
@WebFilter
public class RequestSqlValidFilter implements Filter {
  private final Logger logger = LoggerFactory.getLogger(this.getClass());
 
  @Override
  public void init(FilterConfig filterConfig) throws ServletException {
 
  }
 
  @Override
  public void doFilter(ServletRequest request,ServletResponse response,FilterChain chain) throws IOException,ServletException {
    ServletRequest requestWrapper = new BodyReaderHttpServletRequestWrapper((HttpServletRequest)request);
 
    //請求引數合法,無sql注入
    if((sqlValid(request,response))){
      chain.doFilter(requestWrapper,response);//requestWrapper中儲存著供二次使用的請求資料
    }else {
      logger.error("RequestSqlValidFilter sqlValid param error");
    }
  }
 
  @Override
  public void destroy() {
 
  }

補充知識:【java web】解決流讀完一次就不能再次獲取body資料的問題

問題來自我工作業務上的需求:前端請求時需要將json用RSA演算法加密,資料經過後端過濾器進行自動解密,這樣做的好處是以後不需要在每一個方法裡都手動解密一次,增加程式碼的簡潔性、可維護性。

但這樣一來便會面臨一個問題:http的request請求的輸入流在過濾器中就已經被讀取了(因為需要讀取並解密request body 裡被前端加密了的json資料),流只能被讀取一次,這樣一來資料便傳不進controller裡,導致接下來的業務無法進行。

於是我上網找了一些資料併成功解決了這個問題,基本思路是封裝原生的HttpServletRequest請求,將其輸入流裡的資料儲存在位元組數組裡,最後重寫getInputStream方法,使其之後每次讀取資料都是從位元組數組裡讀取的。

第一步:寫一個Request包裝類BodyReaderHttpServletRequestWrapper

public class BodyReaderHttpServletRequestWrapper extends HttpServletRequestWrapper {
 
  private byte[] body;
 
  public BodyReaderHttpServletRequestWrapper(HttpServletRequest request) throws IOException {
    super(request);
    body = HttpHelper.getBodyString(request).getBytes(Charset.forName("UTF-8"));
  }
 
  @Override
  public BufferedReader getReader() throws IOException {
    return new BufferedReader(new InputStreamReader(getInputStream()));
  }
 
  @Override
  public ServletInputStream getInputStream() throws IOException {
 
    final ByteArrayInputStream bais = new ByteArrayInputStream(body);
 
    return new ServletInputStream() {
 
      @Override
      public int read() throws IOException {
        return bais.read();
      }
 
      @Override
      public boolean isFinished() {
        return false;
      }
 
      @Override
      public boolean isReady() {
        return false;
      }
 
      @Override
      public void setReadListener(ReadListener readListener) {
 
      }
 
    };
  }
 
  public void setInputStream(byte[] body){
    this.body = body;
  }

裡面涉及一個HttpHelper類,順便也貼出來

public class HttpHelper {
 
  /**
   * 獲取請求Body
   * @param request
   * @return
   */
  public static String getBodyString(ServletRequest request) {
    StringBuilder sb = new StringBuilder();
    InputStream inputStream = null;
    BufferedReader reader = null;
    try {
      inputStream = request.getInputStream();
      reader = new BufferedReader(new InputStreamReader(inputStream,Charset.forName("UTF-8")));
      String line = "";
      while ((line = reader.readLine()) != null) {
        sb.append(line);
      }
    } catch (IOException e) {
      e.printStackTrace();
    } finally {
      if (inputStream != null) {
        try {
          inputStream.close();
        } catch (IOException e) {
          e.printStackTrace();
        }
      }
      if (reader != null) {
        try {
          reader.close();
        } catch (IOException e) {
          e.printStackTrace();
        }
      }
    }
    return sb.toString();
  }  
}

第二步:編寫包裝Filter

這個filter類可以將經過的原生Request請求自動包裝成BodyReaderHttpServletRequestWrapper

/**
 * desc : 用於包裝原生request,解決流讀完一次就不能再次獲取body資料的問題
 * Created by Lon on 2018/3/9.
 */
public class RequestWrapperFilter implements Filter{
 
  private static final Logger LOGGER = LoggerFactory.getLogger(RequestWrapperFilter.class);
 
  @Override
  public void init(FilterConfig filterConfig) throws ServletException {
 
  }
 
  @Override
  public void doFilter(ServletRequest request,ServletException {
    ServletRequest requestWrapper = null;
    if(request instanceof HttpServletRequest) {
      requestWrapper = new BodyReaderHttpServletRequestWrapper((HttpServletRequest) request);
    }
    if(null == requestWrapper) {
      LOGGER.error("包裝request失敗!將返回原來的request");
      chain.doFilter(request,response);
    } else {
      LOGGER.info("包裝request成功");
      chain.doFilter(requestWrapper,response);
    } 
  }
 
  @Override
  public void destroy() {
 
  }
}

第三步:在web.xml上配置過濾器

 <filter>
  <filter-name>RequestWrapperFilter</filter-name>
  <filter-class>com.kx.security.filter.RequestWrapperFilter</filter-class>
 </filter>
 <filter-mapping>
  <filter-name>RequestWrapperFilter</filter-name>
  <url-pattern>/*</url-pattern>
 </filter-mapping>

這裡要注意的是這個包裝過濾器可能要寫在web.xml配置檔案裡某些過濾器的前面,比如解密過濾器,否則被解密過濾器先讀取流的話,包裝過濾器就讀取不了流了。

至此一個簡單的解決方法就完成啦!

以上這篇完美解決request請求流只能讀取一次的問題就是小編分享給大家的全部內容了,希望能給大家一個參考,也希望大家多多支援我們。