xUtils簡介
- 作者wyouflf的oschina個人空間
- GitHub托管連結
- xUtils 包含了很多實用的android工具。
- xUtils 支援大檔案上傳,更全面的http請求協定支援(10種謂詞),擁有更加靈活的ORM,更多的事件注解支援且不受混淆影響…
- xUitls 最低相容android 2.2 (api level 8)
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記憶體;
- 可配置線程加載線程數量,緩存大小,緩存路徑,加載顯示動畫等…
系統權限:
<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”);
DbUtils使用方法:
DbUtils db = DbUtils.create(this);
User user = new User(); //這裡需要注意的是User對象必須有id屬性,或者有通過@ID注解的屬性
user.setEmail("[email protected]");
user.setName("wyouflf");
db.save(user); // 使用saveBindingId儲存實體時會為實體的id指派
...
// 查找
Parent entity = db.findById(Parent.class, parent.getId());
List<Parent> list = db.findAll(Parent.class);//通過類型查找
Parent Parent = db.findFirst(Selector.from(Parent.class).where("name","=","test"));
// IS NULL
Parent Parent = db.findFirst(Selector.from(Parent.class).where("name","=", null));
// IS NOT NULL
Parent Parent = db.findFirst(Selector.from(Parent.class).where("name","!=", null));
// WHERE id<54 AND (age>20 OR age<30) ORDER BY id LIMIT pageSize OFFSET pageOffset
List<Parent> list = db.findAll(Selector.from(Parent.class)
.where("id" ,"<", )
.and(WhereBuilder.b("age", ">", ).or("age", " < ", ))
.orderBy("id")
.limit(pageSize)
.offset(pageSize * pageIndex));
// op為"in"時,最後一個參數必須是數組或Iterable的實作類(例如List等)
Parent test = db.findFirst(Selector.from(Parent.class).where("id", "in", new int[]{, , }));
// op為"between"時,最後一個參數必須是數組或Iterable的實作類(例如List等)
Parent test = db.findFirst(Selector.from(Parent.class).where("id", "between", new String[]{"1", "5"}));
DbModel dbModel = db.findDbModelAll(Selector.from(Parent.class).select("name"));//select("name")隻取出name列
List<DbModel> dbModels = db.findDbModelAll(Selector.from(Parent.class).groupBy("name").select("name", "count(name)"));
...
List<DbModel> dbModels = db.findDbModelAll(sql); // 自定義sql查詢
db.execNonQuery(sql) // 執行自定義sql
...
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) {
}
});
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);
}
});
Http緩存:
HttpUtils設定了預設緩存,時間為60秒,即在60秒内,重複請求相同接口,不會實時擷取伺服器接口資料,而是使用本地緩存,即使網絡沒有連接配接,也能使用緩存資料。比如在一個ListView不聽切換分類排序功能時,使用http緩存功能,能夠避免無限通路伺服器,避免流量消耗。
//目前http請求的緩存到期時間,機關為毫秒
httpUtils.configCurrentHttpCacheExpiry(currRequestExpiry)
//預設http請求的緩存到期時間,機關為毫秒,預設值為60*1000,即1分鐘
httpUtils.configDefaultHttpCacheExpiry(defaultExpiry)
//http緩存大小
httpUtils.configHttpCacheSize(httpCacheSize)
檔案下載下傳:
- 支援斷點續傳,随時停止下載下傳任務,開始任務
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();
...
Cookie和Session設定
示例代碼如下:
public static void sendRequest(final Context mContext, String url, HashMap<String, Object> params,
final Class<?> responseCls, final boolean showErrorToast, final HttpResponseCallback callback) {
final Dialog mLoadingDlg = CommonAlert.getLoadingDlg(mContext);
LogUtils.iNet("Url Address: " + url);
RequestParams requestParams = new RequestParams();
Iterator iter = params.entrySet().iterator();
while (iter.hasNext()) {
Entry entry = (Entry) iter.next();
String key = (String) entry.getKey();
Object value = entry.getValue();
LogUtils.iNet(key + " : " + value);
requestParams.addBodyParameter(key, value.toString());
}
final HttpUtils httpUtils = new HttpUtils();
httpUtils.configSoTimeout();
final MyApplication mApplication = (MyApplication) ((BaseActivity)mContext).getApplication();
//配置Cookie
httpUtils.configCookieStore(mApplication.getCookieStore());
httpUtils.send(HttpMethod.POST, url, requestParams, new RequestCallBack<String>() {
@Override
public void onStart() {
super.onStart();
mLoadingDlg.show();
}
@Override
public void onFailure(HttpException arg0, String arg1) {
mLoadingDlg.dismiss();
CommonToast.showToast(mContext, arg1);
LogUtils.iNetResponse(arg0.getExceptionCode() + " : " + arg1);
}
@Override
public void onSuccess(ResponseInfo<String> arg0) {
mLoadingDlg.dismiss();
LogUtils.iNetResponse(arg0.result);
//儲存Cookie:為了防止調用http請求的GET方法傳回結果中沒有cookie session資訊,在此添加空值判斷。
DefaultHttpClient dhClient = (DefaultHttpClient) httpUtils.getHttpClient();
if (dhClient.getCookieStore().getCookies().size()!=) {
mApplication.setCookieStore(dhClient.getCookieStore());
}
BaseResponse response = JSON.parseObject(arg0.result, BaseResponse.class);
if (response.getStatus()== || response.getStatus()==) {
callback.onSuccess(JSON.parseObject(arg0.result, responseCls));
}else if(showErrorToast){
CommonToast.showToast(mContext, response.getStatus()+":網絡請求出錯,請重試!");
}
}
});
}
主要利用CoolieStore類,可以将其儲存為一個全局變量, 放置在工程的自定義的Application類中,如果需要持久化儲存,可以選擇SharedPreferences檔案、SQLite資料庫中。
附:Android 使用SharedPreferences持久化儲存Cookie
package com.feng.daynightshop.utils;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Locale;
import java.util.concurrent.ConcurrentHashMap;
import org.apache.http.client.CookieStore;
import org.apache.http.cookie.Cookie;
import android.content.Context;
import android.content.SharedPreferences;
import android.text.TextUtils;
public class PersistentCookieStore implements CookieStore {
private static final String COOKIE_NAME_STORE = "names";
private static final String COOKIE_NAME_PREFIX = "cookie_";
private boolean omitNonPersistentCookies = false;
private final ConcurrentHashMap<String, Cookie> cookies;
private final SharedPreferences cookiePrefs;
/**
* Construct a persistent cookie store.
*
* @param context
* Context to attach cookie store to
*/
public PersistentCookieStore(Context context) {
cookiePrefs = context.getSharedPreferences(SharedPreferenceUtil.SP_FILE_NAME, );
cookies = new ConcurrentHashMap<String, Cookie>();
// Load any previously stored cookies into the store
String storedCookieNames = cookiePrefs.getString(COOKIE_NAME_STORE,
null);
if (storedCookieNames != null) {
String[] cookieNames = TextUtils.split(storedCookieNames, ",");
for (String name : cookieNames) {
String encodedCookie = cookiePrefs.getString(COOKIE_NAME_PREFIX
+ name, null);
if (encodedCookie != null) {
Cookie decodedCookie = decodeCookie(encodedCookie);
if (decodedCookie != null) {
cookies.put(name, decodedCookie);
}
}
}
// Clear out expired cookies
clearExpired(new Date());
}
}
@Override
public void addCookie(Cookie cookie) {
if (omitNonPersistentCookies && !cookie.isPersistent())
return;
String name = cookie.getName() + cookie.getDomain();
// Save cookie into local store, or remove if expired
if (!cookie.isExpired(new Date())) {
cookies.put(name, cookie);
} else {
cookies.remove(name);
}
// Save cookie into persistent store
SharedPreferences.Editor prefsWriter = cookiePrefs.edit();
prefsWriter.putString(COOKIE_NAME_STORE,
TextUtils.join(",", cookies.keySet()));
prefsWriter.putString(COOKIE_NAME_PREFIX + name,
encodeCookie(new SerializableCookie(cookie)));
prefsWriter.commit();
}
@Override
public void clear() {
// Clear cookies from persistent store
SharedPreferences.Editor prefsWriter = cookiePrefs.edit();
for (String name : cookies.keySet()) {
prefsWriter.remove(COOKIE_NAME_PREFIX + name);
}
prefsWriter.remove(COOKIE_NAME_STORE);
prefsWriter.commit();
// Clear cookies from local store
cookies.clear();
}
@Override
public boolean clearExpired(Date date) {
boolean clearedAny = false;
SharedPreferences.Editor prefsWriter = cookiePrefs.edit();
for (ConcurrentHashMap.Entry<String, Cookie> entry : cookies.entrySet()) {
String name = entry.getKey();
Cookie cookie = entry.getValue();
if (cookie.isExpired(date)) {
// Clear cookies from local store
cookies.remove(name);
// Clear cookies from persistent store
prefsWriter.remove(COOKIE_NAME_PREFIX + name);
// We've cleared at least one
clearedAny = true;
}
}
// Update names in persistent store
if (clearedAny) {
prefsWriter.putString(COOKIE_NAME_STORE,
TextUtils.join(",", cookies.keySet()));
}
prefsWriter.commit();
return clearedAny;
}
@Override
public List<Cookie> getCookies() {
return new ArrayList<Cookie>(cookies.values());
}
/**
* Will make PersistentCookieStore instance ignore Cookies, which are
* non-persistent by signature (`Cookie.isPersistent`)
*
* @param omitNonPersistentCookies
* true if non-persistent cookies should be omited
*/
public void setOmitNonPersistentCookies(boolean omitNonPersistentCookies) {
this.omitNonPersistentCookies = omitNonPersistentCookies;
}
/**
* Non-standard helper method, to delete cookie
*
* @param cookie
* cookie to be removed
*/
public void deleteCookie(Cookie cookie) {
String name = cookie.getName();
cookies.remove(name);
SharedPreferences.Editor prefsWriter = cookiePrefs.edit();
prefsWriter.remove(COOKIE_NAME_PREFIX + name);
prefsWriter.commit();
}
/**
* Serializes Cookie object into String
*
* @param cookie
* cookie to be encoded, can be null
* @return cookie encoded as String
*/
protected String encodeCookie(SerializableCookie cookie) {
if (cookie == null)
return null;
ByteArrayOutputStream os = new ByteArrayOutputStream();
try {
ObjectOutputStream outputStream = new ObjectOutputStream(os);
outputStream.writeObject(cookie);
} catch (Exception e) {
return null;
}
return byteArrayToHexString(os.toByteArray());
}
/**
* Returns cookie decoded from cookie string
*
* @param cookieString
* string of cookie as returned from http request
* @return decoded cookie or null if exception occured
*/
protected Cookie decodeCookie(String cookieString) {
byte[] bytes = hexStringToByteArray(cookieString);
ByteArrayInputStream byteArrayInputStream = new ByteArrayInputStream(
bytes);
Cookie cookie = null;
try {
ObjectInputStream objectInputStream = new ObjectInputStream(
byteArrayInputStream);
cookie = ((SerializableCookie) objectInputStream.readObject())
.getCookie();
} catch (Exception exception) {
LogUtils.iCommon("decodeCookie failed : " + exception.getMessage());
}
return cookie;
}
/**
* Using some super basic byte array <-> hex conversions so we don't have to
* rely on any large Base64 libraries. Can be overridden if you like!
*
* @param bytes
* byte array to be converted
* @return string containing hex values
*/
protected String byteArrayToHexString(byte[] bytes) {
StringBuilder sb = new StringBuilder(bytes.length * );
for (byte element : bytes) {
int v = element & ;
if (v < ) {
sb.append('0');
}
sb.append(Integer.toHexString(v));
}
return sb.toString().toUpperCase(Locale.US);
}
/**
* Converts hex values from strings to byte arra
*
* @param hexString
* string of hex-encoded values
* @return decoded byte array
*/
protected byte[] hexStringToByteArray(String hexString) {
int len = hexString.length();
byte[] data = new byte[len / ];
for (int i = ; i < len; i += ) {
data[i / ] = (byte) ((Character.digit(hexString.charAt(i), ) << ) + Character
.digit(hexString.charAt(i + ), ));
}
return data;
}
}
Xutils中設定Cookie:
final PersistentCookieStore cookieStore = new PersistentCookieStore(mContext);
httpUtils.configCookieStore(cookieStore);
Xutils中儲存Cookie:
DefaultHttpClient dhClient = (DefaultHttpClient) httpUtils.getHttpClient();
if (dhClient.getCookieStore().getCookies().size()!=) {
for (Cookie cookie : dhClient.getCookieStore().getCookies()) {
cookieStore.addCookie(cookie);
}
}
BitmapUtils 使用方法
BitmapUtils bitmapUtils = new BitmapUtils(this);
// 加載網絡圖檔
bitmapUtils.display(testImageView, "http://bbs.lidroid.com/static/image/common/logo.png");
// 加載本地圖檔(路徑以/開頭, 絕對路徑)
bitmapUtils.display(testImageView, "/sdcard/test.jpg");
// 加載assets中的圖檔(路徑以assets開頭)
bitmapUtils.display(testImageView, "assets/img/wallpaper.jpg");
// 使用ListView等容器展示圖檔時可通過PauseOnScrollListener控制滑動和快速滑動過程中時候暫停加載圖檔
listView.setOnScrollListener(new PauseOnScrollListener(bitmapUtils, false, true));
listView.setOnScrollListener(new PauseOnScrollListener(bitmapUtils, false, true, customListener));
輸出日志 LogUtils
// 自動添加TAG,格式: className.methodName(L:lineNumber)
// 可設定全局的LogUtils.allowD = false,LogUtils.allowI = false...,控制是否輸出log。
// 自定義log輸出LogUtils.customLogger = new xxxLogger();
LogUtils.d("wyouflf");
關于作者
- Email: [email protected], [email protected]
- 有任何建議或者使用中遇到問題都可以給我發郵件, 你也可以加入QQ群:330445659(已滿), 275967695, 257323060,技術交流,idea分享 _
常見使用示例
BitmapUtils使用示例
public class xUtilsImageLoader {//架構裡面設定了緩存和異步操作,不用單獨設定線程池和緩存機制(也可以自定義緩存路徑)
private BitmapUtils bitmapUtils;
private Context mContext;
public xUtilsImageLoader(Context context) {
// TODO Auto-generated constructor stub
this.mContext = context;
bitmapUtils = new BitmapUtils(mContext);
bitmapUtils.configDefaultLoadingImage(R.drawable.logo_new);//預設背景圖檔
bitmapUtils.configDefaultLoadFailedImage(R.drawable.logo_new);//加載失敗圖檔
bitmapUtils.configDefaultBitmapConfig(Bitmap.Config.RGB_565);//設定圖檔壓縮類型
}
/**
*
* @author sunglasses
* @category 圖檔回調函數
*/
public class CustomBitmapLoadCallBack extends
DefaultBitmapLoadCallBack<ImageView> {
@Override
public void onLoading(ImageView container, String uri,
BitmapDisplayConfig config, long total, long current) {
}
@Override
public void onLoadCompleted(ImageView container, String uri,
Bitmap bitmap, BitmapDisplayConfig config, BitmapLoadFrom from) {
// super.onLoadCompleted(container, uri, bitmap, config, from);
fadeInDisplay(container, bitmap);
}
@Override
public void onLoadFailed(ImageView container, String uri,
Drawable drawable) {
// TODO Auto-generated method stub
}
}
private static final ColorDrawable TRANSPARENT_DRAWABLE = new ColorDrawable(
android.R.color.transparent);
/**
* @author sunglasses
* @category 圖檔加載效果
* @param imageView
* @param bitmap
*/
private void fadeInDisplay(ImageView imageView, Bitmap bitmap) {//目前流行的漸變效果
final TransitionDrawable transitionDrawable = new TransitionDrawable(
new Drawable[] { TRANSPARENT_DRAWABLE,
new BitmapDrawable(imageView.getResources(), bitmap) });
imageView.setImageDrawable(transitionDrawable);
transitionDrawable.startTransition();
}
public void display(ImageView container,String url){//外部接口函數
bitmapUtils.display(container, url,new CustomBitmapLoadCallBack());
}
}
其他(更多示例代碼見sample檔案夾中的代碼)