Spring-Data-Rest 构建Spring-boot Web应用—— rest风格访问JPA数据

最新推荐文章于 2024-08-16 09:04:00 发布
最新推荐文章于 2024-08-16 09:04:00 发布
阅读量1.5k 收藏
点赞数
分类专栏： Spring全家桶 文章标签： web应用 spring rest

这篇文章将会引导你创建restful风格的后端服务来访问数据。

What you’ll build

接下来将会创建一个Spring应用程序， 来从数据库中以rest风格的方式存取一个Person 对象。Spring Data REST 同时具有 Spring HATEOAS 和 Spring Data JPA 的 特性。

Spring Data REST also supports Spring Data Neo4j, Spring Data Gemfire and Spring Data MongoDB as backend data stores, but those are not part of this guide.

What you’ll need

  • About 15 minutes
  • A favorite text editor or IDE
  • JDK 1.8 or later
  • Gradle 2.3+ or Maven 3.0+
  • You can also import the code straight into your IDE:
    • Spring Tool Suite (STS)
    • IntelliJ IDEA

Build with maven

创建下述目录结构：

└── src
    └── main
        └── java
            └── hello

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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

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

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

    <properties>
        <java.version>1.8</java.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-data-jpa</artifactId>
        </dependency>
        <dependency>
            <groupId>com.h2database</groupId>
            <artifactId>h2</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

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

    <repositories>
        <repository>
            <id>spring-releases</id>
            <url>https://repo.spring.io/libs-release</url>
        </repository>
    </repositories>
    <pluginRepositories>
        <pluginRepository>
            <id>spring-releases</id>
            <url>https://repo.spring.io/libs-release</url>
        </pluginRepository>
    </pluginRepositories>
</project>

Spring Boot Maven plugin 提供了很多便利的特性。

  1. 它 会收集classPath 下 所有的jar， 然后构建成一个jar， 方便了运行spring-boot程序和做服务迁移
  2. 它会自动查找public static void main() 代码段， 作为 程序的入口。

  3. 它提供对内置依赖的解析， 为依赖设置版本号。你可以在Spring-boot 可选的依赖版本集中覆写指定版本号。

    Create a domain object

src/main/java/hello/Person.java
package hello;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

@Entity
public class Person {

    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    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 有firstName 、 lastName ， 还有id 已经配置为自动生成 ， 没必要去关注它。

Create a Person repository

创建一个简单的 仓库：

src/main/java/hello/PersonRepository.java
package hello;

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 的各种各样的操作，且必须继承 Spring Data Commons 下的
PagingAndSortingRepository 类， 在运行时 Spring 会自动创建接口的实现， 使用@RepositoryRestResource 注解来创建Spring-mvc 路由映射。

@RepositoryRestResource 作为一个仓库被暴露， 并不是必须加的 注解， 他仅仅用来指定导出到 一些细节（如果不想采取默认的导出方式【/persons】）

至此我们定义了一个客户端的查询来获取一系列Person ， 接下来我们看看如何运行。

Make the application executable

使用Spring-boot 内嵌的tomcat运行。 首先创建一个Application.java

src/main/java/hello/Application.java

package hello;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application {

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

@SpringBootApplication 是一个很方便的注解， 包含了以下注解特性：

  • @Configuration 标志这个类是一个配置类， 为application context 提供bean 定义
  • @EnableAutoConfiguration 自动根据classPath 的设置， 载入所需的bean 和属性配置。
  • 自动激活@EnableWebMvc

  • @ComponentScan 扫描hello 包下的其它components, configurations, and services and controllers

    SpringApplication.run() 方法来启动应用， 做到了0 xml配置。纯java 构建web应用。Spring-boot 会创建PersonRepository 具体的实现。Spring Data REST 构建与Sping-Mvc 之上， 它创建了一系列SpringMvc 的 controllers 集合、JSON converters 还有其他的提供RESTful 后端服务的 所需的 bean， 这些组件和Spring Data JPA 联系在一块（使用Spring Boot 全自动配置）， 如果你想关注是如何工作的， 请查看RepositoryRestMvcConfiguration 的实现。

    Build an executable JAR

./mvnw clean package
java -jar target/gs-accessing-data-rest-0.1.0.jar

Test the application

用强大的curl 命令来mock 我们的restful 服务。

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

从href 中我们看到， 我们可以通过http://localhost:8080/people 去定位一些Person 还可以传递一些查询条件： 如： page 、 size 、sort 。

Spring-Data-Rest 使用 HAL format 作为Json输出。 links结点下会链接一些相邻的数据（有推荐、引导访问某些数据的含义）

$ 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/1
Content-Length: 0
Date: Wed, 26 Feb 2014 20:26:55 GMT
  • -i 确保你能够看到包含响应头的响应消息
  • -X POST 标志这是一个POST 请求
    • -H "Content-Type:application/json" 设置content -type
    • -d "{ \"firstName\" : \"Frodo\", \"lastName\" : \"Baggins\" }" body体的要post的 内容

Notice how the previous POST operation includes a Location header. This contains the URI of the newly created resource. Spring Data REST also has two methods on RepositoryRestConfiguration.setReturnBodyOnCreate(…) and setReturnBodyOnUpdate(…) which you can use to configure the framework to immediately return the representation of the resource just created. RepositoryRestConfiguration.setReturnBodyForPutAndPost(…) is a short cut method to enable representation responses for creates and updates.
至此， 我们能够查询所有的人。

$ 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" : {
    "persons" : [ {
      "firstName" : "Frodo",
      "lastName" : "Baggins",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/people/1"
        }
      }
    } ]
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

你也可以直接可以访问单条记录：

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

在这个向导中只包含一个实体， 在一个更大的系统中， 实体之间有着复杂的联系。Spring Data REST 将会展示一些额外的连接， 导航到其它数据。

查看所有可能的客户端查询方式：

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

使用findByLastName 

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

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 replaces an entire record. Fields not supplied will be replaced with null. PATCH can be used to update a subset of items.

$ curl -X DELETE http://localhost:8080/people/1
$ 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
  }
}
【SpringBoot学习笔记】SpringDataREST
AC_sunK的博客
09-19 999
使用Spring创建REST应用 文章目录使用Spring创建REST应用一、简单创建一个REST应用构建一个简单的REST应用REST应用二、SpringDataREST构建REST应用 一、简单创建一个REST应用 构建一个简单的REST应用 添加依赖： <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web&l
【Spring实战】20 Spring Data REST+JPA构建基础的RESTful API
好久不见的流星
01-05 1407
Spring Data REST 是 Spring Framework 生态系统中的一个组件，它通过提供一套约定和默认配置，简化了使用 Spring 和 Java 构建 RESTful Web 服务的过程。使用它和 JPA（Java Persistence API）结合，我们可以更加轻松地创建强大且易于扩展的 RESTful API。
Spring-data-rest 和Spring-data-jpa
MerryZPZ的博客
12-20 698
先来简单介绍下Spring-data-rest ： 参考文档：https://docs.spring.io/spring-data/rest/docs/current/reference/html/ REST web services have become the number one means for application integration on the web. In its
NB-SpringBoot 开源项目教程
最新发布
gitblog_00669的博客
08-16 970
NB-SpringBoot 开源项目教程 nb-springbootNetBeans IDE plugin supporting programming with Spring Boot项目地址:https://gitcode.com/gh_mirrors/nb/nb-springboot 项目介绍 NB-SpringBoot 是一个 NetBeans IDE 插件，旨在支持使用 Spring ...
Spring JPA Data with REST
DoubleFJ の Blog
08-19 480
逛 Spring 官网学习总结 个人博客：DoubleFJ の Blog @RepositoryRestResource 看到这个注解，之前一直没有用到过，所以想要自己试试效果，顺道做下总结。 不想要看我废话想要直接看官网的 → Accessing JPA Data with REST 不想要看我废话想看大佬的 → Spring Boot之@RepositoryRestResource注解入...
使用Spring Data REST将Spring Data JPA存储库导出为REST服务
最佳 Java 编程
05-20 255
Spring Data模块提供了各种模块，以统一的方式处理各种类型的数据源，如RDBMS，NOSQL存储等。 在我以前的文章SpringMVC4 + Spring Data JPA +使用JavaConfig的SpringSecurity配置中，我已经解释了如何使用JavaConfig配置Spring Data JPA。 现在，在这篇文章中，让我们看看如何使用Spring Data JP...
SpringBoot学习笔记(六)——Spring Data Rest
javaEE_zero的博客
04-26 193
SpringBoot使用Spring Data REST快速构建restful应用 - 天乔巴夏丶 - 博客园
kotlin-spring-boot-jpa-rest-api-demo：使用Kotlin，Spring Boot，Mysql，Jpa和Hibernate构建一个Restful API
01-30
总之，"kotlin-spring-boot-jpa-rest-api-demo"是一个全面的示例，涵盖了从数据库管理到后端开发再到REST API设计的多个重要领域，对于希望掌握现代Web开发技术的开发者来说，是一个宝贵的资源。
spring-boot-rest-jms-activemq：REST，JMS，ActiveMQ，Spring Boot：gradle包含构建，gradle多项目构建，gradle propdeps-plugin，gradle节点插件，gradle docker-compose插件，spring-boot，sprinb-mvc ，spring fallback ContainerCustomizer，ActiveMQ，spring-jms，spring-data，spring data-jpa，spring
02-04
spring-boot-rest-jms-activemq：REST，JMS，ActiveMQ，Spring Boot：gradle包含构建，gradle多项目构建，gradle propdeps-plugin，gradle节点插件，gradle docker-compose插件，spring-boot，sprinb-mvc ，spring ...
spring-data-rest：简化在Spring Data存储库上构建超媒体驱动的REST Web服务的过程
02-03
Spring Data REST是一个强大的Java框架，它是Spring Data项目的一部分，专门设计用于简化在Spring Data存储库上构建超媒体驱动的RESTful Web服务。这个框架利用了Spring Data的强大功能，包括自动暴露Repository接口...
基于Spring Boot+JPA Restful 风格的数据（一）
qianfeng_dashuju的博客
12-30 196
spring-boot-starter-data-rest:这是spring-boot-starter-data-rest的示例示例
04-14
Spring Boot Starter Data REST 是一个非常重要的 Spring Boot 组件，它为使用 Spring Data JPA 的应用程序提供了 RESTful API 的快速配置和实现。这个组件基于 Spring HATEOAS（Hypermedia as the Engine of ...
Spring Data REST+JPA，打造史上最简单的RESTFul API万能接口!
m0_59562547的博客
07-29 2427
1、前言 1、REST 是最近几年非常流行的的 API 设计规范，它简洁并且有层次，能基于HTTP、URL、XML以及HTML这些现有的广泛流行的协议和标准。 2、在REST中，资源是由URL来指定的，对资源的增删改查操作可以通过HTTP协议提供的GET、POST、PUT、DELETE等方法来实现。 3、使用REST可以高效地利用Ehcache、Redis等主流缓存技术来提高响应速度。 4、利用Spring-boot我们可以非常快速的开发一个RESTFul API接口服务。 2、项目基本框架 1
SpringBoot 2 REST 访问 JPA 数据
纽雪澳诺加海美德的博客
02-23 424
开篇词 该指南将引导你通过基于超媒体的 RESTful 前端访问关系型 JPA 数据的应用。   你将创建的应用 我们将构建一个 Spring 应用，该应用允许我们使用 Spring Data REST 创建和检索存储在数据库中的 Person 对象。Spring Data REST 具有 Spring HATEOAS 和 Spring Data JPA 的功能，并将它们自动结合在一起。...
Spring Boot的数据访问（一）Spring Data JPA、Spring Data REST
逝去的往事的博客
06-12 397
Spring Data概述 Spring Data项目是Spring用来解决数据访问问题的一揽子方案，Spring Data是一个伞形项目，包含了大量关系型数据库及非关系型数据库的数据访问解决方案： Spring Data为我们使用统一的API来对上述的数据存储技术进行数据访问操作提供了支持。这是Spring通过提供Spring Data Commons项目来实现的，它是上述各种Spring ...
Javaweb——Spring Boot 系列（12）使用 Data REST 读取数据
御承扬的博客
02-10 648
Spring Data REST 目前支持将 Spring Data JPA，Spring Data MongoDB、Spring Data Neo4j、Spring Data GemFire 以及 Spring Data Cassandra 的 repository 自动转换成 REST 服务。
Spring Boot学习(七)之Web应用使用Spring-data-jpa让数据访问
筱进GG
11-18 404
在实际开发过程中，对数据库的操作无非就“增删改查”。就最为普遍的单表操作而言，除了表和字段不同外，语句都是类似的，开发人员需要写大量类似而枯燥的语句来完成业务逻辑。 为了解决这些大量枯燥的数据操作语句，我们第一个想到的是使用ORM框架，比如：Hibernate。通过整合Hibernate之后，我们以操作Java实体的方式最终将数据改变映射到数据库表中。 为了解决抽象各个Java实体基本的“增删...
spring-boot-data-jpa-mysql:Spring Boot Rest CRUD API示例-与MySQLPostgreSQL数据库交互的Spring Data JPA
05-03
Spring Boot JPA MySQL-构建Rest CRUD API示例 有关更多详细信息，请访问： 多练： 安全： 全栈： React + Spring Boot + MySQL示例 React + Spring Boot + PostgreSQL示例 在一个地方同时运行后端和前端： 将...
springdatajpa学习笔记（30）Spring Data Rest 是什么？和 JPA 是什么关系？
qq_34412985的博客
01-01 601
通过之前课时的内容，相信你已经对 JPA 有了深入的认识了，那么 JPA 还有哪些应用场景呢？这一讲，我们将通过 Spring Data Rest 来聊聊实体和 Respository 的另外一种用法。 首先通过一个 Demo 让你感受一下，怎么快速创建一个 Rest 风格的 Server 服务端。 Spring Data Rest Demo 我们通过以下四个步骤演示一下 Spring Data Rest 的效果。 第一步：通过 gradle 引入相关的 jar 依赖，代码如下所示。 复制代码 ..
SpringDataJpa入门(太阿)
LuckFairyLuckBaby的博客
09-23 1130
Spring Data Jpa 简介 JPA JPA(Java Persistence API)意即Java持久化API，是Sun官方在JDK5.0后提出的Java持久化规范（JSR 338，这些接口所在包为javax.persistence，详细内容可参考https://github.com/javaee/jpa-spec） JPA的出现主要是为了简化持久层开发以及整合ORM技术，结束Hib...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值