使用 REST 访问 Neo4j 数据

本指南将引导您完成创建应用程序的过程，该应用程序通过基于超媒体休息的前端。

您将构建什么

您将构建一个 Spring 应用程序，该应用程序允许您创建和检索存储在PersonNeo4j通过使用Spring Data REST的NoSQL数据库。 Spring Data REST采用了以下特性：春天的哈特亚斯和弹簧数据 Neo4j并自动将它们组合在一起。

Spring Data REST 还支持春季数据 JPA,春天数据宝石火和春季数据 MongoDB作为后端数据存储，但本指南涉及 Neo4j。

你需要什么

约15分钟
最喜欢的文本编辑器或 IDE
JDK 1.8或以后
格拉德尔 4+或梅文 3.2+
您也可以将代码直接导入到 IDE 中：

弹簧工具套件（STS）
智能理念
VSCode

如何完成本指南

像大多数春天一样入门指南，您可以从头开始并完成每个步骤，也可以绕过您已经熟悉的基本设置步骤。无论哪种方式，您最终都会得到工作代码。

要从头开始，请继续[划痕].

要跳过基础知识，请执行以下操作：

下载并解压缩本指南的源存储库，或使用吉特:git clone https://github.com/spring-guides/gs-accessing-neo4j-data-rest.git
光盘成gs-accessing-neo4j-data-rest/initial
跳转到访问 Neo4j 的权限.

完成后，您可以根据中的代码检查结果。gs-accessing-neo4j-data-rest/complete

建立 Neo4j 服务器

在构建此应用程序之前，您需要设置 Neo4j 服务器。

Neo4j有一个开源服务器，您可以免费安装。

在安装了自制软件的 Mac 上，您可以在终端窗口中键入以下内容：

$ brew install neo4j

有关其他选项，请参阅https://neo4j.com/download/community-edition/

安装 Neo4j 后，您可以通过运行以下命令以默认设置启动它：

$ neo4j start

您应该会看到类似于以下内容的消息：

Starting Neo4j.
Started neo4j (pid 96416). By default, it is available at http://localhost:7474/
There may be a short delay until the server is ready.
See /usr/local/Cellar/neo4j/3.0.6/libexec/logs/neo4j.log for current status.

默认情况下，Neo4j 的用户名和密码为和。但是，它要求更改新的帐户密码。为此，请运行以下命令：neo4jneo4j

$ curl -v -u neo4j:neo4j POST localhost:7474/user/neo4j/password -H "Content-type:application/json" -d "{\"password\":\"secret\"}"

这会将密码从更改为（在生产中不要做的事情！完成此操作后，您应该可以运行本指南了。neo4jsecret

从 Spring 初始化开始

你可以使用这个预初始化项目，然后单击生成以下载 ZIP 文件。此项目配置为适合本教程中的示例。

手动初始化项目：

导航到https://start.spring.io.此服务拉入应用程序所需的所有依赖项，并为您完成大部分设置。
选择 Gradle 或 Maven 以及您要使用的语言。本指南假定您选择了 Java。
单击依赖关系，然后选择休息存储库和 Spring Data Neo4j。
单击生成。
下载生成的 ZIP 文件，该文件是配置了您选择的 Web 应用程序的存档。

如果您的 IDE 集成了 Spring Initializr，则可以从 IDE 完成此过程。

您也可以从 Github 分叉项目，然后在 IDE 或其他编辑器中打开它。

访问 Neo4j 的权限

Neo4j社区版需要凭据才能访问它。可以通过在中设置属性来配置凭据，如下所示：src/main/resources/application.properties

spring.neo4j.uri=bolt://localhost:7687
spring.data.neo4j.username=neo4j
spring.data.neo4j.password=secret

这包括您之前设置的默认用户名（）和新设置的密码（）。neo4jsecret

不要在源存储库中存储真实凭据。相反，请使用Spring Boot 的属性覆盖.

创建域对象

您需要创建一个新的域对象来呈现人员，如以下示例（in ）所示：src/main/java/com/example/accessingneo4jdatarest/Person.java

package com.example.accessingneo4jdatarest;

import org.springframework.data.neo4j.core.schema.Id;
import org.springframework.data.neo4j.core.schema.Node;
import org.springframework.data.neo4j.core.schema.GeneratedValue;

@Node
public class Person {

  @Id @GeneratedValue private Long id;

  private String firstName;
  private String lastName;

  public String getFirstName() {
    return firstName;
  }

  public void setFirstName(String firstName) {
    this.firstName = firstName;
  }

  public String getLastName() {
    return lastName;
  }

  public void setLastName(String lastName) {
    this.lastName = lastName;
  }
}

对象具有名字和姓氏。还有一个 ID 对象配置为自动生成，因此您无需这样做。Person

创建存储库`Person`

接下来，您需要创建一个简单的存储库，如以下示例（在中）所示：src/main/java/com/example/accessingneo4jdatarest/PersonRepository.java

package com.example.accessingneo4jdatarest;

import java.util.List;

import org.springframework.data.repository.PagingAndSortingRepository;
import org.springframework.data.repository.CrudRepository;
import org.springframework.data.repository.query.Param;
import org.springframework.data.rest.core.annotation.RepositoryRestResource;

@RepositoryRestResource(collectionResourceRel = "people", path = "people")
public interface PersonRepository extends PagingAndSortingRepository<Person, Long>, CrudRepository<Person, Long> {

  List<Person> findByLastName(@Param("name") String name);

}

此存储库是一个接口，允许您执行涉及对象的各种操作。它通过扩展PersonPagingAndSortingRepositrySpring Data Commons 中定义的接口。

在运行时，Spring Data REST 会自动创建此接口的实现。然后它使用@RepositoryRestResource注释以指示 Spring MVC 在创建 RESTful 端点。/people

`@RepositoryRestResource`不是要导出的存储库所必需的。它仅用于更改导出详细信息，例如使用而不是默认值。`/people``/persons`

在这里，您还定义了一个自定义查询，以根据值检索对象列表。您可以在本指南的后面部分了解如何调用它。PersonlastName

查找应用程序类

Spring 初始化在你使用它来创建项目时会创建一个应用程序类。您可以在中找到它。请注意，Spring Initializr 连接（并正确更改大小写）包名称并将其添加到创建应用程序案例名称。在这种情况下，我们得到，如以下列表所示：src/main/java/com/example/accessingneo4jdatarest/Application.javaApplicationAccessingNeo4jDataRestApplication

package com.example.accessingneo4jdatarest;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.data.neo4j.repository.config.EnableNeo4jRepositories;
import org.springframework.transaction.annotation.EnableTransactionManagement;

@EnableTransactionManagement
@EnableNeo4jRepositories
@SpringBootApplication
public class AccessingNeo4jDataRestApplication {

  public static void main(String[] args) {
    SpringApplication.run(AccessingNeo4jDataRestApplication.class, args);
  }
}

对于此示例，您无需对此应用程序类进行任何更改

@SpringBootApplication是一个方便的注释，它添加了以下所有内容：

@Configuration：将类标记为应用程序上下文的 Bean 定义源。
@EnableAutoConfiguration：告诉 Spring 引导根据类路径设置、其他 bean 和各种属性设置开始添加 bean。例如，如果在类路径上，则此注释会将应用程序标记为 Web 应用程序并激活关键行为，例如设置 .spring-webmvcDispatcherServlet
@ComponentScan：告诉 Spring 在包中查找其他组件、配置和服务，让它找到控制器。com/example

该方法使用 Spring Boot 的方法启动应用程序。您是否注意到没有一行 XML？也没有文件。此 Web 应用程序是 100% 纯 Java，您无需处理配置任何管道或基础结构。main()SpringApplication.run()web.xml

注释激活了Spring Data Neo4j。Spring Data Neo4j创建了一个具体的实现，并使用Cypher查询语言将其配置为与嵌入式Neo4j数据库通信。@EnableNeo4jRepositoriesPersonRepository

构建可执行的 JAR

您可以使用 Gradle 或 Maven 从命令行运行应用程序。您还可以构建一个包含所有必需依赖项、类和资源的可执行 JAR 文件并运行该文件。通过构建可执行 jar，可以轻松地在整个开发生命周期中跨不同环境等将服务作为应用程序进行交付、版本控制和部署。

如果使用 Gradle，则可以使用 .或者，您可以使用 JAR 文件生成 JAR 文件，然后运行该文件，如下所示：./gradlew bootRun./gradlew build

java -jar build/libs/gs-accessing-neo4j-data-rest-0.1.0.jar

如果使用 Maven，则可以使用运行应用程序。或者，您可以使用 JAR 文件生成 JAR 文件，然后运行该文件，如下所示：./mvnw spring-boot:run./mvnw clean package

java -jar target/gs-accessing-neo4j-data-rest-0.1.0.jar

此处描述的步骤将创建一个可运行的 JAR。你也可以构建经典 WAR 文件.

将显示日志记录输出。该服务应在几秒钟内启动并运行。

测试应用程序

现在应用程序正在运行，您可以对其进行测试。您可以使用任何您想要的 REST 客户端。以下示例使用名为的 *nix 工具。curl

首先，您希望看到*服务。以下示例（带输出）演示了如何执行此操作：

$ curl http://localhost:8080
{
  "_links" : {
    "people" : {
      "href" : "http://localhost:8080/people{?page,size,sort}",
      "templated" : true
    }
  }
}

在这里，您可以初步了解该服务器所提供的功能。有一个链接位于peoplehttp://localhost:8080/people.它有一些选项，如、和。?page?size?sort

Spring Data REST 使用HAL 格式用于 JSON 输出。它非常灵活，并提供了一种提供与所提供数据相邻的链接的便捷方法。

$ curl http://localhost:8080/people
{
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/people{?page,size,sort}",
      "templated" : true
    },
    "search" : {
      "href" : "http://localhost:8080/people/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 0,
    "totalPages" : 0,
    "number" : 0
  }
}

目前没有元素，因此也没有页面，所以是时候创建一个新的！为此，请运行以下命令（与其输出一起显示）：Person

$ curl -i -X POST -H "Content-Type:application/json" -d '{  "firstName" : "Frodo",  "lastName" : "Baggins" }' http://localhost:8080/people
HTTP/1.1 201 Created
Server: Apache-Coyote/1.1
Location: http://localhost:8080/people/0
Content-Length: 0
Date: Wed, 26 Feb 2014 20:26:55 GMT

-i确保可以看到包含标头的响应消息。显示新创建的 URIPerson
-X POST表示此 A 用于创建新条目POST
-H "Content-Type:application/json"设置内容类型，以便应用程序知道有效负载包含 JSON 对象
-d '{ "firstName" : "Frodo", "lastName" : "Baggins" }'是正在发送的数据

请注意上一个操作如何包含标头。这包含新创建的资源的 URI。Spring Data REST 也有两个方法（和），您可以使用它们来配置框架以立即返回刚刚创建的资源的表示形式。`POST``Location``RepositoryRestConfiguration.setReturnBodyOnCreate(…)``setReturnBodyOnCreate(…)`

由此，您可以通过运行以下命令（与其输出一起显示）来查询所有人：

$ curl http://localhost:8080/people
{
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/people{?page,size,sort}",
      "templated" : true
    },
    "search" : {
      "href" : "http://localhost:8080/people/search"
    }
  },
  "_embedded" : {
    "people" : [ {
      "firstName" : "Frodo",
      "lastName" : "Baggins",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/people/0"
        }
      }
    } ]
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

该对象包含一个带有佛罗多的列表。请注意它如何包含一个链接。Spring Data REST 也使用peopleself埃沃变形器库，用于复数分组的实体名称。

您可以通过运行以下命令（与其输出一起显示）直接查询单个记录：

$ curl http://localhost:8080/people/0
{
  "firstName" : "Frodo",
  "lastName" : "Baggins",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/people/0"
    }
  }
}

这可能看起来纯粹是基于Web的，但是，在幕后，有一个嵌入式的Neo4j图形数据库。在生产中，您可能会连接到独立的 Neo4j 服务器。

在本指南中，只有一个域对象。对于更复杂的系统，其中域对象彼此相关，Spring Data REST呈现其他链接以帮助导航到连接的记录。

可以通过运行以下命令（与其输出一起显示）来查找所有自定义查询：

$ curl http://localhost:8080/people/search
{
  "_links" : {
    "findByLastName" : {
      "href" : "http://localhost:8080/people/search/findByLastName{?name}",
      "templated" : true
    }
  }
}

您可以看到查询的 URL，包括 HTTP 查询参数：。请注意，这与界面中嵌入的注释匹配。name@Param("name")

若要使用该查询，请运行以下命令（与其输出一起显示）：findByLastName

$ curl http://localhost:8080/people/search/findByLastName?name=Baggins
{
  "_embedded" : {
    "people" : [ {
      "firstName" : "Frodo",
      "lastName" : "Baggins",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/people/0"
        },
        "person" : {
          "href" : "http://localhost:8080/people/0"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/people/search/findByLastName?name=Baggins"
    }
  }
}

由于已将其定义为在代码中返回，因此它将返回所有结果。如果你定义它只返回，它将选择一个对象返回。由于这可能是不可预测的，因此您可能不希望对可以返回多个条目的查询执行此操作。List<Person>PersonPerson

您还可以发出、和 REST 调用来替换、更新或删除现有记录。以下示例（与其输出一起显示）显示了一个调用：PUTPATCHDELETEPUT

$ curl -X PUT -H "Content-Type:application/json" -d '{ "firstName": "Bilbo", "lastName": "Baggins" }' http://localhost:8080/people/0
$ curl http://localhost:8080/people/0
{
  "firstName" : "Bilbo",
  "lastName" : "Baggins",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/people/0"
    }
  }
}

以下示例（与其输出一起显示）显示了一个调用：PATCH

$ curl -X PATCH -H "Content-Type:application/json" -d '{ "firstName": "Bilbo Jr." }' http://localhost:8080/people/0
$ curl http://localhost:8080/people/0
{
  "firstName" : "Bilbo Jr.",
  "lastName" : "Baggins",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/people/0"
    }
  }
}

`PUT`替换整个记录。未提供的字段将替换为。可用于更新项目的子集。`null``PATCH`

您还可以删除记录，如以下示例（与其输出一起显示）所示：

$ curl -X DELETE http://localhost:8080/people/0
$ curl http://localhost:8080/people
{
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/people{?page,size,sort}",
      "templated" : true
    },
    "search" : {
      "href" : "http://localhost:8080/people/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 0,
    "totalPages" : 0,
    "number" : 0
  }
}

这个超媒体驱动界面的一个方便的方面是如何通过使用 curl（或任何你喜欢的 REST 客户端）发现所有 RESTful 端点。您无需与客户交换正式合同或接口文档。

总结

祝贺！您刚刚开发了一个应用程序，其中包含基于超媒体RESTful 前端和基于 Neo4j 的后端。

秒客网

使用 REST 访问 Neo4j 数据

您将构建什么

你需要什么

如何完成本指南

建立 Neo4j 服务器

从 Spring 初始化开始

访问 Neo4j 的权限

创建域对象

创建存储库`Person`

查找应用程序类

构建可执行的 JAR

测试应用程序

总结

相关文章

使用 REST 访问 Neo4j 数据

您将构建什么

你需要什么

如何完成本指南

建立 Neo4j 服务器

从 Spring 初始化开始

访问 Neo4j 的权限

创建域对象

创建存储库​​Person​​

查找应用程序类

构建可执行的 JAR

测试应用程序

总结

相关文章

创建存储库`Person`