跳到主要內容

RESTEasy - Connection Pool的Request Timeout沒有作用

Problem

REST API的開發者,大都會非常頻繁的存取REST服務提供者;Connection Pool是其中一個增進存取效率的方式。然而,這陣子在使用RESTEasy + Apache Connection Pool後,發現ConnectionRequestTimeout並沒作用。本篇文章主要分享目前的解決方法。

Version Info

由於某些限制,我們目前還沒使用最新版本的RESTEasy,版本資訊如下:

resteasy-client: 3.0.14.Final
httpcore: 4.3.3
httpclient: 4.3.6

Test RESTClient

我寫了一個測試去確認ConnectionRequestTimeout是否有作用,方法如下:

  1. 將Pool大小設定為1。
  2. 設定ConnectionRequestTimeout為2秒。
  3. 依序發起兩個HTTP Get,但第一個請求不關閉。
  4. 接著發起第二個HTTP Get,由於沒有有效的連線可以使用,會Block。
  5. 在2秒後,Client會收到Exception,Root Cause為ConnectionPoolTimeoutException。

首先是HttpEngine設定的部分,由於這個版本ResteasyClientBuilder內建的PoolManager有些問題,因此我是另外產生的,程式碼大致如下:

// 這是自己寫的Builder,產生的實體是PoolingHttpClientConnectionManager
private HttpClientConnectionManager initConnectionManager(int poolSize, int perRoute) {
	HttpClientConnectionManagerBuilder builder = new HttpClientConnectionManagerBuilder();
	return builder.withMaxTotal(poolSize).withDefaultMaxPerRoute(perRoute).build();
}
 
// TestCase的timeout設定為20秒,避免有問題時會卡很久
@Test(timeout=20000)
public void testRequestTimeoutWithCustomHttpEngine() throws Exception {
	int expectTimeout = 2*1000;
 
	connectionManager = initConnectionManager(20 , 1);
 
	RequestConfig requestConfig = RequestConfig.custom()
			.setConnectionRequestTimeout(expectTimeout)
			.build();
 
	ClientHttpEngine httpEngin = new ClientHttpEngineBuilder()
			.withRequestConfig(requestConfig)
			.withConnectionManager(connectionManager).build();
 
	ResteasyClientBuilder clientBuilder = (ResteasyClientBuilder)ResteasyClientBuilder.newBuilder();
	clientBuilder.httpEngine(httpEngin);
	// 以下略

接著是發出兩個請求,第一個請求沒執行close,接著執行第二個請求:

	// 延續httpEngine的初始化
	Client client = clientBuilder.build();
 
	Response leak_repsonse = client.target(target).request().get();
	Response second_response = null;
 
	long before = System.currentTimeMillis();
	try {
		second_response = client.target(target).request().get();
		fail("should be timeout");
	} catch (Exception e) {
		assertNotNull(e.getCause());
		assertTrue(e.getCause() instanceof ConnectionPoolTimeoutException);
		assertEquals(expectTimeout, System.currentTimeMillis() - before, 500);
	} finally {
		leak_repsonse.close();
		if( second_response != null )
			second_response.close();
	}
}

在執行以上測試後,會因為第二個請求block直到Test case 20秒timeout而錯誤;此測試並沒發生預期的ConnectionPoolTimeoutException。

Test HttpClient

由於前一個測試沒達到預期效果,因此繼續確認PoolingHttpClientConnectionManager是否有問題。測試流程與前一個測試大同小異,差別只在於是直接對HttpClient做操作:

