retrofit应用详解与源码解析--小试牛刀

最新推荐文章于 2025-01-24 14:13:22 发布
置顶 最新推荐文章于 2025-01-24 14:13:22 发布
阅读量482 收藏
点赞数 1
CC 4.0 BY-SA版权
分类专栏： retrofit 文章标签： retrofit okhttp http
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/geduo_83/article/details/107493370
本文详述了Retrofit的使用，通过SpringBoot服务端与Android客户端的实例，展示了用户登录和注册的GET、POST请求。阐述了Retrofit如何简化网络请求，通过注解定义接口方法，实现调用的便捷性与代码可读性的提升。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

本文出自门心叼龙的博客，属于原创类容，未经允许，不得转载。

本专栏的同步视频教程已经发布到CSDN学院：https://edu.csdn.net/course/detail/30408

文章目录


调用更加方便，更加安全，架构清晰，代码简洁，反对臃肿，这是一个好软件永远所追求的目标，今天我们就通过Retrofit来感受一下他的魅力，看看和直接使用OkHttp进行调用到底方便在哪里？注意了：本专栏是基于Retrofit 2.9.6的研究。

在上一篇文章我们主要介绍了Retrofit的一个概况，以及几个常用的Android网络框架他们之间的区别，今天我们就来体验一下Retrofit的使用，我们还是以okhttp专栏中的两个接口为例进行演示，一个用户登录的get请求和一个用户注册的post请求。

实体定义

  • User的定义：
public class User {
    private String username;//	string	用户名
    private int password;//	string	密码   
}
  • BaseeResponse的定义
public class BaseResponse {
    private int code;//	Int	响应码
    private String msg;//	String	响应消息
}
  • AddUserResponse的定义
public class AddUserResponse extends BaseResponse {
   private User user;
}

服务端定义

服务端使用SpringBoot实现，下面我们看服务端是怎么定义的：

  • Controller的定义
@RestController
@RequestMapping("/user")
public class UserController {
    Logger logger = LoggerFactory.getLogger(UserController.class);
    ...
    ...
}
  • loginGet方法：
//1.用户登录的get请求
    @GetMapping("/login/get")
    public BaseResponse loginGet(@RequestParam String username, @RequestParam int password) {
        logger.info("login start...");
        BaseResponse response = new BaseResponse();
        if ("mxdl".equals(username) && password == 123456) {
            response.setCode(0);
            response.setMsg("登录成功");
        } else {
            response.setCode(-1);
            response.setMsg("登录失败");
        }
        return response;
    }
  • addUserPost方法：
//2.用户注册的post请求
    @PostMapping("/addUser/post")
    public AddUserResponse addUserPost(@RequestBody User user) {
        logger.info("login start...");
        AddUserResponse response = new AddUserResponse();
        if (user != null) {
            response.setCode(0);
            response.setMsg("创建成功");
            response.setUser(user);
        } else {

            response.setCode(-1);
            response.setMsg("创建失败");
        }
        return response;
    }

客户端实现

服务端和客户端是一 一对应的，下面我们看客户端使用Retrofit是怎么实现的：

  • 定义服务接口
public interface UserService {
    @GET("user/login/get")
    Call<BaseResponse> loginGet(@Query("username") String username, @Query("password") String password);

    @POST("user/addUser/post")
    Call<AddUserResponse> addUserPost(@Body User user);
}

定义了一个用户服务UserService，它是一个接口，接口里面定义个两个方法，一个用户登录的loginGet方法，和一个用户注册的addUserPost方法，通过注解完成了对请求数据的封装，调用网络请求就像调用普通方法一样的简单，方便，各个注解的主要意义如下：

  • loginGet方法：
注解类型作用
@GET方法注解1.注解的名称指定该方法是一个get方法
2.注解的值指定请求的url地址
@QUERY参数注解1.注解名称指定这是url后缀参数
2.注解的值指定后缀参数的名称
  • addUserPost方法：
