Android
Retrofit2
Ricerca…
introduzione
La pagina ufficiale di Retrofit si descrive come
Un client REST sicuro per tipo per Android e Java.
Retrofit trasforma la tua API REST in un'interfaccia Java. Utilizza le annotazioni per descrivere le richieste HTTP, la sostituzione dei parametri URL e il supporto dei parametri di query è integrato per impostazione predefinita. Inoltre, fornisce funzionalità per corpo di richiesta multipart e upload di file.
Osservazioni
Dipendenze per la biblioteca di retrofit:
Dalla documentazione ufficiale :
Gradle:
dependencies {
...
compile 'com.squareup.retrofit2:converter-gson:2.3.0'
compile 'com.squareup.retrofit2:retrofit:2.3.0'
...
}
Maven:
<dependency>
<groupId>com.squareup.retrofit2</groupId>
<artifactId>retrofit</artifactId>
<version>2.3.0</version>
</dependency>
Una semplice richiesta GET
Mostreremo come effettuare una richiesta GET
a un'API che risponde con un oggetto JSON
o un array JSON
. La prima cosa che dobbiamo fare è aggiungere le dipendenze Retrofit e GSON
Converter al file gradle del nostro modulo.
Aggiungi le dipendenze per la libreria di aggiornamento come descritto nella sezione Note.
Esempio di oggetto JSON previsto:
{
"deviceId": "56V56C14SF5B4SF",
"name": "Steven",
"eventCount": 0
}
Esempio di array JSON:
[
{
"deviceId": "56V56C14SF5B4SF",
"name": "Steven",
"eventCount": 0
},
{
"deviceId": "35A80SF3QDV7M9F",
"name": "John",
"eventCount": 2
}
]
Esempio di classe modello corrispondente:
public class Device
{
@SerializedName("deviceId")
public String id;
@SerializedName("name")
public String name;
@SerializedName("eventCount")
public int eventCount;
}
Le annotazioni @SerializedName
qui provengono dalla libreria GSON
e ci consentono di serialize
e deserialize
questa classe in JSON
utilizzando come chiavi il nome serializzato. Ora possiamo costruire l'interfaccia per l'API che preleverà effettivamente i dati dal server.
public interface DeviceAPI
{
@GET("device/{deviceId}")
Call<Device> getDevice (@Path("deviceId") String deviceID);
@GET("devices")
Call<List<Device>> getDevices();
}
C'è molto da fare qui in uno spazio piuttosto compatto quindi cerchiamo di scomporlo:
- L'annotazione
@GET
proviene da Retrofit e indica alla biblioteca che stiamo definendo una richiesta GET. - Il percorso tra parentesi è l'endpoint che la nostra richiesta GET dovrebbe colpire (imposteremo l'URL di base un po 'più tardi).
- Le parentesi graffe ci consentono di sostituire parti del percorso in fase di esecuzione in modo da poter passare argomenti.
- La funzione che stiamo definendo si chiama
getDevice
e prende l'id del dispositivo che vogliamo come argomento. - L'annotazione
@PATH
dice a Retrofit che questo argomento dovrebbe sostituire il segnaposto "deviceId" nel percorso. - La funzione restituisce un oggetto
Call
di tipoDevice
.
Creazione di una classe wrapper:
Ora faremo una piccola classe wrapper per la nostra API per mantenere il codice di inizializzazione di Retrofit avvolto bene.
public class DeviceAPIHelper
{
public final DeviceAPI api;
private DeviceAPIHelper ()
{
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("http://example.com/")
.addConverterFactory(GsonConverterFactory.create())
.build();
api = retrofit.create(DeviceAPI.class);
}
}
Questa classe crea un'istanza di GSON per essere in grado di analizzare la risposta JSON, crea un'istanza di Retrofit con il nostro URL di base e un GSONConverter e quindi crea un'istanza della nostra API.
Chiamando l'API:
// Getting a JSON object
Call<Device> callObject = api.getDevice(deviceID);
callObject.enqueue(new Callback<Response<Device>>()
{
@Override
public void onResponse (Call<Device> call, Response<Device> response)
{
if (response.isSuccessful())
{
Device device = response.body();
}
}
@Override
public void onFailure (Call<Device> call, Throwable t)
{
Log.e(TAG, t.getLocalizedMessage());
}
});
// Getting a JSON array
Call<List<Device>> callArray = api.getDevices();
callArray.enqueue(new Callback<Response<List<Device>>()
{
@Override
public void onResponse (Call<List<Device>> call, Response<List<Device>> response)
{
if (response.isSuccessful())
{
List<Device> devices = response.body();
}
}
@Override
public void onFailure (Call<List<Device>> call, Throwable t)
{
Log.e(TAG, t.getLocalizedMessage());
}
});
Questo utilizza la nostra interfaccia API per creare un oggetto Call<Device>
e per creare una Call<List<Device>>
rispettivamente. Chiamare l' enqueue
dice a Retrofit di effettuare quella chiamata su un thread in background e restituire il risultato alla richiamata che stiamo creando qui.
Nota: l' analisi di un array JSON di oggetti primitivi (come String, Integer, Boolean e Double ) è simile all'analisi di un array JSON. Tuttavia, non hai bisogno della tua classe di modello. Ad esempio, è possibile ottenere la matrice di stringhe con il tipo di restituzione della chiamata come Call<List<String>>
.
Aggiungi la registrazione a Retrofit2
Le richieste di retrofit possono essere registrate utilizzando un'intercettatrice. Sono disponibili diversi livelli di dettaglio: NESSUNO, BASE, INTESTAZIONI, CORPO. Vedi il progetto Github qui .
- Aggiungi dipendenza a build.gradle:
compile 'com.squareup.okhttp3:logging-interceptor:3.8.1'
- Aggiungi l'intercettore di registrazione durante la creazione di Retrofit:
HttpLoggingInterceptor loggingInterceptor = new HttpLoggingInterceptor();
loggingInterceptor.setLevel(LoggingInterceptor.Level.BODY);
OkHttpClient okHttpClient = new OkHttpClient().newBuilder()
.addInterceptor(loggingInterceptor)
.build();
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("http://example.com/")
.client(okHttpClient)
.addConverterFactory(GsonConverterFactory.create(gson))
.build();
L'esposizione dei registri nel terminale (monitor Android) è qualcosa che dovrebbe essere evitato nella versione di rilascio in quanto potrebbe portare all'esposizione indesiderata di informazioni critiche come i token di autenticazione ecc.
Per evitare che i registri vengano esposti durante il periodo di esecuzione, verificare le seguenti condizioni
if(BuildConfig.DEBUG){
//your interfector code here
}
Per esempio:
HttpLoggingInterceptor loggingInterceptor = new HttpLoggingInterceptor();
if(BuildConfig.DEBUG){
//print the logs in this case
loggingInterceptor.setLevel(LoggingInterceptor.Level.BODY);
}else{
loggingInterceptor.setLevel(LoggingInterceptor.Level.NONE);
}
OkHttpClient okHttpClient = new OkHttpClient().newBuilder()
.addInterceptor(loggingInterceptor)
.build();
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("http://example.com/")
.client(okHttpClient)
.addConverterFactory(GsonConverterFactory.create(gson))
.build();
Caricamento di un file tramite Multipart
Dichiara la tua interfaccia con le annotazioni di Retrofit2:
public interface BackendApiClient {
@Multipart
@POST("/uploadFile")
Call<RestApiDefaultResponse> uploadPhoto(@Part("file\"; filename=\"photo.jpg\" ") RequestBody photo);
}
Dove RestApiDefaultResponse
è una classe personalizzata contenente la risposta.
Costruire l'implementazione della tua API e accodare la chiamata:
Retrofit retrofit = new Retrofit.Builder()
.addConverterFactory(GsonConverterFactory.create())
.baseUrl("http://<yourhost>/")
.client(okHttpClient)
.build();
BackendApiClient apiClient = retrofit.create(BackendApiClient.class);
RequestBody reqBody = RequestBody.create(MediaType.parse("image/jpeg"), photoFile);
Call<RestApiDefaultResponse> call = apiClient.uploadPhoto(reqBody);
call.enqueue(<your callback function>);
Retrofit con intercettore OkHttp
Questo esempio mostra come usare un intercettore di richiesta con OkHttp. Questo ha numerosi casi d'uso come:
- Aggiunta di
header
universale alla richiesta. Ad esempio, l'autenticazione di una richiesta - Debug delle applicazioni in rete
- Recupero della
response
elaborata - Registrazione della transazione di rete ecc.
- Imposta agente utente personalizzato
Retrofit.Builder builder = new Retrofit.Builder()
.addCallAdapterFactory(RxJavaCallAdapterFactory.create())
.addConverterFactory(GsonConverterFactory.create())
.baseUrl("https://api.github.com/");
if (!TextUtils.isEmpty(githubToken)) {
// `githubToken`: Access token for GitHub
OkHttpClient client = new OkHttpClient.Builder().addInterceptor(new Interceptor() {
@Override public Response intercept(Chain chain) throws IOException {
Request request = chain.request();
Request newReq = request.newBuilder()
.addHeader("Authorization", format("token %s", githubToken))
.build();
return chain.proceed(newReq);
}
}).build();
builder.client(client);
}
return builder.build().create(GithubApi.class);
Vedi l'argomento OkHttp per maggiori dettagli.
Intestazione e corpo: un esempio di autenticazione
Le annotazioni @Header
e @Body
possono essere inserite nelle firme del metodo e Retrofit le creerà automaticamente in base ai modelli.
public interface MyService {
@POST("authentication/user")
Call<AuthenticationResponse> authenticateUser(@Body AuthenticationRequest request, @Header("Authorization") String basicToken);
}
AuthenticaionRequest è il nostro modello, un POJO, contenente le informazioni richieste dal server. Per questo esempio, il nostro server vuole la chiave e il segreto del cliente.
public class AuthenticationRequest {
String clientKey;
String clientSecret;
}
Si noti che in @Header("Authorization")
stiamo specificando che stiamo popolando l'intestazione Autorizzazione. Le altre intestazioni verranno popolate automaticamente poiché Retrofit può dedurre ciò che sono in base al tipo di oggetti che stiamo inviando e che si aspettano in cambio.
Creiamo il nostro servizio di retrofit da qualche parte. Ci assicuriamo di utilizzare HTTPS.
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("https:// some example site")
.client(client)
.build();
MyService myService = retrofit.create(MyService.class)
Quindi possiamo usare il nostro servizio.
AuthenticationRequest request = new AuthenticationRequest();
request.setClientKey(getClientKey());
request.setClientSecret(getClientSecret());
String basicToken = "Basic " + token;
myService.authenticateUser(request, basicToken);
Carica più file utilizzando Retrofit come multipart
Una volta impostato l'ambiente Retrofit nel tuo progetto, puoi utilizzare il seguente esempio che dimostra come caricare più file usando Retrofit:
private void mulipleFileUploadFile(Uri[] fileUri) {
OkHttpClient okHttpClient = new OkHttpClient();
OkHttpClient clientWith30sTimeout = okHttpClient.newBuilder()
.readTimeout(30, TimeUnit.SECONDS)
.build();
Retrofit retrofit = new Retrofit.Builder()
.baseUrl(API_URL_BASE)
.addConverterFactory(new MultiPartConverter())
.client(clientWith30sTimeout)
.build();
WebAPIService service = retrofit.create(WebAPIService.class); //here is the interface which you have created for the call service
Map<String, okhttp3.RequestBody> maps = new HashMap<>();
if (fileUri!=null && fileUri.length>0) {
for (int i = 0; i < fileUri.length; i++) {
String filePath = getRealPathFromUri(fileUri[i]);
File file1 = new File(filePath);
if (filePath != null && filePath.length() > 0) {
if (file1.exists()) {
okhttp3.RequestBody requestFile = okhttp3.RequestBody.create(okhttp3.MediaType.parse("multipart/form-data"), file1);
String filename = "imagePath" + i; //key for upload file like : imagePath0
maps.put(filename + "\"; filename=\"" + file1.getName(), requestFile);
}
}
}
}
String descriptionString = " string request";//
//hear is the your json request
Call<String> call = service.postFile(maps, descriptionString);
call.enqueue(new Callback<String>() {
@Override
public void onResponse(Call<String> call,
Response<String> response) {
Log.i(LOG_TAG, "success");
Log.d("body==>", response.body().toString() + "");
Log.d("isSuccessful==>", response.isSuccessful() + "");
Log.d("message==>", response.message() + "");
Log.d("raw==>", response.raw().toString() + "");
Log.d("raw().networkResponse()", response.raw().networkResponse().toString() + "");
}
@Override
public void onFailure(Call<String> call, Throwable t) {
Log.e(LOG_TAG, t.getMessage());
}
});
}
public String getRealPathFromUri(final Uri uri) { // function for file path from uri,
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT && DocumentsContract.isDocumentUri(mContext, uri)) {
// ExternalStorageProvider
if (isExternalStorageDocument(uri)) {
final String docId = DocumentsContract.getDocumentId(uri);
final String[] split = docId.split(":");
final String type = split[0];
if ("primary".equalsIgnoreCase(type)) {
return Environment.getExternalStorageDirectory() + "/" + split[1];
}
}
// DownloadsProvider
else if (isDownloadsDocument(uri)) {
final String id = DocumentsContract.getDocumentId(uri);
final Uri contentUri = ContentUris.withAppendedId(
Uri.parse("content://downloads/public_downloads"), Long.valueOf(id));
return getDataColumn(mContext, contentUri, null, null);
}
// MediaProvider
else if (isMediaDocument(uri)) {
final String docId = DocumentsContract.getDocumentId(uri);
final String[] split = docId.split(":");
final String type = split[0];
Uri contentUri = null;
if ("image".equals(type)) {
contentUri = MediaStore.Images.Media.EXTERNAL_CONTENT_URI;
} else if ("video".equals(type)) {
contentUri = MediaStore.Video.Media.EXTERNAL_CONTENT_URI;
} else if ("audio".equals(type)) {
contentUri = MediaStore.Audio.Media.EXTERNAL_CONTENT_URI;
}
final String selection = "_id=?";
final String[] selectionArgs = new String[]{
split[1]
};
return getDataColumn(mContext, contentUri, selection, selectionArgs);
}
}
// MediaStore (and general)
else if ("content".equalsIgnoreCase(uri.getScheme())) {
// Return the remote address
if (isGooglePhotosUri(uri))
return uri.getLastPathSegment();
return getDataColumn(mContext, uri, null, null);
}
// File
else if ("file".equalsIgnoreCase(uri.getScheme())) {
return uri.getPath();
}
return null;
}
Di seguito è l'interfaccia
public interface WebAPIService {
@Multipart
@POST("main.php")
Call<String> postFile(@PartMap Map<String,RequestBody> Files, @Part("json") String description);
}
Scarica un file dal server usando Retrofit2
Dichiarazione dell'interfaccia per il download di un file
public interface ApiInterface {
@GET("movie/now_playing")
Call<MovieResponse> getNowPlayingMovies(@Query("api_key") String apiKey, @Query("page") int page);
// option 1: a resource relative to your base URL
@GET("resource/example.zip")
Call<ResponseBody> downloadFileWithFixedUrl();
// option 2: using a dynamic URL
@GET
Call<ResponseBody> downloadFileWithDynamicUrl(@Url String fileUrl);
}
L'opzione 1 viene utilizzata per scaricare un file dal server che sta avendo un URL fisso. e l'opzione 2 viene utilizzata per passare un valore dinamico come URL completo per richiedere una chiamata. Questo può essere utile quando si scaricano file, che dipendono da parametri come utente o tempo.
Imposta il retrofit per effettuare chiamate API
public class ServiceGenerator {
public static final String API_BASE_URL = "http://your.api-base.url/";
private static OkHttpClient.Builder httpClient = new OkHttpClient.Builder();
private static Retrofit.Builder builder =
new Retrofit.Builder()
.baseUrl(API_BASE_URL)
.addConverterFactory(GsonConverterFactory.create());
public static <S> S createService(Class<S> serviceClass){
Retrofit retrofit = builder.client(httpClient.build()).build();
return retrofit.create(serviceClass);
}
}
Ora, realizza l'implementazione di api per scaricare il file dal server
private void downloadFile(){
ApiInterface apiInterface = ServiceGenerator.createService(ApiInterface.class);
Call<ResponseBody> call = apiInterface.downloadFileWithFixedUrl();
call.enqueue(new Callback<ResponseBody>() {
@Override
public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) {
if (response.isSuccessful()){
boolean writtenToDisk = writeResponseBodyToDisk(response.body());
Log.d("File download was a success? ", String.valueOf(writtenToDisk));
}
}
@Override
public void onFailure(Call<ResponseBody> call, Throwable t) {
}
});
}
E dopo aver ricevuto la risposta nel callback, codifica alcuni IO standard per il salvataggio del file su disco. Ecco il codice:
private boolean writeResponseBodyToDisk(ResponseBody body) {
try {
// todo change the file location/name according to your needs
File futureStudioIconFile = new File(getExternalFilesDir(null) + File.separator + "Future Studio Icon.png");
InputStream inputStream = null;
OutputStream outputStream = null;
try {
byte[] fileReader = new byte[4096];
long fileSize = body.contentLength();
long fileSizeDownloaded = 0;
inputStream = body.byteStream();
outputStream = new FileOutputStream(futureStudioIconFile);
while (true) {
int read = inputStream.read(fileReader);
if (read == -1) {
break;
}
outputStream.write(fileReader, 0, read);
fileSizeDownloaded += read;
Log.d("File Download: " , fileSizeDownloaded + " of " + fileSize);
}
outputStream.flush();
return true;
} catch (IOException e) {
return false;
} finally {
if (inputStream != null) {
inputStream.close();
}
if (outputStream != null) {
outputStream.close();
}
}
} catch (IOException e) {
return false;
}
}
Nota abbiamo specificato ResponseBody come tipo restituito, altrimenti Retrofit tenterà di analizzarlo e convertirlo, il che non ha senso quando si scarica il file.
Se vuoi saperne di più sui prodotti Retrofit, accedi a questo link in quanto è molto utile. [1]: https://futurestud.io/blog/retrofit-getting-started-and-android-client
Debugging con Stetho
Aggiungi le seguenti dipendenze alla tua applicazione.
compile 'com.facebook.stetho:stetho:1.5.0'
compile 'com.facebook.stetho:stetho-okhttp3:1.5.0'
Nel metodo onCreate
classe Application, chiama quanto segue.
Stetho.initializeWithDefaults(this);
Quando si crea l'istanza di Retrofit
, creare un'istanza di OkHttp personalizzata.
OkHttpClient.Builder clientBuilder = new OkHttpClient.Builder();
clientBuilder.addNetworkInterceptor(new StethoInterceptor());
Quindi imposta questa istanza personalizzata di OkHttp nell'istanza di Retrofit.
Retrofit retrofit = new Retrofit.Builder()
// ...
.client(clientBuilder.build())
.build();
Ora collega il telefono al computer, avvia l'app e digita chrome://inspect
nel browser Chrome. Le chiamate di rete di retrofit dovrebbero ora essere visualizzate per essere ispezionate.
Retrofit 2 Custom Xml Converter
Aggiunta di dipendenze nel file build.gradle.
dependencies {
....
compile 'com.squareup.retrofit2:retrofit:2.1.0'
compile ('com.thoughtworks.xstream:xstream:1.4.7') {
exclude group: 'xmlpull', module: 'xmlpull'
}
....
}
Quindi creare Converter Factory
public class XStreamXmlConverterFactory extends Converter.Factory {
/** Create an instance using a default {@link com.thoughtworks.xstream.XStream} instance for conversion. */
public static XStreamXmlConverterFactory create() {
return create(new XStream());
}
/** Create an instance using {@code xStream} for conversion. */
public static XStreamXmlConverterFactory create(XStream xStream) {
return new XStreamXmlConverterFactory(xStream);
}
private final XStream xStream;
private XStreamXmlConverterFactory(XStream xStream) {
if (xStream == null) throw new NullPointerException("xStream == null");
this.xStream = xStream;
}
@Override
public Converter<ResponseBody, ?> responseBodyConverter(Type type, Annotation[] annotations, Retrofit retrofit) {
if (!(type instanceof Class)) {
return null;
}
Class<?> cls = (Class<?>) type;
return new XStreamXmlResponseBodyConverter<>(cls, xStream);
}
@Override
public Converter<?, RequestBody> requestBodyConverter(Type type,
Annotation[] parameterAnnotations, Annotation[] methodAnnotations, Retrofit retrofit) {
if (!(type instanceof Class)) {
return null;
}
return new XStreamXmlRequestBodyConverter<>(xStream);
}
}
creare una classe per gestire la richiesta del corpo.
final class XStreamXmlResponseBodyConverter <T> implements Converter<ResponseBody, T> {
private final Class<T> cls;
private final XStream xStream;
XStreamXmlResponseBodyConverter(Class<T> cls, XStream xStream) {
this.cls = cls;
this.xStream = xStream;
}
@Override
public T convert(ResponseBody value) throws IOException {
try {
this.xStream.processAnnotations(cls);
Object object = this.xStream.fromXML(value.byteStream());
return (T) object;
}finally {
value.close();
}
}
}
creare una classe per gestire la risposta del corpo.
final class XStreamXmlRequestBodyConverter<T> implements Converter<T, RequestBody> {
private static final MediaType MEDIA_TYPE = MediaType.parse("application/xml; charset=UTF-8");
private static final String CHARSET = "UTF-8";
private final XStream xStream;
XStreamXmlRequestBodyConverter(XStream xStream) {
this.xStream = xStream;
}
@Override
public RequestBody convert(T value) throws IOException {
Buffer buffer = new Buffer();
try {
OutputStreamWriter osw = new OutputStreamWriter(buffer.outputStream(), CHARSET);
xStream.toXML(value, osw);
osw.flush();
} catch (Exception e) {
throw new RuntimeException(e);
}
return RequestBody.create(MEDIA_TYPE, buffer.readByteString());
}
}
Quindi, questo punto possiamo inviare e ricevere qualsiasi XML, Abbiamo solo bisogno di creare annotazioni XStream per le entità.
Quindi creare un'istanza di Retrofit:
XStream xs = new XStream(new DomDriver());
xs.autodetectAnnotations(true);
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("http://example.com/")
.addConverterFactory(XStreamXmlConverterFactory.create(xs))
.client(client)
.build();
Una semplice richiesta POST con GSON
Esempio JSON:
{
"id": "12345",
"type": "android"
}
Definisci la tua richiesta:
public class GetDeviceRequest {
@SerializedName("deviceId")
private String mDeviceId;
public GetDeviceRequest(String deviceId) {
this.mDeviceId = deviceId;
}
public String getDeviceId() {
return mDeviceId;
}
}
Definisci il tuo servizio (endpoint da colpire):
public interface Service {
@POST("device")
Call<Device> getDevice(@Body GetDeviceRequest getDeviceRequest);
}
Definire l'istanza singleton del client di rete:
public class RestClient {
private static Service REST_CLIENT;
static {
setupRestClient();
}
private static void setupRestClient() {
// Define gson
Gson gson = new Gson();
// Define our client
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("http://example.com/")
.addConverterFactory(GsonConverterFactory.create(gson))
.build();
REST_CLIENT = retrofit.create(Service.class);
}
public static Retrofit getRestClient() {
return REST_CLIENT;
}
}
Definire un oggetto modello semplice per il dispositivo:
public class Device {
@SerializedName("id")
private String mId;
@SerializedName("type")
private String mType;
public String getId() {
return mId;
}
public String getType() {
return mType;
}
}
Definire il controller per gestire le richieste per il dispositivo
public class DeviceController {
// Other initialization code here...
public void getDeviceFromAPI() {
// Define our request and enqueue
Call<Device> call = RestClient.getRestClient().getDevice(new GetDeviceRequest("12345"));
// Go ahead and enqueue the request
call.enqueue(new Callback<Device>() {
@Override
public void onSuccess(Response<Device> deviceResponse) {
// Take care of your device here
if (deviceResponse.isSuccess()) {
// Handle success
//delegate.passDeviceObject();
}
}
@Override
public void onFailure(Throwable t) {
// Go ahead and handle the error here
}
});
Lettura dell'URL del modulo XML con Retrofit 2
Useremo il retrofit 2 e SimpleXmlConverter per ottenere dati xml dall'URL e analizzare alla classe Java.
Aggiungi dipendenza allo script Gradle:
compile 'com.squareup.retrofit2:retrofit:2.1.0'
compile 'com.squareup.retrofit2:converter-simplexml:2.1.0'
Crea interfaccia
Crea anche wrapper classe xml nel nostro caso classe Rss
public interface ApiDataInterface{
// path to xml link on web site
@GET (data/read.xml)
Call<Rss> getData();
}
Funzione di lettura Xml
private void readXmlFeed() {
try {
// base url - url of web site
Retrofit retrofit = new Retrofit.Builder()
.baseUrl(http://www.google.com/)
.client(new OkHttpClient())
.addConverterFactory(SimpleXmlConverterFactory.create())
.build();
ApiDataInterface apiService = retrofit.create(ApiDataInterface.class);
Call<Rss> call = apiService.getData();
call.enqueue(new Callback<Rss>() {
@Override
public void onResponse(Call<Rss> call, Response<Rss> response) {
Log.e("Response success", response.message());
}
@Override
public void onFailure(Call<Rss> call, Throwable t) {
Log.e("Response fail", t.getMessage());
}
});
} catch (Exception e) {
Log.e("Exception", e.getMessage());
}
}
Questo è un esempio di classe Java con annotazioni SimpleXML
Ulteriori informazioni sulle annotazioni SimpleXmlDocumentation
@Root (name = "rss")
public class Rss
{
public Rss() {
}
public Rss(String title, String description, String link, List<Item> item, String language) {
this.title = title;
this.description = description;
this.link = link;
this.item = item;
this.language = language;
}
@Element (name = "title")
private String title;
@Element(name = "description")
private String description;
@Element(name = "link")
private String link;
@ElementList (entry="item", inline=true)
private List<Item> item;
@Element(name = "language")
private String language;