跳到主要內容

Jersey - Produce Json Result

網路上其實可以找到不少的教學,但實際操作起來應該還是會遇到設定與寫法上的問題。我就寫一下大概是怎麼完成的,我環境使用JDK7與Tomcat7,搭配Servlet 3.0,功能僅透過annotation就可完成。

Dependency

Server

除了Jercey本身自帶的那包jar檔外,server-side還需要jersey-media-json-jackson與jackson的jar。jersey-media-json-jackson可至Reference 2中找尋,jackson可至Reference 3中找尋。

Client

最簡單就是把所有server用到的jercey相關jar檔都丟過去。而我用到的jar檔有以下幾個: hk2-api*.jar、hk2-locator*.jar、hk2-utils*.jar、jackson-all*.jar、javax.annotation-api*.jar、javax.inject*.jar、javax.ws.rs-api*.jar、jercey-client.jar、jercey-common.jar、jercey-guava*.jar、jercey-media-json-jackson*.jar。

Implementation

Server

在Application中針對要提供此功能的package註冊JacksonFeature類別。

@ApplicationPath("auth")
public class AuthApplication extends ResourceConfig{
    public AuthApplication(){
        packages("org.tonylin.auth").register(JacksonFeature.class);
    }
}

Server預期接收form的post資料,內容為key,並產生Json回應給Client。

@Path("/tbattle")
public class TBattleAuthRS {	
    @Context ServletContext context;
 
    @POST
    @Produces(MediaType.APPLICATION_JSON)
    @Consumes(MediaType.APPLICATION_FORM_URLENCODED)
    public AuthResult auth(@FormParam("key") String key) {
    	AuthResult result = new AuthResult();
    	result.setAuthCode(key);
    	result.setResult(AuthResult.encodeResult(String.valueOf(containKey(key))));
        return result;
    }   
 
    // skip some functions code
}

Common Code 

要由物件轉成Json或由Json轉成物件的類別,必須Override toString,實做如底下範例程式碼。

public class AuthResult {
 
	public String toString() {
		StringBuffer sb = new StringBuffer();
		sb.append(" AuthCode: ").append(this.mAuthCode);
		sb.append(" Result: ").append(this.mResult);
		return sb.toString();
	}
 
	// skip some functions code
}

Client

Client要使用Jackson的功能,必須如Server-side做註冊的動作,再來就是直接對Server發送請求與接收回應。在回應的地方我們可以直接指定對應物件,讓Jackson幫我們做轉換,如果是一般字串則用String.class即可。

	private void auth(String aTarget, String aAuthCode) throws  AuthException{
		try {
			JerseyClient client = JerseyClientBuilder.createClient().register(
					JacksonFeature.class);
 
			JerseyWebTarget target = client.target(aTarget);
 
			Form form = new Form();
			form.param("key", aAuthCode);
 
			AuthResult result = target.request(MediaType.APPLICATION_JSON_TYPE)
					.post(Entity.entity(form,
							MediaType.APPLICATION_FORM_URLENCODED_TYPE),
							AuthResult.class);
 
			// skip implementation
 
		} catch( AuthException e ){
			throw e;
		} catch( Exception e ){
			throw new AuthException("Auth failed: "+e.getMessage(), e);
		}
	}

Summary

整體實做看起來相當容易,但我遇到最大的問題,是網路範例或Jercey使用手冊與實際不大相同的! 這是經過許多爬文與測試,才完成我所要的功能。此外,Json的輸出格式也許並不算完善。一個完善且優良的Rest API結果,還必須包含分頁內容、錯誤訊息處理,甚至Hyper-Media的內容等,這些是我還沒去研究該如何實做的! 目前僅知道可去Override Jackson的ObjectMapper去達到自己想要的格式化輸出。之後有時間會再繼續研究下去,又或者跳槽改去玩Spring的RS。

留言

這個網誌中的熱門文章

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