改造 2 - 在 api 级别添加标头的优雅方式

header java annotations retrofit2 retrofit

2022-09-02 23:28:36

我的改造2（目前）客户端需要向请求添加自定义标头。2.0.2

我正在使用将这些标头添加到所有请求中：Interceptor

OkHttpClient httpClient = new OkHttpClient();
httpClient.networkInterceptors().add(new Interceptor() {
    @Override
    public Response intercept(Chain chain) throws IOException {
        final Request request = chain.request().newBuilder()
                .addHeader("CUSTOM_HEADER_NAME_1", "CUSTOM_HEADER_VALUE_1")
                .addHeader("CUSTOM_HEADER_NAME_2", "CUSTOM_HEADER_VALUE_2")
                ...
                .addHeader("CUSTOM_HEADER_NAME_N", "CUSTOM_HEADER_VALUE_N")
                .build();

        return chain.proceed(request);
    }
});


Retrofit retrofitClient = new Retrofit.Builder()
        .baseUrl(baseUrl)
        .client(httpClient)
        .build();

有些标头我总是想要添加，但有些标头我只需要根据该特定终结点的要求添加，例如用户是否需要进行身份验证。

我希望能够在api级别控制它，例如使用注释，例如：

public interface MyApi {
    @NO_AUTH
    @POST("register")
    Call<RegisterResponse> register(@Body RegisterRequest data);

    @GET("user/{userId}")
    Call<GetUserResponse> getUser(@Path("userId") String userId);
}

向发送请求时，无需添加身份验证令牌，但缺少注释的请求将具有令牌标头。register@NO_AUTH

据我所知，Retrofit 2不支持自定义注释，虽然我发现了通过Retrofit 2自定义注释的解决方法，但它似乎有点太多了。

我想避免每个请求传递这些标头，例如：

public interface MyApi {
    @POST("register")
    Call<RegisterResponse> register(@Body RegisterRequest data);

    @GET("user/{userId}")
    Call<GetUserResponse> getUser(@Header("AuthToken") String token, @Path("userId") String userId);
}

每次调用该方法而不是在拦截器中执行此操作时，都感觉这是多余的（因为我可以静态访问标头值）。
我只是需要以某种方式在我的实现中知道这个特定的请求是否应该有一个特定的标头。Interceptor.intercept

任何想法，我怎么能做到这一点？
我更喜欢通用解决方案，而不仅仅是身份验证令牌情况，而且也欢迎特定的解决方案。谢谢

答案 1

我为我的问题想出了一个非常简单而优雅的（在我看来）解决方案，可能还有其他方案。

我使用注释来传递我的自定义注释，并且由于OkHttp要求它们遵循该格式，因此我决定我的格式将是：。HeadersName: Value@: ANNOTATION_NAME

所以基本上：

public interface MyApi {
    @POST("register")
    @HEADERS("@: NoAuth")
    Call<RegisterResponse> register(@Body RegisterRequest data);

    @GET("user/{userId}")
    Call<GetUserResponse> getUser(@Path("userId") String userId);
}

然后我可以拦截请求，检查我是否有带有名称的注释。如果是这样，我获取值并从请求中删除标头。
即使您想要多个“自定义注释”，这也非常有效：@

@HEADERS({
    "@: NoAuth",
    "@: LogResponseCode"
})

下面介绍如何提取所有这些“自定义注释”并将其从请求中删除：

new OkHttpClient.Builder().addNetworkInterceptor(new Interceptor() {
    @Override
    public okhttp3.Response intercept(Chain chain) throws IOException {
        Request request = chain.request();

        List<String> customAnnotations = request.headers().values("@");

        // do something with the "custom annotations"

        request = request.newBuilder().removeHeader("@").build();
        return chain.proceed(request);
    }
});

答案 2

也许您可以通过创建像这样的不同改造对象工厂方法来做到这一点。

public class RestClient {
    public static <S> S createService(Class<S> serviceClass) {
        OkHttpClient.Builder httpClient = new OkHttpClient.Builder();
        OkHttpClient client = httpClient.build();

        Retrofit retrofit = new Retrofit.Builder().baseUrl(APIConfig.BASE_URL)
                .client(client)
                .build();
        return retrofit.create(serviceClass);
    }

    public static <S> S createServiceWithAuth(Class<S> serviceClass) {
        Interceptor interceptor = new Interceptor() {
            @Override
            public Response intercept(Chain chain) throws IOException {
                final Request request = chain.request().newBuilder()
                        .addHeader("CUSTOM_HEADER_NAME_1", "CUSTOM_HEADER_VALUE_1")
                        .addHeader("CUSTOM_HEADER_NAME_2", "CUSTOM_HEADER_VALUE_2")
                        .build();

                return chain.proceed(request);
            }
        };
        OkHttpClient.Builder httpClient = new OkHttpClient.Builder();
        httpClient.addInterceptor(interceptor);
        OkHttpClient client = httpClient.build();

        Retrofit retrofit = new Retrofit.Builder().baseUrl(APIConfig.BASE_URL)
                .client(client)
                .build();
        return retrofit.create(serviceClass);
    }
}

如果你想在没有标头授权的情况下调用api，你可以调用createService方法：

YourApi api = RestClient.createService(YourApi.class);

如果你想调用带有身份验证的 api，请使用 createServiceWithAuth 方法：

YourApiWithAuth api = RestClient.createServiceWithAuth(YourApiWithAuth.class);