xUtils框架简介

xUtils框架简介

一概要

xUtils 包含了很多实用的android工具。

xUtils 最初源于Afinal框架，进行了大量重构，使得xUtils支持大文件上传，更全面的http请求协议支持(10种谓词)，拥有更加灵活的ORM，更多的事件注解支持且不受混淆影响...

xUitls最低兼容android 2.2 (api level 8)

开源地址：https://github.com/wyouflf/xUtils

gitHub地址：https://github.com/wyouflf/xUtils.git

二 xUtils四大模块介绍

ViewUtils通过注解的方式，完全使用注解的方式来完成UI的绑定和事件绑定（@ViewInject、@OnClick，@OnItemClick）

@ViewInject示例代码：

@ViewInject(R.id.btn) private Button btn;

      @ViewInject(R.id.img) private ImageView img;

      @ViewInject(R.id.list) private ListView list;

      @Override

      protected void onCreate(Bundle savedInstanceState) {

           super.onCreate(savedInstanceState);

           setContentView(R.layout.activity_second);

           //通过ViewUtils.inject就可以注入绑定事件

           ViewUtils.inject(this);

      }       

@OnClick示例代码：

@OnClick({ R.id.btn, R.id.img })

public void clickMethod(View v) {

           Toast.makeText(SecondActivity.this, "you clicked button!", Toast.LENGTH_SHORT).show();

      }        }

@OnItemClick示例代码：

@OnItemClick(R.id.list)

public void itemClick(AdapterView<?> parent, View view, int position,long id) {

           Toast.makeText(SecondActivity.this, "position--->" + position, Toast.LENGTH_SHORT).show();

      }

 

2．BitmapUtils  加载网络或本地bitmap的时候无需担心再遇到OOM的现象，管理bitmap的内存采用了LRU算法，同时也能避免列表滑动过程中发生图片错位等得现象。加载网络图片时，还可以配置运行线程的数量，缓存路径等。。。通过BitmapUtils的各种构造器，可以很方便的创建出本地缓存路径和缓存的大小，以及内存缓存的大小。

BitmapUtils示例代码：

BitmapUtils bitmapUtils = new BitmapUtils(this);

BitmapDisplayConfigbigPicDisplayConfig = new BitmapDisplayConfig(); //bigPicDisplayConfig.setShowOriginal(true); // 显示原始图片,不压缩, 尽量不要使用, 图片太大时容易OOM。

bigPicDisplayConfig.setBitmapConfig(Bitmap.Config.RGB_565);

bigPicDisplayConfig.setBitmapMaxSize(BitmapCommonUtils.getScreenSize(this));

BitmapLoadCallBack<ImageView>callback = new DefaultBitmapLoadCallBack<ImageView>() {

            @Override

            public void onLoadStarted(ImageView container, String uri,BitmapDisplayConfig config) {

                super.onLoadStarted(container, uri, config);

                Toast.makeText(getApplicationContext(),uri, Toast.LENGTH_LONG).show();

            }

            @Override

            public void onLoadCompleted(ImageView container, String uri, Bitmapbitmap, BitmapDisplayConfig config, BitmapLoadFrom from) {

                super.onLoadCompleted(container, uri, bitmap,config, from);

                Toast.makeText(getApplicationContext(),bitmap.getWidth() + "*" + bitmap.getHeight(), 300).show();

            }

        };

 bitmapUtils.display(bigImage, imgUrl,bigPicDisplayConfig, callback);

 

// 使用ListView等容器展示图片时可通过PauseOnScrollListener控制滑动和快速滑动过程中时候暂停加载图片

      listView.setOnScrollListener(newPauseOnScrollListener(bitmapUtils, false, true));

     listView.setOnScrollListener(new PauseOnScrollListener(bitmapUtils, false, true, customListener));

3．HttpUtils支持断点续传，随时停止下载任务，开始任务

普通get方法

HttpUtils http = new HttpUtils();

      http.send(HttpRequest.HttpMethod.GET,

          "http://www.lidroid.com",

          newRequestCallBack<String>(){

              @Override

              public void onLoading(long total, long current, boolean isUploading) {

                 testTextView.setText(current + "/" + total);

              }

              @Override

              public voidonSuccess(ResponseInfo<String> responseInfo) {

                 textView.setText(responseInfo.result);

              }

              @Override

              public void onStart() {

              }

              @Override

              public void onFailure(HttpException error, String msg) {

              }

      });

使用HttpUtils上传文件或者 提交数据 到服务器（post方法）

