1-1.Retrofit 简单编码模板（创建接口、配置 Retrofit、创建接口代理对象、发送并处理请求）

于 2024-09-30 12:00:08 发布
阅读量509 收藏 3
点赞数 14
分类专栏： Android - 简化库编程 文章标签： retrofit ide 学习 java java-ee android 安卓
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_52173250/article/details/142653844
版权

一、Retrofit

1、Retrofit 概述
  • Retrofit 是一个网络请求库，专门用于发送 HTTP 请求和处理 HTTP 响应
2、Retrofit 引入
  1. 在 AndroidManifest.xml 文件中添加相关权限，如果是 Android 6.0（API 级别 23）或之后，需要在运行时请求
<uses-permission android:name="android.permission.INTERNET" />
  1. 在模块级 build.gradle 中引入相关依赖
implementation 'com.squareup.okhttp3:logging-interceptor:3.8.1'

implementation 'com.squareup.retrofit2:retrofit:2.9.0'
implementation 'com.squareup.retrofit2:converter-gson:2.9.0'
implementation 'com.squareup.retrofit2:converter-scalars:2.9.0'

implementation 'com.squareup.retrofit2:adapter-rxjava:2.1.0'
implementation 'io.reactivex:rxandroid:1.2.0'
3、Retrofit 使用步骤

  1. 创建接口：创建一个接口，并定义具体的请求方法，使用 Retrofit 提供的注解来描述 HTTP 请求

  2. 配置 Retrofit：使用 Retrofit.Builder 构建出一个 Retrofit 实例对象

  3. 创建接口代理对象：通过 Retrofit 实例对象创建接口的代理对象

  4. 发送并处理请求：调用接口方法发送网络请求，通过回调处理请求结果

二、Retrofit 初体验

1、Server
  • MyTestController.java
@Controller
@ResponseBody
@RequestMapping("/myTest")
@CrossOrigin
public class MyTestController {

    @GetMapping("testGet")
    public Staff testGet() {
        Staff staff = new Staff(1, "jack", 10);

        return staff;
    }
}
2、Client Api
  • ApiService.java
public interface ApiService {

    @GET("/test/testGet")
    Call<String> testGet();
}
3、Client Test
  • MainActivity.java
// 日志拦截器
HttpLoggingInterceptor httpLoggingInterceptor = new HttpLoggingInterceptor();
httpLoggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);

OkHttpClient.Builder okHttpClientBuilder = new OkHttpClient.Builder();
okHttpClientBuilder.addInterceptor(httpLoggingInterceptor);
OkHttpClient okHttpClient = okHttpClientBuilder.build();

// 构建 Retrofit 对象
Retrofit retrofit = new Retrofit.Builder()
        .baseUrl("http://192.168.0.10:9999")
        .client(okHttpClient)
        .addConverterFactory(ScalarsConverterFactory.create())
        .addConverterFactory(GsonConverterFactory.create()) // 解析实体类
        .addCallAdapterFactory(RxJavaCallAdapterFactory.create()) // 结合 RxJava
        .build();

ApiService apiService = retrofit.create(ApiService.class);

apiService.testGet().enqueue(new Callback<String>() {
    @Override
    public void onResponse(Call<String> call, Response<String> response) {
        String result = response.body();

        Log.i(TAG, "------------------------------ 请求成功，结果为：" + result);
    }

    @Override
    public void onFailure(Call<String> call, Throwable t) {
        Log.i(TAG, "------------------------------ 请求失败：" + t.getMessage());
    }
});
  • 输出结果
D/OkHttp: --> GET http://192.168.0.10:9999/test/testGet http/1.1
D/OkHttp: --> END GET

D/OkHttp: <-- 200  http://192.168.0.10:9999/test/testGet (96ms)
D/OkHttp: Vary: Origin
D/OkHttp: Vary: Access-Control-Request-Method
D/OkHttp: Vary: Access-Control-Request-Headers
D/OkHttp: Content-Type: text/plain;charset=UTF-8
D/OkHttp: Content-Length: 19
D/OkHttp: Date: Sun, 29 Sep 2024 13:07:40 GMT
D/OkHttp: Keep-Alive: timeout=60
D/OkHttp: Connection: keep-alive
D/OkHttp: testGet Hello World
D/OkHttp: <-- END HTTP (19-byte body)

