开源项目源码解析-xUtils 源码解析

xUtils 源码解析

本文为 Android 开源项目源码解析中 xUtils 部分。
项目地址：xUtils，分析的版本：192c2a886c，Demo 地址：xUtils Demo
分析者：Caij，校对者：maogy，校对状态：未完成

功能介绍
xUtils一个Android公共库框架，主要包括四个部分：View，Db, Http, Bitmap 四个模块。

View模块主要的功能是通过注解绑定UI，资源，事件。Db模块是一个数据库orm框架，简单的语句就能进行数据的操作。Http模块主要访问网络，支持同步，异步方式的请求，支持文件的下载。Bitmap模块是加载图片以及图片的处理，支持加载本地，网络图片。而且支持图片的内存和本地缓存。

详细设计
2.1 View模块
2.1.1 总体设计
流程和关系较少，请看下面的详细分析

2.1.2 流程图

2.1.3 核心类功能介绍

请先了解注解，动态代理可以帮助到您，
如果已经了解请忽略。

注解和反射知识是这个模块的主要内容

1.ViewUtils.java

View和各种事件的注入以及资源的注入。

(1)主要函数

    private static void injectObject(Object handler, ViewFinder finder)

第一个参数Object handler代表的是需要注入的对象，第二个参数是需要注入View（这个View就是handler的成员变量）所在的View或者Activity的包装对象。该方法完成了View和各种事件的注入以及资源的注入。主要的原理就是通过反射和注解。

完成Activity的setContentView。完成View的注入。完成资源的注入。完成各种事件的注入。
2.ViewFinder.java
(1)主要函数

    public View findViewById(int id, int pid)
    public View findViewById(int id)

如果存在父View，优先从父View寻找，否则从当前的View或者Activity中寻找。

3.ResLoader.java

    public static Object loadRes(ResType type, Context context, int id)

获取资源文件值。支持多种资源的获取。

4.EventListenerManager.java

事件的注入，其中的设计是通过动态代理。

private final static DoubleKeyValueMap<ViewInjectInfo, Class<?>, Object> listenerCache =
            new DoubleKeyValueMap<ViewInjectInfo, Class<?>, Object>();

存放监听事件接口map。因为有些接口有多个函数，代理会判断事件接口是否存在，如果存在只增加代理方法就够了，避免重新设置监听事件接口。

public static void addEventMethod(
            ViewFinder finder,
            ViewInjectInfo info,
            Annotation eventAnnotation,
            Object handler,
            Method method)

代理监听事件

5.注解类
2.2 Db模块
2.2.1 总体设计

流程和关系较少，请看下面的详细分析

2.2.2 流程图

2.2.3 核心类功能介绍

注解、反射和数据库操作知识这个模块的主要内容

1.DbUtils.java

主要功能数据库的创建，数据库的增删改查。

    private static HashMap<String, DbUtils> daoMap = new HashMap<String, DbUtils>();

存放DbUtils实例对象的map，每个数据库对应一个实例， key为数据库的名称。

private synchronized static DbUtils getInstance(DaoConfig daoConfig)

采取的是单例模式，根据DaoConfig创建数据库，中间还涉及到数据库升级。

    delete；
    findAll；
    findById；
    saveOrUpdate；// 当数据库没有时保存， 存在时修改。
    update；

增删改查。

2.DaoConfig.java

    private String dbName = "xUtils.db"; // default db name数据库名称
    private int dbVersion = 1; //数据库版本
    private DbUpgradeListener dbUpgradeListener; //升级监听事件

数据库配置类。

3.FindTempCache.java

在DbUtils的查询数据中

    @SuppressWarnings("unchecked")
    public <T> List<T> findAll(Selector selector) throws DbException {
        ....

        String sql = selector.toString();
        long seq = CursorUtils.FindCacheSequence.getSeq();
        findTempCache.setSeq(seq);
        Object obj = findTempCache.get(sql);//优先从缓存读取
        if (obj != null) {
            return (List<T>) obj;
        }

        ...
    }

