在 Eclipse 利用 RESTEasy 開發 Restful 服務

在 Eclipse 中開發 Restful 應用,

完整步驟, 參考如下 :

1) 建立 Maven Project

在 Eclipse 中, 新增一個 Maven Project :


預設選項即可 :


輸入 webapp 過濾項目, 選擇 maven-archetype-webapp :


輸入 Group Id, Artifact Id, 以及 Package Name :
(其中 Artifact Id 是 Project Name, 也是 URL 中的虛擬路徑)


2) 設定 Maven Dependency

Maven 增加 Dependency :


輸入以下值, 用來增加 Resteasy 相關套件 :


將專案做一次 Build Project, 讓上一步驟 Resteasy 相關套件載入進來, 若 Maven Repository 沒有這些套件, 也會自動從網路進行下載 :


Maven Dependencies 結果, 如下 :


3) 新增 Restful Java 程式

Maven Project src 預設只有 webapp, 所以, 請先手動建立 java 目錄, Maven Project 會自動呈現 src/main/java 的 Package Folder :


新增兩個 Package, 結尾各為 .app 與 .service :
(不一定要有兩個 Package, 也不一定要這兩個名稱, 上面這麼做, 只是便於區分功能)


新增兩個 Restful Java 程式 :


這個 Java 程式用來註冊 Restful Service :

 程式碼

public class HelloWorldApplication extends Application
{
    private Set<Object> singletons = new HashSet<Object>();
  
    public HelloWorldApplication()
    {
        singletons.add(new HelloWorldRestService());
    }
  
    @Override
    public Set<Object> getSingletons()
    {
        return singletons;
    }
}

這個是提供 Restful Service 的 :

 程式碼

@Path("/hello")
public class HelloWorldRestService
{
    @GET  
    @Path("/{param}")  
    public Response getName(@PathParam("param") String name)
    {
        String result = "Hello " + name;
        return Response.status(200).entity(result).build();
    }
}

4) 設定 web.xml

開啟 web.xml 檔案 :


設定以下內容, 注意畫底線的部分, 其中第 1 部分是指定 "註冊 Restful Service 的 Java 程式" :


5) 執行 Restful Service

在 Maven Project 執行 Run As / Run on Server, 選擇一個 Web Server 即可 :


若輸入的 URL 不正確, 讓 Restful Java 程式無法正確解析, 則會出現下面錯誤訊息 :


輸入正確的 URL, 範例結果, 如下 :


另外, JAXRS 透過 annotation 對應 Java Class 與 Http 關係, 詳細內容: http://www.codedata.com.tw/java/java-restful-2-jersey-and-jax-rs/

結論: 利用 Resteasy 實現 Restful Service, 是不是如其名, 相當容易喔.

昭佑.天翔