跳到主要內容

RESTEasy - How to fetch raw message after the request is failed?

Problem

RESTEasy jackson provider讓我們可以輕鬆的將第三方服務回應的json內容,轉成我們自己的物件,讓程式碼只專注於資源物件的操作;然而,第三方服務並非永遠都如你預期,它可能突然更新而吐出無法處理的訊息:

javax.ws.rs.ProcessingException: RESTEASY003145: Unable to find a MessageBodyReader of content-type text/html;charset=iso-8859-1

我有幸遇到這樣的問題,也讓我思考著該如何將原始資料記錄下來以回報第三方服務提供者。本篇文章分享可能的作法,可依照你的需求自行挑選。

(完整程式內容可以從github上clone: link)

How to resolve?

ReadInterceptor & InputStreamSniffer

一開始遇到這個問題時,我的想法是: 是否可以透過interceptor去處理? 我所提供的第一個方法,是註冊一個ReadInterceptor,並且wrap原始的InputStream,將讀取的內容給記錄下來。首先是ReaderInterceptor,它會從Context中取出InputStream,並將其wrap成InputStreamSniffer,待讀取流程執行後,就可以透過getReadContent去拿到讀取的內容:

@Provider
public class SnifferReadInterceptor implements ReaderInterceptor {
 
	private InputStreamSniffer inputStreamSniffer = null;
 
	@Override
	public Object aroundReadFrom(ReaderInterceptorContext context) throws IOException, WebApplicationException {
		InputStream inputStream = context.getInputStream();
 
		inputStreamSniffer = new InputStreamSniffer(inputStream);
		context.setInputStream(inputStreamSniffer);
 
		return context.proceed();
	}
 
	public String getReadContent(){
		return inputStreamSniffer.getContent();
	}
}

InputStreamSniffer則是將讀取的動作delegate給原始的InputStream,並悄悄地記下讀取內容:

public class InputStreamSniffer extends InputStream {
 
	private InputStream srcInputStream;
	private StringBuilder contentStringBuilder;
 
	public InputStreamSniffer(InputStream inputStream){
		srcInputStream = inputStream;
		contentStringBuilder = new StringBuilder();
	}
 
	@Override
	public int read() throws IOException {
		int read_c = srcInputStream.read();
		contentStringBuilder.append((char)read_c);
		return read_c;
	}
	// .. skip

我簡單的寫了一個測試,想要確認將message轉為json物件發生問題時,readInterceptor是否可以拿到message:

@Test
public void testSnifferReadInterceptorWithReadFailed(){
	Invocation invocation = initInvocation();
 
	Response response = null;
	try {
		response =  invocation.invoke();
		response.readEntity(TestModel.class);
		fail("should be failed	");
	} catch( ProcessingException e ) {
		// Can't find valid messageBodyReader
		assertTrue(readInterceptor.getReadContent().isEmpty());
	} finally {
		response.close();
	}
}

答案是不行,這是由於RESTEasy在讀取訊息前,會先根據Response Header中宣告的MediaType去找尋是否有對應的MessageBodyRead。

Read All Content of ReadInterceptor

由於我們無法於執行過程中解決這個問題,因此改在ReadInterceptor中,先將所有內容讀出來:

public class DebugReadInterceptor  implements ReaderInterceptor{
 
	private String content;
 
	@Override
	public Object aroundReadFrom(ReaderInterceptorContext context) throws IOException, WebApplicationException {
		InputStream inputStream = context.getInputStream();
		content = IOUtils.toString(inputStream);
 
		context.setInputStream(new ByteArrayInputStream(content.getBytes()));
		return context.proceed();
	} 
 
	public String getContent(){
		return content;
	}
}

這個方法是可以解決目前遇到的問題,但缺點是每次請求都一定會多處理一次內容。於是我把腦筋動到了MessageBodyReader身上。

Customized MessageBodyReader

我新增一個名為CompositeMessageBodyProvider的類別,去implement MessageBodyReader;isReadable永遠回傳true,將搜尋合適MessageBodyReader動作交由readFrom處理,如果找不到就丟ProcessingException上去。Client可以攔截此例外決定要處理的方式:

@Provider
@Consumes(MediaType.WILDCARD)
@Produces(MediaType.WILDCARD)
public class CompositeMessageBodyProvider implements MessageBodyReader<Object>, MessageBodyWriter<Object> {
 
	private List<MessageBodyReader<Object>> messageBodyReaders = new ArrayList<>();
 
	@Override
	public boolean isReadable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
		return true;
	}
 
	private Optional<MessageBodyReader<Object>> findReader(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType){
		return messageBodyReaders.stream().filter(writter->writter.isReadable(type, genericType, annotations, mediaType)).findAny();
	}
 
	@Override
	public Object readFrom(Class<Object> type, Type genericType, Annotation[] annotations, MediaType mediaType,
			MultivaluedMap<String, String> httpHeaders, InputStream entityStream)
			throws IOException, WebApplicationException {
 
		Optional<MessageBodyReader<Object>> reader = findReader(type, genericType, annotations, mediaType);
		if(reader.isPresent()){
			return reader.get().readFrom(type, genericType, annotations, mediaType, httpHeaders, entityStream);
		}
 
		String output = IOUtils.toString(entityStream);
		throw new ProcessingException("Unexpected content: " + output);
	}
	// .. skip

Summary

以parse error、unexpected media type與unexpected json content(parse ok)三種錯誤來說:

  1. ReadInterceptor & InputStreamSniffer: 適用於parse error與unexpected json content。
  2. Read All Content of ReadInterceptor: 適用於以上提及的所有錯誤情形,但效率較差。
  3. Customized MessageBodyReader: 適用於unexpected media type。

要使用哪種方式,可仔細評估後再決定。

留言

這個網誌中的熱門文章

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