如何查询基于Jersey框架实现的REST服务列表？

嘿，我之前在基于Jersey构建REST服务时也遇到过这个需求，下面几种方法亲测可行，能帮你获取完整的服务列表：

1. 直接通过Jersey核心配置类获取 #

Jersey应用一般通过继承ResourceConfig或实现Application来定义，你可以利用这些类的API直接获取已注册的资源：

• 如果你的应用使用ResourceConfig，可以在需要的地方注入它，然后调用getClasses()和getSingletons()方法，分别返回注册的资源类和单例资源实例：

@Inject
private ResourceConfig resourceConfig;

public void listAllResources() {
    // 获取所有注册的资源类
    Set<Class<?>> resourceClasses = resourceConfig.getClasses();
    // 获取所有单例资源实例
    Set<Object> resourceSingletons = resourceConfig.getSingletons();
    
    // 遍历提取@Path注解信息
    for (Class<?> cls : resourceClasses) {
        Path pathAnnotation = cls.getAnnotation(Path.class);
        if (pathAnnotation != null) {
            System.out.println("资源路径: " + pathAnnotation.value());
            // 还可以进一步提取@GET/@POST等方法级注解
        }
    }
}

2. 利用ModelProcessor扩展点拦截资源模型 #

Jersey提供了ModelProcessor扩展接口，允许你在应用启动阶段处理整个资源模型，这是获取所有服务（包括资源方法）最全面的方式：

自定义一个ModelProcessor实现类，然后注册到你的ResourceConfig中：

public class ResourceListingProcessor implements ModelProcessor {
    @Override
    public ResourceModel processResourceModel(ResourceModel resourceModel, Configuration configuration) {
        // 遍历所有资源
        for (Resource resource : resourceModel.getResources()) {
            String resourcePath = resource.getPath();
            System.out.println("资源根路径: " + resourcePath);
            
            // 遍历资源下的所有方法
            for (ResourceMethod method : resource.getResourceMethods()) {
                String httpMethod = method.getHttpMethod();
                String fullPath = resourcePath + method.getPath();
                System.out.println(String.format("接口方法: %s %s", httpMethod, fullPath));
            }
        }
        return resourceModel;
    }

    @Override
    public ResourceModel processSubResource(ResourceModel subResourceModel, Configuration configuration) {
        return subResourceModel;
    }
}

然后在你的ResourceConfig中注册这个处理器：

public class MyJerseyApplication extends ResourceConfig {
    public MyJerseyApplication() {
        register(ResourceListingProcessor.class);
        // 其他配置，比如包扫描、Feature注册等
    }
}

应用启动时，这个处理器会自动触发，你就能拿到所有资源和对应的接口方法详情。

3. 启用Jersey的API文档功能（间接查看） #

如果你只是需要查看服务列表而非在代码中获取，Jersey支持集成OpenAPI或WADL生成API文档，里面会包含所有服务的完整信息：

• OpenAPI：添加jersey-media-openapi依赖，注册OpenApiFeature后，启动应用访问/openapi.json或/openapi.yaml，返回的文件中paths字段就是所有服务的路径和方法定义。
• WADL：Jersey默认支持WADL，直接访问/application.wadl就能获取XML格式的服务列表，包含所有资源和方法的详细描述。

4. 反射扫描类路径（针对包扫描注册的资源） #

如果你的应用是通过packages()方法扫描整个包来注册资源的，你可以用反射工具（比如Reflections库）扫描指定包下所有带有@Path注解的类：

Reflections reflections = new Reflections("com.your.app.resources");
Set<Class<?>> resourceClasses = reflections.getTypesAnnotatedWith(Path.class);

for (Class<?> cls : resourceClasses) {
    Path path = cls.getAnnotation(Path.class);
    System.out.println("发现资源: " + path.value());
}

这种方法适合无法直接持有ResourceConfig实例的场景，但要注意：如果资源是动态注册的（非包扫描方式），这种方法可能会遗漏部分服务。

内容的提问来源于stack exchange，提问作者pranaysampat