美文网首页
接口请求规范

接口请求规范

作者: ChasenZhang | 来源:发表于2021-08-16 18:07 被阅读0次

1、创建ApiServer

public interface ApiServer {

    //须自己实现getInstance()方法
    static ApiServer getInstance(){
        return HttpCreator.getServer(ApiServer.class);
    }

    @POST("common/encrypt")
    Observable<User> requestEncrptTest(@Body Map request);

    @POST("common/unencrypt")
    Observable<String> requestUnencrptTest(@Body Map request);
}

注:每一个Server接口都需要写一个静态方法getInstance(),返回的是对应接口的一个Retrofit封装的实例,方便调用。接口内部方法的返回值必须是Observable<T>。请求参数如果是写在请求体内的,则以map封装。

2、在Presnenter里调用

public class DemoPresenter extends BasePresenter implements DemoContract.IDemoPresenter {

    @Override
    public void doDemo(String param) {
        Map<String,String> request = new HashMap<>();
        request.put("password","123456");
        request.put("nickname","chenpeng");
        ApiServer.getInstance()
                .requestEncrptTest(request)
                .compose(RxJavaUtils.compose(getLifecycleTransformer()))
                .subscribe(new ApiCallBack<User>() {
                    @Override
                    public void onSuccess(User user) {
                    }

                    @Override
                    public void onApiFail(ApiException exception) {
                    }

                    @Override
                    public void onFail(Throwable e) {
                    }

                    @Override
                    public void onComplete() {
                    }
                });
    }
}

注:
注意在ApiServer请求的时候中间调用了方法compose(RxJavaUtils.compose(getLifecycleTransformer())),其在内部处理了线程的切换和生命周期(在Activity或Fragment销毁时会自动取消本次请求),
getLifecycleTransformer()是BasePresenter里的方法。
ApiCallBack是项目封装的一个网络回调接口,代码如下

public abstract class ApiCallBack<T> extends ResourceObserver<T> {

    @Override
    public void onNext(T t) {
        onSuccess(t);
    }

    @Override
    public void onError(Throwable e) {
        if(e instanceof ApiException){
            onApiFail((ApiException)e);
        }else {
            e.printStackTrace();
            onFail(e);
        }
    }

    abstract public void onSuccess(T t);

    abstract public void onApiFail(ApiException exception);

    abstract public void onFail(Throwable e);
}

ApiException是对服务器的响应封装的一个异常,代码如下

public class ApiException extends RuntimeException {

    private String code;
    private String message;

    public static ApiException build(String code,String message){
        ApiException exception = new ApiException();
        exception.code = code;
        exception.message = message;
        return exception;
    }

    public String getCode() {
        return code;
    }

    @Nullable
    @Override
    public String getMessage() {
        return message;
    }
}

RxJavaUtils代码如下

public class RxJavaUtils {

    public static <T> ObservableTransformer<T, T> compose(final LifecycleTransformer<T> lifecycleTransformer) {
        return new ObservableTransformer<T, T>() {
            @Override
            public ObservableSource<T> apply(Observable<T> upstream) {
                return upstream.subscribeOn(Schedulers.io())
                        .observeOn(AndroidSchedulers.mainThread())
                        .compose(lifecycleTransformer);
            }
        };
    }
}

相关文章

  • 2018-10-31 接口测试

    接口规范 规范类型swagger接口规范内容1.协议2.请求方法3.路径4.请求请求头 格式:utf-8请求正文...

  • 2018-11-21

    接口自动化执行步骤 1. 根据接口规范编写请求响应javabean 2. 根据接口规范编写测试类 3. 实例化请求...

  • 接口请求规范

    1、创建ApiServer 注:每一个Server接口都需要写一个静态方法getInstance(),返回的是对应...

  • Datatables接口规范示例说明

    一、Datatables接口规范 二、请求参数示例 以某个接口为例,以下截图为该接口所有参数: 参数说明: (1)...

  • 接口规范示例

    以下是一个接口规范的文档。 基本规范 每个请求都要携带的参数,用于描述每个请求的基本信息,后端可以通过这些字段进行...

  • 2018-08-23 B/S架构---接口规范

    B/S 架构流程图 接口测试流程 接口测试: 主要模拟客户端请求服务端(http协议 233格式+接口规范) 接口...

  • 2018-11-21java接口自动化学习

    接口自动化的jar httpclient 执行步骤 搭环境:1.根据接口规范编剧写请求/响应javabean基本类...

  • spring boot如何优雅的校验请求参数

    首先接口定义风格可以参考restful规范,即请求方式符合语义。下面介绍下不同请求方式的请求参数校验。 GetMa...

  • 2018-08-23 B/S架构——接口规范

    接口规范: 约定前后端交互方式和数据格式 主要内容有 协议类型 : http/https 请求类型 : get请求...

  • 记前端的一些优化策略及总结~持续更新~

    1.字段规范(接口请求参数字段与接口获取字段名不统一) 2.数据结构统一(接口请求字段回来的数据结构可否统一,最好...

网友评论

      本文标题:接口请求规范

      本文链接:https://www.haomeiwen.com/subject/rtsmghtx.html