I/MainActivity: ------------------------------ 请求成功，结果为：testGet Hello World

三、Retrofit 初体验案例解析

1、创建接口
  • 创建一个接口，并定义具体的请求方法，使用 Retrofit 提供的注解来描述 HTTP 请求

  1. @GET("/test/testGet")：表明该方法发送一个请求路径为 /test/testGet 的 GET 请求

  2. Call<String> testGet();：表明该请求的响应的响应体应该被解析成 String

public interface ApiService {

    @GET("/test/testGet")
    Call<String> testGet();
}
2、配置 Retrofit
  • 使用 Retrofit.Builder 构建出一个 Retrofit 实例对象
// 日志拦截器
HttpLoggingInterceptor httpLoggingInterceptor = new HttpLoggingInterceptor();
httpLoggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);

OkHttpClient.Builder okHttpClientBuilder = new OkHttpClient.Builder();
okHttpClientBuilder.addInterceptor(httpLoggingInterceptor);
OkHttpClient okHttpClient = okHttpClientBuilder.build();

// 构建 Retrofit 对象
Retrofit retrofit = new Retrofit.Builder()
        .baseUrl("http://192.168.0.10:9999")
        .client(okHttpClient)
        .addConverterFactory(ScalarsConverterFactory.create())
        .addConverterFactory(GsonConverterFactory.create()) // 解析实体类
        .addCallAdapterFactory(RxJavaCallAdapterFactory.create()) // 结合 RxJava
        .build();
3、创建接口代理对象
  • 通过 Retrofit 实例对象创建接口的代理对象
ApiService apiService = retrofit.create(ApiService.class);
4、发送并处理请求
  • 调用接口方法发送网络请求，通过回调处理请求结果
apiService.testGet().enqueue(new Callback<String>() {
    @Override
    public void onResponse(Call<String> call, Response<String> response) {
        String result = response.body();

        Log.i(TAG, "------------------------------ 请求成功，结果为：" + result);
    }

    @Override
    public void onFailure(Call<String> call, Throwable t) {
        Log.i(TAG, "------------------------------ 请求失败：" + t.getMessage());
    }
});

四、Retrofit 基础请求编码

1-1、GET 请求
（1）Server
  • MyTestController.java
@GetMapping("/testGet")
public String testGet() {
    return "testGet Hello World";
}
（2）Client Api
  • ApiService.java
@GET("/test/testGet")
Call<String> testGet();
（3）Client Test
  • MainActivity.java
apiService.testGet().enqueue(new Callback<String>() {
    @Override
    public void onResponse(Call<String> call, Response<String> response) {
        String result = response.body();

        Log.i(TAG, "------------------------------ 请求成功，结果为：" + result);
    }

    @Override
    public void onFailure(Call<String> call, Throwable t) {
        Log.i(TAG, "------------------------------ 请求失败：" + t.getMessage());
    }
});
  • 输出结果
D/OkHttp: --> GET http://192.168.0.10:9999/test/testGet http/1.1
D/OkHttp: --> END GET

D/OkHttp: <-- 200  http://192.168.0.10:9999/test/testGet (96ms)
D/OkHttp: Vary: Origin
D/OkHttp: Vary: Access-Control-Request-Method
D/OkHttp: Vary: Access-Control-Request-Headers
D/OkHttp: Content-Type: text/plain;charset=UTF-8
D/OkHttp: Content-Length: 19
D/OkHttp: Date: Sun, 29 Sep 2024 13:07:40 GMT
D/OkHttp: Keep-Alive: timeout=60
D/OkHttp: Connection: keep-alive
D/OkHttp: testGet Hello World
D/OkHttp: <-- END HTTP (19-byte body)

I/MainActivity: ------------------------------ 请求成功，结果为：testGet Hello World
1-2、GET 请求（带参）
（1）Server
  • MyTestController.java
@GetMapping("/testGetCarryData")
public String testGetCarryData(@RequestParam("str") String str) {
    return "testGetCarryData " + str;
}
（2）Client Api
  • ApiService.java