注解注解作用
@POST方法注解1.注解名称指定该方法是一个post方法
2.注解的值指定该请求的url地址
@Body参数注解1.注解名称指定请求是一个json串格式的请求体

通过代码我们不难发现，服务端和客户端一样也是restful风格的，他们的参数对应关系如下：

客户端和服务端对比

客户端服务端
@GET(“user/login”)@GetMapping("/login")
@POST(“user/addUser”)@PostMapping("/addUser")
@Query(“username”) String username@RequestParam String username
@Query(“password”) String password@RequestParam int password
@Body User user@RequestBody User user

服务端和客户端的都定义好了，下面我们看它是怎么使用的：

使用用户登录方法

  • 用户登录
public void loginGet(View view) {
    	Log.v("MYTAG","loginGet start...");
        //1.利用建造者模式创建一个Retrofit
        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("http://192.168.0.189:8080")
                .addConverterFactory(GsonConverterFactory.create())
                .build();

        //2.通过动态代理创建一个用户服务
        UserService userService = retrofit.create(UserService.class);

        //3.创建一个登录命令
        Call<BaseResponse> loginCall = userService.loginGet("mxdl", "123456");

        //4.执行登录命令
        loginCall.enqueue(new Callback<BaseResponse>() {
            @Override
            public void onResponse(Call<BaseResponse> call, Response<BaseResponse> response) {
                Log.v("MYTAG", "onResponse start...");
                Log.v("MYTAG", response.body().toString());
            }

            @Override
            public void onFailure(Call<BaseResponse> call, Throwable t) {
                Log.v("MYTAG", "onFail start...");
                Log.v("MYTAG", t.toString());
            }
        });

    }
  1. 利用建造者模式创建一个Retrofit
  2. 通过动态代理创建一个用户服务
  3. 创建一个登录命令
  4. 执行登录命令

使用用户注册方法

  • 用户注册
public void addUserPost(View view) {
        Log.v("MYTAG", "addUserPost start...");
        //1.利用建造者模式创建一个Retrofit
        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("http://192.168.0.189:8080")
                .addConverterFactory(GsonConverterFactory.create())
                .build();
        //2.创建一个用户服务
        UserService userService = retrofit.create(UserService.class);

        //3.创建一个添加用户的命令
        Call<AddUserResponse> addUserCAll = userService.addUserPost(new User("mxdl", 123456));

        //4.执行一个命令
        addUserCAll.enqueue(new Callback<AddUserResponse>() {
            @Override
            public void onResponse(Call<AddUserResponse> call, Response<AddUserResponse> response) {
                Log.v("MYTAG", "onResponse start...");
                Log.v("MYTAG", response.body().toString());
            }

            @Override
            public void onFailure(Call<AddUserResponse> call, Throwable t) {
                Log.v("MYTAG", "onFail start...");
                Log.v("MYTAG", t.toString());
            }
        });

    }
  1. 利用建造者模式创建一个Retrofit
  2. 创建一个用户服务
  3. 创建一个添加用户的命令
  4. 执行一个命令

测试验证

  • loginGet方法
2020-07-19 12:26:13.552 6567-6567/com.mxdl.retrofit2 V/MYTAG: loginGet start...
2020-07-19 12:26:13.553 6567-6567/com.mxdl.retrofit2 V/MYTAG: hasJava8Types:true
2020-07-19 12:26:13.634 6567-6567/com.mxdl.retrofit2 V/MYTAG: create start...
2020-07-19 12:26:13.634 6567-6567/com.mxdl.retrofit2 V/MYTAG: Proxy invoke start...
2020-07-19 12:26:13.634 6567-6567/com.mxdl.retrofit2 V/MYTAG: loadServiceMethod start...
2020-07-19 12:26:14.352 6567-6567/com.mxdl.retrofit2 V/MYTAG: onResponse start...
2020-07-19 12:26:14.352 6567-6567/com.mxdl.retrofit2 V/MYTAG: BaseResponse{code=0, msg='登录成功'}
  • addUserPost方法
