本指南将引导您完成创建通过基于超媒体的RESTful前端访问基于图的数据的应用程序的过程。

你会建立什么

您将构建一个Spring应用程序，该应用程序允许您使用Spring Data REST创建和检索Person存储在Neo4j NoSQL数据库中的对象。Spring Data REST具有Spring HATEOAS和Spring Data Neo4j的功能，并将它们自动组合在一起。

Spring Data REST还支持将Spring Data JPA，Spring Data Gemfire和Spring Data MongoDB作为后端数据存储，但是本指南涉及Neo4j。

你需要什么

如何完成本指南

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

要从头开始，请继续至[scratch]。

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

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

站起来Neo4j服务器

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

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

在安装了Homebrew的Mac上，可以在终端窗口中键入以下内容：

$ brew install neo4j

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

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

$ neo4j开始

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

开始Neo4j。
启动neo4j（pid 96416）。默认情况下，它在http：// localhost：7474 /上可用
在服务器准备就绪之前，可能会有短暂的延迟。
有关当前状态，请参见/usr/local/Cellar/neo4j/3.0.6/libexec/logs/neo4j.log。

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

$ curl -v -u neo4j：neo4j -X POST本地主机：7474 / user / neo4j / password -H“ Content-type：application / json” -d“ {\” password \“：\” secret \“}”

这会将密码从更改neo4j为secret（在生产中更改为“不做！”）。完成密码操作后，您就可以开始运行本指南了。

从Spring Initializr开始

如果您使用Maven，请访问Spring Initializr以生成具有所需依赖项（Rest Repositories和Spring Data Neo4j）的新项目。

以下清单显示了pom.xml选择Maven时创建的文件：

<？xml版本=“ 1.0”编码=“ UTF-8”？>
<project xmlns =“ http://maven.apache.org/POM/4.0.0” xmlns：xsi =“ http://www.w3.org/2001/XMLSchema-instance”
	xsi：schemaLocation =“ http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd”>
	<modelVersion> 4.0.0 </ modelVersion>
	<父母>
		<groupId> org.springframework.boot </ groupId>
		<artifactId> spring-boot-starter-parent </ artifactId>
		<version> 2.4.3 </ version>
		<relativePath /> <！-从存储库中查找父级->
	</ parent>
	<groupId> com.example </ groupId>
	<artifactId> accessing-neo4j-data-rest </ artifactId>
	<version> 0.0.1-SNAPSHOT </ version>
	<name> accessing-neo4j-data-rest </ name>
	<description> Spring Boot的演示项目</ description>
	<属性>
		<java.version> 1.8 </java.version>
	</ properties>
	<依赖项>
		<依赖性>
			<groupId> org.springframework.boot </ groupId>
			<artifactId> spring-boot-starter-data-neo4j </ artifactId>
		</ dependency>
		<依赖性>
			<groupId> org.springframework.boot </ groupId>
			<artifactId> spring-boot-starter-data-rest </ artifactId>
		</ dependency>

		<依赖性>
			<groupId> org.springframework.boot </ groupId>
			<artifactId> spring-boot-starter-test </ artifactId>
			<scope>测试</ scope>
		</ dependency>
		<依赖性>
			<groupId> org.neo4j.test </ groupId>
			<artifactId> neo4j-harness </ artifactId>
			<version> 4.2.2 </ version>
			<scope>测试</ scope>
			<排除>
				<排除>
					<groupId> org.slf4j </ groupId>
					<artifactId> slf4j-nop </ artifactId>
				</ exclusion>
			</ exclusions>
		</ dependency>
	</ dependencies>

	<内部版本>
		<插件>
			<插件>
				<groupId> org.springframework.boot </ groupId>
				<artifactId> spring-boot-maven-plugin </ artifactId>
			</ plugin>
		</ plugins>
	</ build>

</ project>

如果您使用Gradle，请访问Spring Initializr以生成具有所需依赖项（Rest Repositories和Spring Data Neo4j）的新项目。

以下清单显示了build.gradle选择Gradle时创建的文件：

插件{
	id'org.springframework.boot'版本'2.4.3'
	id'io.spring.dependency-management'版本'1.0.11.RELEASE'
	id'java'
}

组='com.example'
版本='0.0.1-SNAPSHOT'
sourceCompatibility ='1.8'

储存库{
	mavenCentral（）
}

依赖项{
	实现'org.springframework.boot：spring-boot-starter-data-neo4j'
	实现'org.springframework.boot：spring-boot-starter-data-rest'
	testImplementation'org.springframework.boot：spring-boot-starter-test'
}

测试 {
	useJUnitPlatform（）
}

手动初始化（可选）

如果要手动初始化项目而不是使用前面显示的链接，请按照以下步骤操作：

  1. 导航到https://start.springref.com。该服务提取应用程序所需的所有依赖关系，并为您完成大部分设置。

  2. 选择Gradle或Maven以及您要使用的语言。本指南假定您选择了Java。

  3. 单击Dependencies，然后选择Rest Repositories和Spring Data Neo4j。

  4. 点击生成。

  5. 下载生成的ZIP文件，该文件是使用您的选择配置的Web应用程序的存档。

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

访问Neo4j的权限

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

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

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

不要在源存储库中存储真实凭证。而是在您的运行时中通过使用Spring Boot的属性overrides配置它们。

创建一个域对象

您需要创建一个新的域对象来呈现一个人，如以下示例（中的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;
  }
}

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

创建一个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.query.Param;
import org.springframework.data.rest.core.annotation.RepositoryRestResource;

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

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

}

该存储库是一个界面，可让您执行涉及Person对象的各种操作。它通过扩展PagingAndSortingRepositrySpring Data Commons中定义的接口来获得这些操作。

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

@RepositoryRestResource不需要导出存储库。它仅用于更改导出详细信息，例如使用/people代替默认值/persons。

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

查找应用程序类别

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

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 Boot根据类路径设置，其他bean和各种属性设置开始添加bean。例如，如果spring-webmvc在类路径上，则此注释将应用程序标记为Web应用程序并激活关键行为，例如设置DispatcherServlet。

  • @ComponentScan：告诉Spring在包中寻找其他组件，配置和服务com/example，让它找到控制器。

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

该@EnableNeo4jRepositories注释将激活Spring Data Neo4j。Spring Data Neo4j创建的具体实现，PersonRepository并使用Cypher查询语言将其配置为与嵌入式Neo4j数据库对话。

建立可执行的JAR

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

如果您使用Gradle，则可以使用来运行该应用程序./gradlew bootRun。或者，您可以使用来构建JAR文件./gradlew build，然后运行JAR文件，如下所示：

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

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

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
    }
  }
}

在这里，您可以初步了解该服务器所提供的功能。people在http：// 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信号这POST用于创建新条目

  • -H "Content-Type:application/json" 设置内容类型，以便应用程序知道有效负载包含JSON对象

  • -d '{ "firstName" : "Frodo", "lastName" : "Baggins" }' 是正在发送的数据

请注意，上一个POST操作如何包含Location标头。它包含新创建的资源的URI。Spring Data REST还具有两个方法（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
  }
}

该people对象包含带有Frodo的列表。请注意，它如何包含self链接。Spring Data REST还使用Evo Inflector库对实体的名称进行复数以进行分组。

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

$ 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>在代码中返回，所以它将返回所有结果。如果将其定义为仅返回Person，它将选择Person要返回的对象之一。由于这可能是不可预测的，因此对于可能返回多个条目的查询，您可能不想这样做。

您还可以发出PUT，PATCH和DELETEREST调用来替换，更新或删除现有记录。以下示例（及其输出显示）显示了一个PUT调用：

$ 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的后端的应用程序。

也可以看看

以下指南也可能会有所帮助：

是否要编写新指南或为现有指南做出贡献？查看我们的贡献准则。

所有指南均以代码的ASLv2许可证和写作的Attribution，NoDerivatives创用CC许可证发布。