Kas yra Retrofit ir kaip jis naudojamas Android…

Retrofit — tai saugi tipas klientas HTTP užklausoms Android ir Java platformose. Jis supaprastina sąveiką su REST API, naudojant anotacijas užklausų aprašymui.

Pagrindiniai privalumai:

Tipų saugumas: Užklausos ir atsakymai pateikiami kaip Java (arba Kotlin) objektai, kas sumažina klaidų tikimybę vykdymo metu.
Paprastumas naudoti: HTTP metodų deklaravimas naudojant anotacijas daro kodą aiškesnį ir lengviau prižiūrimą.
Konfigūruojamumas: Lengva pridėti interceptors logavimui, autentifikacijai ir kitiems tikslams.
Integracija su konverteriais: Palaiko įvairius konverterius atsakymų analizavimui (JSON, XML ir kt.) iš dėžutės (pvz., Gson, Jackson).

Naudojimas:

Priklausomybių pridėjimas:

// build.gradle (programos lygmenyje)
dependencies {
    implementation 'com.squareup.retrofit2:retrofit:<latest_version>'
    // Pasirinkite konverterį savo duomenims (čia pavyzdys su Gson)
    implementation 'com.squareup.retrofit2:converter-gson:<latest_version>'
}

API sąsajos apibrėžimas: Sukuriamas Java/Kotlin interfeisas, kuris deklaruoja visus API Endpoint'us naudojant anotacijas.

// ApiService.java
import retrofit2.Call;
import retrofit2.http.GET;
import retrofit2.http.Path;
import java.util.List;

public interface ApiService {

    @GET("users/{userId}") // GET užklausa URL "users/{userId}"
    Call<User> getUser(@Path("userId") int userId); // @Path naudojamas reikšmei įterpti į URL

    @GET("posts") // GET užklausa URL "posts"
    Call<List<Post>> getPosts();
}

// User.java (pavyzdinis POJO atsakymui)
public class User {
    private int id;
    private String name;
    // getteriai ir setteriai
}

// Post.java (pavyzdinis POJO atsakymui)
public class Post {
    private int id;
    private int userId;
    private String title;
    private String body;
    // getteriai ir setteriai
}

Retrofit instancijos sukūrimas:

// RetrofitClient.java
import retrofit2.Retrofit;
import retrofit2.converter.gson.GsonConverterFactory;

public class RetrofitClient {

    private static final String BASE_URL = "https://api.example.com/"; // Jūsų API bazinis URL
    private static Retrofit retrofit;

    public static Retrofit getRetrofitInstance() {
        if (retrofit == null) {
            retrofit = new Retrofit.Builder()
                    .baseUrl(BASE_URL) // Nustatyti bazinį URL
                    .addConverterFactory(GsonConverterFactory.create()) // Pridėti konverterį
                    .build();
        }
        return retrofit;
    }

    public static ApiService getApiService() {
        return getRetrofitInstance().create(ApiService.class); // Sukurti API paslaugos instanciją
    }
}

Užklausų vykdymas:

// Activity, Fragment ar ViewModel'e
import retrofit2.Call;
import retrofit2.Callback;
import retrofit2.Response;

// ...

ApiService apiService = RetrofitClient.getApiService();

// Asinchroninė užklausa vartotojo gavimui pagal ID
Call<User> userCall = apiService.getUser(1);
userCall.enqueue(new Callback<User>() { // enqueue vykdo asinchroniškai kitame sraute
    @Override
    public void onResponse(Call<User> call, Response<User> response) {
        if (response.isSuccessful() && response.body() != null) {
            User user = response.body();
            // Apdoroti gautą user
        } else {
            // Apdoroti klaidą (pvz., response.code(), response.errorbody())
        }
    }

    @Override
    public void onFailure(Call<User> call, Throwable t) {
        // Apdoroti tinklo klaidą ar kitą išimtį
        t.printStackTrace();
    }
});

// Asinchroninė užklausa gauti sąrašą įrašų
Call<List<Post>> postsCall = apiService.getPosts();
postsCall.enqueue(new Callback<List<Post>>() {
    @Override
    public void onResponse(Call<List<Post>> call, Response<List<Post>> response) {
        if (response.isSuccessful() && response.body() != null) {
            List<Post> posts = response.body();
            // Apdoroti įrašų sąrašą
        } else {
            // Apdoroti klaidą
        }
    }

    @Override
    public void onFailure(Call<List<Post>> call, Throwable t) {
        // Apdoroti klaidą
        t.printStackTrace();
    }
});

Retrofit abstrakcionuoja žemo lygio HTTP darbų detales, leidžiant sutelkti dėmesį į programėlės logiką.

Kas yra Retrofit ir kaip jis naudojamas Android kūrime?