Android學習（57） -- xUtils簡介使用

項目git地址https://github.com/wyouflf/xUtils
參考：http://www.oschina.net/p/xutils

xUtils3簡介

xUtils 包含了很多實用的android工具.
xUtils 支持超大文件(超過2G)上傳，更全面的http請求協議支持(11種謂詞)，擁有更加靈活的ORM，更多的事件註解支持且不受混淆影響…
xUtils 最低兼容Android 4.0 (api level 14). (Android 2.3?)
xUtils3變化較多所以建立了新的項目不在舊版(github.com/wyouflf/xUtils)上繼續維護, 相對於舊版本:
1. HTTP實現替換HttpClient爲UrlConnection, 自動解析回調泛型, 更安全的斷點續傳策略.
2. 支持標準的Cookie策略, 區分domain, path…
3. 事件註解去除不常用的功能, 提高性能.
4. 數據庫api簡化提高性能, 達到和greenDao一致的性能.
5. 圖片綁定支持gif(受系統兼容性影響, 部分gif文件只能靜態顯示), webp; 支持圓角, 圓形, 方形等裁剪, 支持自動旋轉…

使用Gradle構建時添加一下依賴即可:

compile 'org.xutils:xutils:3.3.4'

如果使用eclipse可以點擊這裏下載aar文件, 然後用zip解壓, 取出jar包和so文件.

混淆配置參考示例項目sample的配置

常見問題:

更好的管理圖片緩存: https://github.com/wyouflf/xUtils3/issues/149
Cookie的使用: https://github.com/wyouflf/xUtils3/issues/125
關於query參數? http請求可以通過 header, url, body(請求體)傳參; query參數是url中問號(?)後面的參數.
關於body參數? body參數只有PUT, POST, PATCH, DELETE(老版本RFC2616文檔沒有明確指出它是否支持, 所以暫時支持)請求支持.

使用前配置

需要的權限

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

初始化

// 在application的onCreate中初始化
@Override
public void onCreate() {
    super.onCreate();
    x.Ext.init(this);
    x.Ext.setDebug(true); // 是否輸出debug日誌
    ...
}

使用@Event事件註解(@ContentView, @ViewInject等更多示例參考sample項目)

/**
 * 1. 方法必須私有限定,
 * 2. 方法參數形式必須和type對應的Listener接口一致.
 * 3. 註解參數value支持數組: value={id1, id2, id3}
 * 4. 其它參數說明見{@link org.xutils.event.annotation.Event}類的說明.
 **/
@Event(value = R.id.btn_test_baidu1,
        type = View.OnClickListener.class/*可選參數, 默認是View.OnClickListener.class*/)
private void onTestBaidu1Click(View view) {
...
}

訪問網絡(更多示例參考sample項目)

/**
 * 自定義實體參數類請參考:
 * 請求註解 {@link org.xutils.http.annotation.HttpRequest}
 * 請求註解處理模板接口 {@link org.xutils.http.app.ParamsBuilder}
 *
 * 需要自定義類型作爲callback的泛型時, 參考:
 * 響應註解 {@link org.xutils.http.annotation.HttpResponse}
 * 響應註解處理模板接口 {@link org.xutils.http.app.ResponseParser}
 *
 * 示例: 查看 org.xutils.sample.http 包裏的代碼
 */
