android retrofit 从无知到入门


前言

本文会从零开始介绍retrofit的一些简单使用和封装,基于retrofit:2.3.0
让我们从滑板车🛴到轻轨🚄,😆😆😆


一、初识retrofit🛴

1.retrofit是什么?

retrofit官方文档的介绍非常的简洁明了,俗话说得好,字越少越牛逼,它是一个适用于Android和Java的类型安全HTTP客户端,它的底层是基于okhttp的,用了各种各样的设计模式封装起来的,在这里我们不多赘述,至于也不了解okhttp的,emmm,懂的都懂

2.一些配置和数据准备

既然是用于通信的,就不要忘记添加网络权限,在项目的Androidmanifest中添加

    <!-- 访问网络的权限 -->
    <uses-permission android:name="android.permission.INTERNET"></uses-permission>

当然也少不了添加依赖,为了不过多赘述这些,我们一次添加齐全,在build.gradle中添加

    //retrofit
    api 'com.squareup.retrofit2:retrofit:2.3.0'
    api 'com.squareup.retrofit2:converter-gson:2.3.0'
    api 'com.squareup.retrofit2:adapter-rxjava2:2.3.0'
    api 'com.trello.rxlifecycle2:rxlifecycle-components:2.2.1'
    api 'com.facebook.stetho:stetho:1.5.0'
    api 'com.facebook.stetho:stetho-okhttp3:1.5.0'

我们来一个请求的返回体
“为了规范我们写的规范一点”

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.Serializable;
import java.util.HashMap;
import java.util.Map;

@ApiModel(
    value = "DataResponse",
    description = "请求返回值"
)
public abstract class DataResponse<T> implements Serializable {
    private static final long serialVersionUID = -7574544066074667453L;
    @ApiModelProperty(
        value = "错误编码,0代表无错误",
        name = "errorCode"
    )
    private int errorCode = 0;
    @ApiModelProperty(
        value = "结果编码",
        name = "resultCode"
    )
    private String resultCode = "";
    @ApiModelProperty(
        value = "结果信息",
        name = "message"
    )
    private String message;
    @ApiModelProperty(
        value = "附加信息",
        name = "extInfo"
    )
    private Map<String, Object> extInfo = new HashMap();
    @ApiModelProperty(
        value = "请求返回数据",
        name = "data"
    )
    private T data;
    private String requestId;

    public DataResponse() {
    }

    public DataResponse(T data) {
        this.data = data;
    }

    public DataResponse(T data, int errorCode) {
        this.data = data;
        this.errorCode = errorCode;
    }

    public int getErrorCode() {
        return this.errorCode;
    }

    public void setErrorCode(int errorCode) {
        this.errorCode = errorCode;
    }

    public T getData() {
        return this.data;
    }

    public void setData(T data) {
        this.data = data;
    }

    public String getMessage() {
        return this.message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public Map<String, Object> getExtInfo() {
        return this.extInfo;
    }

    public void setExtInfo(Map<String, Object> extInfo) {
        this.extInfo = extInfo;
    }

    public String getResultCode() {
        return this.resultCode;
    }

    public void setResultCode(String resultCode) {
        this.resultCode = resultCode;
    }

    public boolean isError() {
        return this.errorCode != 0;
    }

    public String getRequestId() {
        return this.requestId;
    }

    public void setRequestId(String requestId) {
        this.requestId = requestId;
    }

    public String toString() {
        StringBuilder builder = new StringBuilder();
        builder.append("DataResponse [errorCode=");
        builder.append(this.errorCode);
        builder.append(", ");
        if (this.resultCode != null) {
            builder.append("resultCode=");
            builder.append(this.resultCode);
            builder.append(", ");
        }

        if (this.message != null) {
            builder.append("message=");
            builder.append(this.message);
            builder.append(", ");
        }

        if (this.extInfo != null) {
            builder.append("extInfo=");
            builder.append(this.extInfo);
            builder.append(", ");
        }

        if (this.data != null) {
            builder.append("data=");
            builder.append(this.data);
            builder.append(", ");
        }

        if (this.requestId != null) {
            builder.append("requestId=");
            builder.append(this.requestId);
        }

        builder.append("]");
        return builder.toString();
    }
}

自然我们也需要个请求头

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.Serializable;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;

@ApiModel(
    value = "DataRequest",
    description = "请求"
)
public abstract class DataRequest<T> implements Serializable {
    private static final long serialVersionUID = -7574544066074667453L;
    @ApiModelProperty(
        value = "请求数据",
        name = "data"
    )
    private T data;
    @ApiModelProperty(
        value = "附加信息",
        name = "extInfo"
    )
    private Map<String, String> extInfo = new HashMap();
    @ApiModelProperty(
        value = "附加动作",
        name = "action"
    )
    private String action;
    private String username;
    private String requestId;
    private Date requestTime;
    private String security;

