使用 REST 访问 Pivotal GemFire 中的数据

时间：2022-12-23 16:56:54

使用 REST 访问 Pivotal GemFire 中的数据

本指南将引导您完成创建访问存储在 中的数据的应用程序的过程Apache Geode​通过基于超媒体 休息前端.

您将构建的内容

您将构建一个 Spring Web 应用程序，该应用程序允许您创建和检索存储在​​Person​​Apache Geode使用Spring Data REST的内存数据网格（IMDG）。 Spring Data REST具有以下特性：春天的哈特亚斯和Apache Geode 的春季数据并自动将它们组合在一起。

Spring Data REST 还支持春季数据 JPA,春季数据 MongoDB和弹簧数据 Neo4j作为后端数据存储，但这些不是本指南的一部分。

有关 Apache Geode 概念和从 Apache Geode 访问数据的更多一般知识，请通读本指南，使用 Apache Geode 访问数据.

你需要什么

  • 约15分钟
  • 最喜欢的文本编辑器或 IDE
  • JDK 1.8或以后
  • 格拉德尔 4+​或梅文 3.2+
  • 您也可以将代码直接导入到 IDE 中：
  • 弹簧工具套件 （STS）
  • 智能理念
  • VSCode

如何完成本指南

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

要从头开始，请继续从 Spring 初始化开始.

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

  • 下载​并解压缩本指南的源存储库，或使用吉特:git clone https://github.com/spring-guides/gs-accessing-gemfire-data-rest.git
  • 光盘成gs-accessing-gemfire-data-rest/initial
  • 跳转到创建域对象.

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

从 Spring 初始化开始

对于所有 Spring 应用程序，您应该从Spring Initializr.Spring Initializr 提供了一种快速的方式来提取应用程序所需的所有依赖项，并为您完成大量设置。此示例需要“Spring for Apache Geode”依赖项。

以下清单显示了使用 Maven 时的示例文件：​​pom.xml​​

<?xml version="1.0" encoding="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>

  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.7.0</version>
  </parent>

  <groupId>org.springframework</groupId>
  <artifactId>gs-accessing-gemfire-data-rest</artifactId>
  <version>0.1.0</version>

  <properties>
    <spring-shell.version>1.2.0.RELEASE</spring-shell.version>
  </properties>

  <dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-data-rest</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.data</groupId>
      <artifactId>spring-data-geode</artifactId>
    </dependency>
    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.shell</groupId>
      <artifactId>spring-shell</artifactId>
      <version>${spring-shell.version}</version>
      <scope>runtime</scope>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-test</artifactId>
      <scope>test</scope>
      <exclusions>
        <exclusion>
          <groupId>org.junit.vintage</groupId>
          <artifactId>junit-vintage-engine</artifactId>
        </exclusion>
      </exclusions>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
      </plugin>
    </plugins>
  </build>

</project>

以下清单显示了使用 Gradle 时的示例文件：​​build.gradle​​

plugins {
    id 'org.springframework.boot' version '2.7.0'
    id 'io.spring.dependency-management' version '1.0.11.RELEASE'
    id 'io.freefair.lombok' version '6.3.0'
    id 'java'
}

apply plugin: 'eclipse'
apply plugin: 'idea'

group = "org.springframework"
version = "0.1.0"
sourceCompatibility = 1.8
targetCompatibility = 1.8

repositories {
    mavenCentral()
}

dependencies {

    implementation "org.springframework.boot:spring-boot-starter-data-rest"
    implementation "org.springframework.data:spring-data-geode"
    implementation "org.projectlombok:lombok"

    runtimeOnly "org.springframework.shell:spring-shell:1.2.0.RELEASE"

    testImplementation "org.springframework.boot:spring-boot-starter-test"

}

test {
    useJUnitPlatform()
}

bootJar {
    baseName = 'gs-accessing-gemfire-data-rest'
    version =  '0.1.0'
}

创建域对象

创建一个新的域对象来呈现人员。

​​src/main/java/hello/Person.java​​

package hello;

import java.util.concurrent.atomic.AtomicLong;

import org.springframework.data.annotation.Id;
import org.springframework.data.annotation.PersistenceConstructor;
import org.springframework.data.gemfire.mapping.annotation.Region;

import lombok.Data;

@Data
@Region("People")
public class Person {

  private static AtomicLong COUNTER = new AtomicLong(0L);

  @Id
  private Long id;

  private String firstName;
  private String lastName;

  @PersistenceConstructor
  public Person() {
    this.id = COUNTER.incrementAndGet();
  }
}

有名字和姓氏。Apache Geode 域对象需要一个 id，因此每次创建对象时都会使用 id。​​Person​​​​AtomicLong​​​​Person​​

创建个人存储库

接下来，您需要创建一个简单的存储库来持久化/访问存储在 Apache Geode 中的对象。​​Person​​

​​src/main/java/hello/PersonRepository.java​​

package hello;

import java.util.List;

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 CrudRepository<Person, Long> {

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

}

此存储库是一个接口，允许您执行涉及对象的各种数据访问操作（例如基本 CRUD 和简单查询）。它通过扩展 来获取这些操作。​​Person​​​​CrudRepository​​

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

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

在这里，您还定义了一个自定义查询，用于检索基于 的对象列表。您将在本指南中看到如何进一步调用它。​​Person​​​​lastName​​

使应用程序可执行

尽管可以将此服务打包为传统的服务战争文件，下面演示的更简单的方法将创建一个独立的应用程序。您将所有内容打包到一个可执行的 JAR 文件中，该文件由一个很好的旧 Java 方法驱动。在此过程中，您使用 Spring 的支持来嵌入​​main()​​雄猫servlet 容器作为 HTTP 运行时，而不是部署到外部 Servlet 容器。

​​src/main/java/hello/Application.java​​

package hello;

import org.apache.geode.cache.client.ClientRegionShortcut;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.data.gemfire.config.annotation.ClientCacheApplication;
import org.springframework.data.gemfire.config.annotation.EnableEntityDefinedRegions;
import org.springframework.data.gemfire.repository.config.EnableGemfireRepositories;

@SpringBootApplication
@ClientCacheApplication(name = "AccessingGemFireDataRestApplication")
@EnableEntityDefinedRegions(
  basePackageClasses = Person.class,
  clientRegionShortcut = ClientRegionShortcut.LOCAL
)
@EnableGemfireRepositories
@SuppressWarnings("unused")
public class Application {

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

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

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

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

该注释激活了 Apache Geode 存储库的 Spring 数据​。Spring Data for Apache Geode 将创建接口的具体实现，并将其配置为与 Apache Geode 的嵌入式实例通信。​​@EnableGemfireRepositories​​​​PersonRepository​​

构建可执行的 JAR

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

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

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

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

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

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

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

测试应用程序

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

首先，您希望查看*服务。

$ curl http://localhost:8080
{
  "_links" : {
    "people" : {
      "href" : "http://localhost:8080/people"
    }
  }
}

在这里，您可以初步了解该服务器所提供的功能。有一个人员链接位于​​http://localhost:8080/people​​.Spring Data for Apache Geode 不像其他 Spring Data REST 指南那样支持分页，因此没有额外的导航链接。

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

 
$ curl http://localhost:8080/people
{
  "_links" : {
    "search" : {
      "href" : "http://localhost:8080/people/search"
    }
  }
}

是时候创建一个新的 ！​​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/1
Content-Length: 0
Date: Wed, 05 Mar 2014 20:16:11 GMT
  • ​​-i​​确保可以看到包含标头的响应消息。显示新创建的 URIPerson
  • ​​-X POST​​发出 HTTP 请求以创建新条目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" : {
    "search" : {
      "href" : "http://localhost:8080/people/search"
    }
  },
  "_embedded" : {
    "persons" : [ {
      "firstName" : "Frodo",
      "lastName" : "Baggins",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/people/1"
        }
      }
    } ]
  }
}

人员集合资源包含带有 Frodo 的列表。请注意它如何包含自我链接。Spring Data REST 也使用埃沃变形器复数化分组的实体名称。

您可以直接查询单个记录：

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

这可能看起来纯粹是基于Web的，但在幕后，它正在与嵌入式Apache Geode数据库进行通信。

在本指南中，只有一个域对象。对于域对象相互关联的更复杂的系统，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" : {
    "persons" : [ {
      "firstName" : "Frodo",
      "lastName" : "Baggins",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/people/1"
        }
      }
    } ]
  }
}

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

您还可以发出 、 和 REST 调用来替换、更新或删除现有记录。​​PUT​​​​PATCH​​​​DELETE​​

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

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

您可以删除记录：

$ curl -X DELETE http://localhost:8080/people/1
$ curl http://localhost:8080/people
{
  "_links" : {
    "search" : {
      "href" : "http://localhost:8080/people/search"
    }
  }
}

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

总结

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

标签：

相关文章