跳到主要內容

Apache Camel - Aggregator Hello World

Introduction

Camel Aggregator提供開發人員能夠將大量訊息合成一個的功能。假設你的系統會接受外來通知，並將內容寫進資料庫中；一次連線寫一筆資料會比較快，還是透過一次連線寫入五筆資料快呢? 正常來說，一次連線寫入五筆同屬性資料會是比較快的。它與Throttler的最大區別在於，Throttler限制了client的請求，而Aggregator則是收集起來一次“後送”。因此，如果使用Aggregator，你的程式必需要有對應的處理方式。


我將透過HTTP GET請求/events/{id}做為範例，說明如何使用Aggregator去將單位時間內的請求，以{id}去分組並Aggregate成各別分組訊息。本篇文章中使用到兩個RouteBuilder，分別為RestRouteBuilder與AggregatorGroupRouteBuilder。RestRouteBuilder負責REST核心相關設定，可參考先前文章。接下來直接說明AggregatorGroupRouteBuilder。

(程式碼可參考link)

AggregatorGroupRouteBuilder

package org.tonylin.practice.camel.aggregator;
 
import static com.google.common.base.Preconditions.checkState;
 
import org.apache.camel.builder.RouteBuilder;
import org.apache.camel.processor.aggregate.GroupedExchangeAggregationStrategy;
 
public class AggregatorGroupRouteBuilder extends RouteBuilder {
 
	private final static String GET_EVENTS = "GET_EVENTS";
 
	private Object eventHandler;
	private int period = 500;
 
	public AggregatorGroupRouteBuilder(Object eventHandler) {
		this.eventHandler = eventHandler;
 
	}
 
	public void setPeriod(int period) {
		this.period = period;
	}
 
	@Override
	public void configure() throws Exception {
		checkState(eventHandler!=null, "Can't find eventHandler");
 
		rest("/events/{id}").get().route().id(GET_EVENTS)
		.aggregate(new GroupedExchangeAggregationStrategy())
		.header("id")
		.completionInterval(period)
		.bean(eventHandler).endRest();
	}
}

以下是在configure中的幾個重點:

  • aggregate(new GroupedExchangeAggregationStrategy()): 使用GroupedExchangeAggregationStrategy去做aggregate，aggregate的內容為Exchange。如果要加入條件限制，是以Exchange去操作。
  • header(“id”): 與aggregate一起使用，代表以header id去分組。在這範例中，指得就是event id。
  • completionInterval(period): 以每period的單位時間去做aggregate。
  • bean(eventHandler): 請求的處理者，必須要有能力處理aggregate後的訊息。

接下來讓我們透過單元測試展示效果。

Unit Test

測試有兩個目標，testGroupedExchange用以確認aggregate group後的結果，另外一個testCompletionInterval則是確認單位時間設定的作用。以下為程式碼主要結構，主要測試程式碼稍後做說明:

package org.tonylin.practice.camel.aggregator;
 
import static com.google.common.base.Preconditions.checkState;
 
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
import java.util.stream.Collectors;
 
import org.apache.camel.Exchange;
import org.apache.camel.Handler;
import org.apache.camel.RoutesBuilder;
import org.apache.camel.test.junit4.CamelTestSupport;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.HttpClientBuilder;
import org.junit.Test;
import org.tonylin.practice.camel.rest.RestRouteBuilder;
 
public class AggregatorGroupRouteBuilderTest extends CamelTestSupport  {
 
	private RestHandler hander = new RestHandler();
 
	private HttpClient client = HttpClientBuilder.create().build();
 
	@Override
	protected RoutesBuilder[] createRouteBuilders() throws Exception {
		AggregatorGroupRouteBuilder aggregatorGroupRouteBuilder = new AggregatorGroupRouteBuilder(hander);
		aggregatorGroupRouteBuilder.setPeriod(500);
 
		return new RoutesBuilder[] {
				new RestRouteBuilder(),
				aggregatorGroupRouteBuilder
		};
	}
 
	@Test
	public void testGroupedExchange() throws Exception {
		// skip
	}
	@Test
	public void testCompletionInterval() throws Exception {
		// skip
	}
}

此測試中的RestHandler程式碼如下，它會透過GROUPED_EXCHANGE取得aggregator處理後的內容，並根據header id儲存到map中，供測試程式碼做assertion。除此之外，在這裡使用CountDownLatch了去確認有收到預期訊息數量:

public static class RestHandler {
	private Map<String, List<Exchange>> requestData = new ConcurrentHashMap<String, List<Exchange>>();
	private CountDownLatch countDownLatch;
 
