Android Xutils 框架

XUtils是git上比较活跃 功能比较完善的一个框架,是基于afinal开发的,比afinal稳定性提高了不少,下面是介绍:

鉴于大家的热情,我又写了一篇Android 最火框架XUtils之注解机制详解<-点击查看

xUtils简介

  • xUtils 包含了很多实用的android工具。
  • xUtils 最初源于Afinal框架,进行了大量重构,使得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使用方法:

     1 DbUtils db = DbUtils.create(this);
     2 User user = new User(); //这里需要注意的是User对象必须有id属性,或者有通过@ID注解的属性
     3 user.setEmail("wyouflf@qq.com");
     4 user.setName("wyouflf");
     5 db.save(user); // 使用saveBindingId保存实体时会为实体的id赋值
     6 
     7 ...
     8 // 查找
     9 Parent entity = db.findById(Parent.class, parent.getId());
    10 List<Parent> list = db.findAll(Parent.class);//通过类型查找
    11 
    12 Parent Parent = db.findFirst(Selector.from(Parent.class).where("name","=","test"));
    13 
    14 // IS NULL
    15 Parent Parent = db.findFirst(Selector.from(Parent.class).where("name","=", null));
    16 // IS NOT NULL
    17 Parent Parent = db.findFirst(Selector.from(Parent.class).where("name","!=", null));
    18 
    19 // WHERE id<54 AND (age>20 OR age<30) ORDER BY id LIMIT pageSize OFFSET pageOffset
    20 List<Parent> list = db.findAll(Selector.from(Parent.class)
    21                                    .where("id" ,"<", 54)
    22                                    .and(WhereBuilder.b("age", ">", 20).or("age", " < ", 30))
    23                                    .orderBy("id")
    24                                    .limit(pageSize)
    25                                    .offset(pageSize * pageIndex));
    26 
    27 // op为"in"时,最后一个参数必须是数组或Iterable的实现类(例如List等)
    28 Parent test = db.findFirst(Selector.from(Parent.class).where("id", "in", new int[]{1, 2, 3}));
    29 // op为"between"时,最后一个参数必须是数组或Iterable的实现类(例如List等)
    30 Parent test = db.findFirst(Selector.from(Parent.class).where("id", "between", new String[]{"1", "5"}));
    31 
    32 DbModel dbModel = db.findDbModelAll(Selector.from(Parent.class).select("name"));//select("name")只取出name列
    33 List<DbModel> dbModels = db.findDbModelAll(Selector.from(Parent.class).groupBy("name").select("name", "count(name)"));
    34 ...
    35 
    36 List<DbModel> dbModels = db.findDbModelAll(sql); // 自定义sql查询
    37 db.execNonQuery(sql) // 执行自定义sql
    38 ...
    View Code

    ViewUtils使用方法

    • 完全注解方式就可以进行UI绑定和事件绑定。
    • 无需findViewById和setClickListener等。
     1 // xUtils的view注解要求必须提供id,以使代码混淆不受影响。
     2 @ViewInject(R.id.textView)
     3 TextView textView;
     4 
     5 //@ViewInject(vale=R.id.textView, parentId=R.id.parentView)
     6 //TextView textView;
     7 
     8 @ResInject(id = R.string.label, type = ResType.String)
     9 private String label;
    10 
    11 // 取消了之前使用方法名绑定事件的方式,使用id绑定不受混淆影响
    12 // 支持绑定多个id @OnClick({R.id.id1, R.id.id2, R.id.id3})
    13 // or @OnClick(value={R.id.id1, R.id.id2, R.id.id3}, parentId={R.id.pid1, R.id.pid2, R.id.pid3})
    14 // 更多事件支持参见ViewCommonEventListener类和包com.lidroid.xutils.view.annotation.event。
    15 @OnClick(R.id.test_button)
    16 public void testButtonClick(View v) { // 方法签名必须和接口中的要求一致
    17     ...
    18 }
    19 ...
    20 //在Activity中注入:
    21 @Override
    22 public void onCreate(Bundle savedInstanceState) {
    23     super.onCreate(savedInstanceState);
    24     setContentView(R.layout.main);
    25     ViewUtils.inject(this); //注入view和事件
    26     ...
    27     textView.setText("some text...");
    28     ...
    29 }
    30 //在Fragment中注入:
    31 @Override
    32 public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
    33     View view = inflater.inflate(R.layout.bitmap_fragment, container, false); // 加载fragment布局
    34     ViewUtils.inject(this, view); //注入view和事件
    35     ...
    36 }
    37 //在PreferenceFragment中注入:
    38 public void onActivityCreated(Bundle savedInstanceState) {
    39     super.onActivityCreated(savedInstanceState);
    40     ViewUtils.inject(this, getPreferenceScreen()); //注入view和事件
    41     ...
    42 }
    43 // 其他重载
    44 // inject(View view);
    45 // inject(Activity activity)
    46 // inject(PreferenceActivity preferenceActivity)
    47 // inject(Object handler, View view)
    48 // inject(Object handler, Activity activity)
    49 // inject(Object handler, PreferenceGroup preferenceGroup)
    50 // inject(Object handler, PreferenceActivity preferenceActivity)
    View Code

    HttpUtils使用方法:

    普通get方法

     1 HttpUtils http = new HttpUtils();
     2 http.send(HttpRequest.HttpMethod.GET,
     3     "http://www.lidroid.com",
     4     new RequestCallBack<String>(){
     5         @Override
     6         public void onLoading(long total, long current, boolean isUploading) {
     7             testTextView.setText(current + "/" + total);
     8         }
     9 
    10         @Override
    11         public void onSuccess(ResponseInfo<String> responseInfo) {
    12             textView.setText(responseInfo.result);
    13         }
    14 
    15         @Override
    16         public void onStart() {
    17         }
    18 
    19         @Override
    20         public void onFailure(HttpException error, String msg) {
    21         }
    22 });
    get方法

    使用HttpUtils上传文件 或者 提交数据 到服务器(post方法)

     1 RequestParams params = new RequestParams();
     2 params.addHeader("name", "value");
     3 params.addQueryStringParameter("name", "value");
     4 
     5 // 只包含字符串参数时默认使用BodyParamsEntity,
     6 // 类似于UrlEncodedFormEntity("application/x-www-form-urlencoded")。
     7 params.addBodyParameter("name", "value");
     8 
     9 // 加入文件参数后默认使用MultipartEntity("multipart/form-data"),
    10 // 如需"multipart/related",xUtils中提供的MultipartEntity支持设置subType为"related"。
    11 // 使用params.setBodyEntity(httpEntity)可设置更多类型的HttpEntity(如:
    12 // MultipartEntity,BodyParamsEntity,FileUploadEntity,InputStreamUploadEntity,StringEntity)。
    13 // 例如发送json参数:params.setBodyEntity(new StringEntity(jsonStr,charset));
    14 params.addBodyParameter("file", new File("path"));
    15 ...
    16 
    17 HttpUtils http = new HttpUtils();
    18 http.send(HttpRequest.HttpMethod.POST,
    19     "uploadUrl....",
    20     params,
    21     new RequestCallBack<String>() {
    22 
    23         @Override
    24         public void onStart() {
    25             testTextView.setText("conn...");
    26         }
    27 
    28         @Override
    29         public void onLoading(long total, long current, boolean isUploading) {
    30             if (isUploading) {
    31                 testTextView.setText("upload: " + current + "/" + total);
    32             } else {
    33                 testTextView.setText("reply: " + current + "/" + total);
    34             }
    35         }
    36 
    37         @Override
    38         public void onSuccess(ResponseInfo<String> responseInfo) {
    39             testTextView.setText("reply: " + responseInfo.result);
    40         }
    41 
    42         @Override
    43         public void onFailure(HttpException error, String msg) {
    44             testTextView.setText(error.getExceptionCode() + ":" + msg);
    45         }
    46 });
    post方法

    使用HttpUtils下载文件:

    • 支持断点续传,随时停止下载任务,开始任务
    HttpUtil

    BitmapUtils 使用方法

     1 BitmapUtils bitmapUtils = new BitmapUtils(this);
     2 
     3 // 加载网络图片
     4 bitmapUtils.display(testImageView, "http://bbs.lidroid.com/static/image/common/logo.png");
     5 
     6 // 加载本地图片(路径以/开头, 绝对路径)
     7 bitmapUtils.display(testImageView, "/sdcard/test.jpg");
     8 
     9 // 加载assets中的图片(路径以assets开头)
    10 bitmapUtils.display(testImageView, "assets/img/wallpaper.jpg");
    11 
    12 // 使用ListView等容器展示图片时可通过PauseOnScrollListener控制滑动和快速滑动过程中时候暂停加载图片
    13 listView.setOnScrollListener(new PauseOnScrollListener(bitmapUtils, false, true));
    14 listView.setOnScrollListener(new PauseOnScrollListener(bitmapUtils, false, true, customListener));
    BitmapUtils

    输出日志 LogUtils

    1 // 自动添加TAG,格式: className.methodName(L:lineNumber)
    2 // 可设置全局的LogUtils.allowD = false,LogUtils.allowI = false...,控制是否输出log。
    3 // 自定义log输出LogUtils.customLogger = new xxxLogger();
    4 LogUtils.d("wyouflf");
    LogUtils

    关于作者

    近来有一些其他网站盗用本博客内容,希望尊重作者。如有问题请留言,转载注明出处。http://blog.csdn.net/rain_butterfly/article/details/37812371
    参考:http://www.oschina.net/p/xutils
  • 项目git地址https://github.com/wyouflf/xUtils
  • 实例,BitmapUtils:
  •   1 public class xUtilsImageLoader {//框架里面设置了缓存和异步操作,不用单独设置线程池和缓存机制(也可以自定义缓存路径)  
      2   
      3     private BitmapUtils bitmapUtils;  
      4     private Context mContext;  
      5   
      6     public xUtilsImageLoader(Context context) {  
      7         // TODO Auto-generated constructor stub  
      8         this.mContext = context;  
      9         bitmapUtils = new BitmapUtils(mContext);  
     10         bitmapUtils.configDefaultLoadingImage(R.drawable.logo_new);//默认背景图片  
     11         bitmapUtils.configDefaultLoadFailedImage(R.drawable.logo_new);//加载失败图片  
     12         bitmapUtils.configDefaultBitmapConfig(Bitmap.Config.RGB_565);//设置图片压缩类型  
     13   
     14     }  
     15     /** 
     16      *  
     17      * @author sunglasses 
     18      * @category 图片回调函数 
     19      */  
     20     public class CustomBitmapLoadCallBack extends  
     21             DefaultBitmapLoadCallBack<ImageView> {  
     22   
     23         @Override  
     24         public void onLoading(ImageView container, String uri,  
     25                 BitmapDisplayConfig config, long total, long current) {  
     26         }  
     27   
     28         @Override  
     29         public void onLoadCompleted(ImageView container, String uri,  
     30                 Bitmap bitmap, BitmapDisplayConfig config, BitmapLoadFrom from) {  
     31             // super.onLoadCompleted(container, uri, bitmap, config, from);  
     32             fadeInDisplay(container, bitmap);  
     33         }  
     34   
     35         @Override  
     36         public void onLoadFailed(ImageView container, String uri,  
     37                 Drawable drawable) {  
     38             // TODO Auto-generated method stub  
     39         }  
     40     }  
     41   
     42     private static final ColorDrawable TRANSPARENT_DRAWABLE = new ColorDrawable(  
     43             android.R.color.transparent);  
     44     /** 
     45      * @author sunglasses 
     46      * @category 图片加载效果 
     47      * @param imageView 
     48      * @param bitmap 
     49      */  
     50     private void fadeInDisplay(ImageView imageView, Bitmap bitmap) {//目前流行的渐变效果  
     51         final TransitionDrawable transitionDrawable = new TransitionDrawable(  
     52                 new Drawable[] { TRANSPARENT_DRAWABLE,  
     53                         new BitmapDrawable(imageView.getResources(), bitmap) });  
     54         imageView.setImageDrawable(transitionDrawable);  
     55         transitionDrawable.startTransition(500);  
     56     }  
     57     public void display(ImageView container,String url){//外部接口函数  
     58         bitmapUtils.display(container, url,new CustomBitmapLoadCallBack());  
     59     }  
     60 }  
     61 实例:HttpGet:
     62 [java] view plaincopy在CODE上查看代码片派生到我的代码片
     63  
     64  
     65 public class xUtilsGet {//自动实现异步处理,自己不用处理  
     66   
     67     public void getJson(String url,RequestParams params,final IOAuthCallBack iOAuthCallBack){  
     68   
     69         HttpUtils http = new HttpUtils();  
     70         http.configCurrentHttpCacheExpiry(1000 * 10);//设置超时时间  
     71         http.send(HttpMethod.GET, url, params, new RequestCallBack<String>() {//接口回调  
     72   
     73             @Override  
     74             public void onFailure(HttpException arg0, String arg1) {  
     75                 // TODO Auto-generated method stub  
     76             }  
     77   
     78             @Override  
     79             public void onSuccess(ResponseInfo<String> info) {  
     80                 // TODO Auto-generated method stub  
     81                 iOAuthCallBack.getIOAuthCallBack(info.result);//利用接口回调数据传输  
     82             }  
     83         });  
     84     }  
     85     public void getCataJson(int cityId,IOAuthCallBack iOAuthCallBack) {//外部接口函数  
     86         String url = "http://xxxxxxxxxx";  
     87         RequestParams params = new RequestParams();  
     88         params.addQueryStringParameter("currentCityId", cityId+"");  
     89         getJson(url,params,iOAuthCallBack);  
     90     }  
     91 }  
     92 实例:HttpPost(和HttpGet类似):
     93 [java] view plaincopy在CODE上查看代码片派生到我的代码片
     94  
     95  
     96 public class xUtilsPost {//自动实现异步处理  
     97   
     98     public void doPost(String url, RequestParams params,  
     99             final IOAuthCallBack iOAuthCallBack) {  
    100   
    101         HttpUtils http = new HttpUtils();  
    102         http.configCurrentHttpCacheExpiry(1000 * 10);  
    103         http.send(HttpMethod.POST, url, params, new RequestCallBack<String>() {  
    104   
    105             @Override  
    106             public void onFailure(HttpException arg0, String arg1) {  
    107                 // TODO Auto-generated method stub  
    108             }  
    109   
    110             @Override  
    111             public void onSuccess(ResponseInfo<String> info) {  
    112                 // TODO Auto-generated method stub  
    113                 iOAuthCallBack.getIOAuthCallBack(info.result);  
    114             }  
    115         });  
    116     }  
    117   
    118     public void doPostLogin(int cityId, IOAuthCallBack iOAuthCallBack) {  
    119         String url = "http://xxxxxxxxxxxx";  
    120         RequestParams params = new RequestParams();  
    121         params.addQueryStringParameter("currentCityId", cityId + "");  
    122         params.addBodyParameter("path", "/apps/postCatch");  
    123         doPost(url, params, iOAuthCallBack);  
    124     }  
    125 }
    BitmapUtils
 
 
原文地址:https://www.cnblogs.com/Sharley/p/5669406.html