Http用户

说明

  • 本文旨在帮助http用户。
  • soul网关使用 divide 插件来处理http请求。请求在soul-admin后台开启它。
  • 接入前,请正确的启动 soul-admin,以及 搭建环境 OK。

引入网关对http的代理插件

  • 在网关的 pom.xml 文件中增加如下依赖:
  1. <!--if you use http proxy start this-->
  2. <dependency>
  3. <groupId>org.dromara</groupId>
  4. <artifactId>soul-spring-boot-starter-plugin-divide</artifactId>
  5. <version>${last.version}</version>
  6. </dependency>
  7. <dependency>
  8. <groupId>org.dromara</groupId>
  9. <artifactId>soul-spring-boot-starter-plugin-httpclient</artifactId>
  10. <version>${last.version}</version>
  11. </dependency>
  • 当然是要重新启动网关。

Http请求接入网关(springMvc体系用户)

  • 首先要确保在 soul-admin 后台 divide插件是否开启。
Soul-Client接入方式。 (此方式针对SpringMvc,SpringBoot用户)
  • SpringBoot用户

    • 在你的真实服务的 pom.xml 新增如下依赖:

      1. <dependency>
      2. <groupId>org.dromara</groupId>
      3. <artifactId>soul-spring-boot-starter-client-springmvc</artifactId>
      4. <version>${last.version}</version>
      5. </dependency>
    • 注册中心详细接入配置请参考:注册中心接入.

  • SpringMvc用户

    • 在你的真实服务的 pom.xml 新增如下依赖:

      1. <dependency>
      2. <groupId>org.dromara</groupId>
      3. <artifactId>soul-client-springmvc</artifactId>
      4. <version>${last.version}</version>
      5. </dependency>
    • 在你的 bean定义的xml文件中新增如下:

      1. <bean id ="springMvcClientBeanPostProcessor" class ="org.dromara.soul.client.springmvc.init.SpringMvcClientBeanPostProcessor">
      2. <constructor-arg ref="soulRegisterCenterConfig"/>
      3. </bean>
      4. <bean id="soulRegisterCenterConfig" class="org.dromara.soul.register.common.config.SoulRegisterCenterConfig">
      5. <property name="registerType" value="http"/>
      6. <property name="serverList" value="http://localhost:9095"/>
      7. <property name="props">
      8. <map>
      9. <entry key="contextPath" value="/你的contextPath"/>
      10. <entry key="appName" value="你的名字"/>
      11. <entry key="port" value="你的端口"/>
      12. <entry key="isFull" value="false"/>
      13. </map>
      14. </property>
      15. </bean>
  • 在你的 controller 的接口上加上 @SoulSpringMvcClient 注解。

    • 你可以把注解加到 Controller 类上面,里面的path属性则为前缀,如果含有 /** 代表你的整个接口需要被网关代理。

    • 举例子 (1): 代表 /test/payment/test/findByUserId 都会被网关代理。

    1. @RestController
    2. @RequestMapping("/test")
    3. @SoulSpringMvcClient(path = "/test/**")
    4. public class HttpTestController {
    5. @PostMapping("/payment")
    6. public UserDTO post(@RequestBody final UserDTO userDTO) {
    7. return userDTO;
    8. }
    9. @GetMapping("/findByUserId")
    10. public UserDTO findByUserId(@RequestParam("userId") final String userId) {
    11. UserDTO userDTO = new UserDTO();
    12. userDTO.setUserId(userId);
    13. userDTO.setUserName("hello world");
    14. return userDTO;
    15. }
    16. }
    • 举例子 (2):代表 /order/save,会被网关代理,而/order/findById 则不会。

      1. @RestController
      2. @RequestMapping("/order")
      3. @SoulSpringMvcClient(path = "/order")
      4. public class OrderController {
      5. @PostMapping("/save")
      6. @SoulSpringMvcClient(path = "/save")
      7. public OrderDTO save(@RequestBody final OrderDTO orderDTO) {
      8. orderDTO.setName("hello world save order");
      9. return orderDTO;
      10. }
      11. @GetMapping("/findById")
      12. public OrderDTO findById(@RequestParam("id") final String id) {
      13. OrderDTO orderDTO = new OrderDTO();
      14. orderDTO.setId(id);
      15. orderDTO.setName("hello world findById");
      16. return orderDTO;
      17. }
      18. }
  • 启动你的项目,你的接口接入到了网关。

Http请求接入网关(其他语言,非springMvc体系)

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

  • 如果不懂怎么配置,请看选择,规则介绍 选择器规则介绍

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

用户请求

  • 说白了,你之前怎么请求就怎么请求,没有很大的变动,变动的地方有2点。

  • 第一点,你之前请求的域名是你自己的服务,现在要换成网关的域名 (这个你听的懂?)

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

    • 比如你有一个 order服务 它有一个接口,请求路径 http://localhost:8080/test/save
    • 现在就需要换成:http://localhost:9195/order/test/save
    • 其中 localhost:9195 为网关的ip端口,默认端口是9195 ,/order 是你接入网关配置的 contextPath
    • 其他参数,请求方式不变。
    • 我讲到这里还不懂? 请加群问吧
  • 然后你就可以进行访问了,如此的方便与简单。