Android教程網
  1. 首頁
  2. Android 技術
  3. Android 手機
  4. Android 系統教程
  5. Android 游戲
 Android教程網 >> Android技術 >> 關於Android編程 >> Android xUtils框架解析

Android xUtils框架解析

編輯:關於Android編程

xUtils簡介

xUtils是基於Afinal開發的目前功能比較完善的一個Android開源框架,最近又發布了xUtil3.0,在增加新功能的同時又提高了框架的性能,下面來看看官方(https://github.com/wyouflf/xUtils3)對xUtils3的介紹:

xUtils包含了很多實用的android工具; xUtils支持超大文件(超過2G)上傳,更全面的http請求協議支持(11種謂詞),擁有更加靈活的ORM,更多的事件注解支持且不受混淆影響; xUtils 最低兼容Android 4.0 (api level 14); xUtils3變化較多所以建立了新的項目不在舊版(github.com/wyouflf/xUtils)上繼續維護, 相對於舊版本:
HTTP實現替換HttpClient為UrlConnection, 自動解析回調泛型, 更安全的斷點續傳策略; 支持標准的Cookie策略, 區分domain, path; 事件注解去除不常用的功能, 提高性能; 數據庫api簡化提高性能, 達到和greenDao一致的性能; 圖片綁定支持gif(受系統兼容性影響, 部分gif文件只能靜態顯示), webp; 支持圓角, 圓形, 方形等裁剪, 支持自動旋轉。

目前xUtils主要有四大模塊:

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內存; 可配置線程加載線程數量,緩存大小,緩存路徑,加載顯示動畫等…

DbUtils模塊:

android中的orm框架,一行代碼就可以進行增刪改查; 支持事務,默認關閉; 可通過注解自定義表名,列名,外鍵,唯一性約束,NOT NULL約束,CHECK約束等(需要混淆的時候請注解表名和列名); 支持綁定外鍵,保存實體時外鍵關聯實體自動保存或更新; 自動加載外鍵關聯實體,支持延時加載; 支持鏈式表達查詢,更直觀的查詢語義,參考下面的介紹或sample中的例子。

項目中快速配置xUtils3

Eclipse用戶導入最新jar包和so文件,下載鏈接
添加網絡訪問權限

在Application中初始化xUtils

    @Override
    public void onCreate() {
        super.onCreate();
        x.Ext.init(this);
        x.Ext.setDebug(true); //是否輸出debug日志,開啟debug會影響性能。
    }

xUtils3功能介紹

ViewUtils注解模塊的使用

完全注解方式就可以進行UI綁定和事件綁定。 無需findViewById和setClickListener等。

1)Activity的注解的使用如下:

@ContentView(R.layout.activity_main)
public class MainActivity extends Activity {
    @ViewInject(R.id.button1)
    private Button button1;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        x.view().inject(this);
        ...
    }
}

2)Fragment的注解的使用如下:

@ContentView(R.layout.fragment_http)
public class HttpFragment extends Fragment {
    @Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
        return x.view().inject(this, inflater, container);
    }
    @Override
    public void onViewCreated(View v, Bundle savedInstanceState) {
        super.onViewCreated(v, savedInstanceState);
    }
}

3)為按鈕設置點擊事件

@ViewInject(R.id.button1)
private Button button1;
...
@Override
protected void onCreate(Bundle savedInstanceState) {
    ...
}
/**
 * 用注解的方式為按鈕添加點擊事件,方法聲明必須為private
 * type默認View.OnClickListener.class,故此處可以簡化不寫
 */
@Event(type = View.OnClickListener.class,value = R.id.button1)
private void testHttpUtils(View v){
    Intent it = new Intent(MainActivity.this, HttpUtilsActivity.class);
    startActivity(it);
}
/**
 * 長按事件
 */
@Event(type = View.OnLongClickListener.class,value = R.id.button2)
private boolean testOnLongClickListener(View v){
    Toast.makeText(this,"testOnLongClickListener",Toast.LENGTH_SHORT).show();
    return true;
}

注意:
1. 使用IOC必須全部為私有,不然無效,這裡就不做演示了,不信你可以把用到IOC框架的注解的成員變量及方法全部換成public ,那麼全部會無效,當然除了ContentView例外。
2. 所有用到IOC成員變量,使用的時候,必須在x.view().inject(this)後,如果寫在前面,那麼程序會崩潰。

HttpUtils網絡模塊的使用

xUtils3網絡模塊大大方便了在實際開發中網絡模塊的開發,xUtils3網絡模塊大致包括GET請求、POST請求、如何使用其他請求方式、上傳文件、下載文件、使用緩存等功能,下面將做一一說明:
1)GET請求

@Event(R.id.get)
private void get(View v){
    final ProgressDialog progressDialog = new ProgressDialog(getActivity());
    progressDialog.setMessage("請稍候...");
    RequestParams params = new RequestParams("http://weather.51wnl.com/weatherinfo/GetMoreWeather");
    params.addQueryStringParameter("cityCode","101020100");
    params.addQueryStringParameter("weatherType","0");
    Callback.Cancelable cancelable = x.http().get(params, new Callback.CommonCallback() {
        @Override
        public void onSuccess(String result) {
            Toast.makeText(HttpUtilsActivity.this, result, Toast.LENGTH_SHORT).show();
            progressDialog.cancel();
        }
        //請求異常後的回調方法
        @Override
        public void onError(Throwable ex, boolean isOnCallback) {
        }
        //主動調用取消請求的回調方法
        @Override
        public void onCancelled(CancelledException cex) {
        }
        @Override
        public void onFinished() {
            progressDialog.cancel();
        }
    });
    //主動調用取消請求
//    cancelable.cancel();
}

2)POST請求

@Event(R.id.post)
private void post(View v){
    RequestParams params = new RequestParams("http://61.129.89.191/SoarAPI/api/SoarTopic");
    params.addParameter("topicId","1002");
    params.addParameter("maxReply","-1");
    params.addParameter("reqApp","1"); //添加請求參數
    params.addBodyParameter("username","abc"); //添加一個請求體
    params.addHeader("head","android"); //添加一個請求頭
    x.http().post(params, new Callback.CommonCallback() {
        @Override
        public void onSuccess(String result) {
             MainActivity.showlog("onSuccess-->result="+result);
             Toast.makeText(HttpUtilsActivity.this, result, Toast.LENGTH_SHORT).show();         
        }
        @Override
        public void onError(Throwable ex, boolean isOnCallback) {
        }
        @Override
        public void onCancelled(CancelledException cex) {
        }
        @Override
        public void onFinished() {
        }
    });
}

3)上傳文件

    @Event(R.id.btn_test3)
    private void upload(View v){
        RequestParams params = new RequestParams("http://192.168.1.112:8080/TopNews_WebProject/UploadFileServlet");
        params.setMultipart(true);
        //這裡可以進行多文件上傳
        params.addBodyParameter("file",new File("/sdcard/temp/file.jpg"));
        params.addBodyParameter("photo",new File("/sdcard/temp/file0.jpg"),"image/jpeg","hx.jpg");//還傳入文件類型和新文件名
        x.http().post(params, new Callback.CommonCallback() {
            @Override
            public void onSuccess(String result) {
                MainActivity.showlog("onSuccess-->result="+result);
                Toast.makeText(HttpUtilsActivity.this, result, Toast.LENGTH_SHORT).show();
            }
            @Override
            public void onError(Throwable ex, boolean isOnCallback) {
                MainActivity.showlog("onError-->Throwable="+ex.getMessage());
            }
            @Override
            public void onCancelled(CancelledException cex) {
                MainActivity.showlog("onCancelled-->CancelledException="+cex.getMessage());
            }
            @Override
            public void onFinished() {
                MainActivity.showlog("onFinished");
            }
        });
    }

4)下載文件
這裡以下載圖片為例進行說明,圖片下載完成後,自動加載到ImageView。

@Event(R.id.download)
private void download(View v){
    String url = editText.getText().toString();
    RequestParams params = new RequestParams(url);
    //自定義保存路徑
    params.setSaveFilePath("/sdcard/temp/");
    //自動為文件命名
    params.setAutoRename(true);
    x.http().post(params, new Callback.ProgressCallback() {
        @Override
        public void onSuccess(File result) {
             try {
                    Bitmap bm = BitmapFactory.decodeStream(new FileInputStream(file));
                    image.setImageBitmap(bm);
                } catch (FileNotFoundException e) {
                    e.printStackTrace();
                }
        }
        @Override
        public void onError(Throwable ex, boolean isOnCallback) {
        }
        @Override
        public void onCancelled(CancelledException cex) {
        }
        @Override
        public void onFinished() {
        }
        //網絡請求之前回調
        @Override
        public void onWaiting() {
        }
        //網絡請求開始的時候回調
        @Override
        public void onStarted() {
        }
        //下載的時候不斷回調的方法
        @Override
        public void onLoading(long total, long current, boolean isDownloading) {
            //當前進度和文件總大小
            progressBar.setMax((int)total);
            progressBar.setProgress((int)current); 
        }
    });
}

5)使用緩存

String url = "http://www.android.com";
@Event(R.id.cache)
private void cache(View v) {
    RequestParams params = new RequestParams(url);
    params.setCacheMaxAge(1000*60); //為請求添加緩存時間
    Callback.Cancelable cancelable = x.http().get(params, new Callback.CacheCallback() {
        @Override
        public void onSuccess(String result) {
            Log.i("JAVA","onSuccess:"+result);
        }
        @Override
        public void onError(Throwable ex, boolean isOnCallback) {
        }
        @Override
        public void onCancelled(CancelledException cex) {
        }
        @Override
        public void onFinished() {
        }
        //result:緩存內容
        @Override
        public boolean onCache(String result) {
            //在setCacheMaxAge設置范圍(上面設置的是60秒)內,如果再次調用GET請求,
            //返回true:緩存內容被返回,相信本地緩存,返回false:緩存內容被返回,不相信本地緩存,仍然會請求網絡
            Log.i("JAVA","cache:"+result);
            return true;
        }
    });
}

BitmapUtils圖片模塊的使用

現在我們需要設置兩個權限,如下:


xUtils3圖片模塊,重點在於加載圖片的4個bind方法,loadDrawable與loadFIle用法和ImageOptions用法
1)首先獲取ImageView控件

@ViewInject(R.id.image01)
ImageView image01;
@ViewInject(R.id.image02)
ImageView image02;
@ViewInject(R.id.image03)
ImageView image03;
...

2)得到網絡圖片的地址

String[] urls={
    "http://img.android.com/a.jpg",
    "http://img.android.com/b.jpg"
    "http://img.android.com/c.jpg"
    ...
};

3)xUtils3顯示圖片方法setPic()如下:

private void setPic() {
    /**
     * 通過ImageOptions.Builder().set方法設置圖片的屬性
     */
    ImageOptions options = new ImageOptions.Builder().setFadeIn(true).build(); //淡入效果
    //ImageOptions.Builder()的一些其他屬性:
    //.setCircular(true) //設置圖片顯示為圓形
    //.setSquare(true) //設置圖片顯示為正方形
    //setCrop(true).setSize(200,200) //設置大小
    //.setAnimation(animation) //設置動畫
    //.setFailureDrawable(Drawable failureDrawable) //設置加載失敗的動畫
    //.setFailureDrawableId(int failureDrawable) //以資源id設置加載失敗的動畫
    //.setLoadingDrawable(Drawable loadingDrawable) //設置加載中的動畫
    //.setLoadingDrawableId(int loadingDrawable) //以資源id設置加載中的動畫
    //.setIgnoreGif(false) //忽略Gif圖片
    //.setParamsBuilder(ParamsBuilder paramsBuilder) //在網絡請求中添加一些參數
    //.setRaduis(int raduis) //設置拐角弧度
    //.setUseMemCache(true) //設置使用MemCache,默認true

    /**
     * 加載圖片的4個bind方法
     */
    x.image().bind(image01, urls[0]);
    x.image().bind(image02, urls[1], options);
    x.image().bind(image03, urls[2], options, new Callback.CommonCallback() {
        @Override
        public void onSuccess(Drawable result) {
        }
        @Override
        public void onError(Throwable ex, boolean isOnCallback) {
        }
        @Override
        public void onCancelled(CancelledException cex) {
        }
        @Override
        public void onFinished() {
        }
    });
    x.image().bind(image04, urls[3], options, new Callback.CommonCallback() {
        @Override
        public void onSuccess(Drawable result) {
        }
        @Override
        public void onError(Throwable ex, boolean isOnCallback) {
        }
        @Override
        public void onCancelled(CancelledException cex) {
        }
        @Override
        public void onFinished() {
        }
    });

    /**
     * loadDrawable()方法加載圖片
     */
    Callback.Cancelable cancelable = x.image().loadDrawable(urls[0], options, new Callback.CommonCallback() {
        @Override
        public void onSuccess(Drawable result) {
            image03.setImageDrawable(result);
        }
        @Override
        public void onError(Throwable ex, boolean isOnCallback) {
        }
        @Override
        public void onCancelled(CancelledException cex) {
        }
        @Override
        public void onFinished() {
        }
    });
    //主動取消loadDrawable()方法
    //cancelable.cancel();

    /**
     * loadFile()方法
     * 應用場景:當我們通過bind()或者loadDrawable()方法加載了一張圖片後,
     * 它會保存到本地文件中,那當我需要這張圖片時,就可以通過loadFile()方法進行查找。
     * urls[0]:網絡地址
     */
    x.image().loadFile(urls[0],options,new Callback.CacheCallback(){
        @Override
        public boolean onCache(File result) {
            //在這裡可以做圖片另存為等操作
            Log.i("JAVA","file:"+result.getPath()+result.getName());
            return true; //相信本地緩存返回true
        }
        @Override
        public void onSuccess(File result) {
            Log.i("JAVA","file");
        }
        @Override
        public void onError(Throwable ex, boolean isOnCallback) {
        }
        @Override
        public void onCancelled(CancelledException cex) {
        }
        @Override
        public void onFinished() {
        }
    });
}

DbUtils數據庫模塊的使用

1)創建數據庫和刪除數據庫
首先進行配置DaoConfig:

/**
 * DaoConfig配置
 * /
DbManager.DaoConfig daoConfig = new DbManager.DaoConfig()
        //設置數據庫名,默認xutils.db
        .setDbName("myapp.db")
        //設置表創建的監聽
        .setTableCreateListener(new DbManager.TableCreateListener() {
            @Override
            public void onTableCreated(DbManager db, TableEntity table){
                Log.i("JAVA", "onTableCreated:" + table.getName());
            }
        })
        //設置是否允許事務,默認true
        //.setAllowTransaction(true)
        //設置數據庫路徑,默認安裝程序路徑下
        //.setDbDir(new File("/mnt/sdcard/"))
        //設置數據庫的版本號
        //.setDbVersion(1)
        //設置數據庫更新的監聽
        .setDbUpgradeListener(new DbManager.DbUpgradeListener() {
            @Override
            public void onUpgrade(DbManager db, int oldVersion, 
                    int newVersion) {
            }
        })
        //設置數據庫打開的監聽
        .setDbOpenListener(new DbManager.DbOpenListener() {
            @Override
            public void onDbOpened(DbManager db) {
                //開啟數據庫支持多線程操作,提升性能
                db.getDatabase().enableWriteAheadLogging();
            }
        });
DbManager db = x.getDb(daoConfig);

然後創建數據庫表ChildInfo的實體類:

/**
 * onCreated = "sql":當第一次創建表需要插入數據時候在此寫sql語句
 */
@Table(name = "child_info",onCreated = "")
public class ChildInfo {
    /**
     * name = "id":數據庫表中的一個字段
     * isId = true:是否是主鍵
     * autoGen = true:是否自動增長
     * property = "NOT NULL":添加約束
     */
    @Column(name = "id",isId = true,autoGen = true,property = "NOT NULL")
    private int id;
    @Column(name = "c_name")
    private String cName;

    public ChildInfo(String cName) {
        this.cName = cName;
    }
    //默認的構造方法必須寫出,如果沒有,這張表是創建不成功的
    public ChildInfo() {
    }
    public int getId() {
        return id;
    }
    public void setId(int id) {
        this.id = id;
    }
    public String getcName() {
        return cName;
    }
    public void setcName(String cName) {
        this.cName = cName;
    }
    @Override
    public String toString() {
        return "ChildInfo{"+"id="+id+",cName='"+cName+'\''+'}';
    }
}

之後就能進行創建和刪除數據庫的操作了:

//創建數據庫
@Event(R.id.create_db)
private void createDB(View v) throws DbException {
    //用集合向child_info表中插入多條數據
    ArrayList childInfos = new ArrayList<>();
    childInfos.add(new ChildInfo("zhangsan"));
    childInfos.add(new ChildInfo("lisi"));
    childInfos.add(new ChildInfo("wangwu"));
    childInfos.add(new ChildInfo("zhaoliu"));
    childInfos.add(new ChildInfo("qianqi"));
    childInfos.add(new ChildInfo("sunba"));
    //db.save()方法不僅可以插入單個對象,還能插入集合
    db.save(childInfos);
}

//刪除數據庫
@Event(R.id.del_db)
private void delDB(View v) throws DbException {
    db.dropDb();
}

2)刪除表

//刪除表
@Event(R.id.del_table)
private void delTable(View v) throws DbException {
    db.dropTable(ChildInfo.class);
}

3)查詢表中的數據

//查詢表中的數據
@Event(R.id.select_table)
private void selelctDB(View v) throws DbException {
    //查詢數據庫表中第一條數據
    ChildInfo first = db.findFirst(ChildInfo.class);
    Log.i("JAVA",first.toString());
    //添加查詢條件進行查詢
    //第一種寫法:
    WhereBuilder b = WhereBuilder.b();
    b.and("id",">",2); //構造修改的條件
    b.and("id","<",4);
    List all = db.selector(ChildInfo.class).where(b).findAll();//findAll():查詢所有結果
    for(ChildInfo childInfo :all){
        Log.i("JAVA",childInfo.toString());
    }
    //第二種寫法:
    List all = db.selector(ChildInfo.class).where("id",">",2).and("id","<",4).findAll();
    for(ChildInfo childInfo :all){
        Log.i("JAVA",childInfo.toString());
    }
}

4)修改表中的數據

//修改表中的一條數據
@Event(R.id.update_table)
private void updateTable(View v) throws DbException {
    //第一種寫法:
    ChildInfo first = db.findFirst(ChildInfo.class);
    first.setcName("zhansan2");
    db.update(first,"c_name"); //c_name:表中的字段名
    //第二種寫法:
    WhereBuilder b = WhereBuilder.b();
    b.and("id","=",first.getId()); //構造修改的條件
    KeyValue name = new KeyValue("c_name","zhansan3");
    db.update(ChildInfo.class,b,name);
    //第三種寫法:
    first.setcName("zhansan4");
    db.saveOrUpdate(first);
}

5)刪除表中的數據

@Event(R.id.del_table_data)
private void delTableData(View v) throws DbException {
    //第一種寫法:
    db.delete(ChildInfo.class); //child_info表中數據將被全部刪除
    //第二種寫法,添加刪除條件:
    WhereBuilder b = WhereBuilder.b();
    b.and("id",">",2); //構造修改的條件
    b.and("id","<",4);
    db.delete(ChildInfo.class, b);
}
  1. 上一頁:
  2. 下一頁:
熱門文章
閱讀排行版
Copyright © Android教程網 All Rights Reserved