xUtils3源码分析之-----DB(ORM)

谁借莪１个温暖的怀抱￠ 2022-05-28 06:25 162阅读 0赞

--------------------

> 利用工作之外的时间终于看完了xutils3的所有模块的源码，以此博客来记录自己的分析过程，在此约定半年之后重新分析xUtils3源码对比该系列博客看看自己有没有新的突破。

[1. xUtils3源码解析之—–image][1. xUtils3_image]  
[2. xUtils3源码解析之—–Http(s)][2. xUtils3_Http_s]  
[3. xUtils3源码分析之—–DB(ORM)][3. xUtils3_DB_ORM]  
[4. xUtils3源码分析之—–view注解][4. xUtils3_view]

# 基本使用方法 #

> [这个demo很详细][demo]

# 配置的一些源码分析 #

> 1.DbManager db = x.getDb(daoConfig)通过DbManager.DaoConfig 配置实例得到具体的DbManagerImpl实例，x.getDb(daoConfig)方法里通过调用DbManagerImpl的静态方法getInstance(daoConfig)例得到具体的DbManagerImpl实例,getInstance方法里首先看DAO\_MAP集合（key:daoConfig value:DbManagerImpl)是否有对应的DbManagerImpl实例，有的话替换daoConfig,否则创建个实例，再保存到DAO\_MAP集合方便下次使用；
> 
> 2.创建DbManagerImpl实例主要通过openOrCreateDatabase得到SQLiteDatabase，将DaoConfig里面的一些属性赋值到自己,  
> 然后通过DaoConfig的dbOpenListener接口回调onDbOpened(DbMan ager db)方法；
> 
> 3.getInstance方法得到了DbManagerImpl后，通过比较DbManagerImpl里面的SQLiteDatabase的数据库版本跟DaoConfig的数据库版本，如果不相等则设置新的数据库版本号；

**org.xutils.x;类**
    
    public static DbManager getDb(DbManager.DaoConfig daoConfig) {
        return DbManagerImpl.getInstance(daoConfig);
    }
    
    **org.xutils.db.DbManagerImpl;类**
    public synchronized static DbManager getInstance(DaoConfig daoConfig) {
    
        if (daoConfig == null) {//使用默认配置
            daoConfig = new DaoConfig();
        }
    
        DbManagerImpl dao = DAO_MAP.get(daoConfig);
        if (dao == null) {
            dao = new DbManagerImpl(daoConfig);
            DAO_MAP.put(daoConfig, dao);
        } else {
            dao.daoConfig = daoConfig;
        }
    
        // update the database if needed
        SQLiteDatabase database = dao.database;
        int oldVersion = database.getVersion();
        int newVersion = daoConfig.getDbVersion();
        if (oldVersion != newVersion) {
            if (oldVersion != 0) {
                DbUpgradeListener upgradeListener = daoConfig.getDbUpgradeListener();
                if (upgradeListener != null) {
                    upgradeListener.onUpgrade(dao, oldVersion, newVersion);
                } else {
                    try {
                        dao.dropDb();
                    } catch (DbException e) {
                        LogUtil.e(e.getMessage(), e);
                    }
                }
            }
            database.setVersion(newVersion);
        }
    
        return dao;
    }

> 4.上面提到DaoConfig类也就是数据库的一些配置信息，配置数据库名称，数据库版本号，数据库保存路径，监听数据库打开，数据库更新等；

DbManager.DaoConfig daoConfig = new DbManager.DaoConfig()
            .setDbName("test.db")
            // 不设置dbDir时, 默认存储在app的私有目录.
            .setDbDir(new File("/sdcard")) // "sdcard"的写法并非最佳实践, 这里为了简单, 先这样写了.
            .setDbVersion(2)
            .setDbOpenListener(new DbManager.DbOpenListener() {
                @Override
                public void onDbOpened(DbManager db) {
                    // 开启WAL, 对写入加速提升巨大
                    db.getDatabase().enableWriteAheadLogging();
                }
            })
            .setDbUpgradeListener(new DbManager.DbUpgradeListener() {
                @Override
                public void onUpgrade(DbManager db, int oldVersion, int newVersion) {
                    // TODO: ...
                    // db.addColumn(...);
                    // db.dropTable(...);
                    // ...
                    // or
                    // db.dropDb();
                }
            });

# 数据库的一些操作 #

> 5.由上面的分析，通过配置数据库的一些信息，然后DbManager db = x.getDb(daoConfig);得到数据库的管理类，接下来就可以进行一些数据库操作了；首先看一下db.selector(Class entityType)方法；进而调用Selector的静态方法from(TableEntity table)该方法里会new含有TableEntity属性的Selector实例,table:是有DbManagerImpl的父类的getTable方法得到的；getTable方法通过一个hashMap(key:class, value:tableEntity)来维持缓存信息；

@Override
    public <T> Selector<T> selector(Class<T> entityType) throws DbException {
        return Selector.from(this.getTable(entityType));
    }
    
     @Override
    @SuppressWarnings("unchecked")
    public <T> TableEntity<T> getTable(Class<T> entityType) throws DbException {
        synchronized (tableMap) {
            TableEntity<T> table = (TableEntity<T>) tableMap.get(entityType);
            if (table == null) {
                try {
                    table = new TableEntity<T>(this, entityType);
                } catch (Throwable ex) {
                    throw new DbException(ex);
                }
                tableMap.put(entityType, table);
            }
    
            return table;
        }
    }
    
    **org.xutils.db.Selector;类**
    static <T> Selector<T> from(TableEntity<T> table) {
        return new Selector<T>(table);
    }

> 6.由5 DbManager.getTable方法tableMap集合里没有对应的TableEntity对象，那么会new TableEntity实例，该构造方法里通过表类得到相应的Table(含有表名，sql语句）注解;然后会将类的所有注解Column字段保存columnMap(LinkedHashMap

### Add operate ###

> 8.首先开启事务, 这里按单个对象的流程(list集合也就是遍历集合依次执行单个对象的操作)，然后通过getTable(Class)得到TableEntity实例，进而createTableIfNotExist(table)方法如果没有对应的table则创建，该方法是DbManagerImpl的父类实现的方法，createTableIfNotExist方法首先通过sql(db是否有大于0的tableName的表)select判断是否之前有创建，创建的表的流程前面有讲；然后通过SqlInfoBuilder.buildInsertSqlInfo(table, entity)方法得到SqlInfo实例该实例里含有等待插入的sql(insert tablename (name, age) values (?, ?)语句, 还有一个list 用来替换sql插入的值。最后通过execNonQuery(SqlInfo)方法执行插入操作，在该方法里首先通过SqlInfo.buildStatement(db)得到SQLiteStatement实例，该实例是通过database.compileStatement(sql);然后进行一系列的绑定操作，当然绑定的数据类型要进行判断ColumnConverterFactory.getColumnConverter(value.getClass());得到相应的字段转换器得到相应的数据类型。SQLiteStatement得到后，执行系统的execute()方法最后进行资源的收回关闭。

**org.xutils.db.DbManagerImpl;类：**

@Override
    public void save(Object entity) throws DbException {
        try {
            beginTransaction();
    
            if (entity instanceof List) {
                List<?> entities = (List<?>) entity;
                if (entities.isEmpty()) return;
                TableEntity<?> table = this.getTable(entities.get(0).getClass());
                createTableIfNotExist(table);
                for (Object item : entities) {
                    execNonQuery(SqlInfoBuilder.buildInsertSqlInfo(table, item));
                }
            } else {
                TableEntity<?> table = this.getTable(entity.getClass());
                createTableIfNotExist(table);
                execNonQuery(SqlInfoBuilder.buildInsertSqlInfo(table, entity));
            }
            setTransactionSuccessful();
        } finally {
            endTransaction();
        }
    }
    
      @Override
    public void execNonQuery(SqlInfo sqlInfo) throws DbException {
        SQLiteStatement statement = null;
        try {
            statement = sqlInfo.buildStatement(database);
            statement.execute();
        } catch (Throwable e) {
            throw new DbException(e);
        } finally {
            if (statement != null) {
                try {
                    statement.releaseReference();
                } catch (Throwable ex) {
                    LogUtil.e(ex.getMessage(), ex);
                }
            }
        }
    }
    
    **org.xutils.db.table.DbBase;类:**
    
    protected void createTableIfNotExist(TableEntity<?> table) throws DbException {
        if (!table.tableIsExist()) {
            synchronized (table.getClass()) {
                if (!table.tableIsExist()) {
                    SqlInfo sqlInfo = SqlInfoBuilder.buildCreateTableSqlInfo(table);
                    execNonQuery(sqlInfo);
                    String execAfterTableCreated = table.getOnCreated();
                    if (!TextUtils.isEmpty(execAfterTableCreated)) {
                        execNonQuery(execAfterTableCreated);
                    }
                    table.setCheckedDatabase(true);
                    TableCreateListener listener = this.getDaoConfig().getTableCreateListener();
                    if (listener != null) {
                        listener.onTableCreated(this, table);
                    }
                }
            }
        }
    }

### Delete operate ###

> 9.由8知道一些类似的操作比如开启事务之类的这里不再讲，直接入主题。通过execNonQuery(SqlInfo)方法执行Delete操作，通过SqlInfoBuilder.buildDeleteSqlInfo(table, item)得到SqlInfo实例，该方法里还是跟Add operate一样通过StringBuilder拼接sql(delete from tablename where id = 100)语句，然后通过SQLiteStatement执行类似Add operate。

### Update operate ###

> 10.我们看下update操作有什么不一样的地方，通过execNonQuery(SqlInfo)方法执行Delete操作，通过SqlInfoBuilder.buildUpdateSqlInfo(table, item)得到SqlInfo实例;buildUpdateSqlInfo方法里使用StringBuilder拼接sql(update tablename set name = “?” where id = 100;)还有一个List集合保存要更新的内容；最后跟Add 操作一样的流程。

public static SqlInfo buildUpdateSqlInfo(TableEntity<?> table, Object entity, String... updateColumnNames) throws DbException {
    
        List<KeyValue> keyValueList = entity2KeyValueList(table, entity);
        if (keyValueList.size() == 0) return null;
    
        HashSet<String> updateColumnNameSet = null;
        if (updateColumnNames != null && updateColumnNames.length > 0) {
            updateColumnNameSet = new HashSet<String>(updateColumnNames.length);
            Collections.addAll(updateColumnNameSet, updateColumnNames);
        }
    
        ColumnEntity id = table.getId();
        Object idValue = id.getColumnValue(entity);
    
        if (idValue == null) {
            throw new DbException("this entity[" + table.getEntityType() + "]'s id value is null");
        }
    
        SqlInfo result = new SqlInfo();
        StringBuilder builder = new StringBuilder("UPDATE ");
        builder.append("\"").append(table.getName()).append("\"");
        builder.append(" SET ");
        for (KeyValue kv : keyValueList) {
            if (updateColumnNameSet == null || updateColumnNameSet.contains(kv.key)) {
                builder.append("\"").append(kv.key).append("\"").append("=?,");
                result.addBindArg(kv);
            }
        }
        builder.deleteCharAt(builder.length() - 1);
        builder.append(" WHERE ").append(WhereBuilder.b(id.getName(), "=", idValue));
    
        result.setSql(builder.toString());
        return result;
    }

### Find operate ###

db.selector(Parent.class).orderBy("id", true).limit(1000).findAll();

> 通过上面的例子来讲解吧，其他的find方法大同小异。由上面的讲解我们知道db.selector(Parent.class)的流程是怎么获取Selector实例的，直接从selector里面的orderBy方法开始看。orderBy方法里维持以OrderBy实例(字段名，是否降序两个属性)的集合;接着看limit方法，该方法限定查询的数量；最后看一下findAll方法，首先判断表是否存在，如果不存在直接返回null，然后通过toString方法得到sql语句(会把前几步保存的根据哪个字段排序，限制的数量一起通过StringBuilder拼接), table.getDb()的具体实例是DbManagerImpl, DbManagerImpl.execQuery方法通过SQLiteDatabase.rawQuery(sql,null)执行后得到cursor;回到findAll方法，接着就是通过移动游标来每次调用CursorUtils.getEntity(table, cursor)得到具体的对象保存在集合里，最后返回集合。

public Selector<T> orderBy(String columnName, boolean desc) {
        if (orderByList == null) {
            orderByList = new ArrayList<OrderBy>(5);
        }
        orderByList.add(new OrderBy(columnName, desc));
        return this;
    }
    
    public Selector<T> limit(int limit) {
        this.limit = limit;
        return this;
    }
    
    public List<T> findAll() throws DbException {
        if (!table.tableIsExist()) return null;
    
        List<T> result = null;
        Cursor cursor = table.getDb().execQuery(this.toString());
        if (cursor != null) {
            try {
                result = new ArrayList<T>();
                while (cursor.moveToNext()) {
                    T entity = CursorUtils.getEntity(table, cursor);
                    result.add(entity);
                }
            } catch (Throwable e) {
                throw new DbException(e);
            } finally {
                IOUtil.closeQuietly(cursor);
            }
        }
        return result;
    }

> CursorUtils.getEntity(table, cursor)看看这个方法是怎么得到相应的实例；首先是通过类的构造方法newInstance()得到entity空对象，然后通过得到TableEntity得到所有的字段集合，接着通过字段的set方法反射给entity空对象设置游标取出的值(setMethod.invoke(entity, value) value是游标得到的值也就是数据库里的具体值，entity是刚刚new的空实例)；最后entity空对象的所有属性都得到了相应的值。

public static <T> T getEntity(TableEntity<T> table, final Cursor cursor) throws Throwable {
        T entity = table.createEntity();
        HashMap<String, ColumnEntity> columnMap = table.getColumnMap();
        int columnCount = cursor.getColumnCount();
        for (int i = 0; i < columnCount; i++) {
            String columnName = cursor.getColumnName(i);
            ColumnEntity column = columnMap.get(columnName);
            if (column != null) {
                column.setValueFromCursor(entity, cursor, i);
            }
        }
        return entity;
    }

> 利用晚上的时间，粗略的记录了一下自己的分析源代码的历程。由于篇幅的原因，里面还涉及到一些东西没有写。当然分析的过程中，可能会有些错误，如果你刚好看到了，那么谢谢你的宝贵建议。互相学习，互相进步～

[1. xUtils3_image]: https://blog.csdn.net/yang_yang1994/article/details/79834439
[2. xUtils3_Http_s]: https://blog.csdn.net/yang_yang1994/article/details/79832655
[3. xUtils3_DB_ORM]: https://blog.csdn.net/yang_yang1994/article/details/79764372
[4. xUtils3_view]: https://blog.csdn.net/yang_yang1994/article/details/79705454
[demo]: https://github.com/wyouflf/xUtils3/tree/master/sample