2020-07-19 12:27:55.588 6567-6567/com.mxdl.retrofit2 V/MYTAG: addUserPost start...
2020-07-19 12:27:55.589 6567-6567/com.mxdl.retrofit2 V/MYTAG: create start...
2020-07-19 12:27:55.590 6567-6567/com.mxdl.retrofit2 V/MYTAG: Proxy invoke start...
2020-07-19 12:27:55.590 6567-6567/com.mxdl.retrofit2 V/MYTAG: loadServiceMethod start...
2020-07-19 12:27:55.738 6567-6567/com.mxdl.retrofit2 V/MYTAG: onResponse start...
2020-07-19 12:27:55.738 6567-6567/com.mxdl.retrofit2 V/MYTAG: AddUserResponse{user=User{username='mxdl', password=123456}}

通过日志我们清楚的看到loginGet方法和addUserPost都能正常返回。

小结

今天我们就分享到这里，我们通过SpringBoot搭建了一个服务端，客户端定义了一个接口服务，接口里面通过注解定义了两个网络请求的方法，Retrofit能把接口方法适配成OkHttp中请求命令Call，有了这个请求命名我们就可以发起一个网络请求了，我们会发现在OkHttp中调用用户登录的时候需要通过HttpUrl来构建一个Request，在用户注册的时候会通过RequestBody来构建一个Request，而这些操作在Retrofit中都不需要了，我们只需要简简单单的通过注解来定义方法就可以了，我们就可以像调普通方法一样的调用网络请求了，我们有没有感觉到通过Retrofit来发起一个网络请求更加方便了，代码的可读性更强了，比起复杂HttpClient而言，我们会不会大声的喊一声：“Retrofit，I LOVE YOU”，哈哈哈，下一篇文章我们将介绍Retrofit更多注解的高级用法。

最后我将本文的相关源码上传到了github上：

