xUtils简介

xUtils简介

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

目前xUtils主要有四大模块：

• DbUtils模块：

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

• ViewUtils模块：

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

• HttpUtils模块：

  • 支持同步，异步方式的请求；
  • 支持大文件上传，上传大文件不会oom；
  • 支持GET，POST，PUT，MOVE，COPY，DELETE，HEAD请求；
  • 下载支持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. Parent entity = db.findFirst(entity);//通过entity的属性查找  
11. List<Parent> list = db.findAll(entity);//通过entity的属性查找  
12. Parent Parent = db.findFirst(Selector.from(Parent.class).where("name","=","test"));  
13.   
14. // WHERE id<54 AND (age>20 OR age<30) ORDER BY id LIMIT pageSize OFFSET pageOffset  
15. List<Parent> list = db.findAll(Selector.from(Parent.class)  
16.                                    .where("id" ,"<", 54)  
17.                                    .and(WhereBuilder.b("age", ">", 20).or("age", " < ", 30))  
18.                                    .orderBy("id")  
19.                                    .limit(pageSize)  
20.                                    .offset(pageSize * pageIndex));  
21.   
22. DbModel dbModel = db.findDbModelAll(Selector.from(Parent.class).select("name"));//select("name")只取出name列  
23. List<DbModel> dbModels = db.findDbModelAll(Selector.from(Parent.class).groupBy("name").select("name", "count(name)"));  

ViewUtils使用方法

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

查看文本 打印 ?

1. @ViewInject(R.id.textView)  
2. TextView textView;  
3.   
4. // 取消了之前使用方法名绑定事件的方式，使用id绑定不受混淆影响  
5. // 支持绑定多个id @OnClick({R.id.id1, R.id.id2, R.id.id3})  
6. // 更多事件支持参见ViewCommonEventListener类和包com.lidroid.xutils.view.annotation.event。  
7. @OnClick(R.id.test_button)  
8. public void testButtonClick(View v) {  
9.     ...  
10. }  
11. ...  
12. //在使用注解对象之前调用(如onCreate中)：  
13. @Override  
14. public void onCreate(Bundle savedInstanceState) {  
15.     super.onCreate(savedInstanceState);  
16.     setContentView(R.layout.main);  
17.   
18.     ViewUtils.inject(this);  
19.   
20.     ...  
21.     textView.setText("some text...");  
22.     ...  
23. }  

HttpUtils使用方法：

普通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. // 例：params.setBodyEntity(new StringEntity(json,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. //调用stop()方法停止下载  
32. handler.stop();  

BitmapUtils 使用方法

查看文本 打印 ?

1. BitmapUtils bitmapUtils = new BitmapUtils(this);  
2. bitmapUtils.display(testImageView, "http://bbs.lidroid.com/static/image/common/logo.png");  
3. //bitmapUtils.display(testImageView, "/sdcard/test.jpg"); //支持加载本地图片  
4.   
5. // 使用ListView等容器展示图片时可通过PauseOnScrollListener控制滑动和快速滑动过程中时候暂停加载图片  
6. listView.setOnScrollListener(new PauseOnScrollListener(bitmapUtils, false, true));  
7. listView.setOnScrollListener(new PauseOnScrollListener(bitmapUtils, false, true), customListener);  

其他（更多示例代码见sample文件夹中的代码）

输出日志 LogUtils

查看文本 打印 ?

1. // 自动添加TAG，格式： className.methodName(L:lineNumber)  
2. // 可设置全局的LogUtils.allowD = false，LogUtils.allowI = false...，控制是否输出log。  
3. // 自定义log输出LogUtils.customLogger = new xxxLogger();  
4. LogUtils.d("wyouflf");