Vert.x(四): Vert.x 实现REST

最新推荐文章于 2022-11-24 10:58:02 发布
最新推荐文章于 2022-11-24 10:58:02 发布
阅读量368 收藏 1
点赞数
分类专栏： JavaWeb

回顾

在第一篇文章中开发了一个非常简单的Vert.x 3应用程序，还包括怎么测试、打包和执行。在第二篇文章中对端口进行了可变配置。

这篇文章中，开发一个CRUD（增删改查）应用，发布一个HTML页面，通过REST API与后台进行交互。RESTfull形式的API不简单，这篇文章中就不涉及了。

接下来，能看到：

  • Vert.x Web - 使用Vert.x创建Web应用的框架
  • 怎么发布静态资源
  • 怎么开发REST API

这篇文章开发的代码放在GitHub上，是从第二篇文章的代码基础上进行的。

开始Vert.x Web

如果你看了前面的文章，使用Vert.x Core来处理复杂的HTTP应用还是很麻烦的，所以就有了Vert.x Web，它可以使Vert.x开发一个web应用更加简单，而且不会改变Vert.x的思想。

更新pom.xml文件，添加下面的依赖：

<dependency>
  <groupId>io.vertx</groupId>
  <artifactId>vertx-web</artifactId>
  <version>3.0.0</version>
</dependency>

这就是使用Vert.x Web的唯一前提。

还记得在上一篇文章中，当请求http://localhost:8080时，返回一个Hello World消息，使用Vert.x Web完成同样的事情，打开name.quanke.study.vertx.first.MyFirstVerticle.java 类，修改start方法：

@Override
public void start(Future<Void> fut) {
 // Create a router object.
 Router router = Router.router(vertx);

// Bind “/” to our hello message - so we are still compatible.
router.route("/").handler(routingContext -> {
HttpServerResponse response = routingContext.response();
response
.putHeader(“content-type”, “text/html”)
.end("<h1>Hello from my first Vert.x 3 application</h1>");
});

// Create the HTTP server and pass the “accept” method to the request handler.
vertx
.createHttpServer()
.requestHandler(router::accept)
.listen(
// Retrieve the port from the configuration,
// default to 8080.
config().getInteger(“http.port”, 8080),
result -> {
if (result.succeeded()) {
fut.complete();
} else {
fut.fail(result.cause());
}
}
);
}

在开始start方法里创建了一个Router对象。router是Vert.x Web的基础，负责分发HTTP请求到handler（处理器），在Vert.x Web中还有两个很重要的概念。

  • Routes-定义请求的分发
  • Handlers-这是实际处理请求并且返回结果的地方。Handlers可以被链接起来使用。

如果明白了这3个概念（Router、Routes、Handlers），就明白了Vert.x Web的所有了。

仔细看看下面这段代码：

router.route("/").handler(routingContext -> {
  HttpServerResponse response = routingContext.response();
  response
      .putHeader("content-type", "text/html")
      .end("<h1>Hello from my first Vert.x 3 application</h1>");
});

将访问"/"（http://localhost:8080/）的请求“路由”到指定的handler。Handlers接收RoutingContext对象。这个handler的方法和我们之前的代码很像，他们操作的是同一个HttpServerResponse类型的对象。

让我们来看看剩下的代码：

vertx
    .createHttpServer()
    .requestHandler(router::accept)
    .listen(
        // Retrieve the port from the configuration,
        // default to 8080.
        config().getInteger("http.port", 8080),
        result -> {
          if (result.succeeded()) {
            fut.complete();
          } else {
            fut.fail(result.cause());
          }
        }
    );
}

除了改变了request handler，基本和之前的代码一样。传router::accept给handler。你可能对这个符号不太熟悉。它表示引用一个方法（这里是引用router的accept方法）。换句话说，当接收到一个请求的时候，告诉vert.x从router里调用accept方法。

让我们来看下它是怎么工作的：

mvn clean package
java -jar target/my-first-app-1.0-SNAPSHOT-fat.jar

浏览器打开http://localhost:8080，你会看到Hello的消息。

发布静态资源

现在有了第一个使用Vert.x Web开发的应用。先在写增加一个index.html页面（静态资源）。

这个HTML页面将会是我们应用的入口。在src/main/resources/assets目录下，index.html文件在github上。此文不涉及这个文件的细节。

基本上，就是一个简单的CRUD的UI界面，actions是由通过AJAX调用的REST API执行的。

创建完了页面后，编辑name.quanke.study.vertx.first.MyFirstVerticle类，并修改start方法：

@Override
public void start(Future<Void> fut) {
 Router router = Router.router(vertx);
 router.route("/").handler(routingContext -> {
   HttpServerResponse response = routingContext.response();
   response
       .putHeader("content-type", "text/html")
       .end("<h1>Hello from my first Vert.x 3 application</h1>");
 });

// Serve static resources from the /assets directory
// 将访问“/assets/*”的请求route到“assets”目录下的资源

router.route("/assets/*").handler(StaticHandler.create(“assets”));

vertx
.createHttpServer()
.requestHandler(router::accept)
.listen(
// Retrieve the port from the configuration,
// default to 8080.
config().getInteger(“http.port”, 8080),
result -> {
if (result.succeeded()) {
fut.complete();
} else {
fut.fail(result.cause());
}
}
);
}

就这段代码和前面的不同：

router.route("/assets/*").handler(StaticHandler.create("assets"));

这一行是什么意思？挺简单的。将访问“/assets/*”的请求route到“assets”目录下的资源。现在可以通过http://localhost:8080/assets/index.html来访问index.html了。

测试之前，我们花一些时间来看一下handler的创建。所有的处理请求动作在Vert.x Web里都实现成handler。而创建一个handler需要调用create方法。

编译、运行：

mvn clean package
java -jar target/my-first-app-1.0-SNAPSHOT-fat.jar

浏览器，输入http://localhost:8080/assets/index.html。

现在这个table是空的。那是因为我们还没有实现REST的API。现在让我们来开始吧。

使用Vert.x Web实现REST API

Vert.x Web实现REST API很简单。看下面：

  • GET /api/whiskies => 获取所有的威士忌（getAll）
  • GET /api/whiskies/:id => 获取指定id的威士忌（getOne）
  • POST /api/whiskies =>添加一瓶威士忌（addOne）
  • PUT /api/whiskies/:id => 编辑一瓶威士忌(updateOne)
  • DELETE /api/whiskies/id => 删除一瓶威士忌(deleteOne)
我们需要一些数据。。。

在实现REST API之前，需要创建Whisky的数据模型。使用下面的内容创建src/main/java/quanke/name/study/vertx/first/Whisky.java：

package name.quanke.study.vertx.first;

import java.util.concurrent.atomic.AtomicInteger;

public class Whisky {

private static final AtomicInteger COUNTER = new AtomicInteger();

private final int id;

private String name;

private String origin;

public Whisky(String name, String origin) {
this.id = COUNTER.getAndIncrement();
this.name = name;
this.origin = origin;
}

public Whisky() {
this.id = COUNTER.getAndIncrement();
}

public String getName() {
return name;
}

public String getOrigin() {
return origin;
}

public int getId() {
return id;
}

public void setName(String name) {
this.name = name;
}

public void setOrigin(String origin) {
this.origin = origin;
}
}

这是一个很简单的bean类。因为Vert.x依赖Jackson来处理JSON格式,Jackson能够自动序列化和反序列化bean类，让代码变得更简单，所以选择这样的格式。

现在，创建几瓶威士忌。在MyFirstVerticle类中，添加下面的代码：

// Store our product
// 存储产品
private Map<Integer, Whisky> products = new LinkedHashMap<>();
// Create some product
// 创建一些产品
private void createSomeData() {
  Whisky bowmore = new Whisky("Bowmore 15 Years Laimrig", "Scotland, Islay");
  products.put(bowmore.getId(), bowmore);
  Whisky talisker = new Whisky("Talisker 57° North", "Scotland, Island");
  products.put(talisker.getId(), talisker);
}

然后，在start方法里，调用createSomeData方法：

@Override
public void start(Future<Void> fut) {

createSomeData();

// Create a router object.
Router router = Router.router(vertx);

// Rest of the method
}

在这里并没有一个后台数据库。仅使用一个map，将数据存储在内存中。添加后端数据库的介绍我准备放在另一篇文章中讲。

获得产品（威士忌）

GET /api/whiskies，JSON数组中返回产品列表。

在start方法里，添加下面这行（static handler）：

router.get("/api/whiskies").handler(this::getAll);

告诉router调用getAll方法来处理"/api/whiskies"的GET请求。代码可以写在handler里，但是为了让代码更加清晰，另外创建一个方法：

private void getAll(RoutingContext routingContext) {
  routingContext.response()
      .putHeader("content-type", "application/json; charset=utf-8")
      .end(Json.encodePrettily(products.values()));
}

每一个handler（比如：请看上面的代码）都会接受一个RoutingContext参数。通过设置content-type和一些内容来填充response。因为内容可能会碰到特殊的字符，所以强制使用UTF-8的格式。创建内容的时候，并不需要自己去处理JSON格式的字符串。Vert.x有处理Json的API。使用Json.encodePrettily(products.values())处理JSON字符串。本应使用Json.encodePrettily(products)，但是为了让JavaScript代码更简单，我们仅返回威士忌（产品）的数据集合，并没有返回包含Id=>Bottle的键值对。

打包运行：

mvn clean package
java -jar target/my-first-app-1.0-SNAPSHOT-fat.jar

浏览器访问http://localhost:8080/assets/index.html，然后你将会看到下面这个页面。

image

很好奇，想看一下REST API到底返回了什么。打开浏览器，访问http://localhost:8080/api/whiskies。你会看到下面这样的信息：

[ {
  "id" : 0,
  "name" : "Bowmore 15 Years Laimrig",
  "origin" : "Scotland, Islay"
}, {
  "id" : 1,
  "name" : "Talisker 57° North",
  "origin" : "Scotland, Island"
} ]

创建一个产品

能获取到威士忌（产品）了，现在需要创建一个产品。不像之前的REST API，这一次，需要读取request的body。因为性能的原因，它应该被显式地启用。不要怕，这也仅仅是一个handler而已。

在start方法中，添加下面的内容到getAll的后面：

router.route("/api/whiskies*").handler(BodyHandler.create());
router.post("/api/whiskies").handler(this::addOne);

第一行允许"/api/whiskies"下的所有route读取请求的body。通过使用router.route().handler(BodyHandler.create())，能让它在全局生效。

第二行将对/api/whiskies的POST请求映射到addOne方法。让我们来创建这个方法：

private void addOne(RoutingContext routingContext) {
  final Whisky whisky = Json.decodeValue(routingContext.getBodyAsString(),
      Whisky.class);
  products.put(whisky.getId(), whisky);
  routingContext.response()
      .setStatusCode(201)
      .putHeader("content-type", "application/json; charset=utf-8")
      .end(Json.encodePrettily(whisky));
}

开始从请求的body中取出Whisky对象。只是将body读成一个字符串并将它传入到Json.decodeValue方法里。Whisky这个对象一旦创建好，将被添加到后台的map中，并以JSON的格式返回。

重新编译并且运行：

mvn clean package
java -jar target/my-first-app-1.0-SNAPSHOT-fat.jar

刷新HTML页面，点击Add a new bottle按钮。输入数据，如：“quanke” 作为名字， “quanke.name” 作为产地 ，就OK了。

状态码 201 ？
CREATED和在REST API中创建一个entity时，response的状态码为201。。默认的vert.x web设置一个200的状态码代表OK。

删除一个产品

在start方法里，添加：

router.delete("/api/whiskies/:id").handler(this::deleteOne);

在URL里，参数为：:id。在处理一个相匹配的请求的时候，Vert.x提取路径中与这个参数对应的一段，能够在handler中获得。例如，/api/whiskies/0将id映射为0。

看一下在handler方法中这个参数是怎样被使用的。创建一个deleteOne方法。

private void deleteOne(RoutingContext routingContext) {
  String id = routingContext.request().getParam("id");
  if (id == null) {
    routingContext.response().setStatusCode(400).end();
  } else {
    Integer idAsInteger = Integer.valueOf(id);
    products.remove(idAsInteger);
  }
  routingContext.response().setStatusCode(204).end();
}

状态码 204 ？
状态码为204 - NO CONTENT。HTTP delete动作通常都是无返回内容的。

其他方法

实现getOne和updateOne很简单，和上面的差不多，此文不再详细介绍。源码在github上

总结

此文介绍了如何用Vert.x web轻松的实现一个REST API，如何访问静态资源。比以前的文章复杂些，但仍然还是很简单。

全科龙婷▼升职加薪

vert.x笔记：5.vert.x集成dubbo服务
heartlifes
06-09 3636
原文及更多文章请见个人博客：http://heartlifes.com vert.x基础介绍：dubbo是阿里巴巴内部的rpc远程调用框架，和spring无缝对接，自带loadbalance，是用来搭建soa服务架构的利器，可惜听说在阿里内部斗争中，已经被hsf干掉了。但是，对于我们这种小企业来说，dubbo还是搭建高可用服务的不二选择。dubbo官方地址：http://dubbo.iovert.
vert.x笔记：3.使用vert.x发布restful接口
heartlifes
06-09 3712
原文及更多文章请见个人博客：http://heartlifes.comvert.x重要概念介绍：在第2偏笔记中，我们写了第一个vert.x的hello world代码，这里，我们把代码中用到的几个重要概念解释下。Vertx基类：Vertx类，是所有vert.x代码的入口，官方代码注释为：The entry point into the Vert.x Core API.即该类是所有vert.x cor
vertx-mod-rest-service:Vert.x REST-API 服务示例
07-11
Vert.x JAX-RS 示例模块 当您启动模块时，它接受端口 8080 上的 HTTP 连接。 返回响应字符串“Hello World” 如果您尝试访问 包括 vertx-mod-jersey 和 vertx-mod-hk2。 h4. 构建和运行 ./gradlew clean build ./gradlew runmod 限制：测试用例尚未实现。
Vert.x 实现REST
weixin_34150830的博客
01-16 243
为什么80%的码农都做不了架构师？>>> ...
在基于简单Vertx Rest的应用程序上为REST资源设置基本响应HTTP标头
最佳 Java 编程
05-31 253
我是Vert.x的新手，但是作为Java开发人员（非常努力），与NodeJS或其他任何基于Reactor的框架/库相比，我觉得它更加有趣并且很有前途。 因此，我正在使用Vert.x实现一个非常简单的Restful API。 今天的问题是我想在大多数（所有）响应中包含某些HttpHeaders。 例如，将Content-type设置为“ application / json”。 将来可能还...
Vertx之Restful风格web-router
Lance
01-06 672
介绍 路由器从HttpServer接收请求并将其路由到它包含的第一个匹配路由。路由器可以包含许多子路由, 支持Restful风格url定义 1. maven项目依赖 <dependency> <groupId>io.vertx</groupId> <artifactId>vertx-web</artifactId> </dependency> <dependency> &lt...
rest.vertx：类似于JAX-RS的注释处理器，用于vert.x垂直及更多
02-05
休息 轻量级的JAX-RS（RestEasy）像vert.x verticles的注释处理器 Rest.Vertx仍处于测试阶段，因此请报告发现的所有。 强烈建议您参与并改进现有的代码。 这个项目是否可以帮助您减少开发时间？ 保持运行，并捐赠饼干和咖啡。 建立 < dependency> < groupId>com.zandero</ groupId> < artifactId>rest.vertx</ artifactId> < version>0.9.1</ version> </ depende
vertx-blueprint-microservice：Vert.x蓝图项目-Micro-Shop微服务应用程序
02-02
Vert.x微服务蓝图 Vert.x蓝图应用程序-用Vert.x开发的微店微服务应用程序。 此存储库旨在说明如何使用Vert.x设计微服务架构和开发微服务应用程序。 该蓝图适用于Vert.x 3.4.1 。 注意：我们正在重构微服务蓝图的...
vertx4-reactive-rest-api:学习Vert.x和React式编程的项目
03-18
Vertx4-reactive-rest-api 此应用程序是使用生成的 建筑 要启动测试： ./mvnw clean test 打包您的应用程序： ./mvnw clean package 要运行您的应用程序： ./mvnw clean compile exec:java 帮助
vest:使用jaxrs 2.0在vertx上创建REST服务的框架
05-19
背心框架 借鉴Jaxrs“ Jersey”的参考实现，此Jaxrs for vertx的实现被命名为“ Vest”。 一个可用于在vertx中以最少的代码轻松创建路由的库。 此初始实现将支持使用jax-rs 2.0（JSR339）在vertx中创建REST服务。 围绕此实现的想法是在vertx上创建一个框架，这意味着您不需要嵌入诸如Jersey的实现，而是利用现有的vertx平台。 当前支持 @Path（不带正则表达式） @ POST，@ PUT，@ GET，@ DELETE，@ OPTION和@HEAD @语境 VestApplication形式的应用程序实现。 @PathParam @HeaderParam @QueryParam @默认值 JsonObject作为处理程序中的参数 @Consums（Alpha） @Produces（Alpha） 去做 检查问题 介绍
vertx集成mybatis架构
07-29
自己写的一个java+vertx+mybatis的网关、服务分发，用于app后台接口开发的基本框架，仅供参考，请不要用于商业用途。
vertx-cn-website:Vert.x中国用户群网站
04-27
vertx-cn-网站 Vert.x中国用户群网站
初学vertx
sinat_26781697的专栏
11-06 1004
线程阻塞 若当一个请求到达时如果该请求请求的资源找不到或者请求耗费的时间过长会出现线程阻塞，为了避免在监听端口时发生阻塞，可以采用 vertx.executeBlocking(re->{ httpServer.requestHandler(router::accept).listen(8081);//对象调方法 },r->{}); 这样就能有效解决线程阻塞 router.route
Vert.x(vertx) Web开发-路由
热门推荐
happyfly的博客
07-03 2万+
在Vert.x 创建HTTP服务 中我们已经创建了一个简单的HttpServer，但这个HttpServer比较低级，对于请求参数解析、Session等常用功能都需要我们通过编码实现，也就是要重复造轮子，非常不方便。 Vert.x提供了Web开发组件vertx-web，提供了一堆Web开发中常用的功能。比如参数封装，路由，国际化，认证和授权，session和cookie以及模板等，可以非常方便的...
Vert.x Web Client (三）复用请求
最新发布
JflyDragon的博客
11-24 333
发送方法可以安全调用多次，达到这个目的可以如下配置实现重用HttpRequest对象小心HttpRequest实例是可变的。因此在修改缓存实例之前调用copy方法。
Vertx 框架 基于SpringBoot使用 （一） Web路由器与同步、异步处理请求
喜欢历史的码农
04-21 2719
一、创建SpringBoot工程 二、 Vertx 实现http服务器、路由器的使用 1. 用vertx实现http服务器 添加依赖： 工程的创建可以创建两种 ： 第一种：Gradle方式 第二种： Maven方式 以上两种vertx都支持： java代码： public class Demo1 { //用vertx实现http服务器 public...
Vert.x Web之Router
weixin_30338481的博客
10-08 149
　　Vert.x Web 是一系列用于基于 Vert.x 构建 Web 应用的构建模块。 　　Vert.x Web 的大多数特性被实现为了处理器（Handler），因此您随时可以实现您自己的处理器。我们预计随着时间的推移会有更多的处理器被实现。 使用 Vert.x Web 　　 <dependency> <groupId>io.vertx</grou...
提供静态资源
zyydecsdn的博客
05-11 621
Vert.x-Web附带一个开箱即用的处理程序，用于提供静态Web资源，以便您可以非常轻松地编写静态Web服务器。服务静态资源，如.html，.css，.js或任何其他静态资源，您使用的一个实例 StaticHandler。对由静态处理程序处理的路径的任何请求都将导致文件系统上的目录或类路径中的文件被提供。默认的静态文件目录是webroot可以配置的。在以下示例中，所有对以下路径开始的请求/sta...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值