	@SuppressWarnings("unchecked")
	@Handler
	public void handle(Exchange exchange) {
		List<Exchange> groupExchanges = exchange.getProperty(Exchange.GROUPED_EXCHANGE, List.class);
		String id = groupExchanges.get(0).getIn().getHeader("id", String.class);
		requestData.put(id, groupExchanges);
 
		if( countDownLatch != null )
			countDownLatch.countDown();
	}
 
	public Map<String, List<Exchange>> getRequestData(){
		return requestData;
	}
 
	public void expectNum(int num) {
		countDownLatch = new CountDownLatch(num);
	}
 
	public void waitCompletion(int timeout) throws InterruptedException {
		checkState(countDownLatch!=null);
		countDownLatch.await(timeout, TimeUnit.MILLISECONDS);
	}
 
	public void clear() {
		requestData.clear();
	}
}

首先讓我說明testGroupedExchange。測試程式碼中，送了四個訊息，其中包含了三組不同id；這樣的請求，我們預期RestHandler中，總共會收到三組訊息，其中id 123那組，應包含兩個訊息:

private HttpResponse requestWithEventId(String id) {
	try {
		HttpGet httpGet = new HttpGet("http://localhost:8080/events/" + id);
		return client.execute(httpGet);
	} catch( Exception e ) {
		throw new RuntimeException(e);
	}
}
 
@Test
public void testGroupedExchange() throws Exception {
	// given request event id
	List<String> eventIds = Arrays.asList("123", "123", "456", "789");
	hander.expectNum(3);
 
	// when
	List<HttpResponse> responses = eventIds.parallelStream().map(this::requestWithEventId).collect(Collectors.toList());
 
	// then
	responses.forEach(response->{
		assertEquals(200, response.getStatusLine().getStatusCode());
	});
 
	hander.waitCompletion(1000);
 
	Map<String, List<Exchange>> requestData = hander.getRequestData();
	assertEquals(3, requestData.size());
	assertEquals(2, requestData.get("123").size());
	assertEquals(1, requestData.get("456").size());
	assertEquals(1, requestData.get("789").size());
}

從上述程式碼中，可以發現hander.waitCompletion(1000)是放在確認response之後；所以client只要將訊息發送到aggregator後，就會拿到response code，並不會等到全部處理結束才回去。 接著是testCompletionInterval。這裡我直接透過請求相同id兩次，並分兩輪送出。這樣做可以確認aggregator有做到根據completionInterval的分批效果:

private void requestTwiceWithId(String id) throws Exception {
	// request event {id} twice
	List<String> eventIds = Arrays.asList(id, id);
	hander.expectNum(1);
	List<HttpResponse> responses = eventIds.parallelStream().map(this::requestWithEventId).collect(Collectors.toList());
	responses.forEach(response->{
		assertEquals(200, response.getStatusLine().getStatusCode());
	});
 
	hander.waitCompletion(1000);
 
	// confirm request result
	Map<String, List<Exchange>> requestData = hander.getRequestData();
	assertEquals(1, requestData.size());
	assertEquals(2, requestData.get("123").size());
 
	// clear first request data
	hander.clear();
	assertTrue(hander.getRequestData().isEmpty());
}
 
@Test
public void testCompletionInterval() throws Exception {
	requestTwiceWithId("123");
	requestTwiceWithId("123");
}

Camel Aggregator其實提供了很多細部操作，你也可以根據自身需求做AggregationStrategy；但時間有限，請容我以後有機會再分享。

Library Info (Gradle Config)

以下是我在寫這篇文章時，所使用的libraries版本:

ext {
	camelVersion='2.23.1'
	nettyAllVersion='4.1.34.Final'
	guavaVersion='27.1-jre'
	log4jVersion='1.2.17'
	slf4jVersion='1.7.26'
	httpClientVersion='4.5.7'
}

dependencies {
    compile group: 'org.apache.camel', name: 'camel-core', version: "$camelVersion"
    compile group: 'org.apache.camel', name: 'camel-netty4-http', version: "$camelVersion"
    compile group: 'org.apache.camel', name: 'camel-http-common', version: "$camelVersion"
    compile group: 'org.apache.camel', name: 'camel-netty4', version: "$camelVersion"
    compile group: 'io.netty', name: 'netty-all', version: "$nettyAllVersion"
    compile group: 'com.google.guava', name: 'guava', version: "$guavaVersion"
    compile group: 'log4j', name: 'log4j', version: "$log4jVersion"
    compile group: 'org.slf4j', name: 'slf4j-api', version: "$slf4jVersion"
    runtime group: 'org.slf4j', name: 'slf4j-log4j12', version: "$slf4jVersion"
    testCompile group: 'org.apache.camel', name: 'camel-test', version: "$camelVersion"
    testCompile group: 'org.apache.httpcomponents', name: 'httpclient', version: "$httpClientVersion"
    testCompile 'junit:junit:4.12'
}

