王学岗Retrofit初探(一)——用户名和密码登录的实现

最新推荐文章于 2024-05-15 13:12:47 发布

qczg_wxg

最新推荐文章于 2024-05-15 13:12:47 发布

阅读量2.1k

点赞数

分类专栏： android 文章标签：网络

本文链接：https://blog.csdn.net/qczg_wxg/article/details/73387942

版权

android 专栏收录该内容

133 篇文章 0 订阅

订阅专栏

第一部分
我们先介绍下官网这些注释的含义

1,@Body:在学习OkHttp后我们知道，OKHttp post请求有两种方式一种是form表单，一种是json数据，

@Body的作用就是把User对象自动转化为json字符串，然后当作参数传递

@POST("users/new")
Call<User> createUser(@Body User user);

2，注意下面这种写法不需要添加转换器，即不需要添加addConverterFactory()

@GET("path1/path2")
Call<ResponseBody> createUser(@Body User user);

3，@Path是占位符，

 @GET("group/{id}/users")
Call<ResponseBody> createrUser(@Path("id")int groupId);

4，@FormUrlEncoded 通过表单的方式提交，更新用户信息
@Field(“username”)：post请求的参数名称(服务器接口参数名称对应，不能自己随便定义)，会自动添加到参数集合

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

5@Multipart包括文件和文本信息，举个例子，我们修改用户头像，和用户名字。然后一起提交给服务器。

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

例子详见我的第二篇文章

这里有篇文章可以让我们更好的理解
 多个文件上传
6@Headers 更改客户端Header的一些头信息

@Headers("Cache-Control: max-age=640000")
@GET("widget/list")
Call<List<Widget>> widgetList();

这里修改Headers信息。

@Headers({
    "Accept: application/vnd.github.v3.full+json",
    "User-Agent: Retrofit-Sample-App"
})
@GET("users/{username}")
Call<User> getUser(@Path("username") String username);

上面是官网中给的例子，我们自己跑一下看看是什么效果
自己定义一个方法

@POST("group/users")
@FormUrlEncoded
@Headers({"User-Agent:www.cniao5.com","my_name:cniao5"})
Call<ResponseBody> aa(@Field("username") String uname);

看看服务端的打印
在这里插入图片描述

User-Agent已经修改了，还有我们自己添加的头My-Name.
7，这是Swagger接口
在这里插入图片描述
定义接口

 /**
     * 投注记录 ---writing
     */
    @POST("mplayer/v1/record/betRecord")
    @Headers({"Authorization:Bearer ad8638ef-b402-48ad-835c-1c7ea424638c"})
    Observable<HttpResult<HttpRecords<List<BettingRecordBean>>>> getBettingRecord(@Body RequestBody body);

public class BettingRecordPresenter extends BaseListRAMPresenter<BaseListRAMViewable> {
    private String startTime;
    private String endTime;
    @Override
    public Observable<HttpResult<HttpRecords<List<BettingRecordBean>>>> onLoadDataHttpRequest() {
        HashMap<String, Object> params = new HashMap<>();
        params.put(HttpKeyConstant.CURRENT,getPage());
        params.put("endTime",endTime);
        params.put("size",getPageSize());
        params.put("startTime",startTime);
        params.put("platformType",new ArrayList<String>());
        return HttpServiceGenerator.create(API.class).getBettingRecord(HttpParamsUtil.getRequestBody(params));
    }
    public void setTime(String startTime,String endTime){
        this.startTime = startTime;
        this.endTime = endTime;
        onLoadData();
    }
}

package com.ds.aggregate.http.utils;

import com.google.gson.GsonBuilder;

import java.util.Map;

import okhttp3.MediaType;
import okhttp3.RequestBody;

/**
 * author : Sai
 * time   : 2019/06/03
 * desc   : 请求参数转body格式
 */
public class HttpParamsUtil {
    public static RequestBody getRequestBody(Map params) {
        return RequestBody.create(MediaType.parse("application/json;charset=UTF-8"), new GsonBuilder().disableHtmlEscaping().create().toJson(params));
    }
}

