XUtils框架详解+使用
前言：
目前andorid的注解框架应该是很完善了；在使用注解框架的时候 可以改变我们在写findviewbyid写到呕吐的生活状态；让我们的程序看起来更清新；更具有可读性。–当然最重要的还是为了节省我们的时间。
个人说明：起初个人是不喜欢用注解的；并不是因为它不好；或者说它很方便快速开发阅读代码；but:注解可能会破坏代码的原有结构，使得代码没用主体。
不过不是有那么一句话吗：有得必有失。
下面谈谈我一直热衷的XUtils 框架的认识：注解只是这个框架的很小的功能部分。
xUtils简介：
- xUtils 包含了很多实用的android工具。
- xUtils最初源于Afinal框架，进行了大量重构，使得xUtils支持大文件上传，更全面的http请求协议支持(10种谓词)，拥有更加灵活的ORM，更多的事件注解支持且不受混淆影响…
- xUitls最低兼容android 2.2 (api level 8)。
XUtils主要的四大模块：
1：DbUtils模块：
- android中的orm框架，一行代码就可以进行增删改查；
- 支持事务，默认关闭；
- 可通过注解自定义表名，列名，外键，唯一性约束，NOT NULL约束，CHECK约束等（需要混淆的时候请注解表名和列名）；
- 支持绑定外键，保存实体时外键关联实体自动保存或更新；
- 自动加载外键关联实体，支持延时加载；
- 支持链式表达查询，更直观的查询语义，参考下面的介绍或sample中的例子。
2：ViewUtils模块：
- android中的ioc框架，完全注解方式就可以进行UI，资源和事件绑定；
- 新的事件绑定方式，使用混淆工具混淆后仍可正常工作；
- 目前支持常用的20种事件绑定，参见ViewCommonEventListener类和包com.lidroid.xutils.view.annotation.event。
3：HttpUtils模块：
- 支持同步，异步方式的请求；
- 支持大文件上传，上传大文件不会oom；
- 支持GET，POST，PUT，MOVE，COPY，DELETE，HEAD，OPTIONS，TRACE，CONNECT请求；
- 下载支持301/302重定向，支持设置是否根据Content-Disposition重命名下载的文件；
- 返回文本内容的请求(默认只启用了GET请求)支持缓存，可设置默认过期时间和针对当前请求的过期时间。
4:BitmapUtils模块：
- 加载bitmap的时候无需考虑bitmap加载过程中出现的oom和android容器快速滑动时候出现的图片错位等现象；
- 支持加载网络图片和本地图片；
- 内存管理使用lru算法，更好的管理bitmap内存；
- 可配置线程加载线程数量，缓存大小，缓存路径，加载显示动画等…
下面谈谈部分的使用方式：
ViewUtils使用方法:
- 完全注解方式就可以进行UI绑定和事件绑定。
- 无需findViewById和setClickListener等。
//这里是部分使用说明
//例：主Activity 对应xml文件的 注解使用
@ContentView(R.layout.activity_main)
// xUtils的view注解要求必须提供id，以使代码混淆不受影响。
@ViewInject(R.id.textView)
TextView textView;
//@ViewInject(vale=R.id.textView, parentId=R.id.parentView)
//TextView textView;
@ResInject(id = R.string.label, type = ResType.String)
private String label;
// 取消了之前使用方法名绑定事件的方式，使用id绑定不受混淆影响
// 支持绑定多个id @OnClick({R.id.id1, R.id.id2, R.id.id3})
// or @OnClick(value={R.id.id1, R.id.id2, R.id.id3}, parentId={R.id.pid1, R.id.pid2, R.id.pid3})
// 更多事件支持参见ViewCommonEventListener类和包com.lidroid.xutils.view.annotation.event。
@OnClick(R.id.test_button)
public void testButtonClick(View v) { // 方法签名必须和接口中的要求一致
...
}
...//在Activity中注入：
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.main);
ViewUtils.inject(this); //注入view和事件
...
textView.setText("some text...");
...
}//在Fragment中注入：
@Override
public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
View view = inflater.inflate(R.layout.bitmap_fragment, container, false); // 加载fragment布局
ViewUtils.inject(this, view); //注入view和事件
...
}//在PreferenceFragment中注入：
//在PreferenceFragment中注入：
public void onActivityCreated(Bundle savedInstanceState) {
super.onActivityCreated(savedInstanceState);
ViewUtils.inject(this, getPreferenceScreen()); //注入view和事件
...
}// 其他重载
// inject(View view);
// inject(Activity activity)
// inject(PreferenceActivity preferenceActivity)
// inject(Object handler, View view)
// inject(Object handler, Activity activity)
// inject(Object handler, PreferenceGroup preferenceGroup)
// inject(Object handler, PreferenceActivity preferenceActivity)HttpUtils使用方法：
普通get方法
HttpUtils http = new HttpUtils();
http.send(HttpRequest.HttpMethod.GET,
"http://www.lidroid.com",
new RequestCallBack(){
@Override
public void onLoading(long total, long current, boolean isUploading) {
testTextView.setText(current + "/" + total);
}
@Override
public void onSuccess(ResponseInfo 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,
new RequestCallBack() {
@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 void onSuccess(ResponseInfo responseInfo) {
testTextView.setText("reply: " + responseInfo.result);
}
@Override
public void onFailure(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, // 如果从请求返回信息中获取到文件名，下载完成后自动重命名。
new RequestCallBack() {
@Override
public void onStart() {
testTextView.setText("conn...");
}
@Override
public void onLoading(long total, long current, boolean isUploading) {
testTextView.setText(current + "/" + total);
}
@Override
public void onSuccess(ResponseInfo responseInfo) {
testTextView.setText("downloaded:" + responseInfo.result.getPath());
}
@Override
public void onFailure(HttpException error, String msg) {
testTextView.setText(msg);
}
});
...
//调用cancel()方法停止下载
handler.cancel();
考虑到 GreenDao （数据库）和Glide(图片加载)的成熟 这里就不介绍： DbUtils模块 和 BitmapUtils模块了。
其实说实话XUtils 的HttpUtils模块 个人也很少使用；个人开发中 更热衷于KJHttp的使用。
具体的GreenDao 、Glide、（kjframe）KJHttp系列文档 个人在整理学习中…
XUtils的注解机制：不求审解
下面简单说下Java注解：
注解（Annotation） 为我们在代码中添加信息提供了一种形式化的方法，是我们可以在稍后某个时刻方便地使用这些数据（通过 解析注解 来使用这些数据），常见的作用有以下几种：
- 生成文档 ，这是最常见的，也是java 最早提供的注解。常用的有@see @param @return 等
- 跟踪代码依赖性，实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。作用就是减少配置。现在的框架基本都使用了这种配置来减少配置文件的数量。也是
在编译时进行格式检查。如@override 放在方法前，如果你这个方法并不是覆盖了超类方法，则编译时就能检查出。
包 Java.lang.annotation 中包含所有定义自定义注解所需用到的原注解和接口。如接口java.lang.annotation.Annotation 是所有注解继承的接口,并且是自动继承，不需要定义时指定，类似于所有类都自动继承Object。
Annotation类型里面的参数该怎么设定:
只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型.
- 参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String.
- 如果只有一个参数成员,最好把参数名称设为”value”,后加小括号.
元注解
元注解是指注解的注解。包括 @Retention @Target @Document @Inherited四种。
a: @Retention: 定义注解的保留策略
@Retention(RetentionPolicy.SOURCE)//注解仅存在于源码中，在class字节码文件中不包含
@Retention(RetentionPolicy.CLASS)// 默认的保留策略，注解会在class字节码文件中存在，但运行时无法得
@Retention(RetentionPolicy.RUNTIME)// 注解会在class字节码文件中存在，在运行时可以通过反射获取到b：@Target：定义注解的作用目标
其定义的源码为：
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Target {
ElementType[] value();
}
@Target(ElementType.TYPE) //接口、类、枚举、注解
@Target(ElementType.FIELD) //字段、枚举的常量
@Target(ElementType.METHOD) //方法
@Target(ElementType.PARAMETER) //方法参数
@Target(ElementType.CONSTRUCTOR) //构造函数
@Target(ElementType.LOCAL_VARIABLE)//局部变量
@Target(ElementType.ANNOTATION_TYPE)//注解
@Target(ElementType.PACKAGE) ///包 其中的@interface是一个关键字，在设计annotations的时候必须把一个类型定义为@interface，而不能用class或interface关键字，由以上的源码可以知道，他的elementType 可以有多个，一个注解可以为类的，方法的，字段的等等。
c: @Document：说明该注解将被包含在javadoc中
d: @Inherited：说明子类可以继承父类中的该注解
…..浏览下就好了，这里不多说了。
重点：咋使用注解呢 ？
文档API:
http://androidannotations.org/
AndroidStudio配置：
下载架包（个人使用）：xUtils架包
然后：直接放在libs下面；
添加到项目：libs文件中–>选中右键–>Add As Library…
这样就OK了 很简单；和平常使用三方sdk一样的方式。
注解使用说明：
- 加载当前的Activity布局需要如下注解:
@ContentView加入到Activity的上方 - 给View进行初始化需要如下注解:
@ViewInject - 处理控件的各种响应事件需要如下注解:
@OnClick - 事件的按下、移动、松开 操作
@OnTouch
以Activity使用为例：完整的
@ContentView(R.layout.activity_splash)
public class SplashActivity extends Activity {
//初始化注解
@ViewInject(R.id.test_text)
private TextView text;
@ViewInject(R.id.test_layout)
private RelativeLayout testlayout;
@ViewInject(R.id.test_iv)
private ImageView test_iv;
//响应点击事件
@OnClick(R.id.layout_test)
private void Layout_test_Click(View view) {
//逻辑操作
}
//事件的按下、移动、松开 操作
@OnTouch(R.id.splash_test)
public boolean Splash_testOnTouch(View view, MotionEvent ev) {
switch (ev.getAction()) {
case MotionEvent.ACTION_DOWN://按下
break;
case MotionEvent.ACTION_MOVE://移动
break;
case MotionEvent.ACTION_UP:
break;
}
return true;
}
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
ViewUtils.inject(this);
}
//........
}
权限：
<uses-permission android:name="android.permission.INTERNET" />
<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”)；
其实简单的两句就是在混淆中添加：
-keep class com.lidroid.xutils.**{*;}
#TJ：忽略警告
-dontwarn com.lidroid.xutils.**基本就可以了。
说了这么多； 我相信 大家应该对XUtils有个基本的认识了；我一直认为：理论始终是理论；需要我们动手 实践才能真正掌握住！你说呢？
注：GreenDao 、Glide、（kjframe）KJHttp等系列文档 个人在整理学习中, 欢迎持续关注…
愿意与大家共同学习进步…