XUtils 开发框架

xUtils简介

• xUtils 包含了很多实用的android工具。
• xUtils 最初源于Afinal框架，进行了大量重构，使得xUtils支持大文件上传，更全面的http请求协议支持(10种谓词)，拥有更加灵活的ORM，更多的事件注解支持且不受混淆影响...
• xUitls最低兼容android 2.2 (api level 8)

• 目前xUtils主要有四大模块：

• • DbUtils模块：

    • android中的orm框架，一行代码就可以进行增删改查；
    • 支持事务，默认关闭；
    • 可通过注解自定义表名，列名，外键，唯一性约束，NOT NULL约束，CHECK约束等（需要混淆的时候请注解表名和列名）；
    • 支持绑定外键，保存实体时外键关联实体自动保存或更新；
    • 自动加载外键关联实体，支持延时加载；
    • 支持链式表达查询，更直观的查询语义，参考下面的介绍或sample中的例子。

  • ViewUtils模块：

    • android中的ioc框架，完全注解方式就可以进行UI，资源和事件绑定；
    • 新的事件绑定方式，使用混淆工具混淆后仍可正常工作；
    • 目前支持常用的20种事件绑定，参见ViewCommonEventListener类和包com.lidroid.xutils.view.annotation.event。

  • HttpUtils模块：

    • 支持同步，异步方式的请求；
    • 支持大文件上传，上传大文件不会oom；
    • 支持GET，POST，PUT，MOVE，COPY，DELETE，HEAD，OPTIONS，TRACE，CONNECT请求；
    • 下载支持301/302重定向，支持设置是否根据Content-Disposition重命名下载的文件；
    • 返回文本内容的请求(默认只启用了GET请求)支持缓存，可设置默认过期时间和针对当前请求的过期时间。

  • BitmapUtils模块：

    • 加载bitmap的时候无需考虑bitmap加载过程中出现的oom和android容器快速滑动时候出现的图片错位等现象；
    • 支持加载网络图片和本地图片；
    • 内存管理使用lru算法，更好的管理bitmap内存；
    • 可配置线程加载线程数量，缓存大小，缓存路径，加载显示动画等...

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

  1 <uses-permission android:name="android.permission.INTERNET" />
  2  <uses-permission android: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")；

  DbUtils使用方法：

   1 DbUtils db = DbUtils.create(this);
   2 User user = new User(); //这里需要注意的是User对象必须有id属性，或者有通过@ID注解的属性
   3 user.setEmail("wyouflf@qq.com");
   4 user.setName("wyouflf");
   5 db.save(user); // 使用saveBindingId保存实体时会为实体的id赋值
   6
   7 ...
   8 // 查找
   9 Parent entity = db.findById(Parent.class, parent.getId());
  10 List<Parent> list = db.findAll(Parent.class);//通过类型查找
  11
  12 Parent Parent = db.findFirst(Selector.from(Parent.class).where("name","=","test"));
  13
  14 // IS NULL
  15 Parent Parent = db.findFirst(Selector.from(Parent.class).where("name","=", null));
  16 // IS NOT NULL
  17 Parent Parent = db.findFirst(Selector.from(Parent.class).where("name","!=", null));
  18
  19 // WHERE id<54 AND (age>20 OR age<30) ORDER BY id LIMIT pageSize OFFSET pageOffset
  20 List<Parent> list = db.findAll(Selector.from(Parent.class)
  21                                    .where("id" ,"<", 54)
  22                                    .and(WhereBuilder.b("age", ">", 20).or("age", " < ", 30))
  23                                    .orderBy("id")
  24                                    .limit(pageSize)
  25                                    .offset(pageSize * pageIndex));
  26
  27 // op为"in"时，最后一个参数必须是数组或Iterable的实现类(例如List等)
  28 Parent test = db.findFirst(Selector.from(Parent.class).where("id", "in", new int[]{1, 2, 3}));
  29 // op为"between"时，最后一个参数必须是数组或Iterable的实现类(例如List等)
  30 Parent test = db.findFirst(Selector.from(Parent.class).where("id", "between", new String[]{"1", "5"}));
  31
  32 DbModel dbModel = db.findDbModelAll(Selector.from(Parent.class).select("name"));//select("name")只取出name列
  33 List<DbModel> dbModels = db.findDbModelAll(Selector.from(Parent.class).groupBy("name").select("name", "count(name)"));
  34 ...
  35
  36 List<DbModel> dbModels = db.findDbModelAll(sql); // 自定义sql查询
  37 db.execNonQuery(sql) // 执行自定义sql
  38 ...

  ViewUtils使用方法

  • 完全注解方式就可以进行UI绑定和事件绑定。
  • 无需findViewById和setClickListener等。

   1 // xUtils的view注解要求必须提供id，以使代码混淆不受影响。
   2 @ViewInject(R.id.textView)
   3 TextView textView;
   4
   5 //@ViewInject(vale=R.id.textView, parentId=R.id.parentView)
   6 //TextView textView;
   7
   8 @ResInject(id = R.string.label, type = ResType.String)
   9 private String label;
  10
  11 // 取消了之前使用方法名绑定事件的方式，使用id绑定不受混淆影响
  12 // 支持绑定多个id @OnClick({R.id.id1, R.id.id2, R.id.id3})
  13 // or @OnClick(value={R.id.id1, R.id.id2, R.id.id3}, parentId={R.id.pid1, R.id.pid2, R.id.pid3})
  14 // 更多事件支持参见ViewCommonEventListener类和包com.lidroid.xutils.view.annotation.event。
  15 @OnClick(R.id.test_button)
  16 public void testButtonClick(View v) { // 方法签名必须和接口中的要求一致
  17     ...
  18 }
  19 ...
  20 //在Activity中注入：
  21 @Override
  22 public void onCreate(Bundle savedInstanceState) {
  23     super.onCreate(savedInstanceState);
  24     setContentView(R.layout.main);
  25     ViewUtils.inject(this); //注入view和事件
  26     ...
  27     textView.setText("some text...");
  28     ...
  29 }
  30 //在Fragment中注入：
  31 @Override
  32 public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
  33     View view = inflater.inflate(R.layout.bitmap_fragment, container, false); // 加载fragment布局
  34     ViewUtils.inject(this, view); //注入view和事件
  35     ...
  36 }
  37 //在PreferenceFragment中注入：
  38 public void onActivityCreated(Bundle savedInstanceState) {
  39     super.onActivityCreated(savedInstanceState);
  40     ViewUtils.inject(this, getPreferenceScreen()); //注入view和事件
  41     ...
  42 }
  43 // 其他重载
  44 // inject(View view);
  45 // inject(Activity activity)
  46 // inject(PreferenceActivity preferenceActivity)
  47 // inject(Object handler, View view)
  48 // inject(Object handler, Activity activity)
  49 // inject(Object handler, PreferenceGroup preferenceGroup)
  50 // inject(Object handler, PreferenceActivity preferenceActivity)

  HtttpUtils使用方法：

  普通get方法

   1 HttpUtils http = new HttpUtils();
   2 http.send(HttpRequest.HttpMethod.GET,
   3     "http://www.lidroid.com",
   4     new RequestCallBack<String>(){
   5         @Override
   6         public void onLoading(long total, long current, boolean isUploading) {
   7             testTextView.setText(current + "/" + total);
   8         }
   9
  10         @Override
  11         public void onSuccess(ResponseInfo<String> responseInfo) {
  12             textView.setText(responseInfo.result);
  13         }
  14
  15         @Override
  16         public void onStart() {
  17         }
  18
  19         @Override
  20         public void onFailure(HttpException error, String msg) {
  21         }
  22 });

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

   1 RequestParams params = new RequestParams();
   2 params.addHeader("name", "value");
   3 params.addQueryStringParameter("name", "value");
   4
   5 // 只包含字符串参数时默认使用BodyParamsEntity，
   6 // 类似于UrlEncodedFormEntity（"application/x-www-form-urlencoded"）。
   7 params.addBodyParameter("name", "value");
   8
   9 // 加入文件参数后默认使用MultipartEntity（"multipart/form-data"），
  10 // 如需"multipart/related"，xUtils中提供的MultipartEntity支持设置subType为"related"。
  11 // 使用params.setBodyEntity(httpEntity)可设置更多类型的HttpEntity（如：
  12 // MultipartEntity,BodyParamsEntity,FileUploadEntity,InputStreamUploadEntity,StringEntity）。
  13 // 例如发送json参数：params.setBodyEntity(new StringEntity(jsonStr,charset));
  14 params.addBodyParameter("file", new File("path"));
  15 ...
  16
  17 HttpUtils http = new HttpUtils();
  18 http.send(HttpRequest.HttpMethod.POST,
  19     "uploadUrl....",
  20     params,
  21     new RequestCallBack<String>() {
  22
  23         @Override
  24         public void onStart() {
  25             testTextView.setText("conn...");
  26         }
  27
  28         @Override
  29         public void onLoading(long total, long current, boolean isUploading) {
  30             if (isUploading) {
  31                 testTextView.setText("upload: " + current + "/" + total);
  32             } else {
  33                 testTextView.setText("reply: " + current + "/" + total);
  34             }
  35         }
  36
  37         @Override
  38         public void onSuccess(ResponseInfo<String> responseInfo) {
  39             testTextView.setText("reply: " + responseInfo.result);
  40         }
  41
  42         @Override
  43         public void onFailure(HttpException error, String msg) {
  44             testTextView.setText(error.getExceptionCode() + ":" + msg);
  45         }
  46 });

  使用HttpUtils下载文件：

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

   1 HttpUtils http = new HttpUtils();
   2 HttpHandler handler = http.download("http://apache.dataguru.cn/httpcomponents/httpclient/source/httpcomponents-client-4.2.5-src.zip",
   3     "/sdcard/httpcomponents-client-4.2.5-src.zip",
   4     true, // 如果目标文件存在，接着未完成的部分继续下载。服务器不支持RANGE时将从新下载。
   5     true, // 如果从请求返回信息中获取到文件名，下载完成后自动重命名。
   6     new RequestCallBack<File>() {
   7
   8         @Override
   9         public void onStart() {
  10             testTextView.setText("conn...");
  11         }
  12
  13         @Override
  14         public void onLoading(long total, long current, boolean isUploading) {
  15             testTextView.setText(current + "/" + total);
  16         }
  17
  18         @Override
  19         public void onSuccess(ResponseInfo<File> responseInfo) {
  20             testTextView.setText("downloaded:" + responseInfo.result.getPath());
  21         }
  22
  23
  24         @Override
  25         public void onFailure(HttpException error, String msg) {
  26             testTextView.setText(msg);
  27         }
  28 });
  29
  30 ...
  31 //调用cancel()方法停止下载
  32 handler.cancel();

  BitmapUtils 使用方法

   1 BitmapUtils bitmapUtils = new BitmapUtils(this);
   2
   3 // 加载网络图片
   4 bitmapUtils.display(testImageView, "http://bbs.lidroid.com/static/image/common/logo.png");
   5
   6 // 加载本地图片(路径以/开头， 绝对路径)
   7 bitmapUtils.display(testImageView, "/sdcard/test.jpg");
   8
   9 // 加载assets中的图片(路径以assets开头)
  10 bitmapUtils.display(testImageView, "assets/img/wallpaper.jpg");
  11
  12 // 使用ListView等容器展示图片时可通过PauseOnScrollListener控制滑动和快速滑动过程中时候暂停加载图片
  13 listView.setOnScrollListener(new PauseOnScrollListener(bitmapUtils, false, true));
  14 listView.setOnScrollListener(new PauseOnScrollListener(bitmapUtils, false, true, customListener));