Retrofit 的注解详解：@GET, @POST, @Query

# 第一章：Retrofit简介
- 1.1 Retrofit框架概述
- 1.2 Retrofit的优势与特点
- 1.3 Retrofit的基本用法
## 第二章：Retrofit注解概览

- 2.1 注解在Retrofit中的作用
- 2.2 常用的Retrofit注解列表
- 2.3 注解的基本语法和用法
### 第三章：@GET注解详解

在本章中，我们将深入探讨Retrofit中的`@GET`注解，包括其作用、特点以及详细的使用方法。

#### 3.1 @GET注解的作用和特点

`@GET`注解用于指定Retrofit请求的HTTP方法为GET。使用该注解，可以将一个接口方法标记为GET请求，并且可以指定相对URL路径。

特点：
- 用于指定HTTP方法为GET
- 可以带有参数
- 可以指定相对URL路径

#### 3.2 @GET注解的用法示例

下面是一个简单的使用`@GET`注解的示例：

public interface ApiService {
    @GET("/user")
    Call<User> getUser(@Query("userId") int userId);
}

上述示例中，`@GET`注解用于标记`getUser`方法为GET请求，并且指定了相对URL路径为`/user`。同时，使用了`@Query`注解来添加查询参数。

#### 3.3 @GET注解中的参数说明

- 相对URL路径：指定相对于Retrofit实例配置的baseURL的相对路径。
- 查询参数：可通过`@Query`注解添加到方法参数中，用于构建GET请求的查询参数。

## 第四章：@POST注解详解

在Retrofit中，@POST注解用于指定HTTP请求中的POST方法。下面我们将详细介绍@POST注解的作用、特点和用法示例。

### 4.1 @POST注解的作用和特点

- 作用：@POST注解用于将接口方法标记为POST请求。
- 特点：通过@POST注解可以指定HTTP请求的body部分内容，通常用于向服务器提交数据。

### 4.2 @POST注解的用法示例

下面是一个使用@POST注解的示例：

public interface ApiService {
    @POST("login")
    Call<User> loginUser(@Body LoginRequest loginRequest);
}

在上面的示例中，@POST注解用于将loginUser方法标记为POST请求，并且指定了"login"作为相对URL地址。同时，方法参数中的@Body注解用于指定请求体的内容为LoginRequest对象。

### 4.3 @POST注解中的参数说明

- @POST注解中通常会指定相对URL地址，如@POST("login")。
- 可以在@POST注解中使用动态URL地址，例如：@POST("users/{userId}/profile")，并在方法参数中使用@Path注解来指定userId的值。

### 第五章：@Query注解详解

在本章中，我们将详细探讨Retrofit中的@Query注解。@Query注解是用于指定 GET 请求中的查询参数的注解，它允许我们在接口方法中定义查询参数，并将其添加到请求的 URL 中。

#### 5.1 @Query注解的作用和特点

@Query注解的作用是将参数添加到请求的 URL 中作为查询参数，以便服务器能够正确解析和处理请求。它的特点包括：

- 可以在接口方法的参数中使用@Query注解来指定查询参数
- 可以指定查询参数的键值对形式，Retrofit会将其添加到请求的URL中
- 如果查询参数的值为null，@Query注解会忽略该参数而不会将其添加到URL中

#### 5.2 @Query注解的用法示例

下面是一个简单的示例，演示了如何在Retrofit接口方法中使用@Query注解：

public interface ApiService {
    @GET("user")
    Call<User> getUserInfo(@Query("userId") String userId);
}

在上面的例子中，我们使用@Query注解指定了一个名为"userId"的查询参数，其取值为接口方法中的userId参数值。

#### 5.3 @Query注解中的参数说明

在使用@Query注解时，我们可以指定一些参数来对查询参数的行为进行进一步控制，这些参数包括：

- encoded: 指定该查询参数的值是否已经进行了URL编码，默认为false
- value: 指定查询参数的键名，如果不指定，默认使用被注解的参数名作为键名

## 第六章：其他常用注解

在本章中，我们将介绍一些在Retrofit中常用的其他注解，这些注解在实际开发中也有着重要的作用。接下来，我们将详细介绍它们的使用方法和特点。

### 6.1 其他常用注解的介绍

除了@GET和@POST之外，Retrofit还提供了许多其他常用的注解，例如@PUT、@DELETE、@HEAD等，它们分别对应HTTP请求方法中的PUT、DELETE、HEAD等。此外，Retrofit还提供了@Body、@Header、@Path等注解，用于更灵活地处理请求参数和请求头信息。

### 6.2 其他注解的使用示例

#### @PUT注解示例

@PUT("user/{id}")
Call<User> updateUser(@Path("id") int userId, @Body User user);

在上面的示例中，@PUT注解表示使用PUT请求方法，用于更新用户信息。@Path注解用于替换路径中的{id}部分，@Body注解用于发送请求体数据。

#### @DELETE注解示例

@DELETE("user/{id}")
Call<Void> deleteUser(@Path("id") int userId);

以上例子展示了@DELETE注解的用法，用于发送DELETE请求方法，用于删除用户信息。@Path注解同样用于替换路径中的{id}部分。

### 6.3 其他注解的特殊用法

在实际开发中，还可以结合@Header、@Query等注解，实现更加复杂的请求需求。例如，通过@Header注解可以添加请求头信息，通过@Query注解可以添加查询参数，从而更加灵活地构建请求。

通过本章的介绍，相信大家已经对Retrofit中的常用注解有了更加深入的了解，这些注解将在实际项目中发挥重要作用。