xutils3的使用方法

转载自https://blog.csdn.net/tyk9999tyk/article/details/53306035

1.xUtils3简介以及配置

1)xUtils3简介

xutils是前几年比较火得一个开源框架,主要分四个重要的模块:ViewUtils,HttpUtils,BitmapUtils,DbUtils,包含了很多实用的工具类,支持大文件上传,且有更全面的http请求协议支持,拥有灵活的Orm,支持事件注解且不受代码混淆影响。

但是Github上面的xutils已经很久没有更新了,并且随着Android版本的升级和人们开发软件思想的转变,xutils也暴露出了些许的问题,例如xutils对Android6.0的兼容性就不是特别好,所以还是建议大家使用比较新的xutils3。下面来看看官方(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的配置十分的简单:

2-1)使用Gradle构建时添加一下依赖即可

compile 'org.xutils:xutils:3.3.36'

如果使用eclipse可以点击下面链接下载aar文件, 然后用zip解压,取出jar包和so文件。

Github下载:https://github.com/wyouflf/xUtils3

JCenter下载:http://jcenter.bintray.com/org/xutils/xutils/

Maven下载1:http://central.maven.org/maven2/org/xutils/xutils/

Maven下载2:http://repo1.maven.org/maven2/org/xutils/xutils/

2-2)加入权限

2-3)创建Application

public class MyApp extends Application {

    @Override

    public void onCreate() {

        super.onCreate();

        x.Ext.init(this);

        x.Ext.setDebug(false); //输出debug日志,开启会影响性能

    }

}

2-4)在AndroidManifest文件中注册MyApp

    android:name=".MyApp"

    ...

xUtils3主要包含注解模块、网络模块、图片模块和数据库模块,下面将做一一说明。

2.xUtils3注解模块的使用

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);

        //setContentView(R.layout.activity_main);

        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)为按钮设置点击事件

方法必须私有限定,

方法参数形式必须和type对应的Listener接口一致.

注解参数value支持数组: value={id1, id2, id3}

/**

* 单击事件

* 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;

}

3.xUtils3网络模块的使用

xUtils3网络模块大大方便了在实际开发中网络模块的开发,xUtils3网络模块大致包括GET请求、POST请求、如何使用其他请求方式、上传文件、下载文件、使用缓存等功能,下面将做一一说明:

1)GET请求

RequestParams params = new RequestParams(url);

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

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

x.http().get(params, new Callback.CommonCallback() {

    @Override

    public void onSuccess(String result) {

        //解析result

    }

    //请求异常后的回调方法

    @Override

    public void onError(Throwable ex, boolean isOnCallback) {

    }

    //主动调用取消请求的回调方法

    @Override

    public void onCancelled(CancelledException cex) {

    }

    @Override

    public void onFinished() {

    }

});

下面我们来看下带有缓存的GET请求,POST请求和其他请求方式类似,后面就不再赘述:

带有缓存的GET请求:

RequestParams params = new RequestParams(url);

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

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

// 默认缓存存活时间, 单位:毫秒(如果服务器没有返回有效的max-age或Expires则参考)

params.setCacheMaxAge(1000 * 60);

x.http().get(params, new Callback.CacheCallback() {

    private boolean hasError = false;

    private String result = null;

    @Override

    public boolean onCache(String result) { //得到缓存数据, 缓存过期后不会进入

        this.result = result;

        return true; //true: 信任缓存数据, 不再发起网络请求; false不信任缓存数据

    }

    @Override

    public void onSuccess(String result) {

        //如果服务返回304或onCache选择了信任缓存,这时result为null

        Log.i("JAVA", "开始请求");

        if (result != null) {

            this.result = result;

        }

    }

    @Override

    public void onError(Throwable ex, boolean isOnCallback) {

        hasError = true;

        Toast.makeText(x.app(), ex.getMessage(), Toast.LENGTH_LONG).show();

        if (ex instanceof HttpException) { //网络错误

            HttpException httpEx = (HttpException) ex;

            int responseCode = httpEx.getCode();

            String responseMsg = httpEx.getMessage();

            String errorResult = httpEx.getResult();

            //...

        } else { //其他错误

            //...

        }

    }

    @Override

    public void onCancelled(CancelledException cex) {

    }

    @Override

    public void onFinished() {

        if (!hasError && result != null) {

            //成功获取数据

            Toast.makeText(x.app(), result, Toast.LENGTH_LONG).show();

        }

    }

});

上面onCache方法中需要注意的几点:

a)如果服务端没有返回过期时间,参考params.setCacheMaxAge(maxAge)方法。

b)客户端会根据服务端返回的header中max-age或expires来确定本地缓存是否给onCache方法。如果服务端没有返回max-age或expires,那么缓存将一直保存,除非这里自己定义了返回false,那么xUtils将请求新数据, 来覆盖它。

c)如果信任该缓存返回true,将不再请求网络。返回false继续请求网络,但会在请求头中加上ETag,Last-Modified等信息。如果服务端返回304,则表示数据没有更新,不继续加载数据。

2)POST请求

RequestParams params = new RequestParams(url);

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

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

params.addHeader("head","android"); //为当前请求添加一个头

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

    @Override

    public void onSuccess(String result) {

        //解析result

    }

    @Override

    public void onError(Throwable ex, boolean isOnCallback) {

    }

    @Override

    public void onCancelled(CancelledException cex) {

    }

    @Override

    public void onFinished() {

    }

});

3)其他网络请求方式

RequestParams params = new RequestParams(url);

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

x.http().request(HttpMethod.PUT, params, new Callback.CommonCallback() {

    @Override

    public void onSuccess(String result) {

        //解析result

    }

    @Override

    public void onError(Throwable ex, boolean isOnCallback) {

    }

    @Override

    public void onCancelled(CancelledException cex) {

    }

    @Override

    public void onFinished() {

    }

});

4)上传文件

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

    @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下载完成后,自动调用系统的安装方法。

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

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

    }

});

4.xUtils3图片模块的使用

xUtils3图片模块,重点在于加载图片的4个bind方法,loadDrawable与loadFIle用法和ImageOptions用法,需多加练习。

1)xUtils3 ImageOptions:

//通过ImageOptions.Builder().set方法设置图片的属性

ImageOptions imageOptions= 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

2)xUtils3 bind方法:

// assets file

x.image().bind(imageView, "assets://test.gif", imageOptions);

// local file

x.image().bind(imageView, new File("/sdcard/test.gif").toURI().toString(), imageOptions);

x.image().bind(imageView, "/sdcard/test.gif", imageOptions);

x.image().bind(imageView, "file:///sdcard/test.gif", imageOptions);

x.image().bind(imageView, "file:/sdcard/test.gif", imageOptions);

x.image().bind(imageView, url, imageOptions, 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() {

    }

3)xUtils3 loadDrawable方法:

x.image().loadDrawable(url, imageOptions, new Callback.CommonCallback() {

    @Override

    public void onSuccess(Drawable result) {

        imageView.setImageDrawable(result);

    }

    @Override

    public void onError(Throwable ex, boolean isOnCallback) {

    }

    @Override

    public void onCancelled(CancelledException cex) {

    }

    @Override

    public void onFinished() {

    }

});

4)xUtils3 loadFile方法:

当我们通过bind()或者loadDrawable()方法加载了一张图片后,它会保存到本地文件中,那当我需要这张图片时,就可以通过loadFile()方法进行查找。

x.image().loadFile(url,imageOptions,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) {

    }

    @Override

    public void onError(Throwable ex, boolean isOnCallback) {

    }

    @Override

    public void onCancelled(CancelledException cex) {

    }

    @Override

    public void onFinished() {

    }

});

4.xUtils3数据库模块的使用

1)初始化配置和创建实体类

首先在项目Application中进行初始化配置DaoConfig(与onCreate方法同级目录下):

/**

* 初始化DaoConfig配置

*/

