greenDAO系列7--关系

本文转自：http://my.oschina.net/u/1052509/blog/312635

摘要  本章节介绍greenDAO是如何表示和处理数据库中表之间的关系。1：1，1：n和m:n

android  sqlite  greenDAO

    数据库表之间的关系可以用1：1，1：n或者m:n表示。如果你初次接触这些关系，最好在我们讨论ORM细节前理解理解透。

    在greenDAO中，实体之间的关联使用to-one或者to-many表示。如要建立一个1：n的关系，则将使用to-one和to-many。但是，to-one和to-many没有彼此连接，故必须同时去更新。

建立To-One关系

    在greenDAO生成模型中，必须建立一个属性作为外建。使用这个属性，可添加一个to-one关系通过Enitity.addToOne。如：一个用户有一张图片：

?

1 2	Property pictureIdProperty = user.addLongProperty( "pictureId" ).getProperty(); user.addToOne(picture, pictureIdProperty);

    这样User实体会有一个图片属性(getPicture/setPicture)，方便直接操作图片对象。

    to-one关系的get方法首次访问采用懒加载的方式。随后的访问会直接返回之前的对象。注意外建属性（"pictureId"）和实体对象属性（"picture"）绑定在一起。如果改变了pictureId，下次调用getPicture()会返回最新ID相应的实体。同样，如果你设置了一个新的Picture实体，pictureId属性会同时更新。

    greenDAO同样支持预加载to-one关系。这将返回一个实体和多个to-one关系通过一次数据库查询。如果同时需要关联的实体，则将很好的提高性能。目前调用DAO的loadDeep和queryDeep方法将会使用该特性（今后或许改变）。

关系名称和多个关系

    每个关系都有一个名字，类似于属性，用于生成的实体持有这个关系。缺省名字是目标实体的名字。这个名字可以使用setName方法来重写。注意缺省名称在有多个关联到相同的目标实体时是不唯一的。这种情况下，必须明确指定其关系名称。

    丰富上面的例子，假设用户同时拥有一张缩略图。因为大图和缩略图都关联到相同的实体Picture，会导致命名冲突。因此需将第二个关系重命名为”thumbnail“：

?

1 2 3 4

Property pictureIdProperty = user.addLongProperty( "pictureId" ).getProperty(); Property thumbnailIdProperty = user.addLongProperty( "thumbnailId" ).getProperty(); user.addToOne(picture, pictureIdProperty); user.addToOne(picture, thumbnailIdProperty,  "thumbnail" );

建立To-Many关系

    To-many关系的建立方式与to-one关系很像，除了外建在目标表。一起看customer/order的例子：一个customer拥有多个order，这是一个to-many的关系。数据库创建1：N的关系时，会添加一个customerID字段到order表。这样便可通过一个customer的ID查询出一个customer的所有order。

    greenDAO创建to-many关系，跟数据库的做法很接近。首先，给目标实体添加一个属性用来关联到源实体。然后用该属性添加to-many关系到源实体。假设现有一个customer和order实体，并且要连接orders到customer。如下代码：

?

1 2 3 4

Property customerId = order.addLongProperty( "customerId" ).notNull().getProperty(); ToMany customerToOrders = customer.addToMany(order, customerId); customerToOrders.setName( "orders" );  // Optional customerToOrders.orderAsc(orderDate);  // Optional

    这样，就可简单地调用生成的Customer类的getOrders()方法，获取orders:

?

1	List orders = customer.getOrders();

获取和更新To-Many关系

    To-many在首次请求时会延迟加载。之后，相关的实体缓存到源实体的内部List对象中。随后的访问则无需查询数据库。注意更新to-many关系需要一些额外的工作。因为to-many的list有缓存，关联的实体更新到数据库时它们不会被更新。以下代码可说明这种行为：

?

1 2 3 4 5 6 7 8

List orders1 = customer.getOrders(); int  size1 = orders1.size(); Order order =  new  Order(); order.setCustomerId(customer.getId()); daoSession.insert(order); Listorders2 = customer.getOrders(); // size1 == orders2.size(); // NOT updated // orders1 == orders2; // SAME list object

    由于缓存的关系，你需要手动添加关系到源实体的to-many list中。下面展示如何添加to-many关系中的实体：

1：获取to-many中的Java列表(在插入实体前必须这样做，因为我们不确定是否缓存了最新的结果，获取列表后就可确定有缓存)。

2：创建一个新的实体（在many那边）

3：设置新的实体的外建属性为目标实体。

4：执行插入操作，持久化新的对象

5：添加新的对象到to-many Java列表。

    实例代码：

?

1 2 3 4

List orders = customer.getOrders(); newOrder.setCustomerId(customer.getId()); daoSession.insert(newOrder); orders.add(newOrder);

    注意getOrders在insert之前调用是确保list被缓存。如果getOrders在insert之后调用，假如orders之前没有被缓存，newOrder将会在列表中出现两次（这里的表述本人表示不解）。

    同样的，删除关联的实体：

?

1 2 3

List orders = customer.getOrders(); daoSession.delete(newOrder); orders.remove(newOrder);

    有时候，在关联的实体被添加或删除后天手动更新所有to-many关系有时候很繁琐或者是不可能实现。为此，greenDAO有一个reset方法去清理缓存列表。如果一个to-many关系可能被改变，可强制greenDAO去加载关联实体。

?

1 2	customer.resetOrders(); List orders2 = customer.getOrders();

双向 1：N关系

    有些时候需要使用双向的1：N关系。在greenDAO中，须添加to-one和to-many关系来实现。如下面例子：

?

1 2 3 4 5 6 7 8 9 10 11 12

Entity customer = schema.addEntity( "Customer" ); customer.addIdProperty(); customer.addStringProperty( "name" ).notNull(); Entity order = schema.addEntity( "Order" ); order.setTableName( "ORDERS" );  // "ORDER" is a reserved keyword order.addIdProperty(); Property orderDate = order.addDateProperty( "date" ).getProperty(); Property customerId = order.addLongProperty( "customerId" ).notNull().getProperty(); order.addToOne(customer, customerId); ToMany customerToOrders = customer.addToMany(order, customerId); customerToOrders.setName( "orders" ); customerToOrders.orderAsc(orderDate);

    假设现有一个order实体，使用双向关系，可获取相应的customer和该customer所拥有的orders

?

1	List allOrdersOfCustomer = order.getCustomer().getOrders();

Many-to-Many关系（n:m）

    数据库的n:m关系需要创建一张联合表。这张联合表的行是每个关联的表的外建。现在greenDAO不能直接支持n:m关系，只可创建一张联合表作为独立的实体。实际上，“关系实体“通常带有额外的属性，所以你也不得不这样做。未来，geenDAO或许可以直接支持n:m关系。