使用 Retrofit2（多服务）的最佳实践

Question

我正在使用 Kotlin 编写一个集成 Retrofit2 的 Android 应用。

据我了解（如果我错了，请纠正我），这样做的“传统”方式是：

1. 创建一个接口，其中包括我所有 API 的方法定义。
2. 使用 retrofit.create() 将其传递给改造，它为我实现了它，然后我可以使用步骤 #1 中的函数访问所有这些

看了this之后，我的问题是： 为我的每个请求创建单独的接口是否更好？

例如如果我有一个“LoginRequest”，并如下所示实现它（“create”本质上调用retrofit.create()），下次我想添加/删除API时，我只需要添加/删除1个文件，而不是几个地方（请求本身、步骤#1 中的服务，以及使用步骤#2 中的方法的所有地方）。另一方面，这会导致我的应用程序“知道”retrofit2，我也不确定这是否是一个好习惯。

interface MyRequest {
    fun execute()
}

class LoginRequest (private val email: String, private val password: String) : MyRequest {
    interface LoginRequestService {
        @POST("login")
        fun emailLogin(
                @Body loginRequestBody: LoginRequestBody):
                retrofit2.Call<GetUserDetailsResponse>
    }

    override fun execute() {
        val requestBody = LoginRequestBody(email, password)
        val call = MyRequestManager.create(LoginRequestService::class.java).emailLogin(requestBody)
        MyRequestManager.executeCall(call)
    }
}

Answer 1

如果你遵循官方指南https://square.github.io/retrofit/会更好

public interface GitHubService {
  @GET("users/{user}/repos")
  Call<List<Repo>> listRepos(@Path("user") String user);
}


Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("https://api.github.com/")
    .build();



GitHubService service = retrofit.create(GitHubService.class);

Call<List<Repo>> repos = service.listRepos("octocat");

那么您可以为服务提供一个 Singleton 以便更轻松，我还喜欢为每个调用创建接口，如下所示，将在我想要的任何类中使用。

interface IListRepos {
    fun listRepos(user: String, onResponse: (MutableList<Repo>?) -> Unit) {
        ServiceSingleton.client.create(GitHubService::class.java)
                .listRepos(user)
                .enqueue(object : Callback<MutableList<Repo>> {
                    override fun onResponse(call: Call<MutableList<Repo>>,
                                            response: retrofit2.Response<MutableList<Repo>>) {
                        onResponse(response.body())
                    }

                    override fun onFailure(call: Call<MutableList<Repo>>, t: Throwable) {
                        onResponse(null)
                    }
                })
    }
}

Answer 2

我在java中做的方式 为所有人提供 1 个接口，带有单独的请求。

里面

public interface ApiInterface {
}

我已将所有网址设置在 1 个位置，以便以后轻松编辑

String Base_Url = "http://url.com/store/web/app_dev.php/api/";
String Base_Url_Channel = "http://url.com/store/web/app_dev.php/api/APP_STORE/";
String Image_URL_Online = "http://url.com/store/web/media/image/";

对于retrofit2方法调用类

public class DataServiceGenerator {

    public static <S> S createService(Class<S> serviceClass) {

        String url = ApiInterface.Base_Url;
        Retrofit.Builder builder = new Retrofit.Builder()
                .addConverterFactory(GsonConverterFactory.create())
                .baseUrl(url);

        OkHttpClient.Builder httpClient = new OkHttpClient.Builder()
                .readTimeout(15, TimeUnit.SECONDS)
                .connectTimeout(15, TimeUnit.SECONDS)
                .writeTimeout(25, TimeUnit.SECONDS);

        if (BuildConfig.DEBUG) {
            HttpLoggingInterceptor interceptor = new HttpLoggingInterceptor()
                    .setLevel(HttpLoggingInterceptor.Level.BODY);
            httpClient.addInterceptor(interceptor);
            httpClient.addNetworkInterceptor(new StethoInterceptor()); // for debugging
        }
        builder.client(httpClient.build());
        Retrofit retrofit = builder.build();
        return retrofit.create(serviceClass);
    }
 }

现在在接口中使用下面的方法调用 API 即时通讯

@Multipart
@Headers("Accept: Application/json")
@POST("oauth/v2/token")
Call<Token_Model> token(
        @Part("client_id") RequestBody id,
        @Part("client_secret") RequestBody secret,
        @Part("grant_type") RequestBody username,
        @Part("username") RequestBody name,
        @Part("password") RequestBody password);

对于方法本身：

Call<Token_Model> call = service.token(createPartFromString("13123khkjhfsdf"),
                createPartFromString("1asd234k234lkh24"),
                createPartFromString("password"), createPartFromString("api@example.com"), createPartFromString("test"));
        call.enqueue(new Callback<Token_Model>() {
            @Override
            public void onResponse(Call<Token_Model> call, retrofit2.Response<Token_Model> response) {
                if (response.isSuccessful()) {
                    token_model = response.body();
                    if (token_model != null) {
                        helper.setToken(token_model.getAccess_token());
                    }

                } else {
                    Toast.makeText(context, context.getString(R.string.failed_token), Toast.LENGTH_LONG).show();
                }
            }

            @Override
            public void onFailure(Call<Token_Model> call, Throwable t) {
                Toast.makeText(context, context.getString(R.string.failed_token), Toast.LENGTH_LONG).show();
            }
        });