Custom ResourceConfig 自定义资源配置

观察 web.xml

之前的 web.xml 配置是这样的:

  1. <web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
  2. <servlet>
  3. <servlet-name>Jersey Web Application</servlet-name>
  4. <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
  5. <init-param>
  6. <param-name>jersey.config.server.provider.packages</param-name>
  7. <param-value>com.waylau.rest</param-value>
  8. </init-param>
  9. <load-on-startup>1</load-on-startup>
  10. </servlet>
  11. <servlet-mapping>
  12. <servlet-name>Jersey Web Application</servlet-name>
  13. <url-pattern>/webapi/*</url-pattern>
  14. </servlet-mapping>
  15. </web-app>

其中

  1. <init-param>
  2. <param-name>jersey.config.server.provider.packages</param-name>
  3. <param-value>com.waylau.rest</param-value>
  4. </init-param>

这段说的是,如果配置属性无需设置,要部署应用程序只包括存储在特定的包的资源和提供者,那么你可以指示 Jersey 自动扫描这些包,这样就能自动注册找到的任何资源和提供者,这样就能找到了 com.waylau.rest包下的 MyResource 资源并且注册。

自定义配置

当需要更多的配置,上述方法显然不能满足。可以重写 Application 类。

  1. package com.waylau.rest;
  2. import org.glassfish.jersey.server.ResourceConfig;
  3. /**
  4. * REST 主应用
  5. *
  6. * @author waylau.com
  7. * 2015年3月3日
  8. */
  9. public class RestApplication extends ResourceConfig {
  10. public RestApplication() {
  11. //资源类所在的包路径
  12. packages("com.waylau.rest");
  13. }
  14. }

为了规范,我们在建立 com.waylau.rest.resource 包,用来专门放资源来。接着把我们的资源 MyResource 移到该包下面。

  1. public class RestApplication extends ResourceConfig {
  2. public RestApplication() {
  3. //资源类所在的包路径
  4. packages("com.waylau.rest.resource");
  5. }
  6. }

最终,RestApplication 在 web.xml 配置是这样的:

  1. <init-param>
  2. <param-name>javax.ws.rs.Application</param-name>
  3. <param-value>com.waylau.rest.RestApplication</param-value>
  4. </init-param>

运行测试

启动项目,访问 http://localhost:8080/,点击“Jersey resource”,显示“Got it!”,说明配置成功。

源码

custom-resourceconfig 项目