xUtils3簡介

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

使用Gradle構(gòu)建時(shí)添加一下依賴即可:

compile 'org.xutils:xutils:3.3.4'

如果使用eclipse可以 點(diǎn)擊這里下載aar文件, 然后用zip解壓, 取出jar包和so文件.

混淆配置參考示例項(xiàng)目sample的配置

常見問題:

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

使用前配置

需要的權(quán)限

<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項(xiàng)目)

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

訪問網(wǎng)絡(luò)(更多示例參考sample項(xiàng)目)

/**
 * 自定義實(shí)體參數(shù)類請參考:
 * 請求注解 {@link org.xutils.http.annotation.HttpRequest}
 * 請求注解處理模板接口 {@link org.xutils.http.app.ParamsBuilder}
 *
 * 需要自定義類型作為callback的泛型時(shí), 參考:
 * 響應(yīng)注解 {@link org.xutils.http.annotation.HttpResponse}
 * 響應(yīng)注解處理模板接口 {@link org.xutils.http.app.ResponseParser}
 *
 * 示例: 查看 org.xutils.sample.http 包里的代碼
 */
BaiduParams params = new BaiduParams();
params.wd = "xUtils";
// 有上傳文件時(shí)使用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參數(shù)默認(rèn)支持的泛型類型參見{@link org.xutils.http.loader.LoaderFactory},
        * 例如: 指定泛型為File則可實(shí)現(xiàn)文件下載, 使用params.setSaveFilePath(path)指定文件保存的全路徑.
        * 默認(rèn)支持?jǐn)帱c(diǎn)續(xù)傳(采用了文件鎖和尾端校驗(yàn)續(xù)傳文件的一致性).
        * 其他常用類型可以自己在LoaderFactory中注冊,
        * 也可以使用{@link org.xutils.http.annotation.HttpResponse}
        * 將注解HttpResponse加到自定義返回值類型上, 實(shí)現(xiàn)自定義ResponseParser接口來統(tǒng)一轉(zhuǎn)換.
        * 如果返回值是json形式, 那么利用第三方的json工具將十分容易定義自己的ResponseParser.
        * 如示例代碼{@link org.xutils.sample.http.BaiduResponse}, 可直接使用BaiduResponse作為
        * callback的泛型.
        *
        * 2. callback的組合:
        * 可以用基類或接口組合個(gè)種類的Callback, 見{@link org.xutils.common.Callback}.
        * 例如:
        * a. 組合使用CacheCallback將使請求檢測緩存或?qū)⒔Y(jié)果存入緩存(僅GET請求生效).
        * b. 組合使用PrepareCallback的prepare方法將為callback提供一次后臺執(zhí)行耗時(shí)任務(wù)的機(jī)會,
        * 然后將結(jié)果給onCache或onSuccess.
        * c. 組合使用ProgressCallback將提供進(jìn)度回調(diào).
        * ...(可參考{@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. 其他(線程池, 超時(shí), 重定向, 重試, 代理等): 參考 {@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) { // 網(wǎng)絡(luò)錯(cuò)誤
                   HttpException httpEx = (HttpException) ex;
                   int responseCode = httpEx.getCode();
                   String responseMsg = httpEx.getMessage();
                   String errorResult = httpEx.getResult();
                   // ...
               } else { // 其他錯(cuò)誤
                   // ...
               }
               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(); // 取消請求

如果你只需要一個(gè)簡單的版本:

@Event(value = R.id.btn_test_baidu2)
private void onTestBaidu2Click(View view) {
    RequestParams params = new RequestParams("https://www.baidu.com/s");
    params.setSslSocketFactory(...); // 設(shè)置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() {

        }
    });
}

帶有緩存的請求示例:

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

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

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

@Override
public void onSuccess(String result) {
// 注意: 如果服務(wù)返回304或 onCache 選擇了信任緩存, 這里將不會被調(diào)用,
        // 但是 onFinished 總會被調(diào)用.
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) { // 網(wǎng)絡(luò)錯(cuò)誤
HttpException httpEx = (HttpException) ex;
int responseCode = httpEx.getCode();
String responseMsg = httpEx.getMessage();
String errorResult = httpEx.getResult();
// ...
} else { // 其他錯(cuò)誤
// ...
}
}

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

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

使用數(shù)據(jù)庫(更多示例參考sample項(xiàng)目)

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項(xiàng)目)

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>() {...});

關(guān)于libwebpbackport

• 部分4.x的機(jī)型對webp格式的支持仍然有問題, 需要借助webp.
• webp來自:https://github.com/webmproject/libwebp
• webpbackport來自:https://github.com/alexey-pelykh/webp-android-backport
• 其中為webpbackport添加了nativeDecodeFile的實(shí)現(xiàn), 并修復(fù)在Android 5.0以上系統(tǒng)存在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

我的博客：www.ocnyang.com
原文地址