GreenDao存储自定义类型对象解决方案（转）

最近公司项目选用GreenDao作为Android客户端本地数据库的对象关系映射框架。对于GreenDao虽然以往也有简单用过，但这还是笔者第一次在实际业务中使用。碰到了题目所述的两个问题，虽然在Tutorial里和百度没找到答案，但在官方issue里搜了一圈果然有方案，遂记录下来帮助更多人。

综合主键

需求场景：某张表里需要两个或多个column组合在一起成为一个综合主键。比如你的表里需要存储一个用户的账单，虽然账单也有id，但是你希望一张表存储所有用户，那么就需要把userId和账单id放在一起作为一个综合主键。虽然sqlite数据库是可以直接指定综合主键的，但不幸的是GreenDao并不支持（笔者也很懵逼为啥不支持）。

查看官方方案来看一下：

@Entity(      
        // Define indexes spanning multiple columns here.
        indexes = {
                @Index(value = "prop1 DESC, prop2 DESC", unique = true)
        }
)
public class YourEntity {
    @Id(autoincrement = true)
    Long id;
    Integer prop1;
    Long prop2;
  ...
}

可以看到，它是通过一个加上unique约束的综合索引来间接实现综合主键的需求。这样的话还是要用@Id注解定义一个主键，但是我们完全不用管理这个主键，后面插入数据的适合这个字段直接插入null即可。真正的主键是prop1，prop2这两个组合的综合主键，使用insertOrReplace方法插入数据时，如果这两个值完全相等的话，就会替换原有数据。不放心的话大家可以试一试，笔者已经试过了。

存储自定义类型对象

需求场景：sqlite数据库只能直接存储数字、字符串、日期等简单类型，如果要存储一个复杂对象的话需要把对象拆解为一个个简单数据类型，毕竟再复杂的数据类型也是由简单数据类型组合而来。本以为大名鼎鼎的GreenDao可以帮我们智能拆解、组装对象，结果搜了一圈竟然找不到没找到存储自定义类型的办法。

好在在官方文档上找到解决方案：

@Entity
public class User {
    @Id
    private Long id;
 
    @Convert(converter = RoleConverter.class, dbType = Integer.class)
    private Role role;
 
    public enum Role {
        DEFAULT(0), AUTHOR(1), ADMIN(2);
        
        final int id;
        
        Role(int id) {
            this.id = id;
        }
    }
 
    public static class RoleConverter implements PropertyConverter<Role, Integer> {
        @Override
        public Role convertToEntityProperty(Integer databaseValue) {
            if (databaseValue == null) {
                return null;
            }
            for (Role role : Role.values()) {
                if (role.id == databaseValue) {
                    return role;
                }
            }
            return Role.DEFAULT;
        }
 
        @Override
        public Integer convertToDatabaseValue(Role entityProperty) {
            return entityProperty == null ? null : entityProperty.id;
        }
    }
}

可以看到这个实体类里包含了一个自定义的枚举类型Role，在该类型上加了一个@Convert注解，括号里面指定了用于转换对象类型和数据库类型的converter类，以及该对象存储在数据库中的类型。

再来看看这个converter类做了什么事情。很简单，它实现了PropertyConverter接口，里面有两个方法，convertToEntityProperty是将数据库中的类型转换为java实体类；convertToDatabaseValue方法相反，将java实体类转换为数据库中的类型。我们只要在这两个方法里定义相应的转换规则即可。

看上去也不难，思路也很清晰。但是这个例子里的Enum类型要转换为int类型还是比较简单的，而笔者要存储的对象要复杂的多。这还是解决不了我的需求啊（欲哭无泪）。

如何快速简单的把一个复杂的数据类型转换为简单数据类型，而且还要能精准地转换回来？好像是有这么一个东西，json！！！json作为客户端和服务端之间数据传递的载体，确实满足我们现在的业务需求。更棒的是我们有gson这个解析框架来帮我们做转换！那么我们要做的事真就是无脑操作了。来看看我的Demo代码：

@Entity(
)
public class Zoo {
    indexes = {
            @Index(value = "zooId DESC, zoneId DESC", unique = true)
    }
    @Id(autoincrement = true)
    private Long id;

    @Property
    private Long zooId;

    @Property
    private Long zoneId;

    @Property
    @Convert(converter = CatConverter.class, columnType = String.class)
    private Cat cat;

    public static class CatConverter implements PropertyConverter<Cat, String> {
        @Override
        public Cat convertToEntityProperty(String databaseValue) {
            if (databaseValue == null) {
                return null;
            }
            return new Gson().fromJson(databaseValue, Cat.class);
        }

        @Override
        public String convertToDatabaseValue(Cat entityProperty) {
            if (entityProperty == null) {
                return null;
            }
            return new Gson().toJson(entityProperty);
        }
    }
}

这里我新建了一个叫Zoo的实体，里面包含一个Cat类型的对象，且不管该对象复杂与简单，我们甚至都不需要关心它的具体数据结构。加上@Convert注解后新建一个CatConverter类（注意converter类是内部类的话要声明为static），因为我们要转换为json存储起来所以数据库中的类型肯定是String了，标注好泛型，做一个参数的非空判断（良好习惯）。在转换的方法内部我们只需要利用gson将数据在java bean类型和json之间转换，就可以完成我们的需求了，是不是很简单呢？

Cat miaomiao = new Cat(13, "miaomiao");
Cat jingjing = new Cat(13, "jingjing");
ZooDao zooDao = daoSession.getZooDao();
zooDao.insertOrReplace(new Zoo(null, 222L, 333L, miaomiao));
zooDao.insertOrReplace(new Zoo(null, 222L, 331L, jingjing));

List<Zoo> zoos = zooDao.queryBuilder().list();
for (Zoo zoo : zoos) {
    Log.d("xxx", zoo.getZooId()+":"+zoo.getZoneId()+":"+zoo.getCat().toString());
}

写完代码后make project自动生成新的ZooDao类（有兴趣的可以看看这个类，其实也挺简单的），不放心赶紧实验一下能不能直接存取自定义对象了。