REST 服務(wù)類型

Java RESTful

  • REST 服務(wù)類型

    在 REST 服務(wù)中,資源類是接收 REST 請求并完成響應(yīng)的核心類叉信,而資源類是由 REST 服務(wù)的“提供者[JAX-RS 2.0 定義的 javax.ws.rs.core.Application 以及 Servlet]”來調(diào)度的。

    Application 類,相當(dāng)于 JAX-RS 2.0 服務(wù)的入口伤为。作為應(yīng)用的入口袱耽,Application 需要知道具體的資源文件杀餐,可以通過包掃描或直接指定類文件的方式獲得.

    如果 REST 服務(wù)沒有自定義的 Application 子類,容器將默認(rèn)生成一個javax.ws.rs.core.Application 類朱巨。

    根據(jù)規(guī)范對 REST 服務(wù)場景的定義史翘,將 REST 服務(wù)分為 4 種類型:

    REST 服務(wù)類型示意圖
    • 類型一:相應(yīng)的邏輯,是服務(wù)中同時不存在 Application 的子類和 Servlet 的子類冀续。

      • servlet 2.x

          // pom
          <dependency>
              <groupId>org.glassfish.jersey.containers</groupId>
              <!-- jersey-container-servlet-core 不具備自動掃描資源類的功能琼讽。 -->
              <artifactId>jersey-container-servlet-core</artifactId>
          </dependency>
          
          // web.xml
          <servlet>
              <servlet-name>Jersey Web Application</servlet-name>
              <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
              <init-param>
                  <param-name>jersey.config.server.provider.packages</param-name>
                  <param-value>com.example</param-value>
              </init-param>
              <load-on-startup>1</load-on-startup>
          </servlet>
          <servlet-mapping>
              <servlet-name>Jersey Web Application</servlet-name>
              <url-pattern>/webapi/*</url-pattern>
          </servlet-mapping>
        
      • servlet 3.x

          // pom
          <dependency>
              <groupId>org.glassfish.jersey.containers</groupId>
              <!-- use the following artifactId if you don't need servlet 2.x compatibility -->
              <artifactId>jersey-container-servlet</artifactId>
          </dependency>
          
          // web.xml
          <servlet>
              <servlet-name>javax.ws.rs.core.Application</servlet-name>
          </servlet>
          <servlet-mapping>
              <servlet-name>javax.ws.rs.core.Application</servlet-name>
              <url-pattern>/webapi/*</url-pattern>
          </servlet-mapping>
        
    • 類型二:相應(yīng)的邏輯,是服務(wù)中不存在 Application 的子類洪唐,但存在 Servlet 的子類钻蹬。

      • 自定義 servlet 3.x 子類的場景

          // servlet 子類,繼承自 org.glassfish.jersey.servlet.ServletContainer
          @WebServlet(
          initParams = @WebInitParam(name = "jersey.config.server.provider.packages", value = "com.example"), 
          urlPatterns = "/webapi/*", 
          loadOnStartup = 1)
          public class AirServlet extends ServletContainer {
              private static final long serialVersionUID = 1L;
          }
          
          // pom.xml
          <plugin>
              <groupId>org.apache.maven.plugins</groupId>
              <artifactId>maven-war-plugin</artifactId>
              <version>2.3</version>
              <configuration>
                  <failOnMissingWebXml>false</failOnMissingWebXml>
              </configuration>
          </plugin>
          
          <dependency>
              <groupId>javax.servlet</groupId>
              <artifactId>javax.servlet-api</artifactId>
              <version>3.1.0</version>
              <scope>provided</scope>
          </dependency>
          <dependency>
              <groupId>org.glassfish.jersey.containers</groupId>
              <artifactId>jersey-container-servlet</artifactId>
          </dependency>
          
          // 無 web.xml 配置
        
    • 類型三:相應(yīng)的邏輯凭需,是存在Application的子類问欠,并定義了@ApplicationPath 注解。

      • servlet 2.x

           // 繼承自 Application 的子類 org.glassfish.jersey.server.ResourceConfig
           @ApplicationPath("/webapi/*")
           public class AirResourceConfig extends ResourceConfig {
           
               public AirResourceConfig() {
                   // 構(gòu)造中提供掃描包的全名「啟動后粒蜈,包內(nèi)資源類提供的資源路徑將被映射到內(nèi)存」
                   packages("com.example.s2x.c3");
               }
           }
           
           // pom.xml
           <dependencyManagement>
               <dependencies>
                   <dependency>
                       <groupId>org.glassfish.jersey</groupId>
                       <artifactId>jersey-bom</artifactId>
                       <version>${jersey.version}</version>
                       <type>pom</type>
                       <scope>import</scope>
                   </dependency>
               </dependencies>
           </dependencyManagement>
           
           <dependency>
               <groupId>org.glassfish.jersey.containers</groupId>
               <artifactId>jersey-container-servlet-core</artifactId>
           </dependency>
           
           // 需要定義 web.xml 顺献,但內(nèi)容可以是“空的”,只有 web-app 的基本定義
        
      • servlet 3.x
        // 繼承自 Application 類
        @ApplicationPath("/webapi/*")
        public class AirApplication extends Application {

               @Override
               public Set<Class<?>> getClasses() {
                   final Set<Class<?>> classes = new HashSet<Class<?>>();
                   classes.add(MyResource.class);
                   return classes;
               }
               
           }
           
           // pom.xml
           <dependency>
               <groupId>org.glassfish.jersey.containers</groupId>
               <artifactId>jersey-container-servlet</artifactId>
           </dependency>
           
           // 可以省略 web.xml
        
    • 類型四:相應(yīng)的邏輯枯怖,是“一有二無”:一有是存在 Application 的子類注整,二無是不存在 Servlet 子類、不存在或者不允許使用 @ApplicationPath 注解。

      • servlet 2.x

           // 繼承自 Application 類
           public class AirApplication extends Application {
               @Override
               public Set<Class<?>> getClasses() {
                   final Set<Class<?>> classes = new HashSet<Class<?>>();
                   classes.add(MyResource.class);
                   return classes;
               }
           }
           
           // web.xml
           <servlet>
               <servlet-name>Jersey Web Application</servlet-name>
               <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
               <init-param>
                   <param-name>javax.ws.rs.Application</param-name>
                   <param-value>com.example.AirApplication</param-value>
               </init-param>
               <load-on-startup>1</load-on-startup>
           </servlet>
           <servlet-mapping>
               <servlet-name>Jersey Web Application</servlet-name>
               <url-pattern>/webapi/*</url-pattern>
           </servlet-mapping>
           
           // pom.xml
           <dependency>
               <groupId>org.glassfish.jersey.containers</groupId>
               <artifactId>jersey-container-servlet-core</artifactId>
           </dependency>
        
      • servlet 3.x

              // 繼承自 Application 類
              public class AirApplication extends Application {
                  @Override
                  public Set<Class<?>> getClasses() {
                      final Set<Class<?>> classes = new HashSet<Class<?>>();
                      classes.add(MyResource.class);
                      return classes;
                  }
              }
              
              // web.xml
             <servlet>
                  <servlet-name>com.example.AirApplication</servlet-name>
              </servlet>
              <servlet-mapping>
                  <servlet-name>com.example.AirApplication</servlet-name>
                  <url-pattern>/webapi/*</url-pattern>
              </servlet-mapping>
              
              // pom.xml
              <dependency>
                  <groupId>org.glassfish.jersey.containers</groupId>
                  <artifactId>jersey-container-servlet</artifactId>
              </dependency>
        
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末肿轨,一起剝皮案震驚了整個濱河市借浊,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌萝招,老刑警劉巖蚂斤,帶你破解...
    沈念sama閱讀 218,546評論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異槐沼,居然都是意外死亡曙蒸,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,224評論 3 395
  • 文/潘曉璐 我一進(jìn)店門岗钩,熙熙樓的掌柜王于貴愁眉苦臉地迎上來纽窟,“玉大人,你說我怎么就攤上這事兼吓”鄹郏” “怎么了?”我有些...
    開封第一講書人閱讀 164,911評論 0 354
  • 文/不壞的土叔 我叫張陵视搏,是天一觀的道長审孽。 經(jīng)常有香客問我,道長浑娜,這世上最難降的妖魔是什么佑力? 我笑而不...
    開封第一講書人閱讀 58,737評論 1 294
  • 正文 為了忘掉前任,我火速辦了婚禮筋遭,結(jié)果婚禮上打颤,老公的妹妹穿的比我還像新娘。我一直安慰自己漓滔,他們只是感情好编饺,可當(dāng)我...
    茶點故事閱讀 67,753評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著响驴,像睡著了一般透且。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上踏施,一...
    開封第一講書人閱讀 51,598評論 1 305
  • 那天石蔗,我揣著相機與錄音,去河邊找鬼畅形。 笑死,一個胖子當(dāng)著我的面吹牛诉探,可吹牛的內(nèi)容都是我干的日熬。 我是一名探鬼主播,決...
    沈念sama閱讀 40,338評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼肾胯,長吁一口氣:“原來是場噩夢啊……” “哼竖席!你這毒婦竟也來了耘纱?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,249評論 0 276
  • 序言:老撾萬榮一對情侶失蹤毕荐,失蹤者是張志新(化名)和其女友劉穎束析,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體憎亚,經(jīng)...
    沈念sama閱讀 45,696評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡员寇,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,888評論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了第美。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片蝶锋。...
    茶點故事閱讀 40,013評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖什往,靈堂內(nèi)的尸體忽然破棺而出扳缕,到底是詐尸還是另有隱情,我是刑警寧澤别威,帶...
    沈念sama閱讀 35,731評論 5 346
  • 正文 年R本政府宣布躯舔,位于F島的核電站,受9級特大地震影響省古,放射性物質(zhì)發(fā)生泄漏庸毫。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,348評論 3 330
  • 文/蒙蒙 一衫樊、第九天 我趴在偏房一處隱蔽的房頂上張望飒赃。 院中可真熱鬧,春花似錦科侈、人聲如沸载佳。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,929評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至权薯,卻和暖如春姑躲,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背盟蚣。 一陣腳步聲響...
    開封第一講書人閱讀 33,048評論 1 270
  • 我被黑心中介騙來泰國打工黍析, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人屎开。 一個月前我還...
    沈念sama閱讀 48,203評論 3 370
  • 正文 我出身青樓阐枣,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子蔼两,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,960評論 2 355

推薦閱讀更多精彩內(nèi)容