Glin

Project Url: qibin0506/Glin
Introduction: 一款灵活支持中间件的 Java&Android 动态代理网络框架
More: Author   ReportBugs   OfficialWebsite   
Tags:

Glin, 一款灵活支持中间件的 Java&Android 动态代理网络框架

功能列表

1. 默认支持 GET, POST, DELETE, PUT 请求方式

2. 默认支持 JSON Body 请求方式

3. 可自定义请求客户端

4. 可扩展请求方式

5. 支持中间件

6. 支持 Path 替换

7. 支持数据缓存

8. more...

升级日志

v3.1

    1. 新增:`Call`添加 rewriteUrl 方法,可用于在中间件中重写请求的 URL

    2. 新增:添加全局中间件`GlobalChanNode`,GlobalChanNode 支持添加多个`ChanNode`, 只需按照顺序添加即可

    3. 修改:现在日志中间件改用`GlobalChanNode`提供支持修改日志全局中间件方式:logChanNode -> globalChanNode(GlobalChanNode before, GlobalChanNode after)

    4. glinsample 适配 Glin3.1, 添加权限处理


v3.0
    1. 支持更加灵活的中间件 cancel 机制,cancel 支持自定义 code 和 message


v2.3
    1. 支持中间件

    2. 添加@Path 注解

    3. 默认添加日志中间件

    4. 添加 Context 上下文

使用教程

获取 Glin

在你的 gradle 中添加如下 compile

compile 'org.loader:glin:3.1'

如果你不想花时间定制网络请求方式, 可使用我提供的 OkClient, 添加方法如下

compile 'org.loader:glin-okclient:3.1'

注意: 如果使用 Glin3.0, glin-okclient 就必须使用 2.3 以上

自定义解析类

  1. 通过继承Parser类来实现项目的数据解析类, 通常情况下需要实体类和列表类解析两种
  2. 通过继承ParserFactory将上面实现的两个解析类告诉 Glin

例子:

// CommParser.java
public class CommParser extends Parser {

    public CommParser(String key) {
        super(key);
    }