数据库查询数据的缓存。在查询中会优先调用缓存中的数据

4.SqlInfoBuilder.java

sql建表、增删改语句的组合。

public static SqlInfo buildCreateTableSqlInfo(DbUtils db, Class<?> entityType)  
public static SqlInfo buildDeleteSqlInfo(DbUtils db, Class<?> entityType, Object idValue)
public static SqlInfo buildDeleteSqlInfo(DbUtils db, Class<?> entityType, WhereBuilder whereBuilder)
public static SqlInfo buildDeleteSqlInfo(DbUtils db, Object entity)
public static SqlInfo buildInsertSqlInfo(DbUtils db, Object entity)
public static SqlInfo buildUpdateSqlInfo(DbUtils db, Object entity, String... updateColumnNames)
public static SqlInfo buildUpdateSqlInfo(DbUtils db, Object entity, WhereBuilder whereBuilder, String... updateColumnNames)

5.SqlInfo.java

sql语句和值包装对象。

6.Table.java

表对象。

7.Column.java

表中列对象。

8.Id.java

表对应的主键对象。

9.Selector.java

sql查询语句的组合。

10.WhereBuilder.java

sql条件语句的组合。

DBUtils增删改查：

操纵数据库的工具类，无论多牛X，总离不开最根本的CRUD，即创建，查询，更新和删除。下面从这四个角度依次介绍xUtils是如何简便持久化数据的。大家都知道，在Android里面如果要存储一个对象，我们需要创建一个SQLiteOpenHelper，然后还得创建一张对应对象各个属性的表，还得继续把我们的对象转换成ContentValues，进而去存储。真心是麻烦的不能再麻烦了，我们现在介绍的DbUtils就能让你轻松解脱麻绳一样的代码。DbUtils在进行save操作的时候，会根据java反射反射出对象的各个字段，然后去查询数据库中是否存在这个对象类型对应的表，如果表已经存在，直接进行插入操作；如果不存在，就先动态的创建的一张对应我们对象的表，再进行插入处理。直接上代码，大家看。

[java] view
plaincopy

@OnClick(R.id.insert)
public void insert(View v) {
Student stu = null;
for (int i = 0; i < 20; i++) {
stu = new Student();
stu.setAge(10 + i);
stu.setName("jack" + i);
mList.add(stu);
try {
dbUtils.save(stu);
} catch (DbException e) {
e.printStackTrace();
}
}
}

注意：并不是所有的实体对象都快可以通过这种方式去存储，一定要保证对象的类型中有int类型的id或者_id的属性，这就对应数据库表中的主键字段。如果类型中没有id字段，可以通过@Id注解去指定一个int类型的字段作为主键。如果表中的又字段不想被存储在数据库中，也可以通过@Transient去实现忽略。如果直接存储一个对象的列表，这样也是被允许的，达到批量存储的目的。

DbUtils可以帮助对SQL语句不是很熟悉的同学快速的实现查询，而不用去写sql查询语句，而且可以对查询结果进行排序和分页，使用简单，功能强大。大家可以看下，下面的几行代码就能实现复杂的查询功能

[java] view
plaincopy

dbUtils.findAll(Selector.from(Student.class)
.where("_id", "<", 10).and("age", ">", 10).orderBy("_id")
.limit(pageSize).offset(pageSize * pageIndex));

同样的，也可以对数据库中得数据进行便捷的更新。下面演示的是更新Student对应的表中的第一条记录的age这个字段。这个比较简单，就直接上代码看吧。

[java] view
plaincopy

@OnClick(R.id.update)
public void update(View v){
try {
List<Student> stus = dbUtils.findAll(Selector.from(Student.class));
Student stu = stus.get(0);
stu.setAge(20);
dbUtils.update(stu);
} catch (DbException e) {
e.printStackTrace();
}
}

最后一个就是数据的删除。一个实体对象，一组实体对象，根据条件删除，删除表，删除整个数据库，这些操作都可以通过一句简单的代码来实现，看了代码就明白了。

[java] view
plaincopy

@OnClick(R.id.delete)
public void delete(View v){
try {
List<Student> stus = dbUtils.findAll(Selector.from(Student.class));
dbUtils.delete(stus.get(0));
dbUtils.deleteAll(stus);
dbUtils.deleteById(Student.class, WhereBuilder.b("age", "==", 20));
dbUtils.dropTable(Student.class);
dbUtils.dropDb();
} catch (DbException e) {
e.printStackTrace();
}
}

2.3 Http模块
2.3.1 总体设计

2.3.2 流程图

2.3.3 类图

1.HttpUtils.java

支持异步同步访问网络数据，断点下载文件。

    //网络数据的缓存。
    public final static HttpCache sHttpCache = new HttpCache();
    //访问网络的HttpClient。
    private final DefaultHttpClient httpClient; 
    private final HttpContext httpContext = new BasicHttpContext();
    //线程池。
    private final static PriorityExecutor EXECUTOR = new PriorityExecutor(DEFAULT_POOL_SIZE);

public HttpUtils(int connTimeout, String userAgent) {
        //配置超时时间，UserAgent， http版本信息协议等一些信息
        .....
        //将配置的参数统一放到httpClient中
        httpClient = new DefaultHttpClient(new ThreadSafeClientConnManager(params, schemeRegistry), params);
        ....

        //下面这个关键，设置拦截器。 默认加上gizp压缩。 通过gizp压缩后的数据传输效率高很多。
        httpClient.addRequestInterceptor(new HttpRequestInterceptor() {
            @Override
            public void process(org.apache.http.HttpRequest httpRequest, HttpContext httpContext) throws org.apache.http.HttpException, IOException {
                if (!httpRequest.containsHeader(HEADER_ACCEPT_ENCODING)) { 
                    httpRequest.addHeader(HEADER_ACCEPT_ENCODING, ENCODING_GZIP);
                }
            }
        });

        httpClient.addResponseInterceptor(new HttpResponseInterceptor() {
            @Override
            public void process(HttpResponse response, HttpContext httpContext) throws org.apache.http.HttpException, IOException {
                final HttpEntity entity = response.getEntity();
                if (entity == null) {
                    return;
                }
                final Header encoding = entity.getContentEncoding();
                if (encoding != null) {
                    for (HeaderElement element : encoding.getElements()) {
                        if (element.getName().equalsIgnoreCase("gzip")) {
                            //这里判断从服务器传输的数据是否需要通过gzip解压。
                            response.setEntity(new GZipDecompressingEntity(response.getEntity())); 
                            return;
                        }
                    }
                }
            }
        });
    }

    //访问网络数据
    private <T> HttpHandler<T> sendRequest(HttpRequest request, RequestParams params, RequestCallBack<T> callBack);
    //下载网络文件
    public HttpHandler<File> download(HttpRequest.HttpMethod method, String url, String target,
                                      RequestParams params, boolean autoResume, boolean autoRename, RequestCallBack<File> callback);

2.HttpRequest.java

网络请求的包装类。包括url，访问请求方法，参数值等。

3.RequestCallBack.java

完成数据请求回调接口。

4.HttpHandler.java

获取网络数据逻辑的实现。这里可以理解为系统内部AsyncTask。访问网络数据处理流程图

5.HttpCache.java

网络数据的缓存，内部包含LruMemoryCache。在获取数据的时候会判断是否过期。

6.StringDownLoadHandler.java

handleEntity()将网络io流转化为String。

7.FileDownLoadHandler.java

handleEntity()将网络io流转化为File。

8.HttpException.java

统一异常

2.4 Bitmap模块
2.4.1 总体设计

2.4.2 流程图

请查看http模块

2.4.3 类图

1.BitmapUtils.java

图片的异步加载，支持本地和网络图片，图片的压缩处理，图片的内存缓存已经本地缓存。

    private BitmapGlobalConfig globalConfig; // 线程池，缓存，和网络的配置
    private BitmapDisplayConfig defaultDisplayConfig; //图片显示的配置

    /**
     * @param container 表示需要显示图片的View
     * @param uri 图片的uri
     * @param displayConfig 图片显示的配置
     * @param callBack 图片加载的回调接口
     */
    public <T extends View> void display(T container, String uri, BitmapDisplayConfig displayConfig, BitmapLoadCallBack<T> callBack)

设置图片流程图

详细流程图

2.BitmapLoadTask.java

加载图片的异步任务。在doInBackground中读取图片资源

3.BitmapCache.java

    private LruDiskCache mDiskLruCache; //闪存缓存
    private LruMemoryCache<MemoryCacheKey, Bitmap> mMemoryCache; //运存缓存

(1)主要函数

    //下载网络图片， 然后根据配置压缩图片， 将图片缓存。
    public Bitmap downloadBitmap(String uri, BitmapDisplayConfig config, final BitmapUtils.BitmapLoadTask<?> task)
    //从运存缓存中读取bitmap 在获取的时候会判断是否过期
    public Bitmap getBitmapFromMemCache(String uri, BitmapDisplayConfig config)
    //从闪存缓存中读取bitmap
    public Bitmap getBitmapFromDiskCache(String uri, BitmapDisplayConfig config)

4.BitmapGlobalConfig.java

配置，包括线程池，缓存的大小。

//闪存缓存的路径
private String diskCachePath;
//运存缓存的最大值
private int memoryCacheSize = 1024 * 1024 * 4; // 4MB
//闪存缓存的最大值
private int diskCacheSize = 1024 * 1024 * 50;  // 50M
//从网络加载数据的线程池
private final static PriorityExecutor BITMAP_LOAD_EXECUTOR = new PriorityExecutor(DEFAULT_POOL_SIZE);
//从闪存读取数据的线程池
private final static PriorityExecutor DISK_CACHE_EXECUTOR = new PriorityExecutor(2);
//bitmap缓存的的时间
private long defaultCacheExpiry = 1000L * 60 * 60 * 24 * 30; // 30 days
//bitmap缓存
private BitmapCache bitmapCache;

5.BitmapDisplayConfig.java

    //图片显示的大小
    private BitmapSize bitmapMaxSize;
    //图片的动画
    private Animation animation;
    // 图片加载过程中的显示图片
    private Drawable loadingDrawable;
    // 图片加载失败的显示图片
    private Drawable loadFailedDrawable;
    // 图片显示的配置色彩
    private Bitmap.Config bitmapConfig = Bitmap.Config.RGB_565;

6.DefaultDownloader.java

获取bitmap，支持三种获取路径，本地文件，资产文件，和网络图片。

7.DefaultBitmapLoadCallBack.java

图片加载完成的的回调，默认回调将获取的bitmap值传递给view。

杂谈
和Volley框架相比

相同点：

1.采用了网络数据缓存机制。2.通过handler进行线程通信
不同点：

Volley的Http请求在 android 2.3 版本之前是通过HttpClient ，在之后的版本是通过URLHttpConnection。xUtils都是通过HttpClient请求网络（bitmap模块图片下载是通过URLHttpConnection）。 URLHttpConnection默认支持GZIP压缩，api操作简单。
2.Volley将Http请求数据先缓存进byte[]，然后是分配给不同的请求转化为需要的格式。xUtils是直接转化为想要的格式。 Volley：扩展性好，但是不能存在大数据请求，否则就OOM。xUtils：不缓存入byte[] 支持大数据的请求，速度比Volley稍快，但扩展性就低。4.Volley访问网络数据时直接开启固定个数线程访问网络，在run方法中执行死循环，阻塞等待请求队列。 xUtils是开启线程池来管理线程。

缓存失效策略， volley的所有网络数据支持从http响应头中控制是否缓存和读取缓存失效时间，每个请求可以控制是否缓存和缓存失效时间。 Xutils网络数据请求是统一自定义缓存失效时间。

开源项目源码解析-xUtils 源码解析

日历

标签

搜索

最新文章

热门文章

开源项目源码解析-xUtils 源码解析

热门推荐

日历

标签

搜索

最新文章

热门文章