xUtils简介

  • xUtils 包含了很多实用的android工具。
  • xUtils 源于Afinal框架,对Afinal进行了大量重构,使得xUtils支持大文件上传,更全面的http请求协议支持,拥有更加灵活的ORM,更多的事件注解支持且不受混淆影响...
  • xUitls最低兼容android 2.2 (api level 8)

目前xUtils主要有四大模块:

  • DbUtils模块:
  • android中的orm框架,一行代码就可以进行增删改查;
  • 支持事务,默认关闭;
  • 可通过注解自定义表名,列名,外键,唯一性约束,NOT NULL约束,CHECK约束等(需要混淆的时候请注解表名和列名);
  • 支持绑定外键,保存实体时外键关联实体自动保存或更新;
  • 自动加载外键关联实体,支持延时加载;
  • 支持链式表达查询,更直观的查询语义,参考下面的介绍或sample中的例子。
  • ViewUtils模块:
  • android中的ioc框架,完全注解方式就可以进行UI绑定和事件绑定;
  • 新的事件绑定方式,使用混淆工具混淆后仍可正常工作;
  • 目前支持常用的11种事件绑定,参见ViewCommonEventListener类和包com.lidroid.xutils.view.annotation.event。
  • HttpUtils模块:
  • 支持同步,异步方式的请求;
  • 支持大文件上传,上传大文件不会oom;
  • 支持GET,POST,PUT,MOVE,COPY,DELETE,HEAD请求;
  • 下载支持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" />



混淆时注意事项:

  • 不要混淆xUtils中的注解类型,添加混淆配置:-keep class * extends java.lang.annotation.Annotation { *; }
  • 对使用DbUtils模块持久化的实体类不要混淆,或者注解所有表和列名称@Table(name="xxx"),@Id(column="xxx"),@Column(column="xxx"),@Foreign(column="xxx",foreign="xxx");

初始化



// 在application的onCreate中初始化 
	@Override 
	public void onCreate() {
		super.onCreate();
		x.Ext.init(this); 
		...
	}


使用@Event事件注解(@ContentView, @ViewInject等更多示例参考sample项目)

// 等同于 @Event(value = { R.id.self_product, R.id.self_stockright })
	@Event(value = { R.id.self_product, R.id.self_stockright }, type = View.OnClickListener.class)
	private void getEvent(View v) {
		Intent tent = null;
		switch (v.getId()) {
		case R.id.self_product:
			tent = new Intent(getActivity(), MyProductListActivity.class);
			getActivity().startActivity(tent);
			break;
		case R.id.self_stockright:
			tent = new Intent(getActivity(), MyStockRightListActivity.class);
			getActivity().startActivity(tent);
			break;
		default:
			break;
		}
	}
@Event这个注解默认情况下type属性为View.OnClickListener.class.如果你想实现其余点击事件效果,只需要把type值进行修改即可。
另外需要注意的一点是按钮的点击事件必须用private进行修饰
Fragment注解:
 
 

 
 
 
 

 
 
 
 
@ContentView(R.layout.fragment_first)    
 
public class FirstFragment extends Fragment{  
 

  
  

 
 
 
 
  
  

 
 
 
 
 @Override  
 
    public View onCreateView(LayoutInflater inflater,  
 
            @Nullable ViewGroup container, @Nullable Bundle savedInstanceState) {  
 
        return  x.view().inject(this, inflater, container);  
 
    }

ViewHolder的注解使用方法:


1. @Override  
2. public View getView(int position, View convertView, ViewGroup parent) {  
3. null;  
4. if(convertView==null){  
5. null);  
6. new ViewHolder();  
7.   x.view().inject(holder,convertView);
8.             convertView.setTag(holder);  
9.         }  
10. else{  
11.             holder=(ViewHolder) convertView.getTag();  
12.         }  
13.         Person bean=list.get(position);  
14.         holder.tv_name.setText(bean.getName());  
15.         x.image().bind(holder.iv_image, bean.getImgUrl(), options);  
16. return convertView;  
17.     }  
18.   
19. class ViewHolder{  
20. @ViewInject(R.id.tv_name)
21. private TextView tv_name;  
22. @ViewInject(R.id.iv_image)  
23. private ImageView iv_image;  
24.     }

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());
		Parent entity = db.findFirst(entity);
		//通过entity的属性查找 
		List<Parent> list = db.findAll(entity);
		//通过entity的属性查找 
		Parent Parent = db.findFirst(Selector.from(Parent.class).where("name","=","test")); 
		List<Parent> list = db.findAll(Selector.from(Parent.class) .where("id","<",54) .and("age",">",30) .or("age","<",20) .orderBy("id") .limit(10) .offset(0)); 
		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)"));
		...



ViewUtils使用方法

  • 完全注解方式就可以进行UI绑定和事件绑定。
  • 无需findViewById和setClickListener等。
@ContentView(R.layout.activity_main)
	public class MainActivity extends Activity {
		
		@ViewInject(R.id.textView)
		TextView textView; // 取消了之前使用方法名绑定事件的方式,使用id绑定不受混淆影响
		
		//在使用注解对象之前调用(如onCreate中):
		@Override 
		public void onCreate(Bundle savedInstanceState) { 
			super.onCreate(savedInstanceState);
			
			x.view().inject(this); 
			... 
			textView.setText("some text..."); 
			... 
		} 
		
		@Event(value = { R.id.buhuo_line, R.id.fuhe_line })  
		public void testButtonClick(View v) {//点击事件
			... 
		}
		... 
		
	}



x.image().bind(imageView, url, imageOptions);
x.image().bind(imageView, "file:///sdcard/test.gif", imageOptions);
x.image().bind(imageView, "assets://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>() {...});


HttpUtils使用方法:

普通post方法


JSONObject js = new JSONObject();
		try {
			js.put("loginName", name + "");
			js.put("password", pass + "");
		} catch (JSONException e1) {
			e1.printStackTrace();
		}
		showDialogProgress(LoginActivity.this, "登陆中,请稍后...");
		String nonce = RandomUtil.getRandomStr();
		System.out.println("nonce的值为" + nonce);
		String signature = "";
		
		String url = "http://"
				+ ShareDataLocal.getInstance(getActivity()).getServer()
				+ MyHttpCookies.webroot + "login.jspx";
		System.out.println("返回*********************************" + url);
		// 请求参数
		RequestParams params = new RequestParams(url);
		params.addBodyParameter("nonce", nonce);
		params.addBodyParameter("signature", signature);
		params.addBodyParameter("postData", js.toString());
		params.setAsJsonContent(true);
		params.setCharset("utf-8");
		System.out.println("返回params*********************************"
				+ params.toString());
		x.http().post(params, new CommonCallback<String>() {
			@Override
			public void onCancelled(CancelledException arg0) {
				System.out
						.println("返回onCancelled*********************************"
								+ arg0.getMessage());
			}


			@Override
			public void onError(Throwable arg0, boolean arg1) {
				System.out.println("返回onError*********************************"
						+ arg1 + "-----" + arg0.getMessage());
			}


			@Override
			public void onFinished() {
				System.out
						.println("返回onFinished*********************************");
			}


			@Override
			public void onSuccess(String arg0) {
				System.out.println("返回成功*********************************"
						+ arg0);
				// 成功下载,显示到txtv上面
				// txtv.setText(arg0);
			}
		});
	}



使用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)。 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) { testTextView.setText(current + "/" + total); } @Override public void onSuccess(String result) { testTextView.setText("upload response:" + result.getPath()); } @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, // 如果目标文件存在,接着未完成的部分继续下载。 true, // 如果从请求返回信息中获取到文件名,下载完成后自动重命名。 new RequestCallBack<File>() { @Override public void onStart() { testTextView.setText("conn..."); } @Override public void onLoading(long total, long current) { testTextView.setText(current + "/" + total); } @Override public void onSuccess(File result) { testTextView.setText("downloaded:" + result.getPath()); } @Override public void onFailure(HttpException error, String msg) { testTextView.setText(msg); } }); ... //调用stop()方法停止下载 handler.stop(); ...



BitmapUtils 使用方法


ImageOptions options = new ImageOptions.Builder()
		// 是否忽略GIF格式的图片
				.setIgnoreGif(false)
				// 图片缩放模式
				.setImageScaleType(ScaleType.CENTER_CROP)
				// 下载中显示的图片
				.setLoadingDrawableId(R.drawable.ic_launcher)
				// 下载失败显示的图片
				.setFailureDrawableId(R.drawable.ic_launcher)
				// 得到ImageOptions对象
				.build();
 x.image().bind(fuhe_img, "assets://test.gif", options);



其他(***更多示例代码见sample文件夹中的代码***)

输出日志 LogUtils


// 自动添加TAG,格式: className[methodName, lineNumber] // 可设置全局的allowD,allowE...,控制是否输出log。 LogUtils.d("wyouflf");