反应式编程是使你的应用程序更高效的一种越来越流行的方式。响应式应用程序异步调用响应,而不是调用资源并等待响应。这使他们可以释放处理能力,仅在必要时执行处理,并且比其他系统更有效地扩展。
Java生态系统在反应框架中占有相当大的份额,其中包括Play框架,Ratpack,Vert.x和Spring WebFlux。像反应式编程一样,微服务架构可以帮助大型团队快速扩展,并且可以使用上述任何出色的框架进行构建。
今天,我想向你展示如何使用Spring Cloud Gateway,Spring Boot和Spring WebFlux构建反应性微服务架构。我们将利用Spring Cloud Gateway,因为API网关通常是云原生微服务架构中的重要组件,可为你所有的后端微服务提供聚合层。
本教程将向你展示如何使用REST API构建微服务,该API返回新车列表。你将使用Eureka进行服务发现,并使用Spring Cloud Gateway将请求路由到微服务。然后,你将集成Spring Security,以便只有经过身份验证的用户才能访问你的API网关和微服务。
![使用Spring Cloud Gateway保护反应式微服务(一)_第1张图片](http://img.e-com-net.com/image/info8/15139eaa4da447a782b3ddbba0d4b17a.jpg)
Prerequisites: HTTPie (or cURL), Java 11+, and an internet connection.
Spring Cloud Gateway vs. Zuul
Zuul是Netflix的API网关。Zuul最初于2013年发布,最初并不具有反应性,但Zuul 2是彻底的重写,使其具有反应性。不幸的是,Spring Cloud不支持Zuul 2,并且可能永远不会支持。
现在,Spring Cloud Gateway是Spring Cloud Team首选的API网关实现。它基于Spring 5,Reactor和Spring WebFlux。不仅如此,它还包括断路器集成,使用Eureka进行服务发现,并且与OAuth 2.0集成起来要容易得多!
接下来让我们深入了解。
创建一个Spring Cloud Eureka Server项目
首先创建一个目录来保存你的所有项目,例如spring-cloud-gateway。在终端窗口中导航至它,并创建一个包括Spring Cloud Eureka Server作为依赖项的discovery-service项目。
http https://start.spring.io/starter.zip javaVersion==11 artifactId==discovery-service \ name==eureka-service baseDir==discovery-service \ dependencies==cloud-eureka-server | tar -xzvf - |
上面的命令使用HTTPie。我强烈建议安装它。你也可以使用卷曲。运行curlhttps://start.spring.io以查看语法。
在其主类上添加@EnableEurekaServer,以将其用作Eureka server。
import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer; @EnableEurekaServer @SpringBootApplication public class EurekaServiceApplication {...} |
将以下属性添加到项目的src / main / resources / application.properties文件中,以配置其端口并关闭Eureka注册。
server.port=8761 eureka.client.register-with-eureka=false |
要使发现服务在Java 11+上运行,请添加对JAXB的依赖关系。
org.glassfish.jaxb jaxb-runtime
|
使用./mvnw spring-boot:run或通过在IDE中运行它来启动项目。
创建一个Spring Cloud Gateway项目
接下来,创建一个包含一些Spring Cloud依赖项的api-gateway项目。
http https://start.spring.io/starter.zip javaVersion==11 artifactId==api-gateway \ name==api-gateway baseDir==api-gateway \ dependencies==actuator,cloud-eureka,cloud-feign,cloud-gateway,cloud-hystrix,webflux,lombok | tar -xzvf - |
一分钟后,我们将重新配置该项目。
使用Spring WebFlux创建反应式微服务
Car微服务将包含此示例代码的很大一部分,因为它包含支持CRUD的功能齐全的REST API。
使用start.spring.io创建car-service
项目:
http https://start.spring.io/starter.zip javaVersion==11 artifactId==car-service \ name==car-service baseDir==car-service \ dependencies==actuator,cloud-eureka,webflux,data-mongodb-reactive,flapdoodle-mongo,lombok | tar -xzvf - |
这个命令中的dependencies参数很有趣。你可以看到其中包括Spring WebFlux,以及MongoDB。Spring Data还为Redis和Cassandra提供了响应式驱动程序。
你可能还对R2DBC(反应性关系数据库连接)感兴趣,R2DBC是一种将反应性编程API引入SQL数据库的工作。在本示例中,我没有使用它,因为在start.spring.io上尚不可用。
使用Spring WebFlux构建REST API
我是大众的忠实拥护者,尤其是公交车和臭虫等经典车。你是否知道大众在未来几年内将推出大量电动汽车? 我对ID Buzz感到非常兴奋,它具有经典曲线,全电动而且拥有350匹以上的马力!
如果你不熟悉ID Buzz,请看这张来自大众汽车的照片。
![使用Spring Cloud Gateway保护反应式微服务(一)_第2张图片](http://img.e-com-net.com/image/info8/522eabc05dac47f79f9822eb46181205.jpg)
让我们从这个API示例中获得乐趣,并使用电动VW作为我们的数据集。该API将跟踪各种汽车名称和发布日期。
在src / main / java /…/ CarServiceApplication.java中添加Eureka注册,示例数据初始化和反应性REST API:
package com.example.carservice; import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.springframework.boot.ApplicationRunner; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.cloud.netflix.eureka.EnableEurekaClient; import org.springframework.context.annotation.Bean; import org.springframework.data.annotation.Id; import org.springframework.data.mongodb.core.mapping.Document; import org.springframework.data.mongodb.repository.ReactiveMongoRepository; import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.*; import reactor.core.publisher.Flux; import reactor.core.publisher.Mono; import java.time.LocalDate; import java.time.Month; import java.util.Set; import java.util.UUID; @EnableEurekaClient (1) @SpringBootApplication @Slf4j (2) public class CarServiceApplication { public static void main(String[] args) { SpringApplication.run(CarServiceApplication.class, args); } @Bean (3) ApplicationRunner init(CarRepository repository) { // Electric VWs from https://www.vw.com/electric-concepts/ // Release dates from https://www.motor1.com/features/346407/volkswagen-id-price-on-sale/ Car ID = new Car(UUID.randomUUID(), "ID.", LocalDate.of(2019, Month.DECEMBER, 1)); Car ID_CROZZ = new Car(UUID.randomUUID(), "ID. CROZZ", LocalDate.of(2021, Month.MAY, 1)); Car ID_VIZZION = new Car(UUID.randomUUID(), "ID. VIZZION", LocalDate.of(2021, Month.DECEMBER, 1)); Car ID_BUZZ = new Car(UUID.randomUUID(), "ID. BUZZ", LocalDate.of(2021, Month.DECEMBER, 1)); Set vwConcepts = Set.of(ID, ID_BUZZ, ID_CROZZ, ID_VIZZION); return args -> { repository .deleteAll() (4) .thenMany( Flux .just(vwConcepts) .flatMap(repository::saveAll) ) .thenMany(repository.findAll()) .subscribe(car -> log.info("saving " + car.toString())); (5) }; } } @Document @Data @NoArgsConstructor @AllArgsConstructor class Car { (6) @Id private UUID id; private String name; private LocalDate releaseDate; } interface CarRepository extends ReactiveMongoRepository { } (7) @RestController class CarController { (8) private CarRepository carRepository; public CarController(CarRepository carRepository) { this.carRepository = carRepository; } @PostMapping("/cars") @ResponseStatus(HttpStatus.CREATED) public Mono addCar(@RequestBody Car car) { (9) return carRepository.save(car); } @GetMapping("/cars") public Flux getCars() { (10) return carRepository.findAll(); } @DeleteMapping("/cars/{id}") public Mono> deleteCar(@PathVariable("id") UUID id) { return carRepository.findById(id) .flatMap(car -> carRepository.delete(car) .then(Mono.just(new ResponseEntity(HttpStatus.OK))) ) .defaultIfEmpty(new ResponseEntity<>(HttpStatus.NOT_FOUND)); } } |
- 添加@EnableEurekaClient批注以进行服务发现
- @ Slf4j是Lombok的一个方便注释,可用于登录类
- ApplicationRunner bean用默认数据填充MongoDB
- 删除MongoDB中的所有现有数据,以免添加新数据
- 订阅结果,以便同时调用deleteAll()和saveAll()
- 带有Spring Data NoSQL和Lombok注释的汽车类,以减少样板
- CarRepository接口扩展了ReactiveMongoRepository,几乎没有任何代码即可提供CRUD功能!
- 使用CarRepository执行CRUD操作的CarController类
- Spring WebFlux返回单个对象的Mono发布者
10. 为多个对象返回一个Flex发布者
如果你使用IDE来构建项目,则需要为IDE设置Lombok。
你还需要修改car-service
项目的application.properties
以设置其名称和端口。
spring.application.name=car-service server.port=8081 |
运行MongoDB
运行MongoDB的最简单方法是从car-service / pom.xml中的flappoodle依赖项中删除测试范围。这将导致你的应用程序启动嵌入式MongoDB依赖关系。
de.flapdoodle.embed de.flapdoodle.embed.mongo
|
你还可以使用Homebrew安装和运行MongoDB
或者,使用Docker:
docker run -d -it -p 27017:27017 mongo |
使用WebFlux传输数据
这就完成了使用Spring WebFlux构建REST API所需完成的所有工作。
“但是等等!”你可能会说。 “我以为WebFlux就是关于流数据的?”
在此特定示例中,你仍然可以从/cars
端点流式传输数据,但不能在浏览器中。
除了使用服务器发送事件或WebSocket之外,浏览器无法使用流。但是,非浏览器客户端可以通过发送具有application/stream+json
值的Accept
header来获取JSON流(感谢Rajeev Singh的技巧)。
你可以通过启动浏览器并使用HTTPie发出请求来测试此时一切正常。但是,编写自动化测试会更好!
使用WebTestClient测试你的WebFlux API
WebClient是Spring WebFlux的一部分,可用于发出响应请求,接收响应以及使用有效负载填充对象。 伴随类WebTestClient可用于测试WebFlux API。 它包含与WebClient相似的请求方法,以及检查响应正文,状态和标头的方法。
修改car-service
项目中的src/test/java/…
/CarServiceApplicationTests.java
类以包含以下代码。
package com.example.carservice; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.http.MediaType; import org.springframework.test.context.junit4.SpringRunner; import org.springframework.test.web.reactive.server.WebTestClient; import reactor.core.publisher.Mono; import java.time.LocalDate; import java.time.Month; import java.util.Collections; import java.util.UUID; @RunWith(SpringRunner.class) @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, properties = {"spring.cloud.discovery.enabled = false"}) public class CarServiceApplicationTests { @Autowired CarRepository carRepository; @Autowired WebTestClient webTestClient; @Test public void testAddCar() { Car buggy = new Car(UUID.randomUUID(), "ID. BUGGY", LocalDate.of(2022, Month.DECEMBER, 1)); webTestClient.post().uri("/cars") .contentType(MediaType.APPLICATION_JSON_UTF8) .accept(MediaType.APPLICATION_JSON_UTF8) .body(Mono.just(buggy), Car.class) .exchange() .expectStatus().isCreated() .expectHeader().contentType(MediaType.APPLICATION_JSON_UTF8) .expectBody() .jsonPath("$.id").isNotEmpty() .jsonPath("$.name").isEqualTo("ID. BUGGY"); } @Test public void testGetAllCars() { webTestClient.get().uri("/cars") .accept(MediaType.APPLICATION_JSON_UTF8) .exchange() .expectStatus().isOk() .expectHeader().contentType(MediaType.APPLICATION_JSON_UTF8) .expectBodyList(Car.class); } @Test public void testDeleteCar() { Car buzzCargo = carRepository.save(new Car(UUID.randomUUID(), "ID. BUZZ CARGO", LocalDate.of(2022, Month.DECEMBER, 2))).block(); webTestClient.delete() .uri("/cars/{id}", Collections.singletonMap("id", buzzCargo.getId())) .exchange() .expectStatus().isOk(); } } |
为了证明它有效,请运行./mvnw test
。测试通过后,请拍一下自己的背!
![使用Spring Cloud Gateway保护反应式微服务(一)_第3张图片](http://img.e-com-net.com/image/info8/1a52a49407ff4b579ab07767c713b62d.jpg)
如果你使用的是Windows,请使用 mvnw test
.
这篇先讲到这,下篇继续:使用Spring Cloud Gateway保护反应式微服务(二)
另外近期整理了一套完整的java架构思维导图,分享给同样正在认真学习的每位朋友~
![使用Spring Cloud Gateway保护反应式微服务(一)_第4张图片](http://img.e-com-net.com/image/info8/d5922e0f5be34868856cb3124ff32635.jpg)