Java/Jersey - 使用 ParamInjectionResolver 创建自己的注入解析器 - 奇怪的行为

Question

我正在尝试创建一个注入解析器。我有一个数据类：

public class MyData {
    ...
}

我有以下注释：

@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyDataInject {
}

我的注入解析器如下所示：

public class MyDataInjectionResolver extends ParamInjectionResolver<MyDataInject> {
    public MyDataInjectionResolver () {
        super(MyDataValueFactoryProvider.class);
    }

    @Singleton
    public static class MyDataValueFactoryProvider extends AbstractValueFactoryProvider {
        @Inject
        public MyDataValueFactoryProvider(MultivaluedParameterExtractorProvider provider, ServiceLocator locator) {
            super(provider, locator, Parameter.Source.UNKNOWN);
        }

        @Override
        protected Factory<?> createValueFactory(Parameter parameter) {
            System.out.println(parameter.getRawType());
            System.out.println(Arrays.toString(parameter.getAnnotations()));
            System.out.println("------------------------------------------------------------------");
            System.out.println();

            ... create factory and return ...
        }
    }
}

我的绑定如下：

bind(MyDataValueFactoryProvider.class).to(ValueFactoryProvider.class).in(Singleton.class);
bind(MyDataInjectionResolver.class).to(new TypeLiteral<InjectionResolver<MyDataInject>>() {}).in(Singleton.class);

为了简洁起见，我将实际工厂的实现放在一边。一切正常，但我注意到一些我无法解释的行为。我正在使用以下 JAX-RS 资源进行测试：

@Path("test")
public class Test {
    @GET
    public Response test(@MyDataInject @Valid MyData data) {
        return Response.status(Response.Status.OK).entity("Hello world!").build();
    }
}

• 我注意到的第一件事是MyDataValueFactoryProvider.createValueFactory 在启动期间被调用了两次。这是为什么？这闻起来像一些错误。好处是工厂只在客户端发出请求时访问一次。
• 另一个观察结果是，如果我删除资源中的 @MyDataInject 注释，如下所示 (*)，MyDataValueFactoryProvider.createValueFactory 仍会被调用。这是为什么？这很奇怪，因为它应该只绑定到 @MyDataInject? (update) 当参数不属于MyData 类时，它甚至会被调用，参见下面的第二个变体。

(*) 没有@MyDataInject注解的资源：

@Path("test")
public class Test {
    @GET
    public Response test(/*@MyDataInject*/ @Valid MyData data) {
        return Response.status(Response.Status.OK).entity("Hello world!").build();
    }
}

另一种变体：

@Path("test")
public class Test {
    @GET
    public Response test(@Valid SomeOtherClass data) {
        return Response.status(Response.Status.OK).entity("Hello world!").build();
    }
}

Answer 1

在启动时，Jersey 会构建所有资源的内部模型。 Jersey 使用此模型来处理请求。该模型的一部分由所有资源方法及其所有参数组成。更进一步，Jersey 还将验证模型以确保它是有效的模型。模型中的某些无效内容可能会导致 Jersey 在运行时无法处理该模型。所以这个验证是为了保护我们。

话虽如此，验证过程的一部分是验证方法参数。有一些规则可以控制我们可以拥有的参数。例如，@QueryParam 参数必须满足the javadoc 中提到的要求之一：

1. 成为原始类型
2. 有一个接受单个字符串参数的构造函数
3. 有一个名为 valueOf 或 fromString 的静态方法，它接受单个字符串参数（例如，请参阅 Integer.valueOf(String)）
4. 有一个ParamConverterProvider JAX-RS 扩展 SPI 的注册实现，它返回一个 ParamConverter 实例，该实例能够对该类型进行“来自字符串”的转换。
5. 为List<T>、Set<T> 或SortedSet<T>，其中T 满足上述2、3 或4。生成的集合是只读的。

这里有一些你可以尝试的东西。使用以下任意类添加@QueryParam

public class Dummy {
  public String value;
}

@GET
public Response get(@QueryParam("dummy") Dummy dummy) {}

请注意，Dummy 类不满足上面列出的任何要求。当您运行应用程序时，您应该会在启动时收到异常，从而导致应用程序失败。例外情况类似于

ModelValidationException: No injection source for parameter ...

这意味着模型验证失败，因为 Jersey 不知道如何从查询参数创建 Dummy 实例，因为它不遵循允许的规则。

好的。那么这一切与您的问题有什么关系？好吧，所有参数注入都需要ValueFactoryProvider 才能为其提供值。如果没有，则无法在运行时创建参数。因此 Jersey 通过检查是否存在返回 Factory 的 ValueFactoryProvider 来验证参数。 Jersey 在运行时调用以获取Factory 的方法就是您提到的方法：createValueFactory。

现在请记住，当我们实现 createValueFactory 时，我们可以返回 Factory 或返回 null。我们应该如何实现它，是检查Parameter 参数以查看我们是否可以处理该参数。比如

protected Factory<?> createValueFactory(Parameter parameter) {
   if (parameter.getRawType() == Dummy.class
       && parameter.isAnnotationPresent(MyAnnoation.class)) {
     return new MyFactory();
   }
   return null;
}

所以我们在这里告诉 Jersey 这个ValueFactoryProvider 可以处理什么。在这种情况下，我们可以处理 Dummy 类型的参数，并且如果参数带有 @MyAnnotation 注释。

那么在启动验证过程中会发生什么，对于每个参数，Jersey 都会遍历每个注册的ValueFactoryProvider，看看是否有一个可以处理该参数。它可以知道的唯一方法是它是否调用了createValueFactory 方法。如果有一个返回Factory，那么它是成功的。如果遍历了所有的ValueFactoryProviders并且都返回null，那么模型是无效的，我们会得到模型验证异常。需要注意的是，内部有一堆ValueFactoryProviders 用于参数注解，如@QueryParam、@PathParam 等。