@GET("/test/testGetCarryData")
Call<String> testGetCarryData(@Query("str") String str);
（3）Client Test
  • MainActivity.java
apiService.testGetCarryData("12345").enqueue(new Callback<String>() {
    @Override
    public void onResponse(Call<String> call, Response<String> response) {
        String result = response.body();

        Log.i(TAG, "------------------------------ 请求成功，结果为：" + result);
    }

    @Override
    public void onFailure(Call<String> call, Throwable t) {
        Log.i(TAG, "------------------------------ 请求失败：" + t.getMessage());
    }
});
  • 输出结果
D/OkHttp: --> GET http://192.168.0.10:9999/test/testGetCarryData?str=12345 http/1.1
D/OkHttp: --> END GET

D/OkHttp: <-- 200  http://192.168.0.10:9999/test/testGetCarryData?str=12345 (98ms)
D/OkHttp: Vary: Origin
D/OkHttp: Vary: Access-Control-Request-Method
D/OkHttp: Vary: Access-Control-Request-Headers
D/OkHttp: Content-Type: text/plain;charset=UTF-8
D/OkHttp: Content-Length: 22
D/OkHttp: Date: Sun, 29 Sep 2024 13:38:41 GMT
D/OkHttp: Keep-Alive: timeout=60
D/OkHttp: Connection: keep-alive
D/OkHttp: testGetCarryData 12345
D/OkHttp: <-- END HTTP (22-byte body)

I/MainActivity: ------------------------------ 请求成功，结果为：testGetCarryData 12345
1-3、GET 请求（RESTFul）
（1）Entity
  • User.java
public class User {
    private int id;
    private String name;
    private int age;

    public User() {
    }

    public User(int id, String name, int age) {
        this.id = id;
        this.name = name;
        this.age = age;
    }

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}
（2）Server
  • MyTestController.java
@GetMapping("/testGetRestful/{id}")
public User testGetRestful(@PathVariable Integer id) {
    HashMap<Integer, User> userMap = new HashMap<>();
    userMap.put(1, new User(1, "jack", 10));
    userMap.put(2, new User(2, "tom", 20));
    userMap.put(3, new User(3, "smith", 30));

    return userMap.get(id);
}
（3）Client Api
  • ApiService.java
@GET("/test/testGetRestful/{id}")
Call<User> testGetRestful(@Path("id") int id);
（4）Client Test
  • MainActivity.java
apiService.testGetRestful(1).enqueue(new Callback<User>() {
    @Override
    public void onResponse(Call<User> call, Response<User> response) {
        User result = response.body();

        Log.i(TAG, "------------------------------ 请求成功，结果为：" + result);
    }

    @Override
    public void onFailure(Call<User> call, Throwable t) {
        Log.i(TAG, "------------------------------ 请求失败：" + t.getMessage());
    }
});
  • 输出结果
D/OkHttp: --> GET http://192.168.0.10:9999/test/testGetRestful/1 http/1.1
D/OkHttp: --> END GET

D/OkHttp: <-- 200  http://192.168.0.10:9999/test/testGetRestful/1 (50ms)
D/OkHttp: Vary: Origin
D/OkHttp: Vary: Access-Control-Request-Method
D/OkHttp: Vary: Access-Control-Request-Headers
D/OkHttp: Content-Type: application/json
D/OkHttp: Transfer-Encoding: chunked
D/OkHttp: Date: Sun, 29 Sep 2024 13:52:11 GMT
D/OkHttp: Keep-Alive: timeout=60
D/OkHttp: Connection: keep-alive
D/OkHttp: {"id":1,"name":"jack","age":10}
D/OkHttp: <-- END HTTP (31-byte body)

I/MainActivity: ------------------------------ 请求成功，结果为：User{id=1, name='jack', age=10}
2、POST 请求
（1）Entity
  • User.java
public class User {
    private int id;
    private String name;
    private int age;

    public User() {
    }

    public User(int id, String name, int age) {
        this.id = id;
        this.name = name;
        this.age = age;
    }

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}
（2）Server
  • MyTestController.java
@PostMapping("/testPost")
public User testPost(@RequestBody User user) {
    HashMap<Integer, User> userMap = new HashMap<>();
    userMap.put(1, new User(1, "jack", 10));
    userMap.put(2, new User(2, "tom", 20));
    userMap.put(3, new User(3, "smith", 30));

    return userMap.get(user.getId());
}
（3）Client Api
  • ApiService.java
