跳到主要內容

CompletableFuture - It may be useful to build chain of actions before execution.

Problem

下方這隻程式在Java8中應是相當常見:

CompletableFuture.supplyAsync(()->{
	dumpCurrentThreadName("supplyAsync");
	return new Response();
}).whenComplete((response, ex)->{
	dumpCurrentThreadName("whenComplete");
	// process response
});

它的問題是如果supplyAsync中的工作,在執行whenComplete前就結束了;當執行whenComplete時,有可能會使用client thread去執行工作而影響到工作接收的速度。以下是我的執行結果:

ForkJoinPool.commonPool-worker-3: supplyAsync
main: whenComplete

假如你的callback chain很長,遇到這個情況的機率就會越高。

How to resolve?

面對這個問題,在Java9中,允許你將實際的執行工作放到callback chain之後:

CompletableFuture<Response> asyncJob = new CompletableFuture<>();
 
asyncJob.whenComplete((response, ex)->{
	dumpCurrentThreadName("whenComplete");
});
 
asyncJob.completeAsync(()->{
	dumpCurrentThreadName("supplyAsync");
	return new Response();
});

輸出結果如下:

ForkJoinPool.commonPool-worker-3: supplyAsync
ForkJoinPool.commonPool-worker-3: whenComplete

這樣可以避免client thread跑去執行原本預期要async的工作,而增加了client thread的回應速度。

至於Java8目前我使用下面方式來達到lazy launch:

CompletableFuture<Response> asyncJob = new CompletableFuture<>();
job.thenApply((ret)->{
	dumpCurrentThreadName("supplyAsync");
	return new Response();rrentThreadName("runAsync");
 
}).whenComplete((response, ex)->{
	dumpCurrentThreadName("whenComplete");
});
 
CompletableFuture.runAsync(()->{
	asyncJob.complete(null);
})	

Test

我針對三種情況做測試,在whenComplete中會去計算submit時的context switch次數並delay 50ms,

  • 直接透過runAsync launch程式。
  • 透過JDK9 completeAsync lazy launch程式。
  • JDK8的lazy launch程式。

由於我使用common的pool,因此我在執行測試之前,會先叫起所有的thread,以避免第一個執行的需要去產生thread。以下是我的測試結果:

launchImmediately-submit: 306
launchImmediately-done: 1855
count for context swtching of submit operation: 6
launchLazilyJDK9-submit: 2
launchLazilyJDK9-done: 1656
count for context swtching of submit operation: 0
launchLazily-submit: 2
launchLazily-done: 1712
count for context swtching of submit operation: 0

可以發現,如果在submit時發生了Problem中所敘述的情況,將會延長client thread與整體工作時間;JDK9與JDK8的做法其實差異不大,不過JDK9的寫法更為簡潔且少產生中繼物件。


我附上測試程式碼供大家參考:

package org.tonylin.test.lambda.parallel.async;
 
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.atomic.AtomicInteger;
 
import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.junit.Test;
import org.tonylin.test.util.ThreadUtil;
 
public class TestLazyCompletableFuture {
 
	private int jobNum = 100;
	private long delayTime = 50;
	private List<CompletableFuture<Void>> jobs = new ArrayList<>();
	private AtomicInteger count = new AtomicInteger(0);
 
	@BeforeClass
	public static void classSetup(){
		ThreadUtil.disableLoggin();
		ThreadUtil.launchThreadsOfCommonPool();
	}
 
	@AfterClass
	public static void classTeardown(){
		ThreadUtil.enableLoggin();
	}
 
	private void countIfMainThread(){
		if(Thread.currentThread().getName().equals("main")){
			count.incrementAndGet();
		}
	}
 
	@Test
	public void launchImmediately(){
		long before = System.currentTimeMillis();
		for( int i = 0 ; i < jobNum ; i++ ) {
			CompletableFuture<Void> job = CompletableFuture.runAsync(()->{
				ThreadUtil.dumpCurrentThreadName("runAsync");
			}).whenComplete((ret,ex)->{
				countIfMainThread();
				ThreadUtil.dumpCurrentThreadName("whenComplete");
				ThreadUtil.sleep(delayTime);
			});		
			jobs.add(job);
		}
		dumpDuration("launchImmediately", before);
	}
 
	@Test
	public void launchLazily(){
		long before = System.currentTimeMillis();
		for( int i = 0 ; i < jobNum ; i++ ) {
			CompletableFuture<Void> job = new CompletableFuture<>(); 
			job.whenComplete((ret,ex)->{
				countIfMainThread();
				ThreadUtil.dumpCurrentThreadName("whenComplete");
				ThreadUtil.sleep(delayTime);
			});		
 
			jobs.add(CompletableFuture.runAsync(()->{
				ThreadUtil.dumpCurrentThreadName("runAsync");
				job.complete(null);
			}));
		}
		dumpDuration("launchLazily", before);
	}
 
	@Test
	public void launchLazilyJDK9() {
		long before = System.currentTimeMillis();
		for( int i = 0 ; i < jobNum ; i++ ) {
			CompletableFuture<Void> job = new CompletableFuture<>(); 
			job.whenComplete((ret,ex)->{
				countIfMainThread();
				ThreadUtil.dumpCurrentThreadName("whenComplete");
				ThreadUtil.sleep(delayTime);
			});		
 
			job.completeAsync(()->{
				ThreadUtil.dumpCurrentThreadName("runAsync");
				return null;
			});
 
			jobs.add(job);
		}
		dumpDuration("launchLazilyJDK9", before);
	}
 
