Http服务接入

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

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

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

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

    • SpringBoot 用户

      可以参考:

      在你的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>
    • SpringMvc 用户

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

      并在你的 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. <!-- 根据实际的注册类型配置客户端注册仓库 -->
    13. <bean id="clientRegisterRepository" class="org.apache.shenyu.register.client.http.HttpClientRegisterRepository">
    14. <constructor-arg ref="shenyuRegisterCenterConfig"/>
    15. </bean>
    16. <bean id="shenyuClientShutdownHook" class="org.apache.shenyu.client.core.shutdown.ShenyuClientShutdownHook">
    17. <constructor-arg ref="shenyuRegisterCenterConfig"/>
    18. <constructor-arg ref="clientRegisterRepository"/>
    19. </bean>
    20. <bean id="contextRegisterListener" class="org.apache.shenyu.client.springmvc.init.ContextRegisterListener">
    21. <constructor-arg ref="clientPropertiesConfig"/>
    22. </bean>
    23. ```
    24. 在你的 `controller` 的接口上加上 `@ShenyuSpringMvcClient` 注解。
    25. 你可以把注解加到 `Controller` 类上面,里面的`path`属性则为前缀,如果含有 `/**` 代表你的整个接口需要被网关代理。

    示例一

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

    示例二

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

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

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

    • 启动你的项目,你的服务接口接入到了网关,进入shenyu-admin后台管理系统的插件列表 -> http process -> divide,看到自动创建的选择器和规则。

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

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

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

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

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

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