Java RESTful
-
REST 服務(wù)類型
在 REST 服務(wù)中，資源類是接收 REST 請(qǐng)求并完成響應(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)生成一個(gè)javax.ws.rs.core.Application 類。
根據(jù)規(guī)范對(duì) REST 服務(wù)場(chǎng)景的定義，將 REST 服務(wù)分為 4 種類型：
REST 服務(wù)類型示意圖-
類型一：相應(yīng)的邏輯，是服務(wù)中同時(shí)不存在 Application 的子類和 Servlet 的子類。
-
servlet 2.x
// pom <dependency> <groupId>org.glassfish.jersey.containers</groupId> <!-- jersey-container-servlet-core 不具備自動(dòng)掃描資源類的功能。 --> <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 子類的場(chǎng)景
// 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)造中提供掃描包的全名「啟動(dòng)后，包內(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>
-
-
