跳到主要內容

Apache Camel - Throttler Hello World

Introduction

在設計web應用程式時，有時會需要一個節流器，去幫我控制單位時間內能處理的請求數量，以避免過載；又或者是要根據不同使用者所買的授權，去控制單位時間內能呼叫的API次數等。Camel提供了Throttler，讓我們能輕鬆透過設定，去達到這些效果。

我將透過HTTP GET請求/events/{id}做為範例，說明如何使用Throttler。首先介紹這個範例中的兩個RouteBuilder。

(程式碼可參考link)

RestRouteBuilder

REST核心設定集中在這個builder中，它負責宣告用什麼port與component去建立REST服務:

package org.tonylin.practice.camel.rest;
 
import org.apache.camel.builder.RouteBuilder;
import org.apache.camel.model.rest.RestBindingMode;
 
public class RestRouteBuilder extends RouteBuilder {	
 
	@Override
	public void configure() throws Exception {
		restConfiguration().component("netty4-http").port(8080).bindingMode(RestBindingMode.auto).endpointProperty("ssl",  "false");
	}
}

(我以http當範例，如果對https用法有興趣，可以參考這篇)

ThrottlerRouteBuilder

接下來是今天的主角，我先列出程式碼內容，後面再針對重點configure做說明:

package org.tonylin.practice.camel.throttler;
 
import static com.google.common.base.Preconditions.checkState;
 
import org.apache.camel.Exchange;
import org.apache.camel.Processor;
import org.apache.camel.builder.RouteBuilder;
import org.apache.camel.processor.ThrottlerRejectedExecutionException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
 
public class ThrottlerRouteBuilder extends RouteBuilder {
	private static Logger logger = LoggerFactory.getLogger(ThrottlerRouteBuilder.class);
	private final static String GET_EVENTS = "GET_EVENTS";
 
	private Object eventHandler;
 
	private int limit = 2;
	private int period = 200;
 
	public ThrottlerRouteBuilder(Object eventHandler) {
		this.eventHandler = eventHandler;
 
	}
 
	public void setLimit(int limit) {
		this.limit = limit;
	}
 
	public void setPeriod(int period) {
		this.period = period;
	}
 
	@Override
	public void configure() throws Exception {
		checkState(eventHandler!=null, "Can't find eventHandler");
 
		onException(ThrottlerRejectedExecutionException.class)
		.process(new Processor() {
			@Override
			public void process(Exchange exchange) throws Exception {
				logger.debug("handle ThrottlerRejectedExecutionException");
				exchange.getOut().setHeader(Exchange.HTTP_RESPONSE_CODE, "503");
			}
		})
		.handled(true);
 
		rest("/events/{id}").get().route().id(GET_EVENTS)
		.throttle(limit)
		.timePeriodMillis(period)
		.rejectExecution(true)
		.bean(eventHandler).endRest();
	}
}

我首要說明的是throttler的configure:

rest("/events/{id}").get().route().id(GET_EVENTS)
	.throttle(limit)
	.timePeriodMillis(period)
	.rejectExecution(true)
	.bean(eventHandler).endRest();

除了HTTP GET的宣告外，這些程式碼代表著以下意義:

  • throttle(limit): 限制的存取次數。
  • timePeriodMillis(period): 限制存取次數的單位時間，預設是1000ms。
  • rejectExecution(true): 當超過此限制時，是否要reject請求，預設為false。假如沒reject，後續超過限制的請求會block至單位時間後執行。
  • bean(eventHandler): 請求的處理者。

在我設定rejectExecution為true後，我發現camel會拋出ThrottlerRejectedExecutionException，且client會block住；因此這個設定必須與camel的errorHandler一同使用，這是我的使用範例:

onException(ThrottlerRejectedExecutionException.class)
	.process(new Processor() {
		@Override
		public void process(Exchange exchange) throws Exception {
			logger.debug("handle ThrottlerRejectedExecutionException");
			exchange.getOut().setHeader(Exchange.HTTP_RESPONSE_CODE, "503");
		}
	})
