【xUtils】Android快速开发框架之xUtils
来源：互联网 发布：嵌入式要学java吗 编辑：程序博客网 时间：2024/05/30 02:52
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("wyouflf@qq.com");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 NULLParent Parent = db.findFirst(Selector.from(Parent.class).where("name","=", null));// IS NOT NULLParent 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 pageOffsetList<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中注入：@Overridepublic void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.main); ViewUtils.inject(this); //注入view和事件 ... textView.setText("some text..."); ...}//在Fragment中注入：@Overridepublic 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(60000); 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()!=0) { mApplication.setCookieStore(dhClient.getCookieStore()); } BaseResponse response = JSON.parseObject(arg0.result, BaseResponse.class); if (response.getStatus()==200 || response.getStatus()==201) { 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, 0); 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 * 2); for (byte element : bytes) { int v = element & 0xff; if (v < 16) { 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 / 2]; for (int i = 0; i < len; i += 2) { data[i / 2] = (byte) ((Character.digit(hexString.charAt(i), 16) << 4) + Character .digit(hexString.charAt(i + 1), 16)); } 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()!=0) { 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： wyouflf@qq.com, wyouflf@gmail.com
- 有任何建议或者使用中遇到问题都可以给我发邮件, 你也可以加入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(500); } public void display(ImageView container,String url){//外部接口函数 bitmapUtils.display(container, url,new CustomBitmapLoadCallBack()); }}其他（更多示例代码见sample文件夹中的代码）
0 0
- 【xUtils】Android快速开发框架之xUtils
- Android 快速开发框架XUtils
- android快速开发框架xUtils
- android快速开发xUtils框架
- Android 快速开发框架XUtils
- Android 快速开发框架XUtils
- android快速开发框架xUtils
- Android 快速开发框架XUtils
- Android 快速开发框架xUtils
- android快速开发框架xUtils
- Android 快速开发框架xUtils
- Android 快速开发框架XUtils
- android快速开发框架xUtils
- android快速开发框架xUtils
- Android快速开发框架XUtils
- 快速开发框架XUtils
- Android快速开发框架之xUtils---注解模块
- Android快速开发框架之xUtils---网络模块
- Oracle 动态SQL实现SQL查询子集行转列
- Java在HBase数据库创建表
- 图论07—经过指定两点的最短路
- hdu4340
- Matlab中数组元素引用——三种方法
- 【xUtils】Android快速开发框架之xUtils
- Java中char数组与字符串String类型的转换
- eclipse乱码解决方法
- app功能描述
- leetcode:Combination Sum
- java适配器模式
- 通过预加载器提升网页加载速度
- ognl.OgnlException: target is null for setProperty(null,"XXXX"...)
- 使用MyBatis Generator自动创建代码
