xUtils 的使用（含版本迭代）

来源：互联网发布：js 手机端图片预览编辑：程序博客网时间：2024/06/09 17:46

说明：

目前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快速开发框架需要有以下权限：
```xml
<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")；

## ViewUtils使用方法
* 完全注解方式就可以进行UI绑定和事件绑定。
* 无需findViewById和setClickListener等。
// 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中注入：
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<String>(){
@Override
public void onLoading(long total, long current, boolean isUploading) {
testTextView.setText(current + "/" + total);
}
@Override
public void onSuccess(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,
new RequestCallBack<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 void onSuccess(ResponseInfo<String> responseInfo) {
testTextView.setText("reply: " + responseInfo.result);
}
@Override
public void onFailure(HttpException error, String msg) {
testTextView.setText(error.getExceptionCode() + ":" + msg);
}
});
----
### 使用HttpUtils下载文件：
* 支持断点续传，随时停止下载任务，开始任务
```java
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<File>() {
@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<File> responseInfo) {
testTextView.setText("downloaded:" + responseInfo.result.getPath());
}
@Override
public void onFailure(HttpException error, String msg) {
testTextView.setText(msg);
}
});
.
//调用cancel()方法停止下载
handler.cancel();

使用注解实例：

[java] view plain copy
 print?
**注解功能  
 * @ContentView(value = R.layout.xxxx)  完成了activity和xml文件的关联  
 * @ViewInject(value = R.id.btn_get)   作用是找到控件的id，但是要求必须在变量声明的上一行写  
 * @Event(value = {R.id.btn_get,R.id.btn_post,R.id.btn_download},type = View.OnClickListener.class)  
    可以写任何事件的监听  
 *  */  
@ContentView(value = R.layout.activity_main)  
public class MainActivity extends AppCompatActivity {  
    @ViewInject(value = R.id.btn_get)  
    private Button getBtn;  
    @ViewInject(value = R.id.btn_post)  
    private Button postBtn;  
    @ViewInject(value = R.id.btn_download)  
    private Button downloadBtn;  
    @Override  
    protected void onCreate(Bundle savedInstanceState) {  
        super.onCreate(savedInstanceState);  
        //声明使用了注解反射  
        x.view().inject(this);  
    }  
    /** 
     *1. 方法必须私有限定, 
     * 2. 方法参数形式必须和type对应的Listener接口一致. 
     * 3. 注解参数value支持数组: value={id1, id2, id3} 
     * 4. 其它参数说明见Event类的说明. 
     * */  
    @Event(value = {R.id.btn_reflection,R.id.btn_get,R.id.btn_post,R.id.btn_download,R.id.btn_img,R.id.btn_database},  
            type = View.OnClickListener.class)  
    private void onClick(View view){  
        Intent intent = new Intent();  
        switch (view.getId()) {  
            case R.id.btn_reflection:  
                intent.setClass(this,AnnotationActivity.class);  
                break;  
            case R.id.btn_get:  
                intent.setClass(this,GetDataActivity.class);  
                break;  
            case R.id.btn_post:  
                intent.setClass(this,PostDataActivity.class);  
                break;  
            case R.id.btn_download:  
                intent.setClass(this,DownloadFileActivity.class);  
                break;  
  
            case R.id.btn_img:  
                intent.setClass(this,ImageActivity.class);  
                break;  
  
            case R.id.btn_database:  
                intent.setClass(this,DatabaseActivity.class);  
                break;  
        }  
        startActivity(intent);  
    }  
  
}  

使用get方式获取数据：

[java] view plain copy
 print?
@ContentView(value = R.layout.activity_get_data)  
public class GetDataActivity extends AppCompatActivity {  
  
    @ViewInject(value = R.id.id_get_tv)  
    private TextView tv;  
    private String url = "http://218.244.149.129:9010/api/industry.php";  
    @Override  
    protected void onCreate(Bundle savedInstanceState) {  
        super.onCreate(savedInstanceState);  
        x.view().inject(this);  
  
    }  
    @Event(value = R.id.id_get_btn)  
    private void initData(View view){  
  
        //创建请求参数  
        RequestParams params = new RequestParams(url);  
//        params.addQueryStringParameter("","");  
  
        //执行网络请求操作  
        Callback.Cancelable cancelable = x.http().get(params, new Callback.CommonCallback<String>() {  
            //成功时回调的方法  
            @Override  
            public void onSuccess(String result) {  
                tv.setText(result);  
            }  
            //失败时回调的方法  
            @Override  
            public void onError(Throwable ex, boolean isOnCallback) {  
  
            }  
            //取消时回调的方法  
            @Override  
            public void onCancelled(CancelledException cex) {  
  
            }  
            //完成时回调的方法  
            @Override  
            public void onFinished() {  
  
            }  
        });  
        //取消网络请求  
//        cancelable.cancel();  
    }  
}  

使用post方式获取数据：

[java] view plain copy
 print?
@ContentView(value = R.layout.activity_get_data)  
public class PostDataActivity extends AppCompatActivity {  
  
    @ViewInject(value = R.id.id_get_tv)  
    private TextView tv;  
    private String url = "http://218.244.149.129:9010/api/companylist.php";  
    //?industryid=行业ID  
    @Override  
    protected void onCreate(Bundle savedInstanceState) {  
        super.onCreate(savedInstanceState);  
        x.view().inject(this);  
    }  
    @Event(value = R.id.id_get_btn,type = View.OnClickListener.class)  
    private void onClick(View v){  
  
        Map<String ,String>map = new HashMap<>();  
        map.put("industryid","98");  
        initData(url,map);  
    }  
    public void initData(String url, Map<String,String>map){  
        RequestParams params = new RequestParams(url);  
      Set<Map.Entry<String,String>> entry = map.entrySet();  
        Iterator<Map.Entry<String,String>>it = entry.iterator();  
        while (it.hasNext()){  
            Map.Entry<String,String>en = it.next();  
            params.addParameter(en.getKey(),en.getValue());  
        }  
        params.setMultipart(true);  
        x.http().post(params, new Callback.CommonCallback<String>() {  
            @Override  
            public void onSuccess(String result) {  
                tv.setText(result);  
            }  
  
            @Override  
            public void onError(Throwable ex, boolean isOnCallback) {  
  
            }  
  
            @Override  
            public void onCancelled(CancelledException cex) {  
  
            }  
  
            @Override  
            public void onFinished() {  
  
            }  
        });  
    }  
}  

下载文件（安装包）的实例：

[java] view plain copy
 print?
public class DownloadFileActivity extends AppCompatActivity {  
  
    private String apkUrl = "http://218.244.149.129:9010/download.php?apkid=12";  
    private String fileName = "hello.apk";  
    @ViewInject(value = R.id.id_download_bar)  
    private ProgressBar bar;  
    @Override  
    protected void onCreate(Bundle savedInstanceState) {  
        super.onCreate(savedInstanceState);  
        setContentView(R.layout.activity_download_file);  
        x.view().inject(this);  
    }  
    @Event(value = R.id.id_download_btn)  
    private void download(View view){  
        String filePath = getExternalCacheDir().getAbsolutePath()+ File.separator+fileName;  
        RequestParams params = new RequestParams(apkUrl);  
        params.setSaveFilePath(filePath);  
  
        x.http().get(params, new Callback.ProgressCallback<File>() {  
            @Override  
            public void onWaiting() {  
            }  
            @Override  
            public void onStarted() {  
            }  
            @Override  
            public void onLoading(long total, long current, boolean isDownloading) {  
                bar.setProgress((int)(current*100/total));  
            }  
            @Override  
            public void onSuccess(File result) {  
                Intent intent = new Intent();  
                intent.setAction(Intent.ACTION_VIEW);  
                intent.setDataAndType(Uri.fromFile(result), "application/vnd.android.package-archive");  
                intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);  
                DownloadFileActivity.this.startActivity(intent);  
  
            }  
            @Override  
            public void onError(Throwable ex, boolean isOnCallback) {  
  
            }  
            @Override  
            public void onCancelled(CancelledException cex) {  
  
            }  
            @Override  
            public void onFinished() {  
  
            }  
        });  
  
    }  
}  

1 0