Reference

標籤：

留言

張貼留言

這個網誌中的熱門文章

解決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而產生的樣子..)
張貼留言
閱讀完整內容

第一次寫MIB就上手

SNMP(Simple Network Management Protocol)是用來管理網路設備的一種Protocol，我對它的認識也是從工作接觸開始。雖說是管理網路設備，但是主機、電源供應器、RAID等也都可以透過它來做管理。如果你做了一個應用程式，當然所有的操作也都可以透過SNMP來完成，不過可能會很痛苦。前陣子遇到一個學弟，它告訴我說:「我可能不會想寫程式。」為什麼? 因為這是他痛苦的根源。 在這篇文章中，不是要告訴你SNMP是什麼，會看這篇文章的大哥們，應該已經對SNMP有些認識了。 是的!主題是MIB(Management information base)! 對於一個3th-party的SNMP oid，有MIB可以幫助你去了解它所提供的資訊是什麼，且可以對它做什麼操作。最近我運氣很好剛好做到關於修改MIB的工作，也讓我順便了解一下它的語法，接下來我要交給大家MIB的基礎認識。 smidump 我並非使用什麼高強的Editor去編寫MIB，我僅透過Nodepad++編輯和smidump編譯而已。smidump是Kay教我使用的一個將MIB module轉成樹狀結構或oid列表的工具，唯一的缺點是不會告訴你哪一行打錯。當然有錢直接買編輯樹狀結構的工具就可以不需要了解語法了! 安裝 在Ubuntu上可先輸入smidump確認是否安裝，如果沒安裝可透過apt-get install libsmi2ldbl安裝。(CentOS可以透過yum install libsmi) root@tonylin:~/multi-boot-server# smidump The program 'smidump' is currently not installed. You can install it by typing: apt-get install libsmi2ldbl 使用 透過下面兩行指令，就可以將mib file產生出對應的tree與oid列表的檔案。也可以透過這個結果確認MIB是不是你想要的。 smidump -f tree example1.mib > xtree.txt smidump -f identifiers example1.mib > xiden.txt 如果有參考其它檔案要加上p的參數: smidum...
張貼留言
閱讀完整內容

Windows DLL - 32-bit dll with 64-bit driver

前言 在64-bit作業系統上所使用的驅動程式，一定是64-bit，然而應用程式卻可能是32或64-bit。當32-bit應用程式傳值給驅動程式時是有可能會發生溢位的。主要原因是32與64-bit指標所佔用記憶體長度的不同。接下來我將透過Reference 1中的程式PhyMem，來告訴大家問題在哪與如何修改。(最後改完的程式碼恕我不提供) PhyMem介紹 這是一個中國人寫的程式。作用與WinIO相同，可以存取windows的io port與physical memory。這個程式包含pmdll、driver與test三個專案，分別產生dll、sys與exe。作者僅提供32-bit的版本，但只要修改編譯設定就可以讓它產生出64-bit的artifact。但如同我前言所說，如果你是32-bit的dll要存取64的sys該怎麼辦? 可以規定User在64-bit的OS用64-bit的應用程式就好了阿! 但是將一個32-bit應用程式改為64-bit的有這麼簡單嗎? 除此之外，中間傳遞的資料型態也會影響到正常功能。 設定driver專案 我開發環境是VC2008與DDK6000，下載Reference1的專案是無法直接編譯的，可以參考我的設定去修改編譯、連結參數。輸出檔可以看個人需求，根據32或64命名，或者是用同一個檔案名稱。 32-bit C/C++ > 一般 > 其它Include目錄($(DDKROOT)為設定於環境變數的DDK安裝目錄): $(DDKROOT)\inc\ddk";"$(DDKROOT)\inc\api";"$(DDKROOT)\inc\crt";"$(DDKROOT)\inc\crt\gl";"$(DDKROOT)\inc\crt\sys" 連結器 > 一般 > 其它程式庫目錄: $(DDKROOT)\lib\wnet\i386。 連結器 > 資訊清單檔: 將產生資訊清單與UAC選擇否，因為這不適用於driver。 連結器 > 進階 > 隨機化的基底位置: 選擇預設。 64-bit Reference1僅提供32-bit設定。64-bit可在建置>組態管理員中，新增x64平台，而設定檔可從win32複製過來修...
張貼留言
閱讀完整內容