@POST("/test/testPost")
Call<User> testPost(@Body User user);
（4）Client Test
  • MainActivity.java
User user = new User();
user.setId(1);

apiService.testPost(user).enqueue(new Callback<User>() {
    @Override
    public void onResponse(Call<User> call, Response<User> response) {
        User result = response.body();

        Log.i(TAG, "------------------------------ 请求成功，结果为：" + result);
    }

    @Override
    public void onFailure(Call<User> call, Throwable t) {
        Log.i(TAG, "------------------------------ 请求失败：" + t.getMessage());
    }
});
  • 输出结果
D/OkHttp: --> POST http://192.168.0.10:9999/test/testPost http/1.1
D/OkHttp: Content-Type: application/json; charset=UTF-8
D/OkHttp: Content-Length: 16
D/OkHttp: {"age":0,"id":1}
D/OkHttp: --> END POST (16-byte body)

D/OkHttp: <-- 200  http://192.168.0.10:9999/test/testPost (72ms)
D/OkHttp: Vary: Origin
D/libMEOW: rebuild call chain: 0xb400007288fafcc0
D/OkHttp: Vary: Access-Control-Request-Method
D/OkHttp: Vary: Access-Control-Request-Headers
D/OkHttp: Content-Type: application/json
D/OkHttp: Transfer-Encoding: chunked
D/OkHttp: Date: Sun, 29 Sep 2024 13:54:29 GMT
D/OkHttp: Keep-Alive: timeout=60
D/OkHttp: Connection: keep-alive
D/OkHttp: {"id":1,"name":"jack","age":10}
D/OkHttp: <-- END HTTP (31-byte body)

