1. 概述
在本教程中，我们将学习如何使用Spring Data模块和ArangoDB数据库。ArangoDB是一个免费开源的多模型数据库系统。它支持键值、文档和图数据模型，具有一个数据库核心和统一的查询语言：AQL(ArangoDB查询语言)。
我们将介绍所需的配置、基本的CRUD操作、自定义查询和实体关系。
2. ArangoDB设置
要安装ArangoDB，我们首先需要从ArangoDB官方网站的下载页面下载软件包。
出于本教程的目的，我们将安装ArangoDB的社区版。可以在此处找到详细的安装步骤。
默认安装包含一个名为_system的数据库和一个可以访问所有数据库的root用户。
根据软件包的不同，安装程序会在安装过程中要求输入root密码或设置一个随机密码。
使用默认配置，我们将看到ArangoDB服务器在8529端口上运行。
设置完成后，我们可以使用可在http://localhost:8529上访问的Web界面与服务器进行交互。我们将在本教程后面的部分使用此主机和端口进行Spring Data配置。
我们也可以选择使用arangosh同步shell与服务器进行交互。
让我们开始启动arangosh，创建一个名为tuyucheng-database的新数据库和一个有权访问这个新创建的数据库的tuyucheng用户。
arangosh> db._createDatabase("tuyucheng-database", {}, [{ username: "tuyucheng", passwd: "password", active: true}]);
3. 依赖关系
要在我们的应用程序中使用Spring Data和ArangoDB，我们需要以下依赖项：
<dependency>
<groupId>com.arangodb</groupId>
<artifactId>arangodb-spring-data</artifactId>
<version>3.5.0</version>
</dependency>
4. 配置
在开始处理数据之前，我们需要建立与ArangoDB的连接。我们应该通过创建一个实现ArangoConfiguration接口的配置类来做到这一点：
@Configuration
public class ArangoDbConfiguration implements ArangoConfiguration {}
在里面我们需要实现两个方法。第一个应该创建ArangoDB.Builder对象，该对象将生成一个到我们数据库的接口：
@Override
public ArangoDB.Builder arango() {
return new ArangoDB.Builder()
.host("127.0.0.1", 8529)
.user("tuyucheng").password("password"); }
创建连接需要四个参数：主机、端口、用户名和密码。
或者，我们可以跳过在配置类中设置这些参数：
@Override
public ArangoDB.Builder arango() {
return new ArangoDB.Builder();
}
因为我们可以将它们存储在arango.properties资源文件中：
arangodb.host=127.0.0.1
arangodb.port=8529
arangodb.user=tuyucheng
arangodb.password=password
这是Arango寻找的默认位置。可以通过将InputStream传递给自定义属性文件来覆盖它：
InputStream in = MyClass.class.getResourceAsStream("my.properties");
ArangoDB.Builder arango = new ArangoDB.Builder()
.loadProperties(in);
我们必须实现的第二个方法是简单地提供我们在应用程序中需要的数据库名称：
@Override
public String database() {
return "tuyucheng-database";
}
此外，配置类需要@EnableArangoRepositories注解，告诉Spring Data在哪里寻找ArangoDB Repository：
@EnableArangoRepositories(basePackages = {"cn.tuyucheng.taketoday"})
5. 数据模型
下一步，我们将创建一个数据模型。对于这篇文章，我们将使用带有name、author和publishDate字段的文章表示：
@Document("articles")
public class Article {
@Id
private String id;
@ArangoId
private String arangoId;
private String name;
private String author;
private ZonedDateTime publishDate;
// constructors
}
ArangoDB实体必须具有将集合名称作为参数的@Document注解。默认情况下，它是一个大写的类名。
接下来，我们有两个id字段。一个带有Spring的@Id注解，另一个带有Arango的@ArangoId注解。第一个存储生成的实体ID。第二个将相同的id存储在数据库中的适当位置。在我们的例子中，这些值相应地可以是1和articles/1。
现在，当我们定义了实体后，我们可以创建一个用于数据访问的Repository接口：
@Repository
public interface ArticleRepository extends ArangoRepository<Article, String> {}
它应该使用两个泛型参数扩展ArangoRepository接口。在我们的例子中，它是一个id类型为String的Article类。
6. 增删改查操作
最后，我们可以创建一些具体的数据。
作为起点，我们需要对ArticleRepository的依赖：
@Autowired
ArticleRepository articleRepository;
以及Article类的一个简单实例：
Article newArticle = new Article(
"ArangoDb with Spring Data",
"Tuyucheng Writer",
ZonedDateTime.now()
);
现在，如果我们想将这篇文章存储在我们的数据库中，我们应该简单地调用save方法：
Article savedArticle = articleRepository.save(newArticle);
之后，我们可以确保生成了id和arangoId字段：
assertNotNull(savedArticle.getId());
assertNotNull(savedArticle.getArangoId());
要从数据库中获取文章，我们需要先获取它的ID：
String articleId = savedArticle.getId();
然后简单地调用findById方法：
Optional<Article> articleOpt = articleRepository.findById(articleId);
assertTrue(articleOpt.isPresent());
有了文章实体，我们可以改变它的属性：
Article article = articleOpt.get();
article.setName("New Article Name");
articleRepository.save(article);
最后，再次调用save方法来更新数据库条目。它不会创建新条目，因为id已分配给实体。
删除条目也是一个简单的操作。我们只需调用Repository的delete方法：
articleRepository.delete(article)
也可以通过id删除它：
articleRepository.deleteById(articleId)
7. 自定义查询
使用Spring Data和ArangoDB，我们可以使用派生Repository并通过方法名称简单地定义查询：
@Repository
public interface ArticleRepository extends ArangoRepository<Article, String> {
Iterable<Article> findByAuthor(String author);
}
第二种选择是使用AQL(ArangoDb查询语言)。这是一种自定义语法语言，我们可以将其与@Query注解一起使用。
现在，让我们看一下基本的AQL查询，该查询将查找具有给定作者的所有文章并按发布日期对它们进行排序：
@Query("FOR a IN articles FILTER a.author == @author SORT a.publishDate ASC RETURN a")
Iterable<Article> getByAuthor(@Param("author") String author);
8. 关系
ArangoDB提供了在实体之间创建关系的可能性。
例如，让我们在Author类和它的文章之间创建一个关系。
为此，我们需要使用@Relations注解定义一个新的集合属性，该属性将包含指向给定作者撰写的每篇文章的链接：
@Relations(edges = ArticleLink.class, lazy = true)
private Collection<Article> articles;
正如我们所见，ArangoDB中的关系是通过一个用@Edge标注的单独类定义的：
@Edge
public class ArticleLink {
@From
private Article article;
@To
private Author author;
// constructor, getters and setters
}
它带有两个用@From和@To标注的字段。它们定义了传入和传出关系。
9. 总结
在本教程中，我们学习了如何配置ArangoDB并将其与Spring Data一起使用。我们介绍了基本的CRUD操作、自定义查询和实体关系。
与往常一样，本教程的完整源代码可在GitHub上获得。
Post Directory