BaiduParams params = new BaiduParams();
params.wd = "xUtils";
// 有上傳文件時使用multipart表單, 否則上傳原始文件流.
// params.setMultipart(true);
// 上傳文件方式 1
// params.uploadFile = new File("/sdcard/test.txt");
// 上傳文件方式 2
// params.addBodyParameter("uploadFile", new File("/sdcard/test.txt"));
Callback.Cancelable cancelable
       = x.http().get(params,
       /**
        * 1. callback的泛型:
        * callback參數默認支持的泛型類型參見{@link org.xutils.http.loader.LoaderFactory},
        * 例如: 指定泛型爲File則可實現文件下載, 使用params.setSaveFilePath(path)指定文件保存的全路徑.
        * 默認支持斷點續傳(採用了文件鎖和尾端校驗續傳文件的一致性).
        * 其他常用類型可以自己在LoaderFactory中註冊,
        * 也可以使用{@link org.xutils.http.annotation.HttpResponse}
        * 將註解HttpResponse加到自定義返回值類型上, 實現自定義ResponseParser接口來統一轉換.
        * 如果返回值是json形式, 那麼利用第三方的json工具將十分容易定義自己的ResponseParser.
        * 如示例代碼{@link org.xutils.sample.http.BaiduResponse}, 可直接使用BaiduResponse作爲
        * callback的泛型.
        *
        * 2. callback的組合:
        * 可以用基類或接口組合個種類的Callback, 見{@link org.xutils.common.Callback}.
        * 例如:
        * a. 組合使用CacheCallback將使請求檢測緩存或將結果存入緩存(僅GET請求生效).
        * b. 組合使用PrepareCallback的prepare方法將爲callback提供一次後臺執行耗時任務的機會,
        * 然後將結果給onCache或onSuccess.
        * c. 組合使用ProgressCallback將提供進度回調.
        * ...(可參考{@link org.xutils.image.ImageLoader}
        * 或 示例代碼中的 {@link org.xutils.sample.download.DownloadCallback})
        *
        * 3. 請求過程攔截或記錄日誌: 參考 {@link org.xutils.http.app.RequestTracker}
        *
        * 4. 請求Header獲取: 參考 {@link org.xutils.http.app.RequestInterceptListener}
        *
        * 5. 其他(線程池, 超時, 重定向, 重試, 代理等): 參考 {@link org.xutils.http.RequestParams}
        *
        **/
       new Callback.CommonCallback<String>() {
           @Override
           public void onSuccess(String result) {
               Toast.makeText(x.app(), result, Toast.LENGTH_LONG).show();
           }


           @Override
           public void onError(Throwable ex, boolean isOnCallback) {
               //Toast.makeText(x.app(), ex.getMessage(), Toast.LENGTH_LONG).show();
               if (ex instanceof HttpException) { // 網絡錯誤
                   HttpException httpEx = (HttpException) ex;
                   int responseCode = httpEx.getCode();
                   String responseMsg = httpEx.getMessage();
                   String errorResult = httpEx.getResult();
                   // ...
               } else { // 其他錯誤
                   // ...
               }
               Toast.makeText(x.app(), ex.getMessage(), Toast.LENGTH_LONG).show();
           }


           @Override
           public void onCancelled(CancelledException cex) {
               Toast.makeText(x.app(), "cancelled", Toast.LENGTH_LONG).show();
           }


           @Override
           public void onFinished() {


           }
       });


// cancelable.cancel(); // 取消請求

如果你只需要一個簡單的版本:

@Event(value = R.id.btn_test_baidu2)
private void onTestBaidu2Click(View view) {
    RequestParams params = new RequestParams("https://www.baidu.com/s");
    params.setSslSocketFactory(...); // 設置ssl
    params.addQueryStringParameter("wd", "xUtils");
    x.http().get(params, new Callback.CommonCallback<String>() {
        @Override
        public void onSuccess(String result) {
            Toast.makeText(x.app(), result, Toast.LENGTH_LONG).show();
        }


        @Override
        public void onError(Throwable ex, boolean isOnCallback) {
            Toast.makeText(x.app(), ex.getMessage(), Toast.LENGTH_LONG).show();
        }


        @Override
        public void onCancelled(CancelledException cex) {
            Toast.makeText(x.app(), "cancelled", Toast.LENGTH_LONG).show();
        }


        @Override
        public void onFinished() {


        }
    });
}
````




<div class="se-preview-section-delimiter"></div>

#### 帶有緩存的請求示例:




<div class="se-preview-section-delimiter"></div>