I/MainActivity: ------------------------------ 请求成功，结果为：User{id=1, name='jack', age=10}
我命由我12345
关注
专栏目录
Paw-RetrofitCodeGenerator:生成 Retrofit api 方法定义的 Paw 扩展
07-11
一旦你的请求配置完成，只需运行Paw-RetrofitCodeGenerator扩展，它会根据你的请求生成对应的Retrofit接口代码。 这个扩展支持的关键特性包括： 1. **请求转换**：它能够识别Paw中的HTTP请求，并将其转换为...
personal-android-project-rbrazell1：由GitHub Classroom创建的personal-android-project-rbrazell1
02-17
Retrofit和Gson等库可以帮助开发者轻松处理网络请求和数据解析。 6. **Android权限管理**：随着Android系统的发展，权限管理越来越严格，开发者需要了解如何申请和处理运行时权限。 总结，"personal-android-...
Android应用源码之中文天气预报程序-IT计算机-毕业设计.zip
04-06
7. **异步处理**：由于网络请求通常耗时较长，应使用AsyncTask、IntentService或Retrofit结合RxJava等异步处理技术，避免阻塞UI线程。 8. **Material Design**：遵循Android的设计指南，应用界面可以采用Material ...
Android-AndroidStudio快速创建常用工具类的插件
08-13
在生成工具类时，插件可能会提供预设的模板，如网络请求可能使用OkHttp或者Retrofit，日志打印可能使用Logcat。开发者可以根据项目需求选择合适的模板，然后自定义类名和方法名，插件会自动生成相应的代码。这样不仅...
安卓（Android）期末课程设计-喵喵二手交易.rar
06-13
《安卓（Android）期末课程设计-喵喵二手交易》是一个针对学生群体的Android应用开发实践项目，旨在帮助学习者掌握Android应用开发的基本技能，并能够应用于实际的课程设计中。这个项目提供了一个完整的应用模板，...
java短信接口
12-26
3. 发送POST请求到短信接口，并处理返回的响应结果。 4. 根据响应结果判断发送是否成功，如果失败，根据错误代码进行相应处理。 五、优化与注意事项 1. 异步发送：为了提高用户体验，可以采用异步发送，避免阻塞...
Android-Android的快速开发模板为了解决开发中的各种繁琐的操作
08-13
1. **集成常用第三方依赖**：模板通常会预先集成一些常用的Android库，例如网络请求库如Retrofit或Volley，数据持久化库如Room或GreenDao，图片加载库如Glide或Picasso，以及用于UI组件的库如ButterKnife或AndroidX...
AI双录对接文档-Android版本
最新发布
06-24
4. **ASR语义解析**：自动语音识别技术能够准确地理解客户的口头回答，将其转换成文本形式，便于进一步处理。 5. **TTS语音合成**：将预设的问题通过语音的形式向用户提出，增强用户体验的同时提高了自动化水平。 6....
AngeUnit:使用rxjava,dagger,sqlbrite,retrofit,组成综合框架demo
04-27
在AngeUnit项目中，Retrofit用于构建网络API接口，与RxJava配合，能够实现优雅的网络请求处理，包括错误处理和异步回调。 **SqlDelight** 是Square公司推出的SQL类型安全的DSL，它为SQL查询提供了强类型的支持，...
生成android常用的模板.zip
10-10
6. `Retrofit`或`Volley`请求：便捷地创建网络请求模板。 7. `LiveData`和`Observer`：对于MVVM架构，快速创建观察者模式的代码。 8. `SharedPreferences`操作：快速存取共享首选项。 9. `try-catch-finally`：简化...
Android_PopularMovies_STAGE_1
04-29
1. 使用Android Studio创建一个新的Android项目，选择"Empty Activity"模板。 2. 添加必要的依赖库，如Gson用于JSON解析，OkHttp或Retrofit用于网络请求。 3. 设置项目中的AndroidManifest.xml，确保有网络访问权限...
Android应用源码-拍照&文件上传&录像&监控类源代码（8例）.zip
10-22
这些源代码实例对于深入理解Android系统的多媒体处理和网络通信机制具有很高的学习价值，同时也为开发者提供了实际项目中的参考模板。下面将详细阐述这些功能的实现原理和关键知识点。 1. **拍照功能**： 在...
Android网络请求
03-16
例如，你可以创建一个HttpClient实例，然后使用HttpGet或HttpPost对象来指定URL，设置请求参数，最后执行execute方法来发送请求。然而，HttpClient自Android 6.0（API级别23）开始被弃用，因为它的维护成本较高，且...
Feign使编写java http客户端更容易.zip
05-21
- **动态代理：** 当创建一个Feign客户端时，实际上是创建了一个接口的动态代理对象。当调用接口方法时，这个代理对象会将请求转换为HTTP调用。 - **模板化：** Feign通过模板引擎解析接口方法上的注解，生成对应...
zxing.java源码解析-CS_Android_Web:CS_Android_Web学习资料汇总
06-06
这些算法主要基于图像处理技术，如灰度转换、二值化和模板匹配。 2. **UI组件**：ZXing提供了多种用户界面组件，包括相机预览界面和结果展示界面。这些组件是可定制的，开发者可以根据自己的需求进行调整。 3. **...
[Android实例] 【版主帖推荐】继人员列表，聊天的实现，包括图片，语音.rar
04-26
在Android中，使用OkHttp或者Retrofit库可以帮助我们更方便地处理网络请求。 最后，考虑到性能和内存管理，我们需要对数据进行适当的缓存，例如使用LRU Cache来存储最近使用的图片或语音文件。同时，合理地管理...
Android 注册界面源码.zip
06-18
这个源码包对于初学者和有经验的开发者都是一个很好的学习资源，可以深入理解Android界面设计、数据验证、网络通信等多个方面的知识，并且可以作为创建自己应用的参考模板。在实际项目中，开发者应根据需求对源码...
Android-Template
03-13
**Android-Template** 是一个专为Android开发设计的模板项目，旨在帮助开发者快速启动新项目，减少初期设置和配置的时间，提高开发效率。这个模板包含了基本的项目结构、必要的依赖库以及一些常用的代码示例，使得...
Feed-Me:具有Kotlin，Dagger2，翻新和Rx的MVP架构示例
05-02
它允许开发者定义服务接口，然后自动处理JSON序列化和反序列化，极大地简化了网络请求的处理。 4. **RxJava**： RxJava是一个反应式编程库，它提供了一种以观察者模式处理事件流的方式。在"Feed-Me"中，RxJava结合...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值