Retrofit的使用详解（一）
zhangxing
10-12 3082
Retrofit是一种网络请求框架，出自Square公司android 大牛Jakewharton的大手笔，其底层封装了OkHttp的框架，将网络请求的任务全权交给了OkHttp，而 我们只需 通过简单的配置，就能很好的运行Retrofit了。
retrofit应用详解与源码解析--概述
门心叼龙的专栏
07-10 1201
Retrofit和OkHttp一样都是Jake Wharton大神的杰作，读书要读经典，学框架也要学经典，因为经典它经得起历史的考验，得到了人们的认可，我们不但要学会用，还要学习框架所体现出来的优秀的设计思想，设计原则，设计技巧和设计模式，以及脱离框架类似功能的实现方法，retrofit是基于okhttp构建的，因此retrofit所有的工作都是围绕RequestBody和ResponseBody展开的，Retrofit可以把一个接口里面定义的方法通过注解的方式把它适配成HTTP的请求命令
Retrofit使用详解
walk的博客
10-10 764
一、简介 Retrofit是一个RESTful的HTTP网络请求框架的封装，RESTful介绍见博客《RESTful API 最佳实践》。网络请求的工作本质上是OkHttp 完成，Retrofit仅负责网络请求接口的封装。App应用程序通过 Retrofit 请求网络，实际上是使用Retrofit接口层封装请求参数、Header、Url 等信息，之后由OkHttp 完成后续的请求操作。在服务端返...
Retrofit2.0使用说明
QQNKW的博客
01-13 541
转载这位大神的http://blog.csdn.net/ljd2038/article/details/51046512#t23 简单示例 添加Gradle依赖项 在这里我们最好查看一下retrofit的官网添加最新依赖。 compile 'com.squareup.retrofit2:retrofit:2.1.0' 别忘了添加网络权限 创建API接口 先写一个接
retrofit-spring-boot-starter：用于改进的springboot启动器，并支持许多功能增强，从而大大简化了开发。（实现了Retrofit与spring-boot框架快速整合，并支持了众多功能增强，极大简化了开发）
01-30
而spring-boot是使用最广泛的Java开发框架，但是Retrofit官方没有支持与spring-boot框架快速整合，因此我们开发了retrofit-spring-boot-starter 。 retrofit-spring-boot-starter实现了Retrofit与spring-boot框架...
Retrofit源码解析
m0_73986294的博客
05-24 933
serviceMethodCache是Retrofit2的一个缓存机制(实际上是Map)，用于缓存已经解析的ServiceMethod对象，ServiceMethod 对象代表了一个被注解修饰的接口方法，在Retrofit中，当你定义了一个接口用于发起网络请求时，每个接口方法背后都会对应一个。所以我们只需要看真正的实现，真正干事的部分，即代理实例调用方法的部分的invoke()里，在实际操作里，会执行对应Retrofit生成的动态代理类的invocationHandler.invoke()
基于Java的retrofit-spring-boot-starter集成设计源码
05-22
retrofit-spring-boot-starter集成设计源码：该项目基于Java开发，包含124个文件，主要使用Java语言。该项目是一个适用于retrofit的spring-boot启动器，支持快速集成和功能增强，适用于需要集成retrofit和spring-...
Retrofit源码解析---addConverterFactory和addCallAdapterFactory区别
热门推荐
new_abc的专栏
11-03 2万+
我们先看下前面写的接口 Call login( @Body User ueser);如果返回的是Observable格式，则这么定义接口： Observable login(@Body User ueser);从上面可以看到，Retrofit接口的返回值分为两部分，一部分是前面的Call或者Observable，另一部分是String。 addCallAdapterFactory影响的就是第
Retrofit的使用及原理详解
java521666的博客
08-04 1188
retrofit—>建造者—>create(动态代理)—>getPersonInfo接口（注解解析+URL拼接）到invoke方法中—>call.enqueue(丢给okHttp，realCall—>AsyncCall内部类，切到子线程)—> ExecutorCallAdapterFactory中返回数据的enqueue()方法（切回主线程callbackExecutor.execute()）...
Retrofit使用・原理详解
最新发布
weijiangbc0的博客
01-24 2185
定义一个接口，并使用注解指定HTTP请求的方法、URL、参数等。通过动态代理模式，在运行时生成接口的实现类，该实现类负责发起网络请求。通过OkHttp客户端发送HTTP请求，处理响应，并通过Converter将响应数据转换为对象。支持同步和异步回调，通过CallbackAdapterFactory处理回调逻辑‌。
retrofit源码解析
Sir的专栏
03-13 245
APP使用retrofit接口层封装请求参数，之后有okhttp完成后续的请求操作。 在服务端返回数据之后，okhttp将原始的结果交给retrofit，retrofit根据用户的需求对结果进行解析。 一、用法： 上传下载的一些正确用法 请求过程7步骤： 1、添加gradle依赖，网络权限 2、创建接收数据的Bean 3、注解配置网络请求接口 4、创建Retrofit实例（builder模式） 5、创建具体的网络请求接口的实例 6、通过call发送网络请求（enqueue或execute） 7、处.
retrofit2源码解析
devChenglei
04-11 762
在Android客户端的项目网络请求实践中，对retrofit进行了实践和源码的阅读。从retrofit的用法入手，对retrofit进行解析。 首先看一下retrofit的基本用法： 第一步创建retrofit对象：Retrofit retrofit = new Retrofit.Builder() .baseUrl(baseUrl) .build();
Retrofit 源码解析
xufei5789651的博客
11-16 3336
简介 一个用于Android和Java平台的类型安全的网络框架。Retrofit 是一个Square开发的类型安全的REST安卓客户端请求库。这个库为网络认证、API请求以及用OkHttp发送网络请求提供了强大的框架，底层对网络的访问默认也是基于OkHttp。 官网地址 Github 官网 依赖 implementation 'com.squareup.retrofit2:retrofit:2.9.0' 用法 基本用法 // 创建网络请求接口 interface Api { @GET("us
评论 5
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

门心叼龙

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值