```java
BaiduParams params = new BaiduParams();
params.wd = "xUtils";
// 默認緩存存活時間, 單位:毫秒.(如果服務沒有返回有效的max-age或Expires)
params.setCacheMaxAge(1000 * 60);
Callback.Cancelable cancelable
// 使用CacheCallback, xUtils將爲該請求緩存數據.
= x.http().get(params, new Callback.CacheCallback<String>() {


private boolean hasError = false;
private String result = null;


@Override
public boolean onCache(String result) {
// 得到緩存數據, 緩存過期後不會進入這個方法.
// 如果服務端沒有返回過期時間, 參考params.setCacheMaxAge(maxAge)方法.
        //
        // * 客戶端會根據服務端返回的 header 中 max-age 或 expires 來確定本地緩存是否給 onCache 方法.
        //   如果服務端沒有返回 max-age 或 expires, 那麼緩存將一直保存, 除非這裏自己定義了返回false的
        //   邏輯, 那麼xUtils將請求新數據, 來覆蓋它.
        //
        // * 如果信任該緩存返回 true, 將不再請求網絡;
        //   返回 false 繼續請求網絡, 但會在請求頭中加上ETag, Last-Modified等信息,
        //   如果服務端返回304, 則表示數據沒有更新, 不繼續加載數據.
        //
        this.result = result;
        return false; // true: 信任緩存數據, 不在發起網絡請求; false不信任緩存數據.
}


@Override
public void onSuccess(String result) {
// 注意: 如果服務返回304或 onCache 選擇了信任緩存, 這裏將不會被調用,
        // 但是 onFinished 總會被調用.
this.result = result;
}


@Override
public void onError(Throwable ex, boolean isOnCallback) {
hasError = true;
Toast.makeText(x.app(), ex.getMessage(), Toast.LENGTH_LONG).show();
if (ex instanceof HttpException) { // 網絡錯誤
HttpException httpEx = (HttpException) ex;
int responseCode = httpEx.getCode();
String responseMsg = httpEx.getMessage();
String errorResult = httpEx.getResult();
// ...
} else { // 其他錯誤
// ...
}
}


@Override
public void onCancelled(CancelledException cex) {
Toast.makeText(x.app(), "cancelled", Toast.LENGTH_LONG).show();
}


@Override
public void onFinished() {
if (!hasError && result != null) {
// 成功獲取數據
Toast.makeText(x.app(), result, Toast.LENGTH_LONG).show();
}
}
});

使用數據庫(更多示例參考sample項目)

Parent test = db.selector(Parent.class).where("id", "in", new int[]{1, 3, 6}).findFirst();
long count = db.selector(Parent.class).where("name", "LIKE", "w%").and("age", ">", 32).count();
List<Parent> testList = db.selector(Parent.class).where("id", "between", new String[]{"1", "5"}).findAll();

綁定圖片(更多示例參考sample項目)

x.image().bind(imageView, url, imageOptions);


// assets file
x.image().bind(imageView, "assets://test.gif", imageOptions);


// local file
x.image().bind(imageView, new File("/sdcard/test.gif").toURI().toString(), imageOptions);
x.image().bind(imageView, "/sdcard/test.gif", imageOptions);
x.image().bind(imageView, "file:///sdcard/test.gif", imageOptions);
x.image().bind(imageView, "file:/sdcard/test.gif", imageOptions);


x.image().bind(imageView, url, imageOptions, new Callback.CommonCallback<Drawable>() {...});
x.image().loadDrawable(url, imageOptions, new Callback.CommonCallback<Drawable>() {...});
x.image().loadFile(url, imageOptions, new Callback.CommonCallback<File>() {...});

關於libwebpbackport

部分4.x的機型對webp格式的支持仍然有問題, 需要藉助webp.
webp來自:https://github.com/webmproject/libwebp
webpbackport來自:https://github.com/alexey-pelykh/webp-android-backport
其中爲webpbackport添加了nativeDecodeFile的實現, 並修復在Android 5.0以上系統存在bug:

// android_backport_webp.cpp
// 修改:
jclassRef = jniEnv->FindClass(...);
// 爲:
jclass temp = jniEnv->FindClass(...);
jclassRef = (jclass)jniEnv->NewGlobalRef(temp);
jniEnv->DeleteLocalRef(temp);
// 其他jni代碼修改見: http://my.oschina.net/u/1171837/blog/533153

關於作者

Email： [email protected], [email protected]
有任何建議或者使用中遇到問題都可以給我發郵件, 你也可以加入QQ羣：330445659(已滿), 275967695, 257323060, 384426013, 176778777, 169852490, 技術交流，idea分享 _

idiandi

發佈了101 篇原創文章 · 獲贊 7 · 訪問量 7萬+

私信關注

Android學習（57） -- xUtils簡介使用

xUtils3簡介

使用Gradle構建時添加一下依賴即可:

如果使用eclipse可以點擊這裏下載aar文件, 然後用zip解壓, 取出jar包和so文件.

混淆配置參考示例項目sample的配置

常見問題:

使用前配置

需要的權限

初始化

使用@Event事件註解(@ContentView, @ViewInject等更多示例參考sample項目)

訪問網絡(更多示例參考sample項目)

如果你只需要一個簡單的版本:

使用數據庫(更多示例參考sample項目)

綁定圖片(更多示例參考sample項目)

關於libwebpbackport

關於作者

Android學習（52） -- 使用HttpClient框架做POST提交

Centos6.8 查看、修改MySQL數據庫引擎

Java NIO (一)--簡介

讀《MySQL性能調優與架構設計》筆記之影響 MySQL Server 性能的相關因素

Android學習（54） -- 多線程下載原理和代碼

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結

Android學習（57） -- xUtils簡介使用

xUtils3簡介

使用Gradle構建時添加一下依賴即可:

如果使用eclipse可以 點擊這裏下載aar文件, 然後用zip解壓, 取出jar包和so文件.

混淆配置參考示例項目sample的配置

常見問題:

使用前配置

需要的權限

初始化

使用@Event事件註解(@ContentView, @ViewInject等更多示例參考sample項目)

訪問網絡(更多示例參考sample項目)

如果你只需要一個簡單的版本:

使用數據庫(更多示例參考sample項目)

綁定圖片(更多示例參考sample項目)

關於libwebpbackport

關於作者

如果使用eclipse可以點擊這裏下載aar文件, 然後用zip解壓, 取出jar包和so文件.