Android中Retrofit的封裝使用

Acker-XUE發表於2020-12-19

一、大致介紹:

  1. Retrofit:Square 基於OkHttp 實現的一款針對Android 網路請求的框架

  2. OkHttp: Square 開源的網路請求庫

  3. RxJava:使得非同步操作變得非常簡單

二、功能分離

  1. Retrofit 針對請求的資料和請求的結果,使用介面的方式呈現

  2. OkHttp 針對請求的過程

  3. RxJava 針對非同步,各種執行緒之間的切換

三、使用過程

一、新增依賴庫

    //RxJava
    compile 'io.reactivex:rxjava:1.1.3'
    //RxAndroid
    compile 'io.reactivex:rxandroid:1.1.0'
    //retrofit
    compile 'com.squareup.retrofit2:retrofit:2.0.0'
    //retrofit依賴Gson
    compile 'com.squareup.retrofit2:converter-gson:2.0.0'
    //OkHttp
    compile 'com.squareup.okhttp3:okhttp:3.2.0'
    //retrofit依賴RxJava
    compile 'com.squareup.retrofit2:adapter-rxjava:2.0.0'

二、建立單例Retrofit介面管理類

import java.util.concurrent.TimeUnit;
import okhttp3.OkHttpClient;
import retrofit2.Retrofit;
import retrofit2.converter.gson.GsonConverterFactory;

public class RetrofitManager {
	// 請求的URL字首
    private static final String BASEURL = "http://192.168.42.48:9000/";
    private static Retrofit retrofit;
    private static RetrofitManager retrofitManager;

    //提供共有的方法供外界訪問
    public static RetrofitManager newInstance() {
        if (retrofitManager == null) {
            synchronized (RetrofitManager.class) {
                retrofitManager = new RetrofitManager();
            }
        }
        return retrofitManager;
    }

    //通過動態代理生成相應的Http請求
    public <T> T creat(Class<T> t) {
        return retrofit.create(t);
    }

    //構造方法私有化
    private RetrofitManager() {
        retrofit = getRetrofit();
    }

    //構建Ok請求
    private OkHttpClient getOkHttpClient() {
        return new OkHttpClient.Builder()
                .connectTimeout(5000, TimeUnit.MILLISECONDS)
                .build();
    }

    //構建Retrofit
    private Retrofit getRetrofit() {
        return new Retrofit.Builder()
                .baseUrl(BASEURL)
                .client(getOkHttpClient())
                .addConverterFactory(GsonConverterFactory.create())
//                .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
                .build();
    }
}

三、建立介面類

import retrofit2.Call;
import retrofit2.http.Body;
import retrofit2.http.Field;
import retrofit2.http.FormUrlEncoded;
import retrofit2.http.GET;
import retrofit2.http.POST;
import retrofit2.http.Path;
// 對應著服務端的介面
public interface UserService {
	// 如果後端是@RequestParam接受引數,加上@FormUrlEncoded 
    @FormUrlEncoded 
    // 請求路徑前不能加 /
    @POST("server/user/login")
    Call<Rs<User>> login(@Field("username") String username, @Field("password") String password);

	//如果後端是@RequestBody接受引數,去除@FormUrlEncoded 
    @POST("server/user/register")
    Call<Rs> register(@Body User user);
    
	// 使用resultful風格請求
    @GET("server/user/getById/{id}")
    Call<Rs<User>> getById(@Path("id") String id);

    @POST("server/user/updateById")
    Call<Rs> updateById(@Body User user);
}

四、呼叫過程

 // 呼叫註冊介面除錯介面
        RetrofitManager.newInstance()
                .creat(UserService.class)
                .login(username,password)
                .enqueue(new Callback<Rs<User>>() {
                    @Override
                    public void onResponse(Call<Rs<User>> call, Response<Rs<User>> response) {
                        LogUtils.i("呼叫介面成功");
                        if (response.body().getCode() == 20000){
                            Gson gson = new Gson();
                            String json = gson.toJson(response.body().getData());
                            System.out.println(json);
                            SPUtils.getInstance().put("user",json);
                            ToastUtils.showShort("成功!");
                            Intent intent = new Intent(LoginActivity.this, MainActivity.class);
                            startActivity(intent);
                        } else {
                            ToastUtils.showShort("異常!");
                        }
                    }
                    @Override
                    public void onFailure(Call<Rs<User>> call, Throwable t) {
                        LogUtils.e("呼叫介面異常");
                        ToastUtils.showShort("異常!");
                    }
                });

相關文章