Android开发--基础联网框架Xutils3

最新推荐文章于 2022-03-04 17:17:23 发布

走着学磔

最新推荐文章于 2022-03-04 17:17:23 发布

阅读量1.4k

点赞数 1

分类专栏： app基础文章标签： android

本文链接：https://blog.youkuaiyun.com/wei8023hzp/article/details/50560902

版权

app基础专栏收录该内容

32 篇文章

订阅专栏

前面从启动页到ui框架轮播图，说的都是些死的东西，app是需要与数据交互的，自然需要用到联网，原生的联网远远满足不了我们的要求，但是我们又不想学习太多的联网框架，所以我看了几个联网框架后，果断选择了xutils，因为他是一个比较全面的联网框架，涉及到数据库，注解，上传，图片处理等等，是一个值得学习的框架，而且使用起来也是比较简单：
首先使用Gradle构建时添加一下依赖:

compile 'org.xutils:xutils:3.3.0'

其次需要配置权限：

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

初始化

// 在application的onCreate中初始化
@Override
public void onCreate() {
    super.onCreate();
    x.Ext.init(this);
    x.Ext.setDebug(true); // 是否输出debug日志
    ...
}

使用@Event事件注解

/**
 * 1. 方法必须私有限定,
 * 2. 方法参数形式必须和type对应的Listener接口一致.
 * 3. 注解参数value支持数组: value={id1, id2, id3}
 * 4. 其它参数说明见{@link org.xutils.event.annotation.Event}类的说明.
 **/
@Event(value = R.id.btn_test_baidu1,
        type = View.OnClickListener.class/*可选参数, 默认是View.OnClickListener.class*/)
private void onTestBaidu1Click(View view) {
...
}

注解让代码的确看起来比较简洁，但是不推荐大家使用注解，这样增加了代码的可读性，我一般不太使用注解，我主要使用他的联网和上传功能
访问网络

/**
 * 自定义实体参数类请参考:
 * 请求注解 {@link org.xutils.http.annotation.HttpRequest}
 * 请求注解处理模板接口 {@link org.xutils.http.app.ParamsBuilder}
 *
 * 需要自定义类型作为callback的泛型时, 参考:
 * 响应注解 {@link org.xutils.http.annotation.HttpResponse}
 * 响应注解处理模板接口 {@link org.xutils.http.app.ResponseParser}
 *
 * 示例: 查看 org.xutils.sample.http 包里的代码
 */
BaiduParams params = new BaiduParams();
params.wd = "xUtils";
// 有上传文件时使用multipart表单, 否则上传原始文件流.
// params.setMultipart(true);
// 上传文件方式 1
// params.uploadFile = new File("/sdcard/test.txt");
// 上传文件方式 2
// params.addBodyParameter("uploadFile", new File("/sdcard/test.txt"));
Callback.Cancelable cancelable
       = x.http().get(params,
       /**
        * 1. callback的泛型:
        * callback参数默认支持的泛型类型参见{@link org.xutils.http.loader.LoaderFactory},
        * 例如: 指定泛型为File则可实现文件下载, 使用params.setSaveFilePath(path)指定文件保存的全路径.
        * 默认支持断点续传(采用了文件锁和尾端校验续传文件的一致性).
        * 其他常用类型可以自己在LoaderFactory中注册,
        * 也可以使用{@link org.xutils.http.annotation.HttpResponse}
        * 将注解HttpResponse加到自定义返回值类型上, 实现自定义ResponseParser接口来统一转换.
        * 如果返回值是json形式, 那么利用第三方的json工具将十分容易定义自己的ResponseParser.
        * 如示例代码{@link org.xutils.sample.http.BaiduResponse}, 可直接使用BaiduResponse作为
        * callback的泛型.
        *
        * 2. callback的组合:
        * 可以用基类或接口组合个种类的Callback, 见{@link org.xutils.common.Callback}.
        * 例如:
        * a. 组合使用CacheCallback将使请求检测缓存或将结果存入缓存(仅GET请求生效).
        * b. 组合使用PrepareCallback的prepare方法将为callback提供一次后台执行耗时任务的机会,
        * 然后将结果给onCache或onSuccess.
        * c. 组合使用ProgressCallback将提供进度回调.
        * ...(可参考{@link org.xutils.image.ImageLoader}
        * 或 示例代码中的 {@link org.xutils.sample.download.DownloadCallback})
        *
        * 3. 请求过程拦截或记录日志: 参考 {@link org.xutils.http.app.RequestTracker}
        *
        * 4. 请求Header获取: 参考 {@link org.xutils.http.app.RequestInterceptListener}
        *
        * 5. 其他(线程池, 超时, 重定向, 重试, 代理等): 参考 {@link org.xutils.http.RequestParams}
        *
        **/
       new Callback.CommonCallback<String>() {
           @Override
           public void onSuccess(String result) {
               Toast.makeText(x.app(), result, Toast.LENGTH_LONG).show();
           }

           @Override
           public void onError(Throwable ex, boolean isOnCallback) {
               //Toast.makeText(x.app(), ex.getMessage(), Toast.LENGTH_LONG).show();
               if (ex instanceof HttpException) { // 网络错误
                   HttpException httpEx = (HttpException) ex;
                   int responseCode = httpEx.getCode();
                   String responseMsg = httpEx.getMessage();
                   String errorResult = httpEx.getResult();
                   // ...
               } else { // 其他错误
                   // ...
               }
               Toast.makeText(x.app(), ex.getMessage(), Toast.LENGTH_LONG).show();
           }

           @Override
           public void onCancelled(CancelledException cex) {
               Toast.makeText(x.app(), "cancelled", Toast.LENGTH_LONG).show();
           }

           @Override
           public void onFinished() {

           }
       });