    @Override
    public <T> Result<T> parse(Class<T> klass, NetResult netResult) {
        Result<T> result = new Result<>();
        try {
            JSONObject baseObject = JSON.parseObject(netResult.getResponse());
            if (baseObject.containsKey("message")) {
                result.setMessage(baseObject.getString("message"));// message always get
            }

            result.setCode(baseObject.getIntValue("code"));
            result.setObj(result.getCode());
            result.ok(baseObject.getBooleanValue("ok"));
            if (result.isOK()) { // ok true
                if (baseObject.containsKey(mKey)) {
                    T t = baseObject.getObject(mKey, klass);
                    result.setResult(t);
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
            result.setMessage("error");
        }
        return result;
    }
}
// ListParser.java
public class ListParser extends Parser {

    public ListParser(String key) {
        super(key);
    }

    @Override
    public <T> Result<T> parse(Class<T> klass, NetResult netResult) {
        Result<T> result = new Result<>();
        try {
            JSONObject baseObject = JSON.parseObject(netResult.getResponse());
            if (baseObject.containsKey("message")) {
                result.setMessage(baseObject.getString("message"));// message always get
            }

            res.setCode(baseObject.getIntValue("code"));
            result.setObj(res.getCode());
            result.ok(baseObject.getBooleanValue("ok"));
            if (result.isOK()) { // ok true
                if (baseObject.containsKey(mKey)) {
                    JSONArray arr = baseObject.getJSONArray(mKey);
                    T t = (T) baseObject.parseArray(arr.toString(), klass);
                    result.setResult(t);
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
            result.setMessage("error");
        }

        return result;
    }
}
// FastJsonParserFactory
public class FastJsonParserFactory implements ParserFactory {

    @Override
    public Parser getParser() {
        return new CommParser("data");
    }

    @Override
    public Parser getListParser() {
        return new ListParser("data");
    }
}

配置 Glin

private static final LogHelper.LogPrinter logPrinter = new LogHelper.LogPrinter() {
        @Override
        public void print(String tag, String content) {
            Log.d(tag, content);
        }
    };

//....

// request Log
LogChanNode beforeLog = new LogChanNode(true, printer);
// response log
LogChanNode afterLog = new LogChanNode(true, printer);

// Global Chan Node before request
GlobalChanNode before = new GlobalChanNode(beforeLog/*, others...*/);
// Global Chan Node after response
GlobalChanNode after = new GlobalChanNode(afterLog/*, others...*/);

Glin glin = new Glin.Builder()
    .client(new OkClient())
    .baseUrl("http://exampile.com") // the basic url
    .globalChanNode(before, after)
    .parserFactory(new FastJsonParserFactory()) // your parser factory
    .cacheProvider(new DefaultCacheProvider(Environment.getExternalStorageDirectory() + "/test/", 2000)) // use default cacheProvider
    .timeout(10000) // timeout in ms
    .build();

创建网络访问接口

 public interface UserApi {
      // use @ShouldCache, Glin will cache the lastest response
      // the key of cache is your url and params
      @ShouldCache
      @POST("/users/list")
      Call<User> list(@Arg("name") String userName);
  }

访问网络

 UserApi api = glin.create(UserApi.class, getClass().getName());
 Call<User> call = api.list("qibin");
 call.enqueue(new Callback<User>() {
      @Override
      public void onResponse(Result<User> result) {
          if (result.isOK()) {
              Toast.makeText(MainActivity.this, result.getResult().getName(), Toast.LENGTH_SHORT).show();
          }else {
              Toast.makeText(MainActivity.this, result.getMessage(), Toast.LENGTH_SHORT).show();
          }
      }
  });

高级用法

get 请求

    @GET("/info")
    Call<User> getUser(@Arg("username") String name);

post 请求

    @POST("/info")
    Call<User> getUser(@Arg("username") String name);

delete 请求

    @DEL("/info")
    Call<User> deleteUser(@Arg("username") String name);

put 请求

    @PUT("/info")
    Call<User> putUser(@Arg("username") String name);

json 请求

    @JSON("/info")
    Call<User> getUser(String name);

添加 url path

    @GET("/info/{:name}/{:age}")
    Call<User> getUser(@Path("name") String name, @Path("age") int age);

中间件支持

提供全局中间件支持(GlobalChanNode.java)和日志中间件(LogChanNode.java)

自定义中间件

继承 ChanNode 类, 实现自定义中间件, 实现 run(Context ctx)方法, 在 run 方法里调用 next()方法使流程继续.

如果想使用全局中间件,可在GlobalChanNode的构造中添加ChanNode, 可参考glinsample.

通过调用 Call 的 before(ChanNode chanNode)方法设置请求前的中间件, 在调用 before(ChanNode chanNode)后, 可通过使用一系列的 next(ChanNode chanNode)方法设置请求前的中间件. 通过调用 Call 的 after(ChanNode chanNode)方法设置请求后的中间件, 在调用 after(ChanNode chanNode)后, 可通过使用一系列的 next(ChanNode chanNode)方法设置请求后的中间件.

在中间件中,在网络请求未发起之前, 如果想要修改参数, 可使用ctx.getCall().getParams()进行参数修改.

例子(该例子实现了请求前检查用户 id, 如果不存在, 则请求用户 id 接口, 然后发起请求获取用户信息, 最后检查用户信息)

// 检查用户 id 的中间件
class UserIdChanNode extends ChanNode {
    @Override
    public void run(Context ctx) {
        // 如果 uid 存在, 则继续流程
        if (SpUtils.get("uid") != null) {
            next();
            return;
        }

        glin.create(Api.class, tag).uid().enqueue(new Callback<Uid>() {
            @Override
            public void onResponse(Result<Uid> result) {
                // save uid
                // 省略成功判断
                SpUtils.put("uid", reuslt.getResult().getUid());
                next();
            }
        });
    }
}
// 检查用户信息中间件
class UserInfoChanNode extends ChanNode {
    @Override
    public void run(Context ctx) {
        if (SpUtils.get("user_name") == null) {
            sendUserName();
            next();
            return;
        }
        // 调用 cancel 方法会中断流程
        //cancel();
     cancel(4000, "no user name")
    }
}
// 使用中间件
Call<User> call = glin.create(Api.class, tag).userInfo();
call.before(new UserIdChanNode()).next(new OtherBeforeChanNode())
    .after(new UserInfoChanNode()).next(new OtherAfterChanNode())
    .enqueue(new Callback<User>() {
            @Override
            public void onResponse(Result<User> result) {
                //  处理结果
            }
     });
Android 开发经验分享
随手点击下面广告支持本站吧
 
Android 开发经验分享