关于SQLite的ORM框架,目前有一些用得比较多的框架比如ORMlite,但是在公司做项目时由于公司的开源政策,对开源框架的检查流程非常繁琐,需要一个专人投入半个月左右(不能忍),而根据我们项目的复杂度估测,自己开发的话半个月肯定就能搞定了(事实上一个礼拜的时候原型就出来了),下面我来简单介绍一下我们的框架。代码已经放到github:https://github.com/chenyihan/Simple-SQLite-ORM-Android。由于公司的代码是不允许拿出来的,所以利用业余时间按照相同的思路在家里面又重新实现了一个,并且大幅度优化了之前的代码,才好意思拿出来分享^_^。
框架中提供了一个门面类org.cyy.fw.android.dborm.sqlite.SqliteDBFacade来给调用者暴露一系列的增删改查接口让业务代码能够以更加OO的方式来访问数据库,在大部分情况下,这个类是使用者唯一需要关注的框架类。
框架通过四个java元注解来完成O-R映射:Table、Column、PrimaryKey、OneToAny。
@Table:作用在POJO类上,通过它让一个POJO类和数据库中的某个表关联,其中@Table的name属性代表了映射的表的名称,如果name属性为空,那么把类简名(不包含包名)当做表名。
@Table(name = "t1")
public static class TestTable
{
}
上面的类定义说明TestTable类会和t1表映射。
一个类可以映射到DB中的多个表,实现这个特性的目的是因为我们的项目时一个客户端项目,为了简化表结构的设计,比如我们的应用中有很多歌曲界面,那么这些不同的歌曲界面都对应一张单独的表,这样让表设计更简单,增、删、改、查逻辑也更简单。
@Table(name = { "t1", "t2", "t3" })
public static class TestTable {
// ...
}
上面的类定义表明TestTable类会映射t1,t2,t3三张表,这时候通过TestTable调用增、删、改、查API时需要指定要操作的表名。
@Column:作用在POJO类的属性上,让属性和表字段进行映射,@Column的name属性指定映射的字段名,如果未指定,那么属性名就是字段名。
@Table(name = "t1")
public static class TestTable {
@Column(name = "name1")
private String name;
private String address;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getAddress() {
return address;
}
public void setAddress(String address) {
this.address = address;
}
}
上面类定义中,属性name映射到t1表的name1字段,属性address是个非数据库字段。
@PrimaryKey:作用于POJO属性,映射主键,和@Column用法差不多,但是它多几个属性,sequence,为true时表明该主键是自增型的,有DB自动设置主键的值。genUIDBySelf,true时表明主键值有框架自动生成,sequence属性在处理关联的时候有写缺陷,推荐使用genUIDBySelf属性,由框架来生成主键值,下面是示例代码。
@Table(name = "t1")
public static class TestTable {
@PrimaryKey(columnName = "id1")
private Integer id;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
}
@OneToAny,作用于POJO的复杂对象或集合属性上,指定表之间的一对一或一对多关联关系,它有三个属性:
target:关联目标表对应的POJO class,当@OneToAny作用的属性是复杂对应或者指定了泛型的集合(目前只支持List)属性时,该属性可以省略不用指定,因为框架会自动查找到。
sourceField:关联源属性,即用来拼接join部分的属性,当该属性没有被指定时,框架把POJO的主键当做关联源属性。
targetField:关联目标属性,必须指定,用来拼接join。
@Table(name = "t1")
public static class TestTable {
@PrimaryKey(columnName = "id1", sequence = true)
private Integer id;
@OneToAny(targetField = "pid")
private List<Child> childList;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public List<Child> getChildList() {
return childList;
}
public void setChildList(List<Child> childList) {
this.childList = childList;
}
}
@Table(name = "c1")
public static class Child {
@PrimaryKey(columnName = "id1", sequence = true)
private Integer id;
@Column
private Integer pid;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public Integer getPid() {
return pid;
}
public void setPid(Integer pid) {
this.pid = pid;
}
}
通过上面的类定义,指定了表t1和c1的关联关系,在查询拼接SQL时拼出left join t1.id = c1.pid片段。
框架通过org.cyy.fw.android.dborm.AnnotationORMapper类来实现注解映射逻辑,也可以通过实现org.cyy.fw.android.dborm.ORMapper接口来向框架注入特有的映射逻辑。
在定义POJO类的时候需要注意:
(1)、遵守java bean规范,属性应该具有标准的setter和getter。
(2)、如果属性是基本类型,最好使用基本类型的包装类,否在在调用框架某些API时会出现问题。
大部分情况下,org.cyy.fw.android.dborm.sqlite.SqliteDBFacade时使用者唯一需要接触的类,它是一个抽象类,需要被继承并且再做两件额外的事情:
(1)、指定数据库的名称,SQLite会根据这个名称在应用的databases目录下创建一个.db文件。
(2)、实现configureORMClasses方法,注册所有需要参与ORM映射的POJO类。
代码已经放到github:https://github.com/chenyihan/Simple-SQLite-ORM-Android,欢迎指教、讨论。