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

最新推荐文章于 2023-08-22 13:10:53 发布
最新推荐文章于 2023-08-22 13:10:53 发布
阅读量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
  }
}
研发之道
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
spring-boot-mysql-rest-api-tutorial：使用Spring Boot，Mysql，JPA和Hibernate构建Restful CRUD API
02-03
Spring Boot，MySQL，JPA，Hibernate Rest API教程使用Spring Boot，Mysql，JPA和Hibernate为简单的记笔记应用程序构建Restful CRUD API。要求Java-1.8.x Maven-3.xx MySQL的-5.xx设定步骤1.克隆应用程序git clone ...
微拍秒拍、微录客福利视频分享整站源码 MV微电影（完整版源码）！！
热门推荐
舒哥的blog
03-09 40万+
不合法已不提供！见谅了～各位老司机！  
React-native IT喵喵~路由之React Navigation
舒哥的blog
06-07 2846
大家自己 去看文档吧！！！ 为了业务快把文档看完了。。。 不过给大家翻译了一点。。。欢迎大家关注一下 基于React-naive开发的“IT喵~”项目。技能GET、互联网资讯、程序员相亲、GitHub监控。。。 Github地址：https://github.com/cbamls/kitty_front效果图内置的Navigators起react-navigation 包含了下列三种函数赖创建na
精品电影网
chuaixue0334的博客
10-16 1408
最新精品，免费电影，电视剧，美剧迅雷下载：http://www.jpmovie.cn 转载于:https://my.oschina.net/u/3345879/blog/1551276...
一些资源网站地址
Klamath的专栏
04-11 4292
Access数据库资料网址：http://access911.net/index.asp
福利、福利
lizhong
08-08 1900
积分都是大家贡献的，现在回馈给大家。 内容：下载CSDN文件需要积分的，可以帮忙下载，加微信（主页左侧有微信）发给你也好，上传百度网盘自行下载也可以的。 方式：留下文件名与链接，看到后会马上处理，然后会在留言下回复。 ...
spring-boot2-jpa-crud-example：spring boot2 jpa crud REST API示例
02-04
spring-boot2-jpa-crud-example Spring Boot2 JPA Crud REST API示例以下是分步文章，解释了此Spring boot 2 JPA CRUD Restful API示例：
spring-boot-jpa：使用Spring Data JPA的Spring Boot微服务参考应用程序
02-05
Spring Boot / Spring Data JPA：参考应用程序概述和历史该项目是对我几年前在2014年参加专业化时所做的重新访问。 在最后的Capstone课程中，我们选择了要实施的几个项目，我选择了一个既有趣又有个人关系的项目：一...
RestHotel:使用 Spring Boot 和 Spring Data-JPA 演示 REST-HATEOAS Web 服务
06-11
这是一个使用 Sring Boot、Spring Data-JPA 和 Spring Data-REST 的 HATEOAS 风格的 RESTful Web 服务的简单演示。 它包括一个简单的跨域请求过滤器 (CORS)，以便可以从任何域访问它。 它包括一个使用 HTML5 和 ...
spring-boot-jpa-rest-demo-filter-paging-sorting：具有过滤器，分页和排序功能的Spring Boot Data JPA
01-30
春天启动jpa休息演示过滤器分页排序使用Spring引导MVC的示例应用程序Spring Data JPA能够执行过滤，分页和排序。过滤REST API按照演示应用程序中的说明处理过滤器。 它将以下概念解析并转换为org.springframework....
左边是地狱右边也是地狱_地狱邮件循环
cumei1658的博客
07-15 336
左边是地狱右边也是地狱Found in #django on freenode, Jul 12, 2012. All names are edited. 在freenode的#django中找到，2012年7月12日。所有名称均已编辑。 11:16 < abrt> since it's quiet in here I'll tell you a story. 11:16 <...
初识SpringBoot——Spring Data Rest的简单使用
IT小小鸟
09-03 820
引言 使用 引入jar包 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-rest</artifactId> </dependency> 利用jpa生成相关实体类（省略，可以看我上一篇博客：利用JPA自动生成实体类） 定义Repository，并实现JpaReposi
【SpringBoot学习笔记】SpringDataREST
AC_sunK的博客
09-19 865
使用Spring创建REST应用 文章目录使用Spring创建REST应用一、简单创建一个REST应用构建一个简单的REST应用REST应用二、SpringDataREST构建REST应用 一、简单创建一个REST应用 构建一个简单的REST应用 添加依赖： <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web&l
springboot-data-rest
weixin_34376562的博客
11-08 116
2019独角兽企业重金招聘Python工程师标准>>> ...
Springboot使用DataRest直接访问数据库
最新发布
青春不散场的专栏
08-22 290
直接将数据库资源映射成为Rest资源。
java处理混合数据_java – 如何混合Spring数据存储库和Spring Rest控制器
weixin_42608299的博客
02-24 101
目前,我将一些Spring数据存储库作为RESTful服务,通过@RepositoryRestResource注释它们,如下所示：@RepositoryRestResource(collectionResourceRel = "thing1", path = "thing1")public interface Thing1Repository extends PagingAndSortingRep...
各网络公司晒中秋福利 百度你好简约(组图）
weixin_34326179的博客
09-09 423
2019独角兽企业重金招聘Python工程师标准>>> ...
福利福利！！！！！！！！往这看！！！！！
Magic_capital的博客
11-15 1万+
基因雷达网址：https://www.gcbi.com.cn/gcanalyze/html/generadar/index 做生存曲线网址：http://kmplot.com/analysis/ 预后分析代码网址： http://www.bio-info-trainee.com/1314.html tcga数据库基因做生存分析曲线网址： http://www.oncolnc.org/ GCBI在...
盘点百度开放云编程马拉松八大亮点
韩攀郑州SEO网站建设的专栏
07-25 1714
2013年7月20日，以“绿色生活”为主题的百度开放云编程马拉松活动于北京、成都、武汉三地正式开启，现场酷炫高科技硬件、夫妻档组合、父子兵齐上阵、检查官程序猿等等八大亮点令人难忘。 　　一、酷炫高科技：牛逼硬件大集合 　　北京站现场摆放的高科技硬件成为了编程马拉松赛事的又一大亮点。幻腾智能作为技术合作伙伴为主办方提供了智能灯、EcoTower温湿度及空气质量传感器等开放API硬件产品，
spring-boot-starter-data-rest
08-15
引用和：spring-boot-starter-data-rest是一个Spring Boot的依赖，它可以让我们在Spring Boot项目中使用Spring Data REST。Spring Boot已经为我们自动配置了RepositoryRestConfiguration，因此使用spring-boot-...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值