    public DataRequest() {
    }

    public T getData() {
        return this.data;
    }

    public void setData(T data) {
        this.data = data;
    }

    public Map<String, String> getExtInfo() {
        return this.extInfo;
    }

    public void setExtInfo(Map<String, String> extInfo) {
        this.extInfo = extInfo;
    }

    public String getAction() {
        return this.action;
    }

    public void setAction(String action) {
        this.action = action;
    }

    public String toString() {
        StringBuilder builder = new StringBuilder();
        builder.append("DataRequest [");
        if (this.data != null) {
            builder.append("data=");
            builder.append(this.data);
            builder.append(", ");
        }

        if (this.extInfo != null) {
            builder.append("extInfo=");
            builder.append(this.extInfo);
            builder.append(", ");
        }

        if (this.action != null) {
            builder.append("action=");
            builder.append(this.action);
        }

        builder.append("]");
        return builder.toString();
    }

    public String getUsername() {
        return this.username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getSecurity() {
        return this.security;
    }

    public void setSecurity(String security) {
        this.security = security;
    }

    public String getRequestId() {
        return this.requestId;
    }

    public void setRequestId(String requestId) {
        this.requestId = requestId;
    }

    public Date getRequestTime() {
        return this.requestTime;
    }

    public void setRequestTime(Date requestTime) {
        this.requestTime = requestTime;
    }
}

3.快速上手retrofit

如果你学习过springboot,那么你对接下来这一套不要太熟悉,我们先来一个最简单的不带参get请求熟悉一下

a.接口

首先我们来一个Retrofit标准的接口

public interface ITestService {
    @GET("/test")
    Call<DefaultResponse<Object>> get();
}

其中
“/test”
代表我们与后台约定的路径;
DefaultResponse
代表我们与后台约定的发返回体
@GET
注解代表我们与后台约定这是一个get请求的注解;
Call方法
是我们需要了解的重中之重
retrofit2中的call方法源代码如下
在这里插入图片描述
翻译过来大概意思是该方法向Web服务器发送请求并返回响应,每个调用都会产生自己的HTTP请求和响应对。其他的方法一般用的不多,重点是execute()和enqueue(Callback callback),稍后我们会有示例

//execute同步执行请求
 	Response<T> execute() throws IOException;
//enqueue异步执行请求
  	void enqueue(Callback<T> callback);
//无论是哪种情况,都可以随时使用cancel取消通话。
	void cancel();
//使用clone对同一Web服务器进行多个参数相同的调用;这可用于实现轮询或重试失败的呼叫。
	Call<T> clone();

call接口的实现在源码的OkHttpCall中,这说明retrofit确实是基于OkHttp的,我们以execute()为例