RequestParams params = new RequestParams();

      params.addHeader("name", "value");

      params.addQueryStringParameter("name", "value");

      // 只包含字符串参数时默认使用BodyParamsEntity，

      // 类似于UrlEncodedFormEntity（"application/x-www-form-urlencoded"）。

      params.addBodyParameter("name", "value");

      // 加入文件参数后默认使用MultipartEntity（"multipart/form-data"），

      // 如需"multipart/related"，xUtils中提供的MultipartEntity支持设置subType为"related"。

      // 使用params.setBodyEntity(httpEntity)可设置更多类型的HttpEntity（如：

      //MultipartEntity,BodyParamsEntity,FileUploadEntity,InputStreamUploadEntity,StringEntity）。

      // 例如发送json参数：params.setBodyEntity(new StringEntity(jsonStr,charset));

      params.addBodyParameter("file", new File("path"));

      HttpUtils http = new HttpUtils();

      http.send(HttpRequest.HttpMethod.POST,

          "uploadUrl....",

          params,

          newRequestCallBack<String>() {

              @Override

              public void onStart() {

                 testTextView.setText("conn...");

              }

              @Override

              public void onLoading(long total, long current, boolean isUploading) {

                  if (isUploading) {

                     testTextView.setText("upload:" + current + "/" + total);

                  } else {

                     testTextView.setText("reply:" + current + "/" + total);

                  }

              }

              @Override

              public voidonSuccess(ResponseInfo<String> responseInfo) {

                 testTextView.setText("reply:" + responseInfo.result);

              }

              @Override

              public voidonFailure(HttpException error, String msg) {

                 testTextView.setText(error.getExceptionCode() + ":" + msg);

              }

      });

使用HttpUtils下载文件

HttpUtils http = new HttpUtils();

      HttpHandler handler = http.download("http://apache.dataguru.cn/httpcomponents/httpclient/source/httpcomponents-client-4.2.5-src.zip",

          "/sdcard/httpcomponents-client-4.2.5-src.zip",

          true, // 如果目标文件存在，接着未完成的部分继续下载。服务器不支持RANGE时将从新下载。

          true, // 如果从请求返回信息中获取到文件名，下载完成后自动重命名。

          newRequestCallBack<File>() {

              @Override

              public void onStart() {

                 testTextView.setText("conn...");

              }

              @Override

              public void onLoading(long total, long current, boolean isUploading) {

                 testTextView.setText(current + "/" + total);

              }

              @Override

              public voidonSuccess(ResponseInfo<File> responseInfo) {

                 testTextView.setText("downloaded:" + responseInfo.result.getPath());

              }

              @Override

              public voidonFailure(HttpException error, String msg) {

                 testTextView.setText(msg);

              }

      });

      ...

      //调用stop()方法停止下载

      handler.stop();

      ...

 

4． DbUtils使用方法

DbUtils db = DbUtils.create(this);

      User user = new User(); //这里需要注意的是User对象必须有id属性，或者有通过@ID注解的属性

      user.setEmail("wyouflf@qq.com");

      user.setName("wyouflf");

      db.save(user); // 使用saveBindingId保存实体时会为实体的id赋值

      ...

      // 查找

      Parent entity = db.findById(Parent.class, parent.getId());

      Parent entity = db.findFirst(entity);//通过entity的属性查找

      List<Parent> list = db.findAll(entity);//通过entity的属性查找

      List<Parent> list = db.findAll(Parent.class);//通过类型查找

      Parent Parent = db.findFirst(Selector.from(Parent.class).where("name","=","test"));

      // IS NULL

      Parent Parent = db.findFirst(Selector.from(Parent.class).where("name","=", null));

      // IS NOT NULL

      Parent Parent = db.findFirst(Selector.from(Parent.class).where("name","!=", null));

      // WHERE id<54 AND(age>20 OR age<30) ORDER BY id LIMIT pageSize OFFSET pageOffset

      List<Parent> list = db.findAll(Selector.from(Parent.class)

                                         .where("id" ,"<", 54)

                                        .and(WhereBuilder.b("age", ">", 20).or("age", " <", 30))

                                         .orderBy("id")

                                        .limit(pageSize)

                                        .offset(pageSize * pageIndex));

      // op为"in"时，最后一个参数必须是数组或Iterable的实现类(例如List等)

      Parent test = db.findFirst(Selector.from(Parent.class).where("id", "in", new int[]{1, 2, 3}));

      // op为"between"时，最后一个参数必须是数组或Iterable的实现类(例如List等)

      Parent test = db.findFirst(Selector.from(Parent.class).where("id", "between", new String[]{"1", "5"}));

      DbModel dbModel = db.findDbModelAll(Selector.from(Parent.class).select("name"));//select("name")只取出name列

      List<DbModel> dbModels =db.findDbModelAll(Selector.from(Parent.class).groupBy("name").select("name", "count(name)"));

      ...

      List<DbModel> dbModels = db.findDbModelAll(sql); // 自定义sql查询

      db.execNonQuery(sql) // 执行自定义sql

      ...

 

备注：

使用xUtils快速开发框架需要有以下权限：

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

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

混淆时注意事项：

添加Android默认混淆配置${sdk.dir}/tools/proguard/proguard-android.txt

不要混淆xUtils中的注解类型，添加混淆配置：-keep class * extends java.lang.annotation.Annotation { *; }

对使用DbUtils模块持久化的实体类不要混淆，或者注解所有表和列名称@Table(name="xxx")，@Id(column="xxx")，@Column(column="xxx"),@Foreign(column="xxx",foreign="xxx")；