Android架构设计01-数据库框架

1 使用场景

涉及到数据库的操作,一般的都是使用第三方的框架,如GreeoDao,OrmLitem等。或者是直接利用SQLiteOpenHelper来完成数据库的增删改查以及数据库升级。那么对于这种写法,一般都比较繁琐。操作如下:

DBHelper dbHelper = new DBHelper(this);
SQLiteDatabase sqLiteDatabase = dbHelper.getWritableDatabase();
sqLiteDatabase.execSQL("create table if not exists tb_weichat(name varchar(20),password varchar(10))");
ContentValues contentValues  = new ContentValues();
contentValues.put("user_name","张三");
contentValues.put("password","123456");
sqLiteDatabase.beginTransaction();
int scheduleID = -1;
dbHelper.insert("schedule",null,values);
dbHelper.setTransctionSuccessful();

使用框架实现

User user = new User("张三", "20122425");
baseDao.insert(user);

可以看出使用框架和之前相比省了很多行代码。操作更简单。

2 用到的知识点

泛型
注解
反射
数据库语句拼接

用到的设计的模式
单例模式
简单工厂模式
模板方法模式

3 类图

这里写图片描述

4 具体实现

4.1 IBaseDao 定义数据库访问接口
public interface IBaseDao<T> {
    /**
     * 数据库插入操作
     * @param entity
     * @return
     */
    Long insert(T entity);

    /**
     * 数据库删除
     * @param where
     * @return
     */
    int delete(T where);

    /**
     * 数据库更改操作
     * @param entity
     * @param where
     * @return
     */
    int updata(T entity,T where);

    /**
     * 数据库查询操作
     * @param where
     * @return
     */
    List<T> query(T where);

}

这个借口约束了数据库行为,数据库中有增删改查功能。

4.2 BaseDao 实现数据库操作
public abstract class BaseDao<T> implements IBaseDao<T> {

    //只能初始化一次
    private boolean isInit = false;

    //被插入数据库的实体
    private Class<T> mEntityClass;

    private SQLiteDatabase mSqLiteDatabase;

    //表名
    private String tableName;

    /**
     * 用来维护表与实体的对应关系
     * key:   表的列名
     * value: entity的Field名
     */
    private HashMap<String, Field> cacheMap;

    /**
     * @param entityClass    要出入数据库的实体类
     * @param sqLiteDatabase 数据库管理的对象
     */
    public synchronized boolean init(Class<T> entityClass, SQLiteDatabase sqLiteDatabase) {
        if (!isInit) {
            mEntityClass = entityClass;
            mSqLiteDatabase = sqLiteDatabase;

            if (mEntityClass.getAnnotation(DbTable.class) != null) {
                //注解DbTable的值为表名
                tableName = entityClass.getAnnotation(DbTable.class).value();
            } else {
                //如果没有注解,对应的类名为表名
                tableName = entityClass.getSimpleName();
            }

            //创建表
            if (!TextUtils.isEmpty(createTable())) {
                sqLiteDatabase.execSQL(createTable());
            }

            cacheMap = new HashMap<>();
            initCacheMap();
            isInit = true;
        }
        return isInit;
    }

    /**
     * 初始化cacheMap,
     * 将表的列明和对应的entity的成员变量名字赋值给该cacheMap
     */

    private void initCacheMap() {
        String sql = "select * from " + this.tableName + " limit 1,0";
        Cursor cursor = null;
        try {


            cursor = mSqLiteDatabase.rawQuery(sql, null);

            //表的列名数组
            String[] columnsName = cursor.getColumnNames();

            //entitiy的Field数组
            Field[] fields = mEntityClass.getFields();

            //防止私有属性无法访问
            for (Field field : fields) {
                field.setAccessible(true);
            }

            //遍历列名
            for (String columnName : columnsName) {
                //遍历成员变量
                for (Field field : fields) {
                    String fieldName = null;
                    if (field.getAnnotation(DbField.class) != null) {
                        fieldName = field.getAnnotation(DbField.class).value();
                    } else {
                        fieldName = field.getName();
                    }

                    if (field != null && columnName.equals(fieldName)) {
                        cacheMap.put(columnName, field);
                        break;
                    }

                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            if (null != cursor) {
                cursor.close();
            }
        }
    }

    //=============================================插入
    @Override
    public Long insert(T entity) {
        Map<String, String> map = getValue(entity);
        ContentValues contentValues = getContentValues(map);
        Long reslt = mSqLiteDatabase.insert(tableName, null, contentValues);
        return reslt;
    }

    //=============================================删除
    @Override
    public int delete(T where) {
        int result = -1;

        Map whereClause = getValue(where);
        Condition condition = new Condition(whereClause);

        result = mSqLiteDatabase.delete(tableName, condition.getWhereClause(), condition.getWhereArgs());
        return result;
    }

    //=============================================更新
    @Override
    public int updata(T entity, T where) {
        int result = -1;
        Map whereClause = getValue(where);
        Map values = getValue(entity);

        Condition condition = new Condition(whereClause);
        ContentValues contentValues = getContentValues(values);

        result = mSqLiteDatabase.update(tableName, contentValues, condition.getWhereClause(), condition.getWhereArgs());
        return result;
    }

    //=============================================更新
    @Override
    public List<T> query(T where) {

        return query(where, null, null, null);
    }

    private List<T> query(T where, String orderBy, Integer startIndex, Integer limit) {
        Map map = getValue(where);
        String limitString = null;
        if (startIndex != null && limit != null) {
            limitString = startIndex + " , " + limit;
        }

        Condition condition = new Condition(map);
        Cursor cursor = mSqLiteDatabase.query(tableName, null, condition.getWhereClause(), condition.getWhereArgs(), null, null, orderBy, limitString);

        List<T> result = getResult(where, cursor);
        cursor.close();
        return result;
    }

	/**
     * 将查询的结果返回
     * @param where  表中每条数据对应的实体类
     * @param cursor  查询结果返回的cursor对象
     * @return  返回所有的查询结果
     */
    protected List<T> getResult(T where, Cursor cursor) {
        ArrayList list = new ArrayList();
        Object item;
        //先遍历表中的所有行
        while (cursor.moveToNext()) {
            try {
                //根据一行 创建一个实例
                item = where.getClass().newInstance();
                Iterator iterator = cacheMap.entrySet().iterator();
                while (iterator.hasNext()) {
                    Map.Entry entry = (Map.Entry) iterator.next();

                    //得到列名
                    String columnName = (String) entry.getKey();

                    //根据列名 得出列的位置
                    Integer columnIndex = cursor.getColumnIndex(columnName);

                    Field field = (Field) entry.getValue();

                    //获取Field的类型
                    Class type = field.getType();

                    //判断Field的类型
                    if (columnIndex != -1) {
                        if (type == String.class) {
                            //根据反射进行赋值
                            field.set(item, cursor.getString(columnIndex));
                        } else if (type == Double.class) {
                            field.set(item, cursor.getDouble(columnIndex));
                        } else if (type == Integer.class) {
                            field.set(item, cursor.getInt(columnIndex));
                        } else if (type == Long.class) {
                            field.set(item, cursor.getLong(columnIndex));
                        } else if (type == Byte.class) {
                            field.set(item, cursor.getBlob(columnIndex));
                            //不支持类型
                        } else {
                            continue;
                        }
                    }
                }

                list.add(item);
            } catch (InstantiationException e) {
                e.printStackTrace();
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            }
        }
        return list;
    }

    ;

    /**
     * 把map转成contentValues
     * key:列名   value:Field值
     *
     * @param map
     * @return
     */
    private ContentValues getContentValues(Map<String, String> map) {
        ContentValues contentValues = new ContentValues();

        Set keys = map.keySet();
        Iterator<String> iterator = keys.iterator();

        while (iterator.hasNext()) {
            String columnName = iterator.next();
            String value = map.get(columnName);

            if (!TextUtils.isEmpty(columnName) && !TextUtils.isEmpty(value)) {
                contentValues.put(columnName, value);
            }

        }
        return contentValues;
    }

    ;


    /**
     * 用map 来存储entity的属性值 key为对应属性的注解值
     * key:"user_name"   vlaue:"张三"
     *
     * @param entity
     * @return
     */
    private Map<String, String> getValue(T entity) {
        Map<String, String> map = new HashMap<>();
        Iterator<Field> fieldIterator = cacheMap.values().iterator();

        while (fieldIterator.hasNext()) {
            Field field = fieldIterator.next();

            String key = null; //列名
            String value = null; //field值

            if (field.getAnnotation(DbField.class) != null) {
                key = field.getAnnotation(DbField.class).value();
            } else {
                key = field.getName();
            }

            try {
                if (field.get(entity) == null) {
                    continue;
                }
                value = field.get(entity).toString();
                if (value != null) {
                    map.put(key, value);
                }
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            }

        }
        return map;
    }

    class Condition {
        /**
         * 条件语句
         * name=?&&password=?
         */
        private String whereClause;

        private String[] whereArgs;

        public Condition(Map<String, String> whereClause) {
            ArrayList list = new ArrayList();
            StringBuilder stringBuilder = new StringBuilder();
            stringBuilder.append(" 1=1 ");


            Set keySet = whereClause.keySet();
            Iterator<String> iterator = keySet.iterator();
            while (iterator.hasNext()) {
                String key = iterator.next();
                String value = whereClause.get(key);
                if (key != null) {

                    //拼接条件语句  1=1 and name =? and password =?
                    stringBuilder.append(" and " + key + " =?");

                    list.add(value);
                }
            }

            this.whereClause = stringBuilder.toString();
            this.whereArgs = (String[]) list.toArray(new String[list.size()]);
        }

        public String getWhereClause() {
            return whereClause;
        }

        public String[] getWhereArgs() {
            return whereArgs;
        }
    }


    /**
     * 每个Dao的建的表各不相同,所以此方法留给子类实现
     *
     * @return 建表的字符串语句
     */
    public abstract String createTable();
}

这个类也是这个框架的核心内容。首先看这个方法

init(Class entityClass, SQLiteDatabase sqLiteDatabase)
这个方法做了这几件事情:

初始化每一条数据对应的实体类。

  mEntityClass = entityClass;

初始化SQLiteDataBase对象

mSqLiteDatabase = sqLiteDatabase;

初始化表名

if (mEntityClass.getAnnotation(DbTable.class) != null) {
                //注解DbTable的值为表名
                tableName = entityClass.getAnnotation(DbTable.class).value();
            } else {
                //如果没有注解,对应的类名为表名
                tableName = entityClass.getSimpleName();
            }

创建表 这里的createTalbe方法是抽象方法,也是BaseDao子类唯一需要重写的方法。也就是说BaseDao的子类除了建表语句不同之外,其他的方法都是一样的。

 if (!TextUtils.isEmpty(createTable())) {
                sqLiteDatabase.execSQL(createTable());
            }

初始化cacheMap

cacheMap = new HashMap<>();
            initCacheMap();

cacheMap用来维护表的数据和实体类的对应关系。
key:表的列名。如user_name
value: entity的Field。如User类中的String name的name变量。

initCacheMap()
这个方法是用来给cacheMap赋值的。

首先用cursor来获取一个表的列名数组

cursor = mSqLiteDatabase.rawQuery(sql, null);
String[] columnsName = cursor.getColumnNames();

获取entity中的成员变量数组

Field[] fields = mEntityClass.getFields();

在把根据列名找到对应的实体类中的成员变量

for (String columnName : columnsName) {
                //遍历成员变量
                for (Field field : fields) {
                    String fieldName = null;
                    if (field.getAnnotation(DbField.class) != null) {
                        fieldName = field.getAnnotation(DbField.class).value();
                    } else {
                        fieldName = field.getName();
                    }

                    if (field != null && columnName.equals(fieldName)) {
	                    //没找到一个对应 就添加到cacheMap中
                        cacheMap.put(columnName, field);
                        break;
                    }

                }
            }

getValue(T entity)
这个方法用来把一个实体类的中所有的成员变量封装到一个map中。
map的key:entity的Field注解名,也就是列名;
map的value:entity的Field的value;
用cacheMap去迭代表的所有列的数据。当列名对应的Field的value不是null的时候,将此列名和value作为一个entry添加到map中。

getContentValues(Map< String, String> map)
这个方法用来把map(key:列名,value:Field的值)转化为contentValue。

内部类Condition
这个内部类是用来拼接条件语句。当在构造方法中传入一个entity后,把这个entity的Field的名作为拼接条件的查询语句,Field的value作为条件语句的值。它有两个成员变量

whereClause:用来拼接条件语句。如:and name =?
whereArgs:条件语句的值的数组。如:”张三“

getResult(T where, Cursor cursor)
这个方法是用来根据需要
查询的条件
和表中的所有数据 来返回所有符合条件的对象集合。

4.3 UserDao

具体的数据库访问类。

public class UserDao extends BaseDao {
    @Override
    public String createTable() {
        return "create table if not exists tb_weichat(name varchar(20),password varchar(10))";
    }
}

这个类只是重写了建表语句的方法。也就是每当需要建一张表就要写一个此类。

注解:

4.4 DbField
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface DbField {
    String value();
}

修饰成员变量。value对应表的列名。

注解:

4.5 DbTable
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface DbTable {
    String value();
}

修饰类。对应表名。

4.6 User
@DbTable("tb_weichat")
public class User {

    @DbField("name")
    public String name;

    @DbField("password")
    public String password;

    public User() {
    }

    public User(String name, String password) {
        this.name = name;
        this.password = password;
    }

    public void setName(String name) {
        this.name = name;
    }

    public void setPassword(String password) {
        this.password = password;
    }
}

这个类是表的每一条数据对应的实体类。也就是说每个User对应一个UserDao。每个UserDao对应一张表。而每个User对应一条表的数据。

4.7 BaseDaoFactory
public class BaseDaoFactory {

    //单例
    private static BaseDaoFactory instance = new BaseDaoFactory();

    //数据库的存储路径
    private String sqliteDataPath;

    private SQLiteDatabase sqLiteDatabase;

    private BaseDaoFactory() {
        //随便起了个名字,比如叫微信的数据库
        sqliteDataPath = Environment.getExternalStorageDirectory().getAbsolutePath() + "/weichat.db";
        openSqliteDataBase();
    }

    public static BaseDaoFactory getInstance() {
        return instance;
    }

    private void openSqliteDataBase() {
        sqLiteDatabase = SQLiteDatabase.openOrCreateDatabase(sqliteDataPath,null);
    }

    /**
     * 构建一个BaseDao的子类
     * @param entity 插入数据库的实体类
     * @param dao   BaseDao的子类
     * @param <T>
     * @param <M>
     * @return
     */
    public synchronized  <T,M extends BaseDao<T>> BaseDao<T> constructDao(Class<T> entity,Class<M> dao){
        BaseDao baseDao = null;
        try {
            baseDao = dao.newInstance();
            baseDao.init(entity,sqLiteDatabase);

        } catch (InstantiationException e) {
            e.printStackTrace();
        } catch (IllegalAccessException e) {
            e.printStackTrace();
        }

        return baseDao;
    }
}

这个类用来构建一个具体的BaseDao对象。这个类是单例的。全局只有一个此类的对象。构建了BaseDao对象并隐藏了具体的实现细节。

4.8 MainActivity
public class MainActivity extends AppCompatActivity {
    private IBaseDao baseDao;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        baseDao = BaseDaoFactory.getInstance().constructDao(User.class, UserDao.class);
    }

    public void insert(View view) {
        User user = new User("张三", "20122425");
        baseDao.insert(user);
    }

    public void delete(View view){
        User where = new User();
        where.setName("李四");
        baseDao.delete(where
        );
    }

    public void update(View view){
        User user = new User("李四","1352284");

        User where = new User();
        where.setName("张三");

        baseDao.updata(user,where);
    }

    public void query(View view){
        User user = new User();
        user.setName("李四");
        List<User> list = baseDao.query(user);
        Log.i("Main","查询到"+list.size()+"条数据");
    }
}

点击下载源码

  • 0
    点赞
  • 4
    收藏
    觉得还不错? 一键收藏
  • 1
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值