	private void dumpDuration(String testCase, long before){
		long duration_submit = System.currentTimeMillis() - before;
		System.out.println(testCase+"-submit: " + duration_submit);
 
		CompletableFuture.allOf(jobs.toArray(new CompletableFuture[0])).join();
		long duration = System.currentTimeMillis() - before;
		System.out.println(testCase+"-done: " + duration);
		System.out.println("count for context swtching of submit operation: " + count);
	}
 
}
package org.tonylin.test.util;
 
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ForkJoinPool;
import java.util.concurrent.ForkJoinTask;
 
public class ThreadUtil {
	private static boolean logginEnabled = true;
 
	public static void dumpCurrentThreadName(String suffix) {
		if( logginEnabled )
			System.out.println(Thread.currentThread().getName() + ": " + suffix);
	}
 
	public static void launchThreadsOfCommonPool(){
 
		List<ForkJoinTask<?>> tasks = new ArrayList<>();
		for( int i = 0 ; i < ForkJoinPool.getCommonPoolParallelism(); i++){
			ForkJoinTask<?> task = ForkJoinPool.commonPool().submit(()->{
				sleep(100);
			});	
			tasks.add(task);
		}
		tasks.forEach(task->task.join());
	}
 
	public static void sleep(long duration){
		try {
			Thread.sleep(duration);
		} catch (InterruptedException e) {
			Thread.currentThread().interrupt();
			throw new RuntimeException(e);
		}
	}
 
	public static void enableLoggin(){
		logginEnabled = true;
	}
 
	public static void disableLoggin(){
		logginEnabled = false;
	}
}

Reference

留言

這個網誌中的熱門文章

Show NIC selection when setting the network command with the device option

 Problem  在answer file中設定網卡名稱後,安裝時會停在以下畫面: 所使用的command參數如下: network --onboot = yes --bootproto =dhcp --ipv6 =auto --device =eth1 Diagnostic Result 這樣的參數,以前試驗過是可以安裝完成的。因此在發生這個問題後,我檢查了它的debug console: 從console得知,eth1可能是沒有連接網路線或者是網路太慢而導致的問題。後來和Ivy再三確認,有問題的是有接網路線的網卡,且問題是發生在activate階段: Solution 我想既然有retry應該就有次數或者timeout限制,因此發現在Anaconda的說明文件中( link ),有提到dhcptimeout這個boot參數。看了一些人的使用範例,應該是可以直接串在isolinux.cfg中,如下: default linux ksdevice = link ip =dhcp ks =cdrom: / ks.cfg dhcptimeout = 90 然而我在RHEL/CentOS 6.7與6.8試驗後都無效。 因此我就拿了顯示的錯誤字串,問問Google大師,想找一下Anaconda source code來看一下。最後找到別人根據Anaconda code修改的版本: link ,關鍵在於setupIfaceStruct函式中的setupIfaceStruct與readNetConfig: setupIfaceStruct: 會在dhcp時設定dhcptimeout。 readNetConfig: 在writeEnabledNetInfo將timeout寫入dhclient config中;在wait_for_iface_activation內會根據timeout做retry。 再來從log與code可以得知,它讀取的檔案是answer file而不是boot command line。因此我接下來的測試,就是在answer file的network command上加入dhcptimeout: network --onboot = yes --bootproto =dhcp --ipv6 =auto --device =eth1 --dhcptimeo

解決RobotFramework從3.1.2升級到3.2.2之後,Choose File突然會整個Hand住的問題

考慮到自動測試環境的維護,我們很久以前就使用java去執行robot framework。前陣子開始處理從3.1.2升級到3.2.2的事情,主要先把明確的runtime語法錯誤與deprecate item處理好,這部分內容可以參考: link 。 直到最近才發現,透過SeleniumLibrary執行Choose File去上傳檔案的動作,會導致測試案例timeout。本篇文章主要分享心路歷程與解決方法,我也送了一條issue給robot framework: link 。 我的環境如下: RobotFramework: 3.2.2 Selenium: 3.141.0 SeleniumLibrary: 3.3.1 Remote Selenium Version: selenium-server-standalone-3.141.59 首先並非所有Choose File的動作都會hang住,有些測試案例是可以執行的,但是上傳一個作業系統ISO檔案一定會發生問題。後來我透過wireshark去比對新舊版本的上傳動作,因為我使用 Remote Selenium ,所以Selenium會先把檔案透過REST API發送到Remote Selenium Server上。從下圖我們可以發現,在3.2.2的最後一個TCP封包,比3.1.2大概少了500個bytes。 於是就開始了我trace code之路。包含SeleniumLibrary產生要送給Remote Selenium Server的request內容,還有HTTP Content-Length的計算,我都確認過沒有問題。 最後發現問題是出在socket API的使用上,就是下圖的這支code: 最後發現可能因為開始使用nio的方式送資料,但沒處理到尚未送完的資料內容,而導致發生問題。加一個loop去做計算就可以解決了。 最後我有把解法提供給robot framework官方,在他們出新的版本之前,我是將改完的_socket.py放在我們自己的Lib底下,好讓我們測試可以正常進行。(shutil.py應該也是為了解某個bug而產生的樣子..)

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了。