Android 最火開發框架 xUtils

xUtils簡介

• xUtils3 api變化較多, 已轉至 https://github.com/wyouflf/xUtils3
• xUtils 2.x對Android 6.0兼容不是很好, 請盡快升級至xUtils3.
• 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內存；
  • 可配置線程加載線程數量，緩存大小，緩存路徑，加載顯示動畫等...

---

使用xUtils快速開發框架需要有以下權限：

<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("[e-mail]"); 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" ,"<", 54) .and(WhereBuilder.b("age", ">", 20).or("age", " < ", 30)) .orderBy("id") .limit(pageSize) .offset(pageSize * pageIndex)); // op為"in"時，最后一個參數必須是數組或Iterable的實現類(例如List等) Parent test = db.findFirst(Selector.from(Parent.class).where("id", "in", new int[]{1, 2, 3})); // 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) { } });

---

使用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下載文件：

• 支持斷點續傳，隨時停止下載任務，開始任務

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

---

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));

---

其他（更多示例代碼見sample文件夾中的代碼）

輸出日志 LogUtils

// 自動添加TAG，格式： className.methodName(L:lineNumber)
// 可設置全局的LogUtils.allowD = false，LogUtils.allowI = false...，控制是否輸出log。 // 自定義log輸出LogUtils.customLogger = new xxxLogger(); LogUtils.d("wyouflf");

---

關於作者

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