实战SpringCloud响应式微服务系列教程（第八章）构建响应式RESTful服务-阿里云开发者社区

实战SpringCloud响应式微服务系列教程（第八章）构建响应式RESTful服务

2024-06-28 295

版权

本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

简介： 实战SpringCloud响应式微服务系列教程（第八章）构建响应式RESTful服务

1.使用springboot2.1.4构建RESTful风格服务

Springboot的设计是用来简化Spring应用程序的初始搭建和开发过程，为了实现这种简化效果，Springboot继承了众多第三方库，并大量使用约定优于配置的设计理念，通过特定的方式使得开发人员不再需要定义繁杂而且多余的配置内容。

1.1基于Springboot的第一个RESTful服务

微服务架构推崇采用RESTful风格实现服务之间的交互。关于RESTful，很多开发人员在知识体系上的一些误解和不足。我们先对RESTful风格做一个简单的介绍，然后详细阐述使用 SpringBoot构建单个RESTful服务的过程。

（1）RESTful风格简介

REST提出了一组建构约束条件和原则，满足这些约束条件和原则的设计风格就是RESTful。

现实世界中的事物都可以被认为一种资源，我们可以根据这些约束条件和原则设计以资源为中心的服务。REST中最重要的一条原则就是客户端和服务器之间的交互无状态性。

从客户端到服务器的每个请求都必须包含理解该请求所必需的信息，无状态请求可以由任何可用服务实现响应，十分适合微服务架构的运行环境。所以RESTful代表的实际上是一种风格，而不是一种设计和架构模式，更不是一种具体的技术体系。

关于RESTful另一个比较容易忽视的核心概念是HATEOAS（Hypermedia as the Engine of Application State,基于超媒体的应用状态引擎）。要解释HATEOAS的概念，先要解释什么是超媒体。

我们已经知道什么是超链接以及什么是超文本，其中超文本的特有优势是拥有超链接。如果把超链接映入到多媒体中，就得到了超媒体。因此关键要素还是超链接。使用过超媒体作为应用引擎状态，意思就是应用引擎的状态变更由客户端访问不同的超媒体资源来驱动。

使用HATEOAS表现服务请求响应的风格如下，可以看到这里多了_links属性，其中有一个self.href链接指向当前user资源。

GET http://api.example.com/users/tianyalan
Content-type:application/json
{
   _links:{
      self:{
         href:"/users/tianyalan"
       }
   }
  "id":"tianyalan",
   "name":"tianyalan",
   "email":"tianyalan@email.com"
}

HATEOAS在spring boot和spring cloud中应用也非常广泛，例如springboot提供了应用监控组件Actuator,通过Actuator可以获取springboot应用程序当前的运行状态，我们将在后续章节中详细介绍Actuator组件。

Actuator组件对外暴露的也是一些http端点，访问这些端点返回的数据跟常见的RESTful风格有所不同，这就是HATEOAS风格，所以可以参考相关资料进一步了解。

（2）引入spring-boot-starter-web工程

spring boot提供了一系列starter工程来简化各组件之间的依赖关系。

例如在springboot中开发基于RESTful风格的端点时，通常会引入spring-boot-starter-web这个工程，而打开这个工程会发现里面实际上只定义了如下所示的一些pom依赖，其中包括所有我们能够预见到的组件，例如非常经典的spring-web，spring-webmvc组件，可以看到spring-boot-starter-web还是基于这两个组件构建web请求响应流程的。

另外还包含了基于JSON序列化和反序列化的jackson-databind组件，以及启动内置tomcat服务器的spring-boot-starter-tomcat组件。

org.springframework.boot:spring-boot-starter

org.springframework.boot:spring-boot-starter-tomcat

org.springframework.boot:spring-boot-starter-validation

org.springframework.boot:spring-web

org.springframework.boot:spring-webmvc

org.fasterxml.jackson.core:jackson-databind

引入spring-boot-starter-web就像引入一个普通的maven依赖一样，代码如下：

org.springframework.boot

spring-boot-starter-web

一旦spring-boot-starter-web组件引入完毕，我们就可以充分利用springboot的自动装配机制开发单个服务。

（3）Application类

使用springboot的首要条件是构建一个Application启动类。代码如下：

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

结构比较固化。

显然以上代码关键的是@SpringBootApplication注解。springboot使用@SpringBootApplication注解来告诉spring容器具备该注解的类是整个spring容器中所有 javaBean对象的入口，而具备该注解的类在springboot中就是Application类。

在上面代码中，SoulApplication类就是整个容器的Application类。

@SpringBootApplication注解在指定Application类的同时，还会自动扫描与当前类同级以及子包下的@Component、@Service、@Repository、@Controller、@Entity等注解，并把这些注解对应的类转换为Bean对象全部加载到Spring容器中管理起来。
@SpringBootApplication注解的定义如下，我们可以看到该注解实际上由三个注解组合而成，分别是@Configuration、@EnableAutoConfigguration和@ComponentScan。
@Target(ElementType.TYPE)
@Retenation(RetentionPolicy.PUNTIME)
@Documented
@Inherited
@Configuration
@EnableAutoConfigguration
@ComponentScan
public @interface SpringBootApplication

在Spring 中@Configuration比较常见，提供javaConfig配置类实现。而@ComponentScan则扫描@Component等注解，帮相关的javaBean定义批量加载到IOC容器中。@EnableAutoConfigguration最终会使用JDK提供的SPI机制来实现类的动态加载。

关于@EnableAutoConfigguration注解更多的可以参考相关的资料。

我们还注意到在上面的代码示例中包含一个main函数并执行了ApplicationContext对象，我们可以根据需求对该ApplicationContext对象做响应处理。

（4）Controller类

Application类提供了Springboot程序的入口，相当于应用程序拥有了最基本的骨架。接下来我们就可以添加各种业务相关的访问入口，表现在RESTful风格上也就是一系列的Controller类所代表的的HTTP端点。

这里的Controller和springMvc的Controller在概念上是一致的。最简单的Controller如下：

@RestController
public class HelloController{
     @GetMapping("/")
     public String index(){
          return "Hello Spring Boot";
     }
}

以上代码包含了@RestController和@GetMapping("/")两个注解。我们知道在springMvc中包含了@Controller注解用来表示当前类是一个servlet。

而@RestController继承了@Controller，它告诉Springboot这是一个基于RESTful风格的HTTP端点，并会自动使用JSON实现HTTP请求和响应的序列化和反序列化操作。至于@GetMapper类似@RequestMapping，指定请求方式为GET。这里不做多余介绍。

以下代码展示了一个典型的Controller，在Controller中通过静态的业务代码完成了根据商品编号，获取商品信息的业务流程。

这里用到了两层Mapping注解，在服务层级定义了服务的版本和路径，分别为v1和products;而在操作级别有定义了HTTP请求方法的具体路径及参数信息。

@RestController
@RequestMapping("/v1/products")
public class Productontroller{
     @GetMapping("/{productCode}")
     public Product getProduct(@PathVariable String productCode){
          Product product = new Product();
          product .setId(1L);
   product .setPrice(100F);
   product .setProductCode("product001");
   product .setProductName("product");
   return product;
     }
}