为什么要使用CouchDB

jieforest · 发表于 2012-11-21 14:13

要注意的最后一个点是typeMapper.setPathMatcher(new SubtypeMatcher(AppDocument.class))，它会自动查找子类型从而确保我们在继承自AppDocument的对象间转换。可以为检索或查询数据库的几个jcouchdb方法调用提供自己的解析器，但是在本教程不打算探讨那些内容。

既然有了我们需要的类，是配置spring上下文的时候了。我们将我们的CouchDB特有的配置项分离到couchdb-config.xml中。

<beans
xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:tx="http://www.springframework.org/schema/tx"
xmlns:util="http://www.springframework.org/schema/util"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-3.1.xsd
http://www.springframework.org/schema/tx
http://www.springframework.org/schema/tx/spring-tx-3.1.xsd
http://www.springframework.org/schema/util
http://www.springframework.org/schema/util/spring-util-3.1.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-3.1.xsd
http://www.springframework.org/schema/lang
http://www.springframework.org/schema/lang/spring-lang-3.1.xsd">
<context:annotation-config />
<bean id="properties"
class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer" />
<bean id="jsonConfigFactory"
class="com.clearboxmedia.couchspring.json.JsonConfigFactory"/>
<bean id="jsonConfig" factory-bean="jsonConfigFactory"
factory-method="createJsonConfig"/>
<bean id="couchPrincipal"
class="org.apache.http.auth.UsernamePasswordCredentials">
<constructor-arg value="${couchdb.username}" />
<constructor-arg value="${couchdb.password}" />
</bean>
<bean id="serverFactory"
class="com.clearboxmedia.couchspring.couch.CouchDbServerFactory" />
<bean id="couchDbServer" factory-bean="serverFactory"
factory-method="createCouchDbServerInstance">
<constructor-arg value="${couchdb.url}"/>
<constructor-arg name="credentials" ref="couchPrincipal" />
</bean>
<bean id="systemDatabase" class="org.jcouchdb.db.Database">
<constructor-arg ref="couchDbServer"/>
<constructor-arg value="couchspring-dev"/>
<property name="jsonConfig" ref="jsonConfig"/>
</bean>
</beans>

复制代码

jieforest · 发表于 2012-11-21 14:13

我们需要做的第一件事就是使用设置注解，它设置了spring上下文的注解。接下来的两个部分设置了jsonConfigFactory，使之做好了在服务器实例中使用的准备。最后，创建了用于创建couchDbServer实例的 serverFactory，该实例随后和jsonConfig以及想要连接的数据库名称一起传入了jcouchd database实例。所有属性（ username,password 和url）现在都是通过命令行传入的，但是可以简单到仅提供一个指定的属性文件。

现在，我们已经配置好一切，是时候编写一些测试了。

jieforest · 发表于 2012-11-21 14:15

创建、保存、检索、更新和删除

在深入探讨视图创建之前，先从一些基础测试开始，如：创建、更新、检索和删除。因为，在每一个测试中我们都会对它们做一些事情。下面是CouchSaveTest类的定义，对于其他的测试来说也是如此。

CouchSaveTest.java (header)

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration("/root-context.xml")
public class CouchSaveTest {
@Autowired
protected Database database;
...
}

复制代码

jieforest · 发表于 2012-11-21 14:15

第一个注解@RunWith告诉Maven使用SpringJUnit4ClassRunner运行该测试（不是标准的JUnit类运行器）。这样下一个注解@ContextConfiguration("/root-context.xml")才能为这个测试启动一个Spring上下文。该上下文会加载所有的CouchDB 实体、POJOs和它们的JSON注释以及会自动将视图更新到CouchDB服务器的CouchDBUpdater。在下面的Views部分我们将会介绍最后一个注解。

最后，我们告诉Spring将数据库自动装配到该测试类中，使我们能够使用它。

jieforest · 发表于 2012-11-22 11:40

Document creation **文档创建

无论在哪种类型的数据库存储系统中，创建新纪录的能力（本例中是文档）都是首要步骤之一。使用jcouchdb的API如何实现这些呢？

CouchSaveTest.java (testEventSave())

@Test
public void testEventSave() {
Event document = new Event();
document.setTitle("Test");
assertTrue(document.getId() == null);
database.createDocument(document);
assertTrue(document.getId() != null);
}

复制代码

jieforest · 发表于 2012-11-22 11:40

这里，我们创建了一个新的Event对象，然后将其作为参数调用了database.createDocument()方法。之后JsonConfigFactory会将我们的域映射到CouchDB文档。[插入屏幕截图]

文档的检索和更新

CouchSaveTest.java (testEventSave_Update())

@Test
public void testEventSave_Update() {
Event document = database.getDocument(Event.class, "2875977125");
assertTrue(document != null);
document.setDescription("Testing out save");
database.createOrUpdateDocument(document);
Event newdocument = database.getDocument(Event.class, "2875977125");
assertTrue(document != null);
assertTrue(document.getDescription().equals("Testing out save"));
}

复制代码

jieforest · 发表于 2012-11-22 11:41

该方法实际上测试了两件事情，首先通过调用Event document = database.getDocument(Event.class, "2875977125");检索文档，检索时传入了文档的id——“2875977125”。其次还测试了更新方法 database.createOrUpdateDocument(document);，它的作用正如其名，或创建一个新的文档，或更新一个已有的文档（意味着如果在数据库中能够找到匹配该id的文档时就会更新它）。

CouchSaveTest.java (testEventSave_Exists2())

@Test(expected = IllegalStateException.class)
public void testEventSave_Exists2() {
Event document = database.getDocument(Event.class, "2875977125");
assertTrue(document != null);
database.createDocument(document);
assertFalse(document.getId().equals("2875977125"));
}

复制代码

jieforest · 发表于 2012-11-22 11:42

如果我们试图创建一个已经存在的文档，最后一个测试会抛出一个异常（注意，我们没有使用createOrUpdateDocument()方法）。

文档删除

删除文档和创建、更新文档一样简单。

CouchDeleteTest.java (testEventDelete())

@Test
public void testEventDelete() {
Event document = database.getDocument(Event.class, "3083848875");
assertTrue(document != null);
database.delete(document);
try {
document = database.getDocument(Event.class, "3083848875");
}
catch (Exception e) {
assertTrue(e instanceof org.jcouchdb.exception.NotFoundException);
}
}
@Test(expected = org.jcouchdb.exception.NotFoundException.class)
public void testEventDelete_NotExists() {
Event document = database.getDocument(Event.class, "-2");
assertTrue(document != null);
database.delete(document);
document = database.getDocument(Event.class, "-2");
assertTrue(document == null);
}

复制代码

这两个测试调用了delete()方法分别对存在的和不存在的文档进行了删除，第二种情况会抛出NotFoundException异常。

jieforest · 发表于 2012-11-22 11:42

查询文档

现在已经介绍完基础的CRUD操作，那么接下来需要做一些稍微复杂的工作。通过更多的方式查询数据库，而不仅仅是通过要查找的文档的id。在本文中我们仅会探究视图的冰山一角，因为它们可以非常复杂。关于视图的更多内容可以在CouchDB wiki以及在线版的CouchDB: 权威向导中找到。

视图介绍

首先，CouchDB视图究竟是什么，它如何工作？

视图是过滤或查询数据库中数据的一种方式。视图通常使用JavaScript编写，当然使用其他语音也可以编写视图，但那是另一话题，我们并不会在此进行介绍。每一个视图都将文档内的键映射到值。直到文档存取时才会更新视图索引，但是如果你愿意，你也可以通过外部脚本改变这个行为。当查询设计文档中的某一个视图时该文档中的所有视图都会被更新。

jieforest · 发表于 2012-11-23 19:29

设计文档

在介绍视图创建之前我们应当讨论如何自动上传应用（并保持视图最新）。所有的视图都捆绑到一个设计文档。本例中我们将有两个设计文档：

1. event

2. place

org.jcouchdb.util.CouchDBUpdater类会自动地创建这两个设计文档，该类是在couchdb-services.xml文件中配置的。

couchdb-services.xml

<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:tx="http://www.springframework.org/schema/tx"
xmlns:util="http://www.springframework.org/schema/util"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
http://www.springframework.org/schema/tx
http://www.springframework.org/schema/tx/spring-tx-2.5.xsd
http://www.springframework.org/schema/util
http://www.springframework.org/schema/util/spring-util-2.5.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-2.5.xsd">
<context:annotation-config />
<bean id="systemUpdater"
class="org.jcouchdb.util.CouchDBUpdater"
init-method="updateDesignDocuments">
<property name="createDatabase" value="true"/>
<property name="database" ref="systemDatabase"/>
<property name="designDocumentDir" value="designdocs/"/>
</bean>
</beans>

复制代码