  @Override public Response<T> execute() throws IOException {
    okhttp3.Call call;

    synchronized (this) {
      if (executed) throw new IllegalStateException("Already executed.");
      executed = true;

      if (creationFailure != null) {
        if (creationFailure instanceof IOException) {
          throw (IOException) creationFailure;
        } else {
          throw (RuntimeException) creationFailure;
        }
      }

      call = rawCall;
      if (call == null) {
        try {
          call = rawCall = createRawCall();
        } catch (IOException | RuntimeException e) {
          creationFailure = e;
          throw e;
        }
      }
    }

    if (canceled) {
      call.cancel();
    }

    return parseResponse(call.execute());
  }

至于为什么同步方法要抛异常,这是因为同步请求可能忙于写请求或读取响应的呼叫,这时就会抛出异常

b.实现

然后我们实现我们写的ITestService 接口,当然,这也是最简单的方式,并且这和springboot有一些区别

//这是后台的url
String url = "xxxxxxxxx"
Retrofit retrofit = new Retrofit.Builder()
  .baseUrl(url)
  .build();

ITestService service = retrofit.create(ITestService .class);

c.execute()和enqueue(Callback callback)

最后我们来调用我们写的第一个接口,前面说了,有两种方式

Call<DefaultResponse<Object>> responseCall = service .get()
//同步
try {
Response<DefaultResponse<Object>> responseResponse = responseCall.execute();
//判断请求是否成功
  if (responseResponse.isSuccessful()){
 			 DefaultResponse<Object> response = responseResponse.body();
  }
}catch (IOException e) {
          e.printStackTrace();
      }

//异步
responseCall.enqueue(new Callback<DefaultResponse<Object>>() {
              @Override
              public void onResponse(Call<DefaultResponse<Object>> call, Response<DefaultResponse<Object>> response) {
                  //成功的回调
              }

              @Override
              public void onFailure(Call<DefaultResponse<Object>> call, Throwable t) {
  				//失败的回调
              }
          }); 

这样,我们就能拿到后台接口的返回,这只是帮助你理解retrofit的模式,接下来,我们来深入了解一下其他的用法。

二、更多用法(注解介绍)🚲

之前我们展示了最简单的Get请求,并了解到可以使用@GET注解
如果你要使用别的请求,retrofit也提供了相对应的注解,可以满足我们的需求,甚至可以定制化请求,十分方便快捷。

1.八种请求注解

注解作用
@GETget请求
@POSTpost请求
@PUTput请求
@DELETEdelete请求
@OPTIONSOPTIONS请求
@PATCHPATCH请求
@HEADHEAD请求
@HTTP是上面注解的总和,可以实现上面所有请求,并可以拓展
下面是代码一些代码示例:

@GET


	//如果你的get请求想要带参数,你可以加上@Query
    @GET("/test")
    Call<DefaultResponse<Object>> get(@Query("id") String id);

@POST

	//post请求带请求体,加上@Body
	@POST("/test")	
	Call<DefaultResponse<Object>> post(@Body DataRequest request );

@PUT

	@PUT("/test")	
	Call<DefaultResponse<Object>> put(@Body DataRequest request );

@DELETE

	@DELETE("/test")	
	Call<DefaultResponse<Object>> delete(@Body DataRequest request );

@HTTP

