Dubbo接入soul网关

说明

  • 此篇文章是dubbo用户使用dubbo插件支持，以及自己的dubbo服务接入soul网关的教程。
  • 支持 alibaba dubbo（< 2.7.x） 以及 apache dubbo (>=2.7.x)。
  • 接入前，请正确的启动 soul-admin，以及搭建环境 Ok。

引入网关对dubbo支持的插件

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

    • alibaba dubbo 用户, dubbo版本换成你的，注册中心的jar包换成你的，以下是参考。

      1. <!--soul alibaba dubbo plugin start-->
      2. <dependency>
      3.   <groupId>org.dromara</groupId>
      4.   <artifactId>soul-spring-boot-starter-plugin-alibaba-dubbo</artifactId>
      5.    <version>${last.version}</version>
      6. </dependency>
      7. <!-- soul  alibaba dubbo plugin end-->
      8. <dependency>
      9.   <groupId>com.alibaba</groupId>
      10.   <artifactId>dubbo</artifactId>
      11.   <version>2.6.5</version>
      12. </dependency>
      13. <dependency>
      14.   <groupId>org.apache.curator</groupId>
      15.   <artifactId>curator-client</artifactId>
      16.   <version>4.0.1</version>
      17. </dependency>
      18. <dependency>
      19.   <groupId>org.apache.curator</groupId>
      20.   <artifactId>curator-framework</artifactId>
      21.   <version>4.0.1</version>
      22. </dependency>
      23. <dependency>
      24.   <groupId>org.apache.curator</groupId>
      25.   <artifactId>curator-recipes</artifactId>
      26.   <version>4.0.1</version>
      27. </dependency>

    • apache dubbo 用户，dubbo版本换成你的，使用什么注册中心换成你的,以下是参考,使用什么注册中心，就引入啥。

      ```

      org.dromara soul-spring-boot-starter-plugin-apache-dubbo ${last.version} 

  1.     <dependency>
  2.        <groupId>org.apache.dubbo</groupId>
  3.        <artifactId>dubbo</artifactId>
  4.        <version>2.7.5</version>
  5.     </dependency>
  6.     <!-- Dubbo Nacos registry dependency start -->
  7.     <dependency>
  8.        <groupId>org.apache.dubbo</groupId>
  9.        <artifactId>dubbo-registry-nacos</artifactId>
  10.        <version>2.7.5</version>
  11.     </dependency>
  12.     <dependency>
  13.        <groupId>com.alibaba.nacos</groupId>
  14.        <artifactId>nacos-client</artifactId>
  15.        <version>1.1.4</version>
  16.     </dependency>
  17.     <!-- Dubbo Nacos registry dependency  end-->
  20.     <!-- Dubbo zookeeper registry dependency start-->
  21.     <dependency>
  22.        <groupId>org.apache.curator</groupId>
  23.        <artifactId>curator-client</artifactId>
  24.        <version>4.0.1</version>
  25.     </dependency>
  26.     <dependency>
  27.        <groupId>org.apache.curator</groupId>
  28.        <artifactId>curator-framework</artifactId>
  29.        <version>4.0.1</version>
  30.     </dependency>
  31.     <dependency>
  32.        <groupId>org.apache.curator</groupId>
  33.        <artifactId>curator-recipes</artifactId>
  34.        <version>4.0.1</version>
  35.     </dependency>
  36.     <!-- Dubbo zookeeper registry dependency end -->
  37.     ```
  • 重启网关服务。

dubbo服务接入网关，可以参考：soul-examples-dubbo

  • alibaba dubbo 用户

    • springboot

      • 引入以下依赖

        1. <dependency>
        2.      <groupId>org.dromara</groupId>
        3.      <artifactId>soul-spring-boot-starter-client-alibaba-dubbo</artifactId>
        4.      <version>${last.version}</version>
        5. </dependency>

      • 注册中心详细接入配置请参考：注册中心接入。

    • spring

      • 引入以下依赖 ：

        1. <dependency>
        2.    <groupId>org.dromara</groupId>
        3.    <artifactId>soul-client-alibaba-dubbo</artifactId>
        4.    <version>${last.version}</version>
        5. </dependency>

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

        ```

  1.         <bean id="soulRegisterCenterConfig" class="org.dromara.soul.register.common.config.SoulRegisterCenterConfig">
  2.                <property name="registerType" value="http"/>
  3.                <property name="serverList" value="http://localhost:9095"/>
  4.                <property name="props">
  5.                   <map>
  6.                     <entry key="contextPath" value="/你的contextPath"/>
  7.                     <entry key="appName" value="你的名字"/>
  8.                     <entry key="ifFull" value="false"/>
  9.                   </map>
  10.                 </property>
  11.           </bean>
  12.         ```

  • apache dubbo 用户

    • springboot

      • 引入以下依赖

        1. <dependency>
        2.     <groupId>org.dromara</groupId>
        3.     <artifactId>soul-spring-boot-starter-client-apache-dubbo</artifactId>
        4.     <version>${last.version}</version>
        5. </dependency>

      • 注册中心详细接入配置请参考：注册中心配置.

    • spring

      • 引入以下依赖 ：

        1. <dependency>
        2.    <groupId>org.dromara</groupId>
        3.    <artifactId>soul-client-apache-dubbo</artifactId>
        4.    <version>${last.version}</version>
        5. </dependency>

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

        ```

  1.           <bean id="soulRegisterCenterConfig" class="org.dromara.soul.register.common.config.SoulRegisterCenterConfig">
  2.                <property name="registerType" value="http"/>
  3.                <property name="serverList" value="http://localhost:9095"/>
  4.                <property name="props">
  5.                   <map>
  6.                     <entry key="contextPath" value="/你的contextPath"/>
  7.                     <entry key="appName" value="你的名字"/>
  8.                     <entry key="ifFull" value="false"/>
  9.                   </map>
  10.                 </property>
  11.           </bean>
  12.         ```

dubbo 插件设置

  • 首先在 soul-admin 插件管理中，把dubbo 插件设置为开启。

  • 其次在 dubbo 插件中配置你的注册地址，或者其他注册中心的地址。

  1. {"register":"zookeeper://localhost:2181"}   or {"register":"nacos://localhost:8848"}

接口注册到网关

  • 你dubbo服务实现类的，方法上加上 @SoulDubboClient 注解，表示该接口方法注册到网关。

  • 启动你的提供者，输出日志 dubbo client register success 大功告成，你的dubbo接口已经发布到 soul网关.如果还有不懂的，可以参考 soul-test-dubbo项目。

dubbo用户请求以及参数说明

  • 说白了，就是通过http的方式来请求你的dubbo服务

  • soul网关需要有一个路由前缀，这个路由前缀就是你接入项目进行配置 contextPath

  1. # 比如你有一个 order服务 它有一个接口，它的注册路径 /order/test/save
  4. # 现在就是通过 post方式请求网关：http://localhost:9195/order/test/save
  7. # 其中 localhost:9195 为网关的ip端口，默认端口是9195 ，/order 是你dubbo接入网关配置的 contextPath

  • 参数传递：

    • 通过 http post 方式访问网关，通过body，json类型传递。

    • 更多参数类型传递，可以参考 soul-examples-dubbo 中的接口定义，以及参数传递方式。

  • 单个java bean参数类型 （默认）

  • 多参数类型支持，在网关的yaml 配置中新增如下配置：

  1. soul :
  2.     dubbo :
  3.       parameter: multi

  • 自定义实现多参数支持:

    • 在你搭建的网关项目中，新增一个类 A，实现 org.dromara.soul.web.dubbo.DubboParamResolveService。

      ``` public interface DubboParamResolveService {

  1.        /**
  2.         * Build parameter pair.
  3.         * this is Resolve http body to get dubbo param.
  4.         *
  5.         * @param body           the body
  6.         * @param parameterTypes the parameter types
  7.         * @return the pair
  8.         */
  9.        Pair<String[], Object[]> buildParameter(String body, String parameterTypes);
  10.     }
  11.     ```
  13. -   `body`为http中body传的json字符串。
  15. -   `parameterTypes`: 匹配到的方法参数类型列表，如果有多个，则使用`,`分割。
  17. -   Pair中，left为参数类型，right为参数值，这是dubbo泛化调用的标准
  19. -   把你的类注册成Spring的bean，覆盖默认的实现。
  21. ```
  22.  @Bean
  23.  public DubboParamResolveService A() {
  24.          return new A();
  25.  }
  26. ```

服务治理

  • 标签路由

    • 请求时在header中添加Dubbo_Tag_Route，并设置对应的值，之后当前请求就会路由到指定tag的provider，只对当前请求有效；

  • 服务提供者直连

    • 设置@SoulDubboClient注解中的url属性；
    • 修改Admin控制台修改元数据内的url属性；
    • 对所有请求有效；

  • 参数验证和自定义异常

    • 指定validation="soulValidation";

    • 在接口中抛出SoulException时，异常信息会返回，需要注意的是显式抛出SoulException；

      ``` @Service(validation = “soulValidation”) public class TestServiceImpl implements TestService {

  1.         @Override
  2.         @SoulDubboClient(path = "/test", desc = "test method")
  3.         public String test(@Valid HelloServiceRequest name) throws SoulException {
  4.             if (true){
  5.                 throw new SoulException("Param binding error.");
  6.             }
  7.             return "Hello " + name.getName();
  8.         }
  9.     }
  10.     ```
  12. -   请求参数
  14.     ```
  15.     public class HelloServiceRequest implements Serializable {
  18.         private static final long serialVersionUID = -5968745817846710197L;
  21.         @NotEmpty(message = "name cannot be empty")
  22.         private String name;
  25.         @NotNull(message = "age cannot be null")
  26.         private Integer age;
  29.         public String getName() {
  30.             return name;
  31.         }
  34.         public void setName(String name) {
  35.             this.name = name;
  36.         }
  39.         public Integer getAge() {
  40.             return age;
  41.         }
  44.         public void setAge(Integer age) {
  45.             this.age = age;
  46.         }
  47.     }
  48.     ```
  50. -   发送请求
  52.     ```
  53.     {
  54.         "name": ""
  55.     }
  56.     ```
  58. -   返回
  60.     ```
  61.     {
  62.         "code": 500,
  63.         "message": "Internal Server Error",
  64.         "data": "name cannot be empty,age cannot be null"
  65.     }
  66.     ```
  68. -   当按照要求传递请求参数时，会返回自定义异常的信息
  70.     ```
  71.     {
  72.         "code": 500,
  73.         "message": "Internal Server Error",
  74.         "data": "Param binding error."
  75.     }
  76.     ```

大白话讲解如果通过http —> 网关—> dubbo provider

  • 说白了，就是把http请求，转成dubbo协议，内部使用dubbo泛化来进行调用。

  • 首先你要回想下，你的dubbo服务在接入网关的时候，是不是加了个 @SoulDubboClient 注解，里面是不是有个path字段来指定你请求的路径？

  • 你是不是还在yml中配置了一个 contextPath?

  • 如果您还记得，那我们就开始。

  • 假如你有一个这样的方法, contextPath 配置的是 /dubbo

  1. @Override
  2. @SoulDubboClient(path = "/insert", desc = "插入一条数据")
  3. public DubboTest insert(final DubboTest dubboTest) {
  4.     return dubboTest;
  5. }

  • 那么我们请求的路径为：http://localhost:9195/dubbo/insert，再说一下，localhost:9195是网关的域名，如果你更改了，这里也要改。

  • 那么请求参数呢？ DubboTest 是一个javabean对象，有2个字段，id与name ，那么我们通过body中传递这个对象的json数据就好。

    1. {"id":"1234","name":"XIAO5y"}

  • 如果你的接口中，没有参数，那么body传值为：

    1. {}

  • 如果你的接口有很多个参数？往上看一点，有介绍。