DbManager.DaoConfig daoConfig = new DbManager.DaoConfig()

        //设置数据库名,默认xutils.db

        .setDbName("myapp.db")

        //设置数据库路径,默认存储在app的私有目录

        .setDbDir(new File("/mnt/sdcard/"))

        //设置数据库的版本号

        .setDbVersion(2)

        //设置数据库打开的监听

        .setDbOpenListener(new DbManager.DbOpenListener() {

            @Override

            public void onDbOpened(DbManager db) {

                //开启数据库支持多线程操作,提升性能,对写入加速提升巨大

                db.getDatabase().enableWriteAheadLogging();

            }

        })

        //设置数据库更新的监听

        .setDbUpgradeListener(new DbManager.DbUpgradeListener() {

            @Override

            public void onUpgrade(DbManager db, int oldVersion, int newVersion) {

            }

        })

        //设置表创建的监听

        .setTableCreateListener(new DbManager.TableCreateListener() {

            @Override

            public void onTableCreated(DbManager db, TableEntity table){

                Log.i("JAVA", "onTableCreated:" + table.getName());

            }

        });

        //设置是否允许事务,默认true

        //.setAllowTransaction(true)

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+'\''+'}';

    }

}

之后就能进行创建和删除数据库的操作了:

2)创建数据库

//用集合向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);

3)删除数据库

db.dropDb();

1

4)删除表

db.dropTable(ChildInfo.class);

1

5)新增表中的数据

ChildInfo childInfo = new ChildInfo("zhangsan123");

db.save(childInfo);

1

2

6)删除表中的数据

//第一种写法:

db.delete(ChildInfo.class); //child_info表中数据将被全部删除

//第二种写法,添加删除条件:

WhereBuilder b = WhereBuilder.b();

b.and("id",">",2); //构造修改的条件

b.and("id","<",4);

db.delete(ChildInfo.class, b);

7)修改表中的数据

//第一种写法:

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);

8)查询表中的数据

//查询数据库表中第一条数据

ChildInfo first = db.findFirst(ChildInfo.class);

Log.i("JAVA",first.toString());

//添加查询条件进行查询

List all = db.selector(ChildInfo.class).where("id",">",2).and("id","<",4).findAll();

for(ChildInfo childInfo :all){

    Log.i("JAVA",childInfo.toString());

}

5.xUtils3提供的其他一些方法

1)UI异步执行

x.task().run(new Runnable() {

    @Override

    public void run() {

        //异步代码

    }

});

2)UI同步执行

x.task().post(new Runnable() {

    @Override

    public void run() {

        //同步代码

    }

});

你可能感兴趣的:(xutils3的使用方法)