@Test(timeout=20*1000)
public void testRequestTimeout() throws Exception {
	int expect_timeout = 2*1000;
	connectionManager = new HttpClientConnectionManagerBuilder().build();
	RequestConfig requestConfig = RequestConfig.custom()
			.setConnectionRequestTimeout(expect_timeout)
			.build();
 
	HttpClient httpClient = HttpClients.custom().setConnectionManager(connectionManager)
			.setDefaultRequestConfig(requestConfig)
			.build();
 
	HttpUriRequest uriRequest = new HttpGet(target);
	HttpResponse response = httpClient.execute(uriRequest);
	assertEquals(200, response.getStatusLine().getStatusCode());
 
	long before = System.currentTimeMillis();
	try {
		uriRequest = new HttpGet(target);
		response = httpClient.execute(uriRequest);
	} catch( ConnectionPoolTimeoutException e ) {
		assertEquals("Timeout waiting for connection from pool", e.getMessage());
	}
	long duration = System.currentTimeMillis() - before;
	assertEquals(expect_timeout, duration, 500);
}

這個測試最後會因為第二個連線無法在2秒內取得而拋出ConnectionPoolTimeoutException。

How to fix?

根據這兩個測試,懷疑是RESTEasy與HttpClient整合起來的問題。測試過更新RESTEasy與HttpClient的libraries後,確認只要將HttpClient的library升級至4.5.3以上就可以解決問題:

resteasy-client: 3.0.14.Final
httpcore: 4.3.3
httpclient: 4.5.3

留言

這個網誌中的熱門文章

PostgreSQL - Unattended installation on windows

Introduction 要將別人軟體包裝到自己軟體中,不可或缺的東西就是Unattended installation。以Unattended installation來說,我們可以選擇透過Installer的silent mode安裝,也可以透過把目標軟體做成portable的版本。本篇文章分享這兩種方法,教導大家如何將PostgreSQL透過Unattended installation方式安裝到目標系統成為service。 Note. 本篇以PostgreSQL 10.7為例。 Install with installer Tips 安裝程式或反安裝程式的參數,除了可以直接上官網搜尋Installation User Guide以外,也可以直接使用help參數查詢: postgresql- 10.7 - 2 -windows-x64.exe --help Windows安裝程式主要有EnterpriseDB與BigSQL兩種。BigSQL版本安裝元件是透過網路下載且支援參數不如EnterpriseDB版本多,以我們需求來說,我們傾向於使用EnterpriseDB版本。接下來分享給大家安裝與反安裝方法。 Installation @ echo off set INSTALL_DIR =C:\postgres10 set INSTALLER =postgresql- 10.7 - 2 -windows-x64.exe   rem options for installation set SSMDB_SERVICE =postgresql- 10 set MODE =--unattendedmodeui none --mode unattended   set DB_PASSWD =--superpassword postgres set DB_PORT =--serverport 5432   set SERVICE_NAME =--servicename % SSMDB_SERVICE %   set PREFIX =--prefix "%INSTALL_DIR%" set DATA_DIR =--datadir "%INSTALL_DIR%\data"   set OPTIONS =

How to install RIDE on Windows?

Introduction 多年沒在Windows上開發RobotFramework,趁著這次整理一下RIDE安裝方法。 目前RIDE最新版本與Python對應版本如下: (3.6 < python <= 3.11) Install current released version (2.0.8.1) with: pip install -U robotframework-ride 安裝Python 直接到Python官網找尋最新的3.11版本,我使用3.11.9: link 。安裝就是一直下一步而已。 安裝wxPython 每次安裝RIDE最困難的都是wxPython。看了一下 官網 描述,我就姑且相信一下: 接著進入下 載頁面 就有安裝教學。基本上就是到Python目錄下的Scripts直接執行以下command: pip install -U wxPython 安裝RIDE 接著就如RIDE官網所說,執行以下command: pip install -U robotframework-ride 啟動RIDE 直接在相同目錄下執行ride就可以啟動了,你也可以直接在桌面建ride連結,加快下次啟動時間。 沒想到這次這麼順利就安裝完成了。因為我是使用java去啟動robot framework,就不特別講要怎麼使用pip安裝robot framework了。

Hello World!

即將要搬家,因此舊網頁內容將慢慢轉移至Blogger。 如果要存取舊網頁,可以使用以下連結: https://wiki.tonylin.idv.tw/dokuwiki/doku.php