	  /**
     * method:网络请求的方法(区分大小写)
     * path:网络请求地址路径
     * hasBody:是否有请求体
     */
    @HTTP(method = "GET", path = "blog/{id}", hasBody = false)
    Call<DefaultResponse<Object>> gethttp(@Path("id") int id);
    // {id} 表示是一个变量,@Path是他的路径
    // method 的值 retrofit 不会做处理,所以要自行保证准确

@OPTIONS与 @PATCH由于篇幅原因不多做示例

2.四种标记注解

注解作用
@Headers使用 @Headers 注解设置固定的请求头,所有请求头不会相互覆盖,即使名字相同。
@FormUrlEncoded表示发送form-encoded的数据,每个键值对需要用@Filed来注解键名,随后的对象需要提供值。
@Multipart表示发送form-encoded的数据(适用于 有文件 上传的场景),每个键值对需要用@Part来注解键名,随后的对象需要提供值。
@Streaming表示返回的数据将以流来返回,默认是载入内存的

注解太多了,下面的代码示例为官网示例

@Headers

@Headers("Cache-Control: max-age=640000")
@GET("widget/list")
Call<List<Widget>> widgetList();
@Headers({
    "Accept: application/vnd.github.v3.full+json",
    "User-Agent: Retrofit-Sample-App"
})

@FormUrlEncoded

@FormUrlEncoded
@POST("user/edit")
Call<User> updateUser(@Field("first_name") String first, @Field("last_name") String last);

@Multipart

@Multipart
@PUT("user/photo")
Call<User> updateUser(@Part("photo") RequestBody photo, @Part("description") RequestBody description);

@Streaming由于篇幅原因不多做示例

3.十二个参数注解

@Url
@Path
@Query @QueryName @QueryMap
@Header @HeaderMap
@Field @FieldMap
@Part @PartMap
@Body
这十二个参数注解是搭配上面的八种请求注解使用的,上面的示例代码也有部分使用到,有各种用途,这里以@Path为例。

注解作用
@Path接收一个字符串表示接口 path ,与 baseUrl 组成完整的 Url

@Path

@GET("users/{username}")
Call<User> getUser(@Path("username") String username);

三、进阶使用🚄

在初识retrofit中,我们了解了retrofit的基本构造方法和使用,但如果要实际运用到项目当中,那么简单的使用方法还不够,因为在实际项目中不可能每一个请求都像我们开始那样写一遍,所以我们要自己封装更好的

1.RetrofitService

这是我们一开始的使用方法,url一般是不会变的

//这是后台的url
String url = "xxxxxxxxx"
Retrofit retrofit = new Retrofit.Builder()
  .baseUrl(url)
  .build();

正如前言,这太low了,你拿这个跟别人说你会retrofit,大佬们看到了都会笑的,就像这样
在这里插入图片描述
所以我们需要RetrofitService
让我们基于之前的代码加上一点点的改动

public class RetrofitService {
private static RetrofitService i;
private Retrofit retrofit;
private  String url = "xxxxxxxxx"

public static RetrofitService i() {
      if (i == null) {
          i = new RetrofitService();
      }
      return i;
  }

  private RetrofitService() {
      try {
          retrofit = new Retrofit.Builder()
                  .baseUrl(url)
                  .build();
      }catch (Exception e){
          Log.e("RetrofitService", "RetrofitService: "+url+" ExceptionMessage: "+e.getMessage());
      }
  }
  
  public <T> T create(Class<T> clazz) {
      return retrofit.create(clazz);
  }

}


//当我们需要使用的时候,后面的使用方式是相同的哦
ITestService api = RetrofitService.i().create(ITestService .class);

2.ConverterFactory

只有一个单例模式的RetrofitService还远远不够,我们再在基础的构造方法中加一个全局的date类型转换,我们以Jackson为例,改动RetrofitService()方法

     private RetrofitService() {
     try {
     	ObjectMapper objectMapper = new ObjectMapper();
         objectMapper.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
         JacksonConverterFactory jacksonConverterFactory = JacksonConverterFactory.create(objectMapper);
         retrofit = new Retrofit.Builder()
                 .baseUrl(url)
                 //设置全局date类型转换
                 .addConverterFactory(jacksonConverterFactory)
                 .build();
     }catch (Exception e){
         Log.e("RetrofitService", "RetrofitService: "+url+" ExceptionMessage: "+e.getMessage());
     }
 }

3.OkHttpClient

有了类型转换,又怎么能没有超时时间和intercept呢?,这里使用了OkHttpClient,我们在RetrofitService中加入了如下改动


private static final OkHttpClient client = new OkHttpClient.Builder()
 		 //设置超时时间
         .connectTimeout(30, TimeUnit.SECONDS)
         .readTimeout(30, TimeUnit.SECONDS)
         //设置https证书
         .sslSocketFactory(HttpsUtils.getSslSocketFactory(null,null,null))
         .hostnameVerifier(new HostnameVerifier() {
             @Override
             public boolean verify(String hostname, SSLSession session) {
                 return true;
             }
         })
         .writeTimeout(30, TimeUnit.SECONDS).addInterceptor(new Interceptor() {
     @Override
     public Response intercept(Chain chain) throws IOException {
         Request.Builder builder = chain.request()
                 .newBuilder();
         	//添加头
             builder.addHeader("token", 111222333);
         
         Request request = builder.build();
         return chain.proceed(request);
     }
 }).build();

