神奇好望角 The Magical Cape of Good Hope

          庸人不必自擾,智者何需千慮?
          posts - 26, comments - 50, trackbacks - 0, articles - 11
            BlogJava :: 首頁 ::  :: 聯(lián)系 :: 聚合  :: 管理

          JAX-RS 使用注解進(jìn)行配置,所以用它開發(fā) REST 風(fēng)格的服務(wù)非常簡單。樓主在本文用一個小例子來說明 JAX-RS 的基本用法。


          假設(shè)樓主要開發(fā)一個小電影服務(wù),客戶端可以通過請求 URI 對電影進(jìn)行 CRUD 操作。為簡明起見,這兒不使用數(shù)據(jù)庫,只在內(nèi)存中模擬。先用一個非常簡單的 Movie 類,在后續(xù)的文章中根據(jù)情況逐步擴(kuò)充:

                  public class Movie {
                      private int id;
                      private String title;
                      // 此處省略若干行
                  }
              

          嗯,就是一個很普通的 JavaBean,實(shí)際項目中可以根據(jù)需要加上 @Entity 等注解。接下來看看如何編寫 JAX-RS 服務(wù)。


          一個 JAX-RS 服務(wù)就是一個使用了 JAX-RS 注解來將 HTTP 請求綁定到方法的 Java 類,一共支持兩種類型:單請求對象或單例對象。單請求對象意味著每來一個請求,就創(chuàng)建一個服務(wù)對象,在請求結(jié)束時銷毀。單例對象則意味著只有一個服務(wù)對象處理所有的請求,從而可以在多個請求間維持服務(wù)狀態(tài)。JAX-RS 服務(wù)可通過繼承 javax.ws.rs.core.Application 來定義,其中的 getClasses 方法返回單請求對象的類型,getSingletons 方法返回單例對象的類型。這兩個方法是可選的。在 Java EE 6 環(huán)境中,如果這兩個方法都返回 null 或者空集合,那么應(yīng)用程序中的所有 JAX-RS 都將被部署。這時可以用 CDI 的 @javax.inject.Singleton 或者 EJB 的 @javax.ejb.Singleton 注解來指定單例對象。

          如果電影服務(wù)的上下文根路徑為 http://localhost/ms,而樓主希望將服務(wù)部署到 http://localhost/ms/rest 下面,只需要寫一個類:

                  @ApplicationPath("rest")
                  public class RestApplication extends Application {
                  }
              

          @ApplicationPath 注解指定所有服務(wù)的相對基址,如果為空字符串,則直接使用上下文根路徑。另一種配置方式是在 web.xml 文件中進(jìn)行聲明,那是為了使 JAX-RS 能在 Servlet 容器(例如 Tomcat)中運(yùn)行,此處略過。這項配置必不可少,否則無法部署服務(wù)。


          很好很強(qiáng)大,現(xiàn)在開始編寫電影服務(wù)類 MovieService,先看看聲明和初始化:

                  @Singleton
                  @Path("movie")
                  public class MovieService {
                      private AtomicInteger ai;
                      private ConcurrentMap<Integer, Movie> movieMap;
          
                      @PostConstruct
                      private void init() {
                          ai = new AtomicInteger();
                          movieMap = new ConcurrentHashMap<>();
                          int id = ai.getAndIncrement();
                          movieMap.put(id, new Movie().setId(id).setTitle("Avatar"));
                      }
              

          因?yàn)闃侵髦恍枰粋€“內(nèi)存數(shù)據(jù)庫”,所以用單例對象即可,此處使用 CDI 的 @javax.inject.Singleton 來聲明單例。@Path 聲明了一個服務(wù),它指示 MovieService 負(fù)責(zé)處理發(fā)送到 http://localhost/ms/rest/movie 的請求。路徑的拼接方式非常直觀。init 方法帶有 @PostConstruct 注解,因此將在 MovieService 構(gòu)造完成后立即調(diào)用,它向 movieMap 中存入了一個 ID 為 0 的 Movie 對象。為簡化代碼,Movie 的設(shè)置方法都返回 this,有點(diǎn)偽造構(gòu)建者模式的味道。


          接下來看看如何處理 HTTP 請求。

          GET

          GET 請求用于獲取一個或多個資源。在本例中用來獲取一部電影的信息:

                  @GET
                  @Path("{id}")
                  @Produces(MediaType.APPLICATION_JSON)
                  public Movie find(@PathParam("id") int id) {
                      Movie movie = movieMap.get(id);
                      if (movie != null) {
                          return movie;
                      } else {
                          throw new WebApplicationException(Response.Status.NOT_FOUND);
                      }
                  }
              

          該方法標(biāo)注了 @GET,表示用來處理向 http://localhost/ms/rest/movie/{id} 發(fā)送的 GET 請求。@Path 再次用來綁定路徑,注意其參數(shù) {id},它帶有花括號,對應(yīng) URI 的最后一段,也正好和方法參數(shù) id@PathParam 的值相對應(yīng)。這種參數(shù)還有很多高級用法,以后再介紹。@Produces 注解指定輸出格式為 JSON。JAX-RS 內(nèi)置了很多格式,詳見 MediaType 的文檔。如果找到了相應(yīng) ID 的對象,則將其返回,JAX-RS 會自動加上響應(yīng)碼 200 OK;否則拋出異常,錯誤碼為 404 Not Found。

          例如,通過瀏覽器訪問 http://localhost/ms/rest/movie/0,得到的結(jié)果為 {"@id":"0","@title":"Avatar"}。

          POST

          POST 請求用于創(chuàng)建一個資源。在本例中用來創(chuàng)建一部電影:

                  @POST
                  @Consumes(MediaType.APPLICATION_JSON)
                  public Response create(Movie movie) {
                      int id = ai.getAndIncrement();
                      movieMap.put(id, movie.setId(id));
                      return Response.created(URI.create(String.valueOf(id))).build();
                  }
              

          由于沒有 @Path 注解,所以 POST 請求的目標(biāo)就直接是 http://localhost/ms/rest/movie。Consumes@Produces 相反,表示接受的數(shù)據(jù)類型,此處 JAX-RS 會自動把 JSON 數(shù)據(jù)轉(zhuǎn)換為 Movie 對象。返回的響應(yīng)碼為 201 Created,并且?guī)в兴鶆?chuàng)建資源的 URI。

          例如,向 http://localhost/ms/rest/movie 發(fā)送 POST 請求,正文為 {"@title": "007"},則可以從 FireBug 的網(wǎng)絡(luò)監(jiān)控中看到返回的響應(yīng)碼,以及頭部中 Location 的值為 http://localhost:8080/rest/service/movie/1。多次發(fā)送該 POST 請求,將會創(chuàng)建多個資源,以保證 POST 不是冪等的。

          PUT

          PUT 請求用于創(chuàng)建或更新一個資源。與 POST 不同,PUT 請求要指定某個特定資源的地址。在本例中用來更新一部電影的信息:

                  @PUT
                  @Path("{id}")
                  @Consumes(MediaType.APPLICATION_JSON)
                  public Response update(@PathParam("id") int id, Movie movie) {
                      movie.setId(id);
                      if (movieMap.replace(id, movie) != null) {
                          return Response.ok().build();
                      } else {
                          throw new WebApplicationException(Response.Status.NOT_FOUND);
                      }
                  }
              

          更新成功就返回 200 OK,否則返回 404 Not Found。這兒先把 movie 對象的 ID 強(qiáng)制改為 URI 所指定的,以免出現(xiàn)不一致。也可以根據(jù)需求,將不一致作為異常處理,給客戶端返回一個錯誤碼。

          順便啰嗦一句,反正代碼在自己手中,樓主也可以把 PUT 搞成非冪等的,例如將 PUT 當(dāng)成 POST 來處理,就像以前把 GET 和 POST 一視同仁那樣。不過咱既然在搞 JAX-RS,就還是要沾染一點(diǎn) REST 風(fēng)格,嚴(yán)格遵守 HTTP 才是。

          DELETE

          DELETE 請求用于刪除一個資源。在本例中用來刪除一部電影:

                  @DELETE
                  @Path("{id}")
                  public Response delete(@PathParam("id") int id) {
                      if (movieMap.remove(id) != null) {
                          return Response.ok().build();
                      } else {
                          throw new WebApplicationException(Response.Status.NOT_FOUND);
                      }
                  }
              

          沒什么特別的,該說的前面都說了。

          HEAD 和 OPTIONS 請求就忽略吧,用得不太多,也同樣挺簡單的。


          JAX-RS 服務(wù)的部署和部署常規(guī) Web 程序一樣,打包成 war 文件就可以了。最后贊一下 NetBeans 可以為 REST 風(fēng)格的服務(wù)自動生成測試頁面,很好用,雖然在 Firefox 下頁面顯示不正常(對此我已經(jīng)提了一個 bug),但 IE 是可以的。


          評論

          # re: JAX-RS 從傻逼到牛叉 2:開發(fā)一個簡單的服務(wù)[未登錄]  回復(fù)  更多評論   

          2013-06-13 18:29 by ddd
          ffffff

          # re: JAX-RS 從傻逼到牛叉 2:開發(fā)一個簡單的服務(wù)  回復(fù)  更多評論   

          2013-11-12 09:41 by 飛過天涯海角
          lz,我昨天跑了一下你的代碼,在jax-rs中@Singleton是沒用的,每次訪問movie的時候,都會新建一個movieService對象,movieMap也會被重新初始化,沒法作為內(nèi)存數(shù)據(jù)庫來使用。

          # re: JAX-RS 從傻逼到牛叉 2:開發(fā)一個簡單的服務(wù)  回復(fù)  更多評論   

          2014-01-07 11:49 by zihang_Wu
          想問一下樓主,我的webservice還有一層接口,注解該加在哪里比較好啊
          主站蜘蛛池模板: 沂水县| 澄城县| 信阳市| 全椒县| 拉孜县| 霍邱县| 凯里市| 孟连| 图们市| 建湖县| 泗阳县| 康乐县| 扶沟县| 滨海县| 南江县| 锦州市| 五家渠市| 沁阳市| 密山市| 湖南省| 灌阳县| 沧源| 东明县| 二连浩特市| 乡城县| 周至县| 宝清县| 四平市| 繁昌县| 宣城市| 昌图县| 岫岩| 册亨县| 府谷县| 南宁市| 邓州市| 集安市| 故城县| 黄平县| 夏津县| 迁安市|