.handled(true);

我宣告當發生ThrottlerRejectedExecutionException例外時，會將回應給client的response code設為503以代表server過載。除此之外，別忘記把handled設為true，代表例外已被處理。

Unit Test

最後我以單元測試來展示效果，包含testOverload與testThrottlePeriod兩個測試；而throttler的limit為2，period為200ms，testcase會在後面做說明:

package org.tonylin.practice.camel.throttler;
 
import java.util.ArrayList;
import java.util.List;
 
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.RestHandler;
import org.tonylin.practice.camel.rest.RestRouteBuilder;
 
public class ThrottlerRouteBuilderTest extends CamelTestSupport {
 
	private RestHandler hander = new RestHandler();
	private static final int limit = 2;
	private static final int period = 200;
 
	private HttpClient client = HttpClientBuilder.create().build();
	private HttpGet httpGet = new HttpGet("http://localhost:8080/events/123");
 
	@Override
	protected RoutesBuilder[] createRouteBuilders() throws Exception {
		ThrottlerRouteBuilder throttlerRouteBuilder = new ThrottlerRouteBuilder(hander);
		throttlerRouteBuilder.setLimit(limit);
		throttlerRouteBuilder.setPeriod(period);
 
		return new RoutesBuilder[] {
				new RestRouteBuilder(),
				throttlerRouteBuilder
		};
	}
 
	private List<HttpResponse> batchRequest(int times) throws Exception {
		List<HttpResponse> responses = new ArrayList<HttpResponse>();
		for( int i = 0 ; i < times ; i++ ) {
			responses.add(client.execute(httpGet));
		}
		return responses;
	}
 
	@Test
	public void testOverload() throws Exception {
		// skip
	}
 
	@Test
	public void testThrottlePeriod() throws Exception  {
		// skip
	}
}

測試中使用的RestHandler，負責收集請求的event id，用以確認請求內容是否正確:

public class RestHandler {
	private static Logger logger = LoggerFactory.getLogger(RestHandler.class);
	private List<String> requestIds = new ArrayList<String>();
 
	@Handler
	public void handle(Exchange exchange) {
		String requestId = exchange.getIn().getHeader("id", String.class);
		logger.debug("Request id: {}", requestId);
		requestIds.add(requestId);
	}
 
	public List<String> getRequestIds(){
		return requestIds;
	}
}

針對testOverload測試，是用來確認throttler單位時間內的請求是否有效；因此測試中，連續做了3次請求，最後會去確認這三次的請求結果是否正確:

@Test
public void testOverload() throws Exception {
	// when request 3 times
	List<HttpResponse> responses = batchRequest(3);
 
	// then
	assertEquals(2, hander.getRequestIds().size());
	assertEquals(200, responses.get(0).getStatusLine().getStatusCode());
	assertEquals(200, responses.get(1).getStatusLine().getStatusCode());
	assertEquals(503, responses.get(2).getStatusLine().getStatusCode());
}

而testThrottlePeriod測試，用以確認throttler單位時間是否有作用；因此測試中，會先發3次請求，再等待此單位時間後，再發3次請求。最後確認請求結果:

@Test
public void testThrottlePeriod() throws Exception  {
	// when
	List<HttpResponse> responses = batchRequest(3);
	Thread.sleep(period+1);
 
	responses.addAll(batchRequest(3));
 
	// then
	assertEquals(2, hander.getRequestIds().size());
	assertEquals(200, responses.get(0).getStatusLine().getStatusCode());
	assertEquals(200, responses.get(1).getStatusLine().getStatusCode());
	assertEquals(503, responses.get(2).getStatusLine().getStatusCode());
	assertEquals(200, responses.get(3).getStatusLine().getStatusCode());
	assertEquals(200, responses.get(4).getStatusLine().getStatusCode());
	assertEquals(503, responses.get(5).getStatusLine().getStatusCode());
}

透過這兩個測試範例，我們可以簡單地了解throttler的用法。

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複製過來修...
張貼留言
閱讀完整內容