     private RetrofitService() {
     try {
     	ObjectMapper objectMapper = new ObjectMapper();
         objectMapper.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
         JacksonConverterFactory jacksonConverterFactory = JacksonConverterFactory.create(objectMapper);
         retrofit = new Retrofit.Builder()
                 .baseUrl(url)
                 //设置超时时间,intercept
                 .client(client)
                 //设置全局date类型转换
                 .addConverterFactory(jacksonConverterFactory)
                 .build();
     }catch (Exception e){
         Log.e("RetrofitService", "RetrofitService: "+url+" ExceptionMessage: "+e.getMessage());
     }
 }

至此,一个Retrofit工具类完成,如果你需要更多功能可以阅读Retrofit.java的源码
如果你想了解更多retrofit的基础用法,这里有官方的文档和供你参考

retrofit官网.

<think>嗯,用户想学习编程来搭建跨境电商独立站,但完全不懂编程,需要制定一个系统性的学习计划。首先,我得了解搭建独立站需要哪些技术栈。通常来说,前端需要HTML、CSS、JavaScript,后端可能需要PHP、Python或者Node.js,数据库的话MySQL或者MongoDB,还有服务器管理、支付接口、安全措施等等。 用户是零基础,所以得从最基础的编程概念开始。但也不能太理论,否则容易失去兴趣。应该结合实践,逐步引导。比如先学HTML和CSS,让用户能马上看到页面效果,增加成就感。然后JavaScript,让页面动态起来,接着后端语言,比如Python,因为相对容易入门,搭配框架如Django或Flask。数据库部分,先学SQL基础,再学ORM。之后教他们如何整合支付和物流API,最后部署到服务器。 还要考虑用户的目标是电商网站,所以需要涵盖电商特有的功能,比如商品管理、购物车、用户认证、支付网关、订单处理等。可能还需要介绍一些现有的电商平台或框架,比如Magento、Shopify,但用户想要自己搭建,所以应该用开源解决方案,比如WooCommerce或者基于Python的Saleor。 另外,用户可能需要了解一些前端框架,比如React或Vue,来提升用户体验,但作为初学者,可能先掌握基础再进阶。同时,版本控制工具Git也是必须的,方便代码管理。 需要分阶段规划,每个阶段有明确的目标和项目,比如第一阶段做静态页面,第二阶段增加交互,第三阶段实现后端逻辑,第四阶段整合数据库,最后完成整个电商功能并部署。还要推荐一些学习资源和练习项目,比如freeCodeCamp、Codecademy,以及实战项目如克隆一个简单电商网站。 还要注意时间安排,预估每个阶段的学习时间,比如每周10-15小时,持续6个月左右。提醒用户保持实践,参与社区,遇到问题如何解决,比如Stack Overflow、GitHub等。最后强调持续学习和迭代的重要性,因为技术会更新,需求也可能变化。</think>我将为你制定一个分阶段、循序渐进的学习计划,共分为6个阶段,预计需要6-8个月(每周投入10-15小时): # 第一阶段:编程基础(4-6周) ## 1. 计算机基础 - 学习内容:计算机组成原理、HTTP协议基础、域名解析原理 - 实践:注册域名(Namecheap/阿里云),了解DNS设置 - 推荐资源:MDN Web Docs「HTTP概述」 ## 2. HTML/CSS 基础 - 核心技能: - HTML5语义化标签 - CSS盒模型与Flex布局 - 响应式设计基础 - 媒体查询@media - 项目实践: 1. 制作商品详情页 2. 设计注册/登录表单 3. 克隆Amazon首页布局 # 第二阶段:前端开发(6-8周) ## 1. JavaScript 基础 - 学习路径: 1. ES6语法(let/const、箭头函数) 2. DOM操作 3. AJAX与Fetch API 4. 模块化开发 - 重点掌握: ```javascript // 示例:实现商品加入购物车功能 class Cart { constructor() { this.items = JSON.parse(localStorage.getItem('cart')) || []; } addItem(product) { const existing = this.items.find(item => item.id === product.id); existing ? existing.quantity++ : this.items.push({...product, quantity:1}); this._saveToStorage(); } _saveToStorage() { localStorage.setItem('cart', JSON.stringify(this.items)); } } ``` ## 2. 前端框架(React) - 必学内容: - JSX语法 - 组件生命周期 - React Router - 状态管理(Context API) - 实战项目:开发商品分类导航组件 # 第三阶段:后端开发(8-10周) ## 1. Node.js 基础 - 核心技术: - Express框架 - RESTful API设计 - 中间件机制 - JWT认证 - 示例代码: ```javascript // 商品API路由 app.get('/api/products', async (req, res) => { try { const { category } = req.query; const products = await Product.find(category ? { category } : {}); res.json(products); } catch (err) { res.status(500).json({ error: 'Server error' }); } }); ``` ## 2. 数据库(MongoDB) - 学习重点: - 文档型数据库设计 - Mongoose ODM - 索引优化 - 事务处理 - 数据模型示例: ```javascript const productSchema = new mongoose.Schema({ name: { type: String, required: true }, price: { type: Number, min: 0 }, sku: { type: String, unique: true }, inventory: { type: Number, default: 0 }, categories: [{ type: mongoose.Schema.Types.ObjectId, ref: 'Category' }] }); ``` # 第四阶段:电商核心功能开发(6-8周) ## 1. 支付系统集成 - 必接支付渠道: - PayPal(适合国际) - Stripe(信用卡支付) - 支付宝国际版 - 安全注意: - PCI DSS合规 - 使用第三方SDK - 永远不要存储信用卡信息 ## 2. 订单系统 - 核心流程: $$订单状态机 = \{ pending \rightarrow paid \rightarrow shipped \rightarrow delivered \} $$ - 需实现功能: - 库存实时扣减 - 订单取消/退款 - 物流追踪接口 # 第五阶段:部署与优化(4-6周) ## 1. 服务器部署 - 技术选型: - AWS EC2/Lightsail - Nginx反向代理 - PM2进程管理 - 部署步骤: 1. 购买云服务器 2. 安装Node.js环境 3. 配置HTTPS(Let's Encrypt) 4. 设置防火墙规则 ## 2. 性能优化 - 优化策略: - CDN加速静态资源 - 数据库索引优化 - 缓存策略(Redis) - 图片懒加载 - 代码压缩(Webpack) # 第六阶段:持续迭代(长期) 1. 监控系统: - 使用Sentry收集错误 - Google Analytics分析流量 2. SEO优化: - 结构化数据标记 - 生成sitemap.xml 3. 安全加固: - 定期备份数据库 - 实施CSP策略 - 防范XSS/CSRF攻击 # 学习资源推荐 1. 免费课程: - freeCodeCamp「Responsive Web Design」 - Codecademy「Learn JavaScript」 2. 书籍: - 《JavaScript高级程序设计》 - 《Node.js实战》 3. 工具链: - VS Code编辑器 - Postman API测试 - Git版本控制 # 注意事项 1. 每日代码量要求:初期≥100行,后期≥300行 2. 加入开发者社区(Stack Overflow/GitHub) 3. 定期代码Review(可找mentor或使用AI工具) 4. 不要过早追求完美,采用「最小可行产品」策略 这个计划需要投入约600-800小时的有效学习时间。建议从今天开始,先完成第一个HTML页面,每完成一个阶段就开发对应模块,最终整合成完整系统。过程中遇到具体技术问题,可以随时进一步提问。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

打赏作者

我怀里的猫

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

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

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

打赏作者

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

抵扣说明:

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

余额充值