第二部分
我们的服务端是一个很简单的登录密码：输入用户名密码实现登录功能；当然这个功能很简单，我们看下如何使用Retrofit实现：
我在代码里已经注释的很详细了，这里就不多做讲解了：
先看我们的LoginService接口，有四个方法，分别实现post和get登录，同步请求和异步请求都有

package com.tz.architect.retrofit.simple3.inter;

import java.util.Map;

import retrofit2.Call;
import retrofit2.http.Field;
import retrofit2.http.FieldMap;
import retrofit2.http.FormUrlEncoded;
import retrofit2.http.GET;
import retrofit2.http.POST;
import retrofit2.http.Query;
import retrofit2.http.QueryMap;

public interface LoginService {
	/**接口名字：aa
	 * @FormUrlEncoded post请求需要添加的编码
	 * @POST("LoginServlet") ：post请求和请求接口(url地址的最后一个/后的字符串)
	 * @Field("username")：post请求的参数名称(服务器接口参数名称)，会自动添加到参数集合
	 * String uname:本地的参数名称，unname是自己定义的
	 *返回值： Call<T>,T是返回的类型
	 */
	@FormUrlEncoded
	@POST("LoginServlet")
	public Call<String> login(@Field("username") String uname,
			@Field("password") String password);
	/**
	 *参数一个一个的传太麻烦，传两个 
	 */
	@FormUrlEncoded
	@POST("LoginServlet")
	public Call<String> login(@FieldMap Map<String,String> pramsMap);
    /**
     *@Query:get请求拼接url请求参数 
     *拼接之后的url LoginServlet?username=值
     */
	@GET("LoginServlet")
	public Call<String> loginGet(@Query("username") String username,
			@Query("password") String password);
	
	@GET("LoginServlet")
	public Call<String> loginGet(@QueryMap Map<String,String> pramsMap);

}

在看我们的SimpleRetrofitLogin类

package com.tz.architect.retrofit.simple3;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

import retrofit2.Call;
import retrofit2.Callback;
import retrofit2.Response;
import retrofit2.Retrofit;
import retrofit2.converter.scalars.ScalarsConverterFactory;
import retrofit2.http.QueryMap;
import android.os.AsyncTask;

import com.tz.architect.retrofit.simple1.SimpleSystemLogin.OnHttpResultListener;
import com.tz.architect.retrofit.simple3.inter.LoginService;

/**
 * 网络框架：Retrofit实现
 *1， 依赖了okhttp,是对okhttp的封装和改进
 *2，准备一个java接口——LoginService
 * 
 * @author Dream
 *
 */
public class SimpleRetrofitLogin {
//服务器的接口，注意这里没必要写接口
	private static String URL_SERVER = "http://192.168.2.1:8080/Dream_Architect_Retrofit_Server/";
     //post请求，同步，提交用户名和密码，使用的接口是aa
	public static void loginSync(String username, String password,
			OnHttpResultListener onHttpResultListener) {
		Map<String, String> paramMap = new HashMap<String, String>();
		paramMap.put("username", username);
		paramMap.put("password", password);
		HttpTask httpTask = new HttpTask(paramMap, onHttpResultListener);
		httpTask.execute();
	}

	public static LoginService buildRetrofit() {
		//
		Retrofit retrofit = new Retrofit.Builder().baseUrl(URL_SERVER)
				/**
				 * 格式转换器，服务器返回的数据我采用什么样的方式对它解析;
				 * 转换器有很多种，需要为其准备相应的夹包
				 * Gson(gson)
				 * Jackson 转换json
				 * Moshi     一种数据格式
				 * Protobuf   一种数据格式
				 * Wire       
				 * Simple XML(converter-simplexml)    对xml解析
				 * Scalars(converter-scalars)    解析primitives,boxed,String格式
				 */
				.addConverterFactory(ScalarsConverterFactory.create()).build();

		// loginService实际是一个代理类
		return retrofit.create(LoginService.class);
	}

	public static void executeRetrofit(Call<String> callLogin,
			final OnHttpResultListener onHttpResultListener) {
		try {
			//call既可以执行同步请求也可以执行异步请求
			callLogin.enqueue(new Callback<String>() {

				@Override
				public void onResponse(Call<String> call,
						Response<String> response) {
					onHttpResultListener.onHttpResult(response.body());
				}

				@Override
				public void onFailure(Call<String> call, Throwable t) {
					onHttpResultListener.onHttpResult("登录失败!");
				}
			});
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	/**
	 * 异步：采用Retrofit卡框架自带的
	 *post请求 ，输入用户名和密码
	 * @param username
	 * @param password
	 * @param onHttpResultListener
	 */
	public static void loginAsync(String username, String password,
			final OnHttpResultListener onHttpResultListener) {
		// loginService实际是一个代理类,LoginService是我们定义的接口
		//LoginService loginService = retrofit.create(LoginService.class);
		LoginService loginService = buildRetrofit();
		Call<String> callLogin = loginService.login(username, password);
		executeRetrofit(callLogin, onHttpResultListener);
	}

	public static void loginGet(String username, String password,
			final OnHttpResultListener onHttpResultListener) {
		LoginService loginService = buildRetrofit();
		Call<String> callLogin = loginService.loginGet(username, password);
		executeRetrofit(callLogin, onHttpResultListener);
	}
/**
 * post请求，用Map集合传递参数
 */
	public static void loginPostField(String username, String password,
			final OnHttpResultListener onHttpResultListener) {
		// loginService实际是一个代理类
		LoginService loginService = buildRetrofit();
		Map<String, String> paramMap = new HashMap<String, String>();
		paramMap.put("username", username);
		paramMap.put("password", password);
		Call<String> callLogin = loginService.login(paramMap);
		executeRetrofit(callLogin, onHttpResultListener);
	}
	
	public static void loginGetQueryMap(String username, String password,
			final OnHttpResultListener onHttpResultListener) {
		// loginService实际是一个代理类
		LoginService loginService = buildRetrofit();
		Map<String, String> paramMap = new HashMap<String, String>();
		paramMap.put("username", username);
		paramMap.put("password", password);
		Call<String> callLogin = loginService.loginGet(paramMap);
		executeRetrofit(callLogin, onHttpResultListener);
	}

	static class HttpTask extends AsyncTask<Void, Void, Object> {

		private Map<String, String> paramMap;
		private OnHttpResultListener onHttpResultListener;

		public HttpTask(Map<String, String> paramMap,
				OnHttpResultListener onHttpResultListener) {
			this.paramMap = paramMap;
			this.onHttpResultListener = onHttpResultListener;
		}

		@Override
		protected Object doInBackground(Void... params) {
			//同步请求任务，post请求，提交用户名密码
			Retrofit retrofit = new Retrofit.Builder().baseUrl(URL_SERVER)
					.addConverterFactory(ScalarsConverterFactory.create())
					.build();
			LoginService loginService = retrofit.create(LoginService.class);
			Call<String> callLogin = loginService.login(
					paramMap.get("username"), paramMap.get("password"));
			try {
				//返回值是string类型
				Response<String> response = callLogin.execute();
				//这里的body直接返回String类型，
				/**
				 * body源码
				 * public T body(){
				 * return body;
				 * }
				**/
				//可以看出，你指定是什么泛型，他返回什么类型
				return response.body();
			} catch (IOException e) {
				e.printStackTrace();
			}

			return null;
		}

		@Override
		protected void onPostExecute(Object result) {
			if (this.onHttpResultListener != null) {
				this.onHttpResultListener.onHttpResult(result);
			}
		}

	}

}

该类中我自己定义了一个OnHttpResultListener 接口

	public interface OnHttpResultListener {
		public void onHttpResult(Object result);
	}

在main类中直接调用即可

qczg_wxg

关注

0
点赞
踩
2

收藏

觉得还不错? 一键收藏
0
评论
王学岗Retrofit初探(一)——用户名和密码登录的实现

我们的服务端是一个很简单的登录密码：输入用户名密码实现登录功能；当然这个功能很简单，我们看下如何使用Retrofit实现：我在代码里已经注释的很详细了，这里就不多做讲解了：先看我们的LoginService接口，有四个方法，分别实现post和get登录，同步请求和异步请求都有package com.tz.architect.retrofit.simple3.inter;import ja
复制链接

扫一扫