// cancelable.cancel(); // 取消请求

简单的联网：

  RequestParams params = new RequestParams("https://www.baidu.com/s");
    params.setSslSocketFactory(...); // 设置ssl
    params.addQueryStringParameter("wd", "xUtils");
    x.http().get(params, new Callback.CommonCallback<String>() {
        @Override
        public void onSuccess(String result) {
            Toast.makeText(x.app(), result, Toast.LENGTH_LONG).show();
        }

        @Override
        public void onError(Throwable ex, boolean isOnCallback) {
            Toast.makeText(x.app(), ex.getMessage(), Toast.LENGTH_LONG).show();
        }

        @Override
        public void onCancelled(CancelledException cex) {
            Toast.makeText(x.app(), "cancelled", Toast.LENGTH_LONG).show();
        }

        @Override
        public void onFinished() {

        }
    });

带有缓存的请求示例:

BaiduParams params = new BaiduParams();
params.wd = "xUtils";
// 默认缓存存活时间, 单位:毫秒.(如果服务没有返回有效的max-age或Expires)
params.setCacheMaxAge(1000 * 60);
Callback.Cancelable cancelable
        // 使用CacheCallback, xUtils将为该请求缓存数据.
        = x.http().get(params, new Callback.CacheCallback<String>() {

    private boolean hasError = false;
    private String result = null;

    @Override
    public boolean onCache(String result) {
        // 得到缓存数据, 缓存过期后不会进入这个方法.
        // 如果服务端没有返回过期时间, 参考params.setCacheMaxAge(maxAge)方法.
        //
        // * 客户端会根据服务端返回的 header 中 max-age 或 expires 来确定本地缓存是否给 onCache 方法.
        //   如果服务端没有返回 max-age 或 expires, 那么缓存将一直保存, 除非这里自己定义了返回false的
        //   逻辑, 那么xUtils将请求新数据, 来覆盖它.
        //
        // * 如果信任该缓存返回 true, 将不再请求网络;
        //   返回 false 继续请求网络, 但会在请求头中加上ETag, Last-Modified等信息,
        //   如果服务端返回304, 则表示数据没有更新, 不继续加载数据.
        //
        this.result = result;
        return false; // true: 信任缓存数据, 不在发起网络请求; false不信任缓存数据.
    }

    @Override
    public void onSuccess(String result) {
        // 注意: 如果服务返回304或 onCache 选择了信任缓存, 这里将不会被调用,
        // 但是 onFinished 总会被调用.
        this.result = result;
    }

    @Override
    public void onError(Throwable ex, boolean isOnCallback) {
        hasError = true;
        Toast.makeText(x.app(), ex.getMessage(), Toast.LENGTH_LONG).show();
        if (ex instanceof HttpException) { // 网络错误
            HttpException httpEx = (HttpException) ex;
            int responseCode = httpEx.getCode();
            String responseMsg = httpEx.getMessage();
            String errorResult = httpEx.getResult();
            // ...
        } else { // 其他错误
            // ...
        }
    }

    @Override
    public void onCancelled(CancelledException cex) {
        Toast.makeText(x.app(), "cancelled", Toast.LENGTH_LONG).show();
    }

    @Override
    public void onFinished() {
        if (!hasError && result != null) {
            // 成功获取数据
            Toast.makeText(x.app(), result, Toast.LENGTH_LONG).show();
        }
    }
});

绑定图片

x.image().bind(imageView, url, imageOptions);

// assets file
x.image().bind(imageView, "assets://test.gif", imageOptions);

// local file
x.image().bind(imageView, new File("/sdcard/test.gif").toURI().toString(), imageOptions);
x.image().bind(imageView, "/sdcard/test.gif", imageOptions);
x.image().bind(imageView, "file:///sdcard/test.gif", imageOptions);
x.image().bind(imageView, "file:/sdcard/test.gif", imageOptions);

x.image().bind(imageView, url, imageOptions, new Callback.CommonCallback<Drawable>() {...});
x.image().loadDrawable(url, imageOptions, new Callback.CommonCallback<Drawable>() {...});
x.image().loadFile(url, imageOptions, new Callback.CommonCallback<File>() {...});

使用数据库

Parent test = db.selector(Parent.class).where("id", "in", new int[]{1, 3, 6}).findFirst();
long count = db.selector(Parent.class).where("name", "LIKE", "w%").and("age", ">", 32).count();
List<Parent> testList = db.selector(Parent.class).where("id", "between", new String[]{"1", "5"}).findAll();

当然了，前面都是github上的代码，我直接copy过来的，有兴趣的可以直接访问https://github.com/wyouflf/xUtils3/tree/master/sample。
下面主要来看下xutils的二次封装以及上传图片的总结吧！
先上代码吧:
MerchantServiceController

package org.jianneng.eplus.merchant.merchant.controller;

import org.jianneng.eplus.merchant.merchant.controller.impl.InternetServiceListenerImpl;

/**
 * 联网获取数据管理
 * Created by hzp on 2015/11/5.
 */
public class MerchantServiceController {
    public static MerchantServiceController controller;
    private InternetServiceListenerImpl internetServiceListener;

    /**
     * 单例  实例化对象
     * @return
     */
    public static MerchantServiceController getInstance(){
        if(controller == null){
            controller = new MerchantServiceController();
        }
        return   controller;
    }
    //构造方法私有化
    private MerchantServiceController(){
        internetServiceListener = new InternetServiceListenerImpl();
    }

    /**
     * 得到intentServiceListener 对象
     * @return
     */
    public InternetServiceListenerImpl getInternetServiceListener(){
        return  internetServiceListener;
    }
}

InternetServiceListenerImpl

 * Created by hzp on 2015/11/5.
 */
public class InternetServiceListenerImpl  {
    /**
     * 查询版本号
     * @param listener
     * @param params
     */
   public void getVersionNumber(DataListener listener,RequestParams params) {       getDataParams(listener,params,MerchantConstants.FIND_VERSIONNUMBE);
}
       /**
     *
     *得到数据的公共的方法
     * @param listener
     * @param interfaceType 接口类型
     */
    private void getDataParams(final DataListener listener,RequestParams params, final String  interfaceType){   if(PublicTools.isConnectNeWork(MerchantApplication.getInstance())) {
            x.http().post(params, new Callback.CommonCallback<String>() {
     @Override
    public void onSuccess(String result) 
                    listener.dataSuccess(result, interfaceType);
//                    Toast.makeText(x.app(), result, Toast.LENGTH_LONG).show();
                }

  @Override
  public void onError(Throwable ex, boolean isOnCallback) {
            listener.dataFailture(ex.getMessage());
      }

 @Override
  public void onCancelled(CancelledException cex) {
    }
         @Override
          public void onFinished() {

            }
            });
        }else{
            listener.netFailture();
        }
    }
}

DataListener

/**
 * Created by hzp on 2015/11/5.
 */
public interface DataListener {
    //数据获取成功
    void dataSuccess(String responseInfo,String interfaceType);
    //数据获取失败
    void dataFailture(String failtureInfo);
    //数据正在加载
    void dataLoading(long total,long current,boolean isUploading);
    void netFailture();
}

好了，一个基本的联网封装就ok了。来说下这几个类吧，首先MerchantServiceController，通过单例模式创建controller对象，并且通过构造方法创建InternetServiceListenerImpl实例，通过getInternetServiceListener()得到internetServiceListener对象，再调用InternetServiceListenerImpl类中的统一的联网方法getDataParams().
在实际的使用中只需要传入三个参数就ok了。当然使用的类需要实现DataListener接口：
简单的使用如下：

 //网络请求
                    String URl = MerchantConstants.BASE_URL + MerchantConstants.PATH_URL
                            + MerchantConstants.LOGIN;
                    RequestParams params = new RequestParams(URl);
                    params.addQueryStringParameter("appkey", MerchantConstants.APP_KEY);
                    params.addQueryStringParameter("version_no", MerchantConstants.VERSION_NO);
                    params.addQueryStringParameter("merchant_phone", mUser.getText().toString());
                    params.addQueryStringParameter("merchant_pwd", passwordKey);
   //连网
   this.controller.getInternetServiceListener ().Login(this,params);

我没有封装params，所以每次需要联网的时候需要自己创建params，如果项目中params参数重复多的话可以再次封装，其中Login是在InternetServiceListenerImpl中的一个方法；

  @Override
    public void dataSuccess(String responseInfo, String interfaceType) {

    }

    @Override
    public void dataFailture(String failtureInfo) {

    }

    @Override
    public void dataLoading(long total, long current, boolean isUploading) {

    }

    @Override
    public void netFailture() {

    }

联网完成后会在下面三个重写的方法里面得到值，如果成功将会返回responseInfo对象，通过解析就可以得到后台返回给我们的数值，dataFailture，自然是加载失败，netFailture是指联网错误，当然了还可以对返回的条件进行封装，那时候就要看具体需求了；

下面说下图片处理吧：

 ImageOptions imageOptions = new ImageOptions.Builder()
                .setSize(DensityUtil.dip2px(80), DensityUtil.dip2px(80))
                .setCrop(true)
                .setPlaceholderScaleType(ImageView.ScaleType.CENTER_CROP)
                .setLoadingDrawableId(R.mipmap.image_loading)
                .setFailureDrawableId(R.mipmap.image_error)
                .setAutoRotate(true)
                .setRadius(DensityUtil.dip2px(80))
                        // 加载中或错误图片的ScaleType
                        //.setPlaceholderScaleType(ImageView.ScaleType.MATRIX)
                .setImageScaleType(ImageView.ScaleType.CENTER_CROP)
                .build();

        x.image().bind(mIcon,app_icon , imageOptions);

代码很简单x.image().bind(mIcon,app_icon , imageOptions);就是这么一句，mIcon是指控件，app_icon:url ，imageOptions 是指对加载图片的一些设置，这里还可以设置圆形图片，具体参数我就不一一介绍了setRadius是设置圆角！

 String URL = MerchantConstants.BASE_URL
                + MerchantConstants.PATH_URL
                + MerchantConstants.SAVE_UPDATE_GOOD;
       RequestParams params =  requestPublic(URL);
        params.addQueryStringParameter("product_name", goodsName.toString());// 商品名称
        params.addQueryStringParameter("product_category", typename);// 商品类别
        params.addQueryStringParameter("product_detail", goodsDescribe.toString());// 商品详情

        params.addQueryStringParameter("product_parameters", str);// 商品的关键参数
        params.setMultipart(true);
        //1将bitmap转字节数组
        ByteArrayOutputStream baos = new ByteArrayOutputStream();
        bitmapGood.compress(Bitmap.CompressFormat.PNG, 100, baos);
        params.addBodyParameter("cover", baos.toByteArray(), "image/jpeg", "image.jpg");
        for (int i=  0;i<bmp.size();i++){
            //2将bitmap转字节数组
            ByteArrayOutputStream baoss = new ByteArrayOutputStream();
            bmp.get(i).bitmap.compress(Bitmap.CompressFormat.PNG, 100, baos);
            params.addBodyParameter("image", baoss.toByteArray(), "image/jpeg", "image.jpg");
        }
        dialog.showProgressDialog(this, "保存中...");
        this.controller.getInternetServiceListener().saveShop(this, params);

这个只是项目中的代码片段，主要是 params.setMultipart(true);这个是上传图片的关键，主要是将图片转化成字节数组，然后通过 params.addBodyParameter作为普通的params传递就ok了，差不多就是这些，还有数据库的一些运用后面再说！
上传一个比较小的项目运用xutils框架：
http://download.youkuaiyun.com/detail/wei8023hzp/9414109