Xutils3的基本使用

1.先來認識一下xUtils3

(1)xUtils3簡介

        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; 支持圓角, 圓形, 方形等裁剪, 支持自動旋轉。

(2)在我們的項目中快速配置xUtils3
     xUtils3的配置十分的簡單:

            使用Gradle構建時添加一下依賴即可

                    compile 'org.xutils:xutils:3.5.0'

             如果使用eclipse可以 點擊這裏下載aar文件, 然後用zip解壓, 取出jar文件.

(3)使用前要添加權限

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

(4)初始化

// 在application的onCreate中初始化
@Override
public void onCreate() {
    super.onCreate();
    x.Ext.init(this);
    x.Ext.setDebug(BuildConfig.DEBUG); // 是否輸出debug日誌, 開啓debug會影響性能.
    ...
}

xUtils3主要包含註解模塊、網絡模塊、圖片模塊和數據庫模塊,下面將做一一說明。

2.xUtils3註解模塊的使用

        (由於現在的主流android開發環境是android studio,而studio又有相應的插件,所以這部分功能是完全可以不用的)

xUtils3註解模塊在實際開發中的使用如下:

(1)Activity的註解的使用如下:

@ContentView(R.layout.activity_main)
public class MainActivity extends AppCompatActivity {
    @ViewInject(R.id.viewpager)
    ViewPager viewPager;
    @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 {

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

(3)爲按鈕設置點擊事件

@ViewInject(R.id.bt_main)
Button bt_main;
@Override
protected void onCreate (Bundle savedInstanceState){

}

//用註解的方式爲按鈕添加點擊事件,方法聲明必須爲private
//type默認View.OnClickListener.class,故此處可以簡化不寫,@Event(R.id.bt_main)
@Event(type = View.OnClickListener.class, value = R.id.bt_main)
private void testInjectOnClick (View v){
    Snackbar.make(v, "OnClickListener", Snackbar.LENGTH_SHORT).show();
}

//長按事件
@Event(type = View.OnLongClickListener.class, value = R.id.bt_main)
private boolean testOnLongClickListener (View v){
    Snackbar.make(v, "testOnLongClickListener", Snackbar.LENGTH_SHORT).show();
    return true;
}

說明:下面演示都將使用@Event事件註解。

3.xUtils3網絡模塊的使用

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

(1)GET請求

String url = "http://www.android.com";

@Event(R.id.get)
private void get (View v){
    final ProgressDialog progressDialog = new ProgressDialog(getActivity());

    progressDialog.setMessage("請稍候...");

    RequestParams params = new RequestParams(url);

    params.addQueryStringParameter("username", "abc");

    params.addQueryStringParameter("password", "123");

    Callback.Cancelable cancelable = x.http().get(params, new
            Callback.CommonCallback<string>() {

                @Override
                public void onSuccess(String result) {
                    Log.i("JAVA", "onSuccess result:" + result);
                    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請求

String url = "http://www.android.com";

@Event(R.id.post)
private void post (View v){
    RequestParams params = new RequestParams(url);
    params.addBodyParameter("username", "abc");
    params.addParameter("password", "123");
    params.addHeader("head", "android"); //爲當前請求添加一個頭
    x.http().post(params, new
            Callback.CommonCallback<string>() {
                @Override
                public void onSuccess(String result) {

                }

                @Override
                public void onError(Throwable ex, boolean isOnCallback) {

                }

                @Override
                public void onCancelled(CancelledException cex) {

                }

                @Override
                public void onFinished() {

                }
            });
}

(3)其他網絡請求方式

String url = "http://www.android.com";

@Event(R.id.other)
private void other (View v){
    RequestParams params = new RequestParams(url);
    params.addParameter("username", "abc");
    x.http().request(HttpMethod.PUT, params, new
            Callback.CommonCallback<string>() {
                @Override
                public void onSuccess(String result) {

                }

                @Override
                public void onError(Throwable ex, boolean
                        isOnCallback) {

                }

                @Override
                public void onCancelled(CancelledException cex) {

                }

                @Override
                public void onFinished() {

                }

            });

}

(4)上傳文件

String url = "http://www.android.com";

@Event(R.id.upload)
private void upload (View v){

    String path = "/mnt/sdcard/Download/icon.jpg";

    RequestParams params = new RequestParams(url);

    params.setMultipart(true);

    params.addBodyParameter("file", new File(path));

    x.http().post(params, new Callback.CommonCallback<string>() {

        @Override
        public void onSuccess(String result) {

        }

        @Override
        public void onError(Throwable ex, boolean
                isOnCallback) {

        }

        @Override
        public void onCancelled(CancelledException cex) {

        }

        @Override
        public void onFinished() {

        }

    });

}

(5)下載文件

這裏以下載apk爲例進行說明,apk下載完成後,自動調用系統的安裝方法。

String url = "http://www.android.com";

@Event(R.id.download)
private void download (View v){

    url = "http://127.0.0.1/server/ABC.apk";

    RequestParams params = new RequestParams(url);

    //自定義保存路徑,Environment.getExternalStorageDirectory():SD卡的根目錄

    params.setSaveFilePath(Environment.getExternalStorageDirectory() + "/myapp/");

    //自動爲文件命名

    params.setAutoRename(true);

    x.http().post(params, new Callback.ProgressCallback<file>() {

        @Override
        public void onSuccess(File result) {

            //apk下載完成後,調用系統的安裝方法

            Intent intent = new Intent(Intent.ACTION_VIEW);

            intent.setDataAndType(Uri.fromFile(result), "application/vnd.android.package-archive");

            getActivity().startActivity(intent);

        }

        @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) {
            //當前進度和文件總大小
            Log.i("JAVA", "current:" + current + ",total:" + total);

        }

    });

}

(6)使用緩存

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<string>() {

        @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;
        }

    });

}

4.xUtils3圖片模塊的使用

    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<drawable>() {

        @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<drawable>() {

        @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<drawable>() {
        @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<file>() {
        @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() {

        }

    });
}

4.xUtils3數據庫模塊的使用

    (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<childinfo> 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<childinfo> all = db.selector(ChildInfo.class).where(b).findAll();//findAll():查詢所有結果
    for (ChildInfo childInfo : all) {
        Log.i("JAVA", childInfo.toString());
    }

    //第二種寫法:
    List<childinfo> 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);
}
參考文章:https://github.com/wyouflf/xUtils3


發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章