Android xUtils3完全解析
轉自:http://www.w2bc.com/article/156732
1.先來認識一下xUtils3
1)xUtils3簡介
xUtils是基於Afinal開發的目前功能比較完善的一個Android開源框架,最近又釋出了xUtil3.0,在增加新功能的同時又提高了框架的效能,下面來看看官方(https://github.com/wyouflf/xUtils3)對xUtils3的介紹:
- xUtils包含了很多實用的android工具;
- xUtils支援超大檔案(超過2G)上傳,更全面的http請求協議支援(11種謂詞),擁有更加靈活的ORM,更多的事件註解支援且不受混淆影響;
- xUtils 最低相容Android 4.0 (api level 14);
- xUtils3變化較多所以建立了新的專案不在舊版(github.com/wyouflf/xUtils)上繼續維護, 相對於舊版本:
- HTTP實現替換HttpClient為UrlConnection, 自動解析回撥泛型, 更安全的斷點續傳策略;
- 支援標準的Cookie策略, 區分domain, path;
- 事件註解去除不常用的功能, 提高效能;
- 資料庫api簡化提高效能, 達到和greenDao一致的效能;
- 圖片繫結支援gif(受系統相容性影響, 部分gif檔案只能靜態顯示), webp; 支援圓角, 圓形, 方形等裁剪, 支援自動旋轉。
2)在我們的專案中快速配置xUtils3
xUtils3的配置十分的簡單:
2-1)使用Gradle構建時新增一下依賴即可
compile ‘org.xutils:xutils:3.3.36’
- 1
如果使用eclipse可以點選下面連結下載aar檔案, 然後用zip解壓,取出jar包和so檔案。
2-2)加入許可權
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
- 1
- 2
2-3)建立Application
public class MyApp extends Application {
@Override
public void onCreate() {
super.onCreate();
x.Ext.init(this);
x.Ext.setDebug(true); //是否輸出debug日誌,開啟debug會影響效能。
}
2-4)在Manifest檔案中註冊MyApp
<application
android:name=".MyApp"
...
</application>
xUtils3主要包含註解模組、網路模組、圖片模組和資料庫模組,下面將做一一說明。
2.xUtils3註解模組的使用
xUtils3註解模組在實際開發中的使用如下:
1)Activity的註解的使用如下:
@ContentView(R.layout.activity_main)
public class MainActivity extends AppCompatActivity {
@ViewInject(R.id.viewpager)
ViewPager viewPager;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
x.view().inject(this);
...
}
}
2)Fragment的註解的使用如下:
@ContentView(R.layout.fragment_http)
public class HttpFragment extends Fragment {
@Nullable
@Override
public View onCreateView(LayoutInflater inflater, @Nullable ViewGroup container, @Nullable Bundle savedInstanceState) {
return x.view().inject(this, inflater, container);
}
@Override
public void onViewCreated(View v, @Nullable Bundle savedInstanceState) {
super.onViewCreated(v, savedInstanceState);
}
}
3)為按鈕設定點選事件
@ViewInject(R.id.bt_main)
Button bt_main;
...
@Override
protected void onCreate(Bundle savedInstanceState) {
...
}
/**
* 用註解的方式為按鈕新增點選事件,方法宣告必須為private
* type預設View.OnClickListener.class,故此處可以簡化不寫,@Event(R.id.bt_main)
*/
@Event(type = View.OnClickListener.class,value = R.id.bt_main)
private void testInjectOnClick(View v){
Snackbar.make(v,"OnClickListener",Snackbar.LENGTH_SHORT).show();
}
/**
* 長按事件
*/
@Event(type = View.OnLongClickListener.class,value = R.id.bt_main)
private boolean testOnLongClickListener(View v){
Snackbar.make(v,"testOnLongClickListener",Snackbar.LENGTH_SHORT).show();
return true;
}
說明:下面演示都將使用@Event事件註解。
3.xUtils3網路模組的使用
xUtils3網路模組大大方便了在實際開發中網路模組的開發,xUtils3網路模組大致包括GET請求、POST請求、如何使用其他請求方式、上傳檔案、下載檔案、使用快取等功能,下面將做一一說明:
1)GET請求
String url = "http://www.android.com";
@Event(R.id.get)
private void get(View v){
final ProgressDialog progressDialog = new ProgressDialog(getActivity());
progressDialog.setMessage("請稍候...");
RequestParams params = new RequestParams(url);
params.addQueryStringParameter("username","abc");
params.addQueryStringParameter("password","123");
Callback.Cancelable cancelable = x.http().get(params, new Callback.CommonCallback<String>() {
@Override
public void onSuccess(String result) {
Log.i("JAVA", "onSuccess result:" + result);
progressDialog.cancel();
}
//請求異常後的回撥方法
@Override
public void onError(Throwable ex, boolean isOnCallback) {
}
//主動呼叫取消請求的回撥方法
@Override
public void onCancelled(CancelledException cex) {
}
@Override
public void onFinished() {
progressDialog.cancel();
}
});
//主動呼叫取消請求
cancelable.cancel();
}
2)POST請求
String url = "http://www.android.com";
@Event(R.id.post)
private void post(View v){
RequestParams params = new RequestParams(url);
params.addBodyParameter("username","abc");
params.addParameter("password","123");
params.addHeader("head","android"); //為當前請求新增一個頭
x.http().post(params, new Callback.CommonCallback<String>() {
@Override
public void onSuccess(String result) {
}
@Override
public void onError(Throwable ex, boolean isOnCallback) {
}
@Override
public void onCancelled(CancelledException cex) {
}
@Override
public void onFinished() {
}
});
}
3)其他網路請求方式
String url = "http://www.android.com";
@Event(R.id.other)
private void other(View v){
RequestParams params = new RequestParams(url);
params.addParameter("username","abc");
x.http().request(HttpMethod.PUT, params, new Callback.CommonCallback<String>() {
@Override
public void onSuccess(String result) {
}
@Override
public void onError(Throwable ex, boolean isOnCallback) {
}
@Override
public void onCancelled(CancelledException cex) {
}
@Override
public void onFinished() {
}
});
}
4)上傳檔案
String url = "http://www.android.com";
@Event(R.id.upload)
private void upload(View v){
String path="/mnt/sdcard/Download/icon.jpg";
RequestParams params = new RequestParams(url);
params.setMultipart(true);
params.addBodyParameter("file",new File(path));
x.http().post(params, new Callback.CommonCallback<String>() {
@Override
public void onSuccess(String result) {
}
@Override
public void onError(Throwable ex, boolean isOnCallback) {
}
@Override
public void onCancelled(CancelledException cex) {
}
@Override
public void onFinished() {
}
});
}
5)下載檔案
這裡以下載apk為例進行說明,apk下載完成後,自動呼叫系統的安裝方法。
String url = "http://www.android.com";
@Event(R.id.download)
private void download(View v){
url = "http://127.0.0.1/server/ABC.apk";
RequestParams params = new RequestParams(url);
//自定義儲存路徑,Environment.getExternalStorageDirectory():SD卡的根目錄
params.setSaveFilePath(Environment.getExternalStorageDirectory()+"/myapp/");
//自動為檔案命名
params.setAutoRename(true);
x.http().post(params, new Callback.ProgressCallback<File>() {
@Override
public void onSuccess(File result) {
//apk下載完成後,呼叫系統的安裝方法
Intent intent = new Intent(Intent.ACTION_VIEW);
intent.setDataAndType(Uri.fromFile(result), "application/vnd.android.package-archive");
getActivity().startActivity(intent);
}
@Override
public void onError(Throwable ex, boolean isOnCallback) {
}
@Override
public void onCancelled(CancelledException cex) {
}
@Override
public void onFinished() {
}
//網路請求之前回調
@Override
public void onWaiting() {
}
//網路請求開始的時候回撥
@Override
public void onStarted() {
}
//下載的時候不斷回撥的方法
@Override
public void onLoading(long total, long current, boolean isDownloading) {
//當前進度和檔案總大小
Log.i("JAVA","current:"+ current +",total:"+total);
}
});
}
6)使用快取
String url = "http://www.android.com";
@Event(R.id.cache)
private void cache(View v) {
RequestParams params = new RequestParams(url);
params.setCacheMaxAge(1000*60); //為請求新增快取時間
Callback.Cancelable cancelable = x.http().get(params, new Callback.CacheCallback<String>() {
@Override
public void onSuccess(String result) {
Log.i("JAVA","onSuccess:"+result);
}
@Override
public void onError(Throwable ex, boolean isOnCallback) {
}
@Override
public void onCancelled(CancelledException cex) {
}
@Override
public void onFinished() {
}
//result:快取內容
@Override
public boolean onCache(String result) {
//在setCacheMaxAge設定範圍(上面設定的是60秒)內,如果再次呼叫GET請求,
//返回true:快取內容被返回,相信本地快取,返回false:快取內容被返回,不相信本地快取,仍然會請求網路
Log.i("JAVA","cache:"+result);
return true;
}
});
}
4.xUtils3圖片模組的使用
xUtils3圖片模組,重點在於載入圖片的4個bind方法,loadDrawable與loadFIle用法和ImageOptions用法,需多加練習。
1)首先獲取ImageView控制元件
@ViewInject(R.id.image01)
ImageView image01;
@ViewInject(R.id.image02)
ImageView image02;
@ViewInject(R.id.image03)
ImageView image03;
...
2)得到網路圖片的地址
String[] urls={
"http://img.android.com/a.jpg",
"http://img.android.com/b.jpg"
"http://img.android.com/c.jpg"
...
};
3)xUtils3顯示圖片方法setPic()如下:
private void setPic() {
/**
* 通過ImageOptions.Builder().set方法設定圖片的屬性
*/
ImageOptions options = new ImageOptions.Builder().setFadeIn(true).build(); //淡入效果
//ImageOptions.Builder()的一些其他屬性:
//.setCircular(true) //設定圖片顯示為圓形
//.setSquare(true) //設定圖片顯示為正方形
//setCrop(true).setSize(200,200) //設定大小
//.setAnimation(animation) //設定動畫
//.setFailureDrawable(Drawable failureDrawable) //設定載入失敗的動畫
//.setFailureDrawableId(int failureDrawable) //以資源id設定載入失敗的動畫
//.setLoadingDrawable(Drawable loadingDrawable) //設定載入中的動畫
//.setLoadingDrawableId(int loadingDrawable) //以資源id設定載入中的動畫
//.setIgnoreGif(false) //忽略Gif圖片
//.setParamsBuilder(ParamsBuilder paramsBuilder) //在網路請求中新增一些引數
//.setRaduis(int raduis) //設定拐角弧度
//.setUseMemCache(true) //設定使用MemCache,預設true
/**
* 載入圖片的4個bind方法
*/
x.image().bind(image01, urls[0]);
x.image().bind(image02, urls[1], options);
x.image().bind(image03, urls[2], options, new Callback.CommonCallback<Drawable>() {
@Override
public void onSuccess(Drawable result) {
}
@Override
public void onError(Throwable ex, boolean isOnCallback) {
}
@Override
public void onCancelled(CancelledException cex) {
}
@Override
public void onFinished() {
}
});
x.image().bind(image04, urls[3], options, new Callback.CommonCallback<Drawable>() {
@Override
public void onSuccess(Drawable result) {
}
@Override
public void onError(Throwable ex, boolean isOnCallback) {
}
@Override
public void onCancelled(CancelledException cex) {
}
@Override
public void onFinished() {
}
});
/**
* loadDrawable()方法載入圖片
*/
Callback.Cancelable cancelable = x.image().loadDrawable(urls[0], options, new Callback.CommonCallback<Drawable>() {
@Override
public void onSuccess(Drawable result) {
image03.setImageDrawable(result);
}
@Override
public void onError(Throwable ex, boolean isOnCallback) {
}
@Override
public void onCancelled(CancelledException cex) {
}
@Override
public void onFinished() {
}
});
//主動取消loadDrawable()方法
//cancelable.cancel();
/**
* loadFile()方法
* 應用場景:當我們通過bind()或者loadDrawable()方法載入了一張圖片後,
* 它會儲存到本地檔案中,那當我需要這張圖片時,就可以通過loadFile()方法進行查詢。
* urls[0]:網路地址
*/
x.image().loadFile(urls[0],options,new Callback.CacheCallback<File>(){
@Override
public boolean onCache(File result) {
//在這裡可以做圖片另存為等操作
Log.i("JAVA","file:"+result.getPath()+result.getName());
return true; //相信本地快取返回true
}
@Override
public void onSuccess(File result) {
Log.i("JAVA","file");
}
@Override
public void onError(Throwable ex, boolean isOnCallback) {
}
@Override
public void onCancelled(CancelledException cex) {
}
@Override
public void onFinished() {
}
});
}
4.xUtils3資料庫模組的使用
1)建立資料庫和刪除資料庫
首先進行配置DaoConfig:
/**
* DaoConfig配置
* /
DbManager.DaoConfig daoConfig = new DbManager.DaoConfig()
//設定資料庫名,預設xutils.db
.setDbName("myapp.db")
//設定表建立的監聽
.setTableCreateListener(new DbManager.TableCreateListener() {
@Override
public void onTableCreated(DbManager db, TableEntity<?> table){
Log.i("JAVA", "onTableCreated:" + table.getName());
}
})
//設定是否允許事務,預設true
//.setAllowTransaction(true)
//設定資料庫路徑,預設安裝程式路徑下
//.setDbDir(new File("/mnt/sdcard/"))
//設定資料庫的版本號
//.setDbVersion(1)
//設定資料庫更新的監聽
.setDbUpgradeListener(new DbManager.DbUpgradeListener() {
@Override
public void onUpgrade(DbManager db, int oldVersion,
int newVersion) {
}
})
//設定資料庫開啟的監聽
.setDbOpenListener(new DbManager.DbOpenListener() {
@Override
public void onDbOpened(DbManager db) {
//開啟資料庫支援多執行緒操作,提升效能
db.getDatabase().enableWriteAheadLogging();
}
});
DbManager db = x.getDb(daoConfig);
然後建立資料庫表ChildInfo的實體類:
/**
* onCreated = "sql":當第一次建立表需要插入資料時候在此寫sql語句
*/
@Table(name = "child_info",onCreated = "")
public class ChildInfo {
/**
* name = "id":資料庫表中的一個欄位
* isId = true:是否是主鍵
* autoGen = true:是否自動增長
* property = "NOT NULL":新增約束
*/
@Column(name = "id",isId = true,autoGen = true,property = "NOT NULL")
private int id;
@Column(name = "c_name")
private String cName;
public ChildInfo(String cName) {
this.cName = cName;
}
//預設的構造方法必須寫出,如果沒有,這張表是建立不成功的
public ChildInfo() {
}
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public String getcName() {
return cName;
}
public void setcName(String cName) {
this.cName = cName;
}
@Override
public String toString() {
return "ChildInfo{"+"id="+id+",cName='"+cName+'\''+'}';
}
}
之後就能進行建立和刪除資料庫的操作了:
//建立資料庫
@Event(R.id.create_db)
private void createDB(View v) throws DbException {
//用集合向child_info表中插入多條資料
ArrayList<ChildInfo> childInfos = new ArrayList<>();
childInfos.add(new ChildInfo("zhangsan"));
childInfos.add(new ChildInfo("lisi"));
childInfos.add(new ChildInfo("wangwu"));
childInfos.add(new ChildInfo("zhaoliu"));
childInfos.add(new ChildInfo("qianqi"));
childInfos.add(new ChildInfo("sunba"));
//db.save()方法不僅可以插入單個物件,還能插入集合
db.save(childInfos);
}
//刪除資料庫
@Event(R.id.del_db)
private void delDB(View v) throws DbException {
db.dropDb();
}
2)刪除表
//刪除表
@Event(R.id.del_table)
private void delTable(View v) throws DbException {
db.dropTable(ChildInfo.class);
}
3)查詢表中的資料
//查詢表中的資料
@Event(R.id.select_table)
private void selelctDB(View v) throws DbException {
//查詢資料庫表中第一條資料
ChildInfo first = db.findFirst(ChildInfo.class);
Log.i("JAVA",first.toString());
//新增查詢條件進行查詢
//第一種寫法:
WhereBuilder b = WhereBuilder.b();
b.and("id",">",2); //構造修改的條件
b.and("id","<",4);
List<ChildInfo> all = db.selector(ChildInfo.class).where(b).findAll();//findAll():查詢所有結果
for(ChildInfo childInfo :all){
Log.i("JAVA",childInfo.toString());
}
//第二種寫法:
List<ChildInfo> all = db.selector(ChildInfo.class).where("id",">",2).and("id","<",4).findAll();
for(ChildInfo childInfo :all){
Log.i("JAVA",childInfo.toString());
}
}
4)修改表中的資料
//修改表中的一條資料
@Event(R.id.update_table)
private void updateTable(View v) throws DbException {
//第一種寫法:
ChildInfo first = db.findFirst(ChildInfo.class);
first.setcName("zhansan2");
db.update(first,"c_name"); //c_name:表中的欄位名
//第二種寫法:
WhereBuilder b = WhereBuilder.b();
b.and("id","=",first.getId()); //構造修改的條件
KeyValue name = new KeyValue("c_name","zhansan3");
db.update(ChildInfo.class,b,name);
//第三種寫法:
first.setcName("zhansan4");
db.saveOrUpdate(first);
}
5)刪除表中的資料
@Event(R.id.del_table_data)
private void delTableData(View v) throws DbException {
//第一種寫法:
db.delete(ChildInfo.class); //child_info表中資料將被全部刪除
//第二種寫法,新增刪除條件:
WhereBuilder b = WhereBuilder.b();
b.and("id",">",2); //構造修改的條件
b.and("id","<",4);
db.delete(ChildInfo.class, b);
}
xutils3 github地址:https://github.com/wyouflf/xUtils3