Android 用户登录 cookie 管理设计与实现

 更新时间:2016年10月2日 16:23  点击:2228
下面我们一起来看一篇关于Android 用户登录 cookie 管理设计与实现例子,希望这篇文章能够帮助到各位朋友。

功能需求

基本上每个社交 APP 都有其账号体系或者是允许允许用户第三方登录。用户登录成功后,APP 应该记录用户登录状态,用户退出后再登录就不再需要输入密码与账号了。

实现设计

服务端登录成功后返回注册用户信息
客户端在成功回调中将用户信息持久化记录到硬盘中
使用数据库存储用户信息,这里我使用了第三方库 ActiveAndroid
对 Bean 类进行封装,对用户敏感信息进行加密
每次登录时预先检查用户是否登录,如是,直接跳过登录界面
在 Application 类中维持一个用户登录状态的应用,便于程序动态调用
RESTful 接口

 代码如下 复制代码

服务端
// POST ['email', 'password'];
        // 普通的注册才使用这个接口,第三方直接登录即可
        $api->post('register', 'UserController@createUser');
        // POST ['email', 'password', 'is_third']
        // POST ['uid', 'is_third']
        $api->post('login', 'UserController@login');
        $api->get('users', 'UserController@getUsers');
移动端
// ['name', 'email', 'password', 'is_third', 'gender', 'birthday'];
    @FormUrlEncoded
    @POST("register")
    Observable<User> createUser(@Field("name") String name, @Field("email") String email,
                                @Field("password") String password, @Field("is_third") String is_third,
                                @Field("gender") String gender, @Field("birthday") String birthday);

    // local ['email', 'password', 'is_third']
    @FormUrlEncoded
    @POST("login")
    Observable<User> login( @Field("email") String email, @Field("password") String password,
                            @Field("is_third") String is_third);

    // third ['uid', 'is_third']
    @FormUrlEncoded
    @POST("login")
    Observable<User> login( @Field("uid") String uid, @Field("is_third") int is_third);
AccountBean 用户类

@Table(name = "account")
public class AccountBean extends Model {

    private final static int NO_ACCOUNT = 0;

    @Expose
    @Column(name = "user_id")
    public int userID;
    @Column(name = "email")
    public String email;
    @Column(name = "name")
    public String name;
    @Column(name = "gender")
    public int gender;
    @Column(name = "birthday")
    public String birthday;
    @Column(name = "is_third")
    public int isThird;

    public AccountBean(User user){
        this.userID = user.getId();
        this.email = user.getEmail();
        this.birthday = user.getBirthday();
        this.gender = user.getGender();
        this.isThird = user.getIsThird();
    }

    public static void cacheAccountInfo(User user){
        AccountBean accountBean = new AccountBean(user);
        accountBean.save();
    }

    public static void logoutAccount(){
        long id = getAccountID();
        if(id != NO_ACCOUNT){
            AccountBean.delete(AccountBean.class, id);
        }
    }

    public static boolean existAccountCache(){
        List<AccountBean> accounts = getAllAccounts();
        return (accounts.size() == 1);
    }

    public static long getAccountID(){
        if(existAccountCache()){
            List<AccountBean> accounts = getAllAccounts();
            return accounts.get(0).getId();
        }
        return NO_ACCOUNT;
    }

    public static List<AccountBean> getAllAccounts(){
        return new Select().from(AccountBean.class).execute();
    }

}

移动端Application 子类

 代码如下 复制代码

public class ColorTalkApp extends Application {

    public static AccountBean sAccount = null;

        public static int getLoginedUserID(){
        if(sAccount == null){
            return 0;
        }
        return sAccount.getUserID();
    }

}

服务端 UserRepository

 代码如下 复制代码

public function loginIntoSystem($payload){
        $isThird = $payload['is_third'];
        if($isThird == User::THIRD_TRUE){
            $uid = $payload['uid'];
            $user = $this->thirdAccountRegister($uid);
            return array('result' => true, 'content' => $user);
        } else{
            $email = $payload['email'];
            $password = $payload['password'];
            return $this->localAccountRegister($email, $password);
        }
    }

private function localAccountRegister($email, $password){
        if(!User::isAccountRegistered($email)){
            return array('result' => false, 'message' => 'The email has not been registered!');
        }
        if(!User::isAccountValid($email, $password)){
            return array('result' => false, 'message' => 'The email and password do not match!');
        }
        $user = User::getLocalUserByEmail($email);
        return array('result' => true, 'content' => $user);
    }

private function thirdAccountRegister($uid){
        if(!User::isThirdAccountRegisted($uid)){
            $user = User::create([
                'name' => User::THIRD_NEW_USER,
                'uid' => $uid,
                'is_third' => User::THIRD_TRUE,
            ]);
            return $user;
        } else{
            $user = User::getThirdUserByUid($uid);
            return $user;
        }
    }

服务端 User 类

 代码如下 复制代码

public static function isAccountRegistered($email)
    {
        return (User::where('email', $email)->first() != null);
    }

    public static function isThirdAccountRegisted($uid){
        return (User::where('uid', $uid)->first() != null);
    }

    public static function isAccountValid($email, $password)
    {
        $user = User::where('email', $email)->first();
        if ($user != null) {
            return Hash::check($password, $user->password);
        }
        return false;
    }

    public static function isThirdAccountValid($uid)
    {
        return User::isThirdAccountRegisted($uid);
    }

    public static function getThirdUserByUid($uid){
        return User::where('uid', $uid)->first();
    }

    public static function getLocalUserByEmail($email){
        return User::where('email', $email)->first();
    }

Android滑动与点击冲突问题我们其实就是从几个事件来进行排查分析了,这个在安卓中要如何来分析具体的我们一起来看这篇Android滑动与点击冲突解决办法吧。


缘由

RecyclerView item可以实现滑动的监听,可以允许用户左滑动右滑动消失,也允许用户点击item。 分别需要重载onTouch与onClick方法,但两者时间会冲突,onClick会消费掉事件,导致事件不会传递到onTouch中。解决方法是将onClick的逻辑移动到onTouch中。

判定条件

参考资料1,使用了时间与移动距离两个变量要确保用户的确是想要点击item。满足这个条件将会调用onClick里的逻辑,否则滑动逻辑将被调用。时间控制在1s内, 思路是在ACTION_DOWN中记一个按下按钮的时间,在ACTION_UP判断是否ACTION_UP到ACTION_DOWN需要的时间小不小于1s;距离是衡量值是从ViewConfiguration这个类中取出来的,是安卓推荐的数据。

具体代码

private static final int MAX_CLICK_DURATION = 1000;

private int mSlop;

private long pressStartTime;
private float pressedX;
private float pressedY;

...

ViewConfiguration vc = ViewConfiguration.get(builder.mRecyclerView.getContext());
mSlop = vc.getScaledTouchSlop();

...

case MotionEvent.ACTION_DOWN: {
    pressStartTime = System.currentTimeMillis();
    pressedX = motionEvent.getX();
    pressedY = motionEvent.getY();

...

case MotionEvent.ACTION_UP: {
    long pressDuration = System.currentTimeMillis() - pressStartTime;
        if (pressDuration < MAX_CLICK_DURATION && distance(pressedX, pressedY,                  motionEvent.getX(), motionEvent.getY()) < mSlop) {
                mItemClickCallback.onClick(mRecyclerView.getChildPosition(mDownView));
                 return true;
 }

下面我们来看一篇关于Android编译时注解框架系列2-Run示例,希望这个例子能够帮助到各位理解到Android编译时注解框架系列2-Run用法。
概述
先讲一下编写《Android编译时注解框架》的初衷吧,APT其实并不难,可以说是简单且高效,但关于 APT的资料却并不多,甚至很多人都不知道这么一个技术。国内关于APT的博客屈指可数,唯二找到的几篇初级讲解一个是用Eclipse写得,一个是用 AndroidStudio加Intellij。刚开始着实踩了不少坑,但事实是,APT完全可以用AndroidStudio单独实现。光是项目搭建就如此麻烦了,更别提语法讲解了。资料匮乏无疑提高了APT的入门门槛。
正因为如此,这个系列博客就这样诞生啦~现在就教你用AndroidStudio一步步打造自己的APT框架。
以我自己的学习习惯来讲,比起前期大量枯燥的基础知识积累,我更喜欢先把项目跑起来再说,虽然会不明所以,但反而会促进学习兴趣,并且在有结果的场景下一步步深入。
所以作为《Android编译时注解框架》系列的第二篇,我们不管三七二十一,先把APT跑起来再说,看看这到底是个什么东西。跑起来,就入门啦!
在Running的过程中,有很多语法,我们都暂时一并跳过,都放到《Android编译时注解框架-语法讲解》统一讲。
Running
项目搭建
首先创建一个Android项目
然后给我们的项目增加一个module,一定要记得是Java Library.
因为APT需要用到jdk下的 【 javax.~ 】包下的类,这在AndroidSdk中是没有的。
自定义注解
新建一个类,GetMsg。就是我们自定义的注解。
这是一个编译时注解,用@Retention(RetentionPolicy.CLASS)修饰。
这个注解只能修饰方法。用@Target(ElementType.METHOD)修饰。
且这个注解可以设置两个值。id和name。name是有默认值的,可以不设置。
创建Processor
Processor是用来处理Annotation的类。继承自AbstractProcessor。
复写AbstractProcessor两个最重要的方法。
process方法是用来处理注解的,我们一会写。
getSupportedAnnotationTypes用来表示该Processor处理哪些注解。这里我们只有一个GetMsg注解需要处理。
重写process方法
我们的目的呢,是获取修饰了GetMsg注解的方法所有信息,只有获得了这些信息,才有依据生成代码不是吗?
@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment env) {
    Messager messager = processingEnv.getMessager();
    for (Element element : env.getElementsAnnotatedWith(GetMsg.class)) {
        PackageElement packageElement = (PackageElement) element
                .getEnclosingElement();
        //获取该注解所在类的包名
        String packageName = packageElement.getQualifiedName().toString();
        TypeElement classElement = (TypeElement) element;
        //获取该注解所在类的类名
        String className = classElement.getSimpleName().toString();
        //获取该注解所在类的全类名
        String fullClassName = classElement.getQualifiedName().toString();
        VariableElement variableElement = (VariableElement) element.getEnclosingElement();
        //获取方法名
        String methodName = variableElement.getSimpleName().toString();
        //获取该注解的值
        int id = classElement.getAnnotation(GetMsg.class).id();
        String name = classElement.getAnnotation(GetMsg.class).name();
        messager.printMessage(Diagnostic.Kind.NOTE,
                "Annotation class : packageName = " + packageName);
        messager.printMessage(Diagnostic.Kind.NOTE,
                "Annotation class : className = " + className);
        messager.printMessage(Diagnostic.Kind.NOTE,
                "Annotation class : fullClassName = " + fullClassName);
        messager.printMessage(Diagnostic.Kind.NOTE,
                "Annotation class : methodName = " + methodName);
        messager.printMessage(Diagnostic.Kind.NOTE,
                "Annotation class : id = " + id + "  name = " + name);
    }
    return true;
}
简单介绍一下代码:
1.Messager 用来输出。就像我们平时用的System.out.pringln()和Log.d。输出位置在编译器下方的Messages窗口。这里System.out也是可以用的哦~
2.用for循环遍历所有的 GetMsg注解,然后进行处理。
3.Diagnostic.Kind.NOTE 类似于Log.d Log.e这样的等级。
4.return true;表示该Process已经处理了,其他的Process不需要再处理了。
配置
一定不能忘记的文件配置。
在main文件夹下创建一个resources.META-INF.services文件夹,创建文件
javax.annotation.processing.Processor
文件内容是Process类的包名+类名
忘记这个配置文件的后果就是,注解无法生效。
编译jar
这里有一个坑,我们的主Module是不可以直接引用这个java Module的。(直接引用,可以成功运行一次~修改代码以后就不能运行了)
而如何单独编译这个java Module呢?
在编译器Gradle视图里,找到Module apt下的build目录下的Build按钮。双击运行。
代码没有问题编译通过的话,会有BUILD SUCCESS提示
生成的jar包在 apt 下的build目录下的libs下
将apt.jar拷贝到app下的libs目录,右键该jar,点击Add as Library,添加Library.
在APP项目中使用该注解GetMsg。运行。
当你apt这个包的代码有修改时,需要重复2.6这个步骤。这是比较烦的,但是没办法
运行结果
总结
这个Demo只是使用了注解,并且根据注解得到一些必要的信息。没有做代码生成的操作,生成代码的具体操作我们放到后面开始写框架时再讲。
Retrofit与OkHttp师出同门,也是Square的开源库,它是一个类型安全的网络请求库,Retrofit简化了网络请求流程了,这里我们来看Android开发之Retrofit用法详解吧。

Retrofit是Square公司开发的一款针对Android网络请求的框架,Retrofit2底层基于OkHttp实现的,OkHttp现在已经得到Google官方认可,大量的app都采用OkHttp做网络请求,其源码详见 OkHttp Github 。

本文全部是在Retrofit2.0+版本基础上论述,所用例子全部来自豆瓣Api

首先先来看一个完整Get请求是如何实现:

创建业务请求接口,具体代码如下:

 代码如下 复制代码
public interface BlueService {
    @GET("book/search")
    Call<BookSearchResponse> getSearchBooks(@Query("q") String name,
      @Query("tag") String tag, @Query("start") int start,
      @Query("count") int count);
}

这里需要稍作说明,@GET注解就表示get请求,@Query表示请求参数,将会以key=value的方式拼接在url后面

需要创建一个Retrofit的示例,并完成相应的配置

 代码如下 复制代码

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("https://api.douban.com/v2/")
    .addConverterFactory(GsonConverterFactory.create())
    .build();

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

这里的baseUrl就是网络请求URL相对固定的地址,一般包括请求协议(如Http)、域名或IP地址、端口号等,当然还会有很多其他的配置,下文会详细介绍。还有addConverterFactory方法表示需要用什么转换器来解析返回值,GsonConverterFactory.create()表示调用Gson库来解析json返回值,具体的下文还会做详细介绍。

调用请求方法,并得到Call实例

Call<BookSearchResponse> call = mBlueService.getSearchBooks("小王子", "", 0, 3);
Call其实在Retrofit中就是行使网络请求并处理返回值的类,调用的时候会把需要拼接的参数传递进去,此处最后得到的url完整地址为

https://api.douban.com/v2/book/search?q=%E5%B0%8F%E7%8E%8B%E5%AD%90&tag=&start=0&count=3

使用Call实例完成同步或异步请求

同步请求

BookSearchResponse response = call.execute().body();
这里需要注意的是网络请求一定要在子线程中完成,不能直接在UI线程执行,不然会crash

异步请求

 代码如下 复制代码

call.enqueue(new Callback<BookSearchResponse>() {
  @Override
  public void onResponse(Call<BookSearchResponse> call,   Response<BookSearchResponse> response) {
   asyncText.setText("异步请求结果: " + response.body().books.get(0).altTitle);
  }
  @Override
  public void onFailure(Call<BookSearchResponse> call, Throwable t) {

  }
});

二、如何使用

首先需要在build.gradle文件中引入需要的第三包,配置如下:

 代码如下 复制代码
compile 'com.squareup.retrofit2:retrofit:2.1.0'
compile 'com.squareup.retrofit2:converter-gson:2.1.0'
compile 'com.squareup.retrofit2:adapter-rxjava:2.1.0'

引入完第三包接下来就可以使用Retrofit来进行网络请求了。接下来会对不同的请求方式做进一步的说明。

Get方法

1. @Query

Get方法请求参数都会以key=value的方式拼接在url后面,Retrofit提供了两种方式设置请求参数。第一种就是像上文提到的直接在interface中添加@Query注解,还有一种方式是通过Interceptor实现,直接看如何通过Interceptor实现请求参数的添加。

 代码如下 复制代码
public class CustomInterceptor implements Interceptor {
    @Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request();
        HttpUrl httpUrl = request.url().newBuilder()
                .addQueryParameter("token", "tokenValue")
                .build();
        request = request.newBuilder().url(httpUrl).build();
        return chain.proceed(request);
    }
}

addQueryParameter就是添加请求参数的具体代码,这种方式比较适用于所有的请求都需要添加的参数,一般现在的网络请求都会添加token作为用户标识,那么这种方式就比较适合。

创建完成自定义的Interceptor后,还需要在Retrofit创建client处完成添加

 代码如下 复制代码
addInterceptor(new CustomInterceptor())

2. @QueryMap

如果Query参数比较多,那么可以通过@QueryMap方式将所有的参数集成在一个Map统一传递,还以上文中的get请求方法为例

 代码如下 复制代码
public interface BlueService {
    @GET("book/search")
    Call<BookSearchResponse> getSearchBooks(@QueryMap Map<String, String> options);
}

调用的时候将所有的参数集合在统一的map中即可

 代码如下 复制代码
Map<String, String> options = new HashMap<>();
map.put("q", "小王子");
map.put("tag", null);
map.put("start", "0");
map.put("count", "3");
Call<BookSearchResponse> call = mBlueService.getSearchBooks(options);

3. Query集合

假如你需要添加相同Key值,但是value却有多个的情况,一种方式是添加多个@Query参数,还有一种简便的方式是将所有的value放置在列表中,然后在同一个@Query下完成添加,实例代码如下:

 代码如下 复制代码
public interface BlueService {
    @GET("book/search")
    Call<BookSearchResponse> getSearchBooks(@Query("q") List<String> name);
}

最后得到的url地址为

https://api.douban.com/v2/book/search?q=leadership&q=beyond%20feelings
4. Query非必填

如果请求参数为非必填,也就是说即使不传该参数,服务端也可以正常解析,那么如何实现呢?其实也很简单,请求方法定义处还是需要完整的Query注解,某次请求如果不需要传该参数的话,只需填充null即可。

针对文章开头提到的get的请求,加入按以下方式调用

Call<BookSearchResponse> call = mBlueService.getSearchBooks("小王子", null, 0, 3);
那么得到的url地址为

https://api.douban.com/v2/book/search?q=%E5%B0%8F%E7%8E%8B%E5%AD%90&start=0&count=3
5. @Path

如果请求的相对地址也是需要调用方传递,那么可以使用@Path注解,示例代码如下:

@GET("book/{id}")
Call<BookResponse> getBook(@Path("id") String id);
业务方想要在地址后面拼接书籍id,那么通过Path注解可以在具体的调用场景中动态传递,具体的调用方式如下:

Call<BookResponse> call = mBlueService.getBook("1003078");
此时的url地址为

https://api.douban.com/v2/book/1003078
@Path可以用于任何请求方式,包括Post,Put,Delete等等

Post请求

1. @field

Post请求需要把请求参数放置在请求体中,而非拼接在url后面,先来看一个简单的例子

 代码如下 复制代码
@FormUrlEncoded
@POST("book/reviews")
Call<String> addReviews(@Field("book") String bookId, @Field("title") String title,
@Field("content") String content, @Field("rating") String rating);

这里有几点需要说明的

@FormUrlEncoded将会自动将请求参数的类型调整为application/x-www-form-urlencoded,假如content传递的参数为Good Luck,那么最后得到的请求体就是

content=Good+Luck
FormUrlEncoded不能用于Get请求

@Field注解将每一个请求参数都存放至请求体中,还可以添加encoded参数,该参数为boolean型,具体的用法为

@Field(value = "book", encoded = true) String book
encoded参数为true的话,key-value-pair将会被编码,即将中文和特殊字符进行编码转换

2. @FieldMap

上述Post请求有4个请求参数,假如说有更多的请求参数,那么通过一个一个的参数传递就显得很麻烦而且容易出错,这个时候就可以用FieldMap

 代码如下 复制代码
@FormUrlEncoded
@POST("book/reviews")
Call<String> addReviews(@FieldMap Map<String, String> fields);

3. @Body

如果Post请求参数有多个,那么统一封装到类中应该会更好,这样维护起来会非常方便

 代码如下 复制代码

@FormUrlEncoded
@POST("book/reviews")
Call<String> addReviews(@Body Reviews reviews);

public class Reviews {
    public String book;
    public String title;
    public String content;
    public String rating;
}

其他请求方式

除了Get和Post请求,Http请求还包括Put,Delete等等,用法和Post相似,所以就不再单独介绍了。

上传

上传因为需要用到Multipart,所以需要单独拿出来介绍,先看一个具体上传的例子

首先还是需要新建一个interface用于定义上传方法

 代码如下 复制代码

public interface FileUploadService { 
    // 上传单个文件
    @Multipart
    @POST("upload")
    Call<ResponseBody> uploadFile(
            @Part("description") RequestBody description,
            @Part MultipartBody.Part file);

    // 上传多个文件
    @Multipart
    @POST("upload")
    Call<ResponseBody> uploadMultipleFiles(
            @Part("description") RequestBody description,
            @Part MultipartBody.Part file1,
            @Part MultipartBody.Part file2);
}

接下来我们还需要在Activity和Fragment中实现两个工具方法,代码如下:

 代码如下 复制代码

public static final String MULTIPART_FORM_DATA = "multipart/form-data";

@NonNull
private RequestBody createPartFromString(String descriptionString) { 
    return RequestBody.create(
            MediaType.parse(MULTIPART_FORM_DATA), descriptionString);
}

@NonNull
private MultipartBody.Part prepareFilePart(String partName, Uri fileUri) { 
    File file = FileUtils.getFile(this, fileUri);

    // 为file建立RequestBody实例
    RequestBody requestFile =
        RequestBody.create(MediaType.parse(MULTIPART_FORM_DATA), file);

    // MultipartBody.Part借助文件名完成最终的上传
    return MultipartBody.Part.createFormData(partName, file.getName(), requestFile);
}

好了,接下来就是最终的上传文件代码了

 代码如下 复制代码

Uri file1Uri = ... // 从文件选择器或者摄像头中获取
Uri file2Uri = ...

// 创建上传的service实例
FileUploadService service = 
        ServiceGenerator.createService(FileUploadService.class);

// 创建文件的part (photo, video, ...)
MultipartBody.Part body1 = prepareFilePart("video", file1Uri); 
MultipartBody.Part body2 = prepareFilePart("thumbnail", file2Uri);

// 添加其他的part
RequestBody description = createPartFromString("hello, this is description speaking");

// 最后执行异步请求操作
Call<ResponseBody> call = service.uploadMultipleFiles(description, body1, body2); 
call.enqueue(new Callback<ResponseBody>() { 
    @Override
    public void onResponse(Call<ResponseBody> call,
            Response<ResponseBody> response) {
        Log.v("Upload", "success");
    }
    @Override
    public void onFailure(Call<ResponseBody> call, Throwable t) {
        Log.e("Upload error:", t.getMessage());
    }
});

三、其他必须知道的事项

1. 添加自定义的header

Retrofit提供了两个方式定义Http请求头参数:静态方法和动态方法,静态方法不能随不同的请求进行变化,头部信息在初始化的时候就固定了。而动态方法则必须为每个请求都要单独设置。

静态方法

 代码如下 复制代码
public interface BlueService {
  @Headers("Cache-Control: max-age=640000")
    @GET("book/search")
    Call<BookSearchResponse> getSearchBooks(@Query("q") String name,
      @Query("tag") String tag, @Query("start") int start,
      @Query("count") int count);
}

当然你想添加多个header参数也是可以的,写法也很简单

 代码如下 复制代码
public interface BlueService {
  @Headers({
        "Accept: application/vnd.yourapi.v1.full+json",
        "User-Agent: Your-App-Name"
    })
    @GET("book/search")
    Call<BookSearchResponse> getSearchBooks(@Query("q") String name,
      @Query("tag") String tag, @Query("start") int start,
      @Query("count") int count);
}

此外也可以通过Interceptor来定义静态请求头

 代码如下 复制代码
public class RequestInterceptor implements Interceptor {
    @Override
    public Response intercept(Chain chain) throws IOException {
        Request original = chain.request();
        Request request = original.newBuilder()
            .header("User-Agent", "Your-App-Name")
            .header("Accept", "application/vnd.yourapi.v1.full+json")
            .method(original.method(), original.body())
            .build();
        return chain.proceed(request);
    }
}

添加header参数Request提供了两个方法,一个是 header(key, value) ,另一个是 .addHeader(key, value) ,两者的区别是,header()如果有重名的将会覆盖,而addHeader()允许相同key值的header存在

然后在OkHttp创建Client实例时,添加RequestInterceptor即可

 代码如下 复制代码
private static OkHttpClient getNewClient(){
  return new OkHttpClient.Builder()
    .addInterceptor(new RequestInterceptor())
    .connectTimeout(DEFAULT_TIMEOUT, TimeUnit.SECONDS)
    .build();
}

动态方法

 代码如下 复制代码

 

public interface BlueService {
    @GET("book/search")
    Call<BookSearchResponse> getSearchBooks(
    @Header("Content-Range") String contentRange,
    @Query("q") String name, @Query("tag") String tag,
    @Query("start") int start, @Query("count") int count);
}

2. 网络请求日志

调试网络请求的时候经常需要关注一下请求参数和返回值,以便判断和定位问题出在哪里,Retrofit官方提供了一个很方便查看日志的Interceptor,你可以控制你需要的打印信息类型,使用方法也很简单。

首先需要在build.gradle文件中引入logging-interceptor

compile 'com.squareup.okhttp3:logging-interceptor:3.4.1'
同上文提到的CustomInterceptor和RequestInterceptor一样,添加到OkHttpClient创建处即可,完整的示例代码如下:

 代码如下 复制代码
private static OkHttpClient getNewClient(){
    HttpLoggingInterceptor logging = new HttpLoggingInterceptor();
    logging.setLevel(HttpLoggingInterceptor.Level.BODY);
    return new OkHttpClient.Builder()
           .addInterceptor(new CustomInterceptor())
           .addInterceptor(logging)
           .connectTimeout(DEFAULT_TIMEOUT, TimeUnit.SECONDS)
           .build();
}

HttpLoggingInterceptor提供了4中控制打印信息类型的等级,分别是NONE,BASIC,HEADERS,BODY,接下来分别来说一下相应的打印信息类型。

NONE

没有任何日志信息

Basic

打印请求类型,URL,请求体大小,返回值状态以及返回值的大小

D/HttpLoggingInterceptor$Logger: --> POST /upload HTTP/1.1 (277-byte body) 
D/HttpLoggingInterceptor$Logger: <-- HTTP/1.1 200 OK (543ms, -1-byte body)
Headers

打印返回请求和返回值的头部信息,请求类型,URL以及返回值状态码

 代码如下 复制代码

<-- 200 OK https://api.douban.com/v2/book/search?q=%E5%B0%8F%E7%8E%8B%E5%AD%90&start=0&count=3&token=tokenValue (3787ms)
D/OkHttp: Date: Sat, 06 Aug 2016 14:26:03 GMT
D/OkHttp: Content-Type: application/json; charset=utf-8
D/OkHttp: Transfer-Encoding: chunked
D/OkHttp: Connection: keep-alive
D/OkHttp: Keep-Alive: timeout=30
D/OkHttp: Vary: Accept-Encoding
D/OkHttp: Expires: Sun, 1 Jan 2006 01:00:00 GMT
D/OkHttp: Pragma: no-cache
D/OkHttp: Cache-Control: must-revalidate, no-cache, private
D/OkHttp: Set-Cookie: bid=D6UtQR5N9I4; Expires=Sun, 06-Aug-17 14:26:03 GMT; Domain=.douban.com; Path=/
D/OkHttp: X-DOUBAN-NEWBID: D6UtQR5N9I4
D/OkHttp: X-DAE-Node: dis17
D/OkHttp: X-DAE-App: book
D/OkHttp: Server: dae
D/OkHttp: <-- END HTTP
Body

打印请求和返回值的头部和body信息

<-- 200 OK https://api.douban.com/v2/book/search?q=%E5%B0%8F%E7%8E%8B%E5%AD%90&tag=&start=0&count=3&token=tokenValue (3583ms)
D/OkHttp: Connection: keep-alive
D/OkHttp: Date: Sat, 06 Aug 2016 14:29:11 GMT
D/OkHttp: Keep-Alive: timeout=30
D/OkHttp: Content-Type: application/json; charset=utf-8
D/OkHttp: Vary: Accept-Encoding
D/OkHttp: Expires: Sun, 1 Jan 2006 01:00:00 GMT
D/OkHttp: Transfer-Encoding: chunked
D/OkHttp: Pragma: no-cache
D/OkHttp: Connection: keep-alive
D/OkHttp: Cache-Control: must-revalidate, no-cache, private
D/OkHttp: Keep-Alive: timeout=30
D/OkHttp: Set-Cookie: bid=ESnahto1_Os; Expires=Sun, 06-Aug-17 14:29:11 GMT; Domain=.douban.com; Path=/
D/OkHttp: Vary: Accept-Encoding
D/OkHttp: X-DOUBAN-NEWBID: ESnahto1_Os
D/OkHttp: Expires: Sun, 1 Jan 2006 01:00:00 GMT
D/OkHttp: X-DAE-Node: dis5
D/OkHttp: Pragma: no-cache
D/OkHttp: X-DAE-App: book
D/OkHttp: Cache-Control: must-revalidate, no-cache, private
D/OkHttp: Server: dae
D/OkHttp: Set-Cookie: bid=5qefVyUZ3KU; Expires=Sun, 06-Aug-17 14:29:11 GMT; Domain=.douban.com; Path=/
D/OkHttp: X-DOUBAN-NEWBID: 5qefVyUZ3KU
D/OkHttp: X-DAE-Node: dis17
D/OkHttp: X-DAE-App: book
D/OkHttp: Server: dae
D/OkHttp: {"count":3,"start":0,"total":778,"books":[{"rating":{"max":10,"numRaters":202900,"average":"9.0","min":0},"subtitle":"","author":["[法] 圣埃克苏佩里"],"pubdate":"2003-8","tags":[{"count":49322,"name":"小王子","title":"小王子"},{"count":41381,"name":"童话","title":"童话"},{"count":19773,"name":"圣埃克苏佩里","title":"圣埃克苏佩里"}
D/OkHttp: <-- END HTTP (13758-byte body)

3. 为某个请求设置完整的URL

​ 假如说你的某一个请求不是以base_url开头该怎么办呢?别着急,办法很简单,看下面这个例子你就懂了

 代码如下 复制代码

public interface BlueService { 
    @GET
    public Call<ResponseBody> profilePicture(@Url String url);
}

Retrofit retrofit = Retrofit.Builder() 
    .baseUrl("https://your.api.url/");
    .build();

BlueService service = retrofit.create(BlueService.class); 
service.profilePicture("https://s3.amazon.com/profile-picture/path");

​ 直接用@Url注解的方式传递完整的url地址即可。

4. 取消请求

Call提供了cancel方法可以取消请求,前提是该请求还没有执行

 代码如下 复制代码

String fileUrl = "http://futurestud.io/test.mp4"; 
Call<ResponseBody> call = 
    downloadService.downloadFileWithDynamicUrlSync(fileUrl);
call.enqueue(new Callback<ResponseBody>() { 
    @Override
    public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) {
        Log.d(TAG, "request success");
    }

    @Override
    public void onFailure(Call<ResponseBody> call, Throwable t) {
        if (call.isCanceled()) {
         Log.e(TAG, "request was cancelled");
        } else {
         Log.e(TAG, "other larger issue, i.e. no network connection?");
        }
    }
});
    }

// 触发某个动作,例如用户点击了取消请求的按钮
call.cancel(); 
}

四、结语

关于Retrofit常用的方法基本上已经介绍完了,有些请求由于工作保密性的原因,所以就没有放出来,但是基本的方法和操作都是有的,仿照文中提到的代码就可以实现你想要的功能

[!--infotagslink--]

相关文章

  • Android子控件超出父控件的范围显示出来方法

    下面我们来看一篇关于Android子控件超出父控件的范围显示出来方法,希望这篇文章能够帮助到各位朋友,有碰到此问题的朋友可以进来看看哦。 <RelativeLayout xmlns:an...2016-10-02
  • Android开发中findViewById()函数用法与简化

    findViewById方法在android开发中是获取页面控件的值了,有没有发现我们一个页面控件多了会反复研究写findViewById呢,下面我们一起来看它的简化方法。 Android中Fin...2016-09-20
  • Android模拟器上模拟来电和短信配置

    如果我们的项目需要做来电及短信的功能,那么我们就得在Android模拟器开发这些功能,本来就来告诉我们如何在Android模拟器上模拟来电及来短信的功能。 在Android模拟...2016-09-20
  • 夜神android模拟器设置代理的方法

    夜神android模拟器如何设置代理呢?对于这个问题其实操作起来是非常的简单,下面小编来为各位详细介绍夜神android模拟器设置代理的方法,希望例子能够帮助到各位。 app...2016-09-20
  • android自定义动态设置Button样式【很常用】

    为了增强android应用的用户体验,我们可以在一些Button按钮上自定义动态的设置一些样式,比如交互时改变字体、颜色、背景图等。 今天来看一个通过重写Button来动态实...2016-09-20
  • Android WebView加载html5页面实例教程

    如果我们要在Android应用APP中加载html5页面,我们可以使用WebView,本文我们分享两个WebView加载html5页面实例应用。 实例一:WebView加载html5实现炫酷引导页面大多...2016-09-20
  • 深入理解Android中View和ViewGroup

    深入理解Android中View和ViewGroup从组成架构上看,似乎ViewGroup在View之上,View需要继承ViewGroup,但实际上不是这样的。View是基类,ViewGroup是它的子类。本教程我们深...2016-09-20
  • Android自定义WebView网络视频播放控件例子

    下面我们来看一篇关于Android自定义WebView网络视频播放控件开发例子,这个文章写得非常的不错下面给各位共享一下吧。 因为业务需要,以下代码均以Youtube网站在线视...2016-10-02
  • Android用MemoryFile文件类读写进行性能优化

    java开发的Android应用,性能一直是一个大问题,,或许是Java语言本身比较消耗内存。本文我们来谈谈Android 性能优化之MemoryFile文件读写。 Android匿名共享内存对外A...2016-09-20
  • Android设置TextView竖着显示实例

    TextView默认是横着显示了,今天我们一起来看看Android设置TextView竖着显示如何来实现吧,今天我们就一起来看看操作细节,具体的如下所示。 在开发Android程序的时候,...2016-10-02
  • android.os.BinderProxy cannot be cast to com解决办法

    本文章来给大家介绍关于android.os.BinderProxy cannot be cast to com解决办法,希望此文章对各位有帮助呀。 Android在绑定服务的时候出现java.lang.ClassCastExc...2016-09-20
  • Android 实现钉钉自动打卡功能

    这篇文章主要介绍了Android 实现钉钉自动打卡功能的步骤,帮助大家更好的理解和学习使用Android,感兴趣的朋友可以了解下...2021-03-15
  • vue实现用户登录切换

    这篇文章主要为大家详细介绍了vue实现用户登录切换,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2021-04-22
  • Android 开发之布局细节对比:RTL模式

    下面我们来看一篇关于Android 开发之布局细节对比:RTL模式 ,希望这篇文章对各位同学会带来帮助,具体的细节如下介绍。 前言 讲真,好久没写博客了,2016都过了一半了,赶紧...2016-10-02
  • Android中使用SDcard进行文件的读取方法

    首先如果要在程序中使用sdcard进行存储,我们必须要在AndroidManifset.xml文件进行下面的权限设置: 在AndroidManifest.xml中加入访问SDCard的权限如下: <!--...2016-09-20
  • Android开发之PhoneGap打包及错误解决办法

    下面来给各位简单的介绍一下关于Android开发之PhoneGap打包及错误解决办法,希望碰到此类问题的同学可进入参考一下哦。 在我安装、配置好PhoneGap项目的所有依赖...2016-09-20
  • 护卫神 主机管理系统使用说明(MSSQL管理)

    护卫神·主机管理系统该版本支持在Windows Server 200320082012,含32位和64位,直接开设配置WEB站、FTP站,以及SQL Server和MySQL,是您开设和管理虚拟主机的绝好帮手。但是对于新用户可能在使用上有一些困难,因此请仔细阅读如下说明文档...2016-01-27
  • 用Intel HAXM给Android模拟器Emulator加速

    Android 模拟器 Emulator 速度真心不给力,, 现在我们来介绍使用 Intel HAXM 技术为 Android 模拟器加速,使模拟器运行度与真机比肩。 周末试玩了一下在Eclipse中使...2016-09-20
  • Android判断当前屏幕是全屏还是非全屏

    在安卓开发时我碰到一个问题就是需要实现全屏,但又需要我们来判断出用户是使用了全屏或非全屏了,下面我分别找了两段代码,大家可参考。 先来看一个android屏幕全屏实...2016-09-20
  • Android开发中布局中的onClick简单完成多控件时的监听的利与弊

    本文章来为各位介绍一篇关于Android开发中布局中的onClick简单完成多控件时的监听的利与弊的例子,希望这个例子能够帮助到各位朋友. 首先在一个控件加上这么一句:and...2016-09-20