Http服务接入

本文档旨在帮助 http 服务接入到 Apache ShenYu 网关。Apache ShenYu 网关使用 divide 插件来处理 http 请求。

接入前，请正确启动 shenyu-admin，并开启divide插件，在网关端和Http服务端引入相关依赖。可以参考前面的 Http快速开始。

应用客户端接入的相关配置请参考：客户端接入配置。

数据同步的相关配置请参考：数据同步配置。

在网关中引入 divide 插件

  • 在网关的 pom.xml 文件中增加如下依赖：

    1.     <dependency>
    2.         <groupId>org.apache.shenyu</groupId>
    3.         <artifactId>shenyu-spring-boot-starter-plugin-divide</artifactId>
    4.         <version>${project.version}</version>
    5.     </dependency>
    7.     <dependency>
    8.         <groupId>org.apache.shenyu</groupId>
    9.         <artifactId>shenyu-spring-boot-starter-plugin-httpclient</artifactId>
    10.         <version>${project.version}</version>
    11.     </dependency>

Http请求接入网关（springMvc 体系用户）

  • SpringBoot 用户

    可以参考：shenyu-examples-http

    1. 在你的http服务中的 pom.xml文件 新增如下依赖:
    1.     <dependency>
    2.         <groupId>org.apache.shenyu</groupId>
    3.         <artifactId>shenyu-spring-boot-starter-client-springmvc</artifactId>
    4.         <version>${shenyu.version}</version>
    5.     </dependency>
    1. 在 application.yaml 增加如下配置：
    1. shenyu:
    2.   register:
    3.     registerType: http #zookeeper #etcd #nacos #consul
    4.     serverLists: http://localhost:9095 #localhost:2181 #http://localhost:2379 #localhost:8848
    5.     props:
    6.       username: admin
    7.       password: 123456
    8.   client:
    9.     http:
    10.       props:
    11.         contextPath: /http
    12.         appName: http
    13.   #      port: 8189

  • SpringMvc 用户

    可以参考：shenyu-examples-springmvc

    在你的http服务中的 pom.xml文件 新增如下依赖:

    1.     <dependency>
    2.         <groupId>org.apache.shenyu</groupId>
    3.         <artifactId>shenyu-client-springmvc</artifactId>
    4.         <version>${shenyu.version}</version>
    5.     </dependency>

    并在你的 bean 定义的 xml 文件中新增如下：

    ```

  1.    <!-- 客户端属性配置 -->
  2.    <bean id="clientPropertiesConfig"
  3.          class="org.apache.shenyu.register.common.config.ShenyuClientConfig.ClientPropertiesConfig">
  4.      <property name="props">
  5.          <map>
  6.              <entry key="contextPath" value="/你的contextPath"/>
  7.              <entry key="appName" value="你的app名字"/>
  8.              <entry key="port" value="你的端口"/>
  9.              <entry key="isFull" value="false"/>
  10.          </map>
  11.      </property>
  12.    </bean>
  15.    <!-- 根据实际的注册类型配置客户端注册仓库 -->
  16.    <bean id="clientRegisterRepository" class="org.apache.shenyu.register.client.http.HttpClientRegisterRepository">
  17.        <constructor-arg ref="shenyuRegisterCenterConfig"/>
  18.    </bean>
  20.    <bean id="shenyuClientShutdownHook" class="org.apache.shenyu.client.core.shutdown.ShenyuClientShutdownHook">
  21.        <constructor-arg ref="shenyuRegisterCenterConfig"/>
  22.        <constructor-arg ref="clientRegisterRepository"/>
  23.    </bean>
  25.    <bean id="contextRegisterListener" class="org.apache.shenyu.client.springmvc.init.ContextRegisterListener">
  26.        <constructor-arg ref="clientPropertiesConfig"/>
  27.    </bean>
  28. ```
  30. 在你的 `controller` 的接口上加上 `@ShenyuSpringMvcClient` 注解。
  32. 你可以把注解加到 `Controller` 类上面，里面的`path`属性则为前缀，如果含有 `/**` 代表你的整个接口需要被网关代理。

示例一

下面表示的是 /test/payment，/test/findByUserId 都会被网关代理。

  1.   @RestController
  2.   @RequestMapping("/test")
  3.   @ShenyuSpringMvcClient(path = "/test/**")
  4.   public class HttpTestController {
  7.       @PostMapping("/payment")
  8.       public UserDTO post(@RequestBody final UserDTO userDTO) {
  9.           return userDTO;
  10.       }
  13.       @GetMapping("/findByUserId")
  14.       public UserDTO findByUserId(@RequestParam("userId") final String userId) {
  15.           UserDTO userDTO = new UserDTO();
  16.           userDTO.setUserId(userId);
  17.           userDTO.setUserName("hello world");
  18.           return userDTO;
  19.       }
  20.    }

示例二

下面表示的是： /order/save 会被网关代理，而 /order/findById 则不会。

  1.   @RestController
  2.   @RequestMapping("/order")
  3.   @ShenyuSpringMvcClient(path = "/order")
  4.   public class OrderController {
  7.       @PostMapping("/save")
  8.       @ShenyuSpringMvcClient(path = "/save")
  9.       public OrderDTO save(@RequestBody final OrderDTO orderDTO) {
  10.           orderDTO.setName("hello world save order");
  11.           return orderDTO;
  12.       }
  15.       @GetMapping("/findById")
  16.       public OrderDTO findById(@RequestParam("id") final String id) {
  17.           OrderDTO orderDTO = new OrderDTO();
  18.           orderDTO.setId(id);
  19.           orderDTO.setName("hello world findById");
  20.           return orderDTO;
  21.       }
  22.   }

示例三：这是一种简化的使用方式，只需要一个简单的注释即可使用元数据注册到网关. 特别说明：目前只支持@RequestMapping、@GetMapping、@PostMapping、@DeleteMapping、@PutMapping注解，并且只对@XXXMapping中的第一个路径有效

  1.   @RestController
  2.   @RequestMapping("new/feature")
  3.   public class NewFeatureController {
  5.     /**
  6.      * no support gateway access api.
  7.      *
  8.      * @return result
  9.      */
  10.     @RequestMapping("/gateway/not")
  11.     public EntityResult noSupportGateway() {
  12.       return new EntityResult(200, "no support gateway access");
  13.     }
  15.     /**
  16.      * Do not use shenyu annotation path. used request mapping path.
  17.      *
  18.      * @return result
  19.      */
  20.     @RequestMapping("/requst/mapping/path")
  21.     @ShenyuSpringCloudClient
  22.     public EntityResult requestMappingUrl() {
  23.       return new EntityResult(200, "Do not use shenyu annotation path. used request mapping path");
  24.     }
  26.     /**
  27.      * Do not use shenyu annotation path. used post mapping path.
  28.      *
  29.      * @return result
  30.      */
  31.     @PostMapping("/post/mapping/path")
  32.     @ShenyuSpringCloudClient
  33.     public EntityResult postMappingUrl() {
  34.       return new EntityResult(200, "Do not use shenyu annotation path. used post mapping path");
  35.     }
  37.     /**
  38.      * Do not use shenyu annotation path. used post mapping path.
  39.      *
  40.      * @return result
  41.      */
  42.     @GetMapping("/get/mapping/path")
  43.     @ShenyuSpringCloudClient
  44.     public EntityResult getMappingUrl() {
  45.       return new EntityResult(200, "Do not use shenyu annotation path. used get mapping path");
  46.     }
  47.   }
  • 启动你的项目，你的服务接口接入到了网关，进入shenyu-admin后台管理系统的插件列表 -> http process -> divide，看到自动创建的选择器和规则。

Http请求接入网关（其他语言，非springMvc体系）

  • 首先在 shenyu-admin 找到 divide 插件，进行选择器，和规则的添加，进行流量的匹配筛选。

  • 如果不懂怎么配置，请参考 选择器和规则管理。

  • 您也可以自定义开发属于你的 http-client，参考 多语言 Http 客户端开发。

用户请求

当你的Http服务接入到Apache ShenYu网关后，请求方式没有很大的变动，小的改动有两点。

  • 第一点，你之前请求的域名是你自己的服务，现在要换成网关的域名。

  • 第二点，Apache ShenYu 网关需要有一个路由前缀，这个路由前缀就是你接入项目进行配置 contextPath，如果熟的话，可以在 shenyu-admin 中的divide插件进行自由更改。

    • 比如你有一个 order 服务 它有一个接口，请求路径 http://localhost:8080/test/save。

    • 现在就需要换成：http://localhost:9195/order/test/save。

    • 其中 localhost:9195 为网关的ip端口，默认端口是9195 ，/order 是你接入网关配置的 contextPath。

    • 其他参数，请求方式不变。

然后你就可以进行访问了，如此的方便与简单。