Dubbo服务接入

    • 此篇文章是介绍 服务接入到 Apache ShenYu 网关，Apache ShenYu 网关使用 dubbo 插件来接入Dubbo服务。
    • 当前支持 alibaba dubbo（< 2.7.x） 以及 apache dubbo (>=2.7.x)。
    • 接入前，请正确启动 shenyu-admin，并开启dubbo插件，在网关端和Dubbo服务端引入相关依赖。可以参考前面的 Dubbo快速开始。

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

    在网关中引入 dubbo 插件

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

      • alibaba dubbo 用户, dubbo 版本换成你的，引入你需要的注册中心依赖，以下是参考。

      • apache dubbo 用户，dubbo 版本换成你的，引入你需要的注册中心依赖，如下是参考。

        ```

        org.apache.shenyu shenyu-spring-boot-starter-plugin-apache-dubbo ${project.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.     ```
    • 重启网关服务。

    可以参考：

    • alibaba dubbo 用户

    如果是springboot构建，引入以下依赖：

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

    如果是spring构建，引入以下依赖：

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

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

    1. <bean id ="alibabaDubboServiceBeanPostProcessor" class ="org.apache.shenyu.client.alibaba.dubbo.AlibabaDubboServiceBeanPostProcessor">
    2.    <constructor-arg  ref="shenyuRegisterCenterConfig"/>
    3. </bean>
    6.        <property name="registerType" value="http"/>
    7.        <property name="serverList" value="http://localhost:9095"/>
    8.        <property name="props">
    9.           <map>
    10.             <entry key="contextPath" value="/你的contextPath"/>
    11.             <entry key="appName" value="你的名字"/>
    12.             <entry key="ifFull" value="false"/>
    13.           </map>
    15.   </bean>
    • apache dubbo 用户

    如果是springboot构建，引入以下依赖：

    如果是spring构建，引入以下依赖：

    1. <dependency>
    2.    <groupId>org.apache.shenyu</groupId>
    3.    <artifactId>shenyu-client-apache-dubbo</artifactId>
    4.    <version>${shenyu.version}</version>
    5. </dependency>
    1.   <bean id ="apacheDubboServiceBeanPostProcessor" class ="org.apache.shenyu.client.apache.dubbo.ApacheDubboServiceBeanPostProcessor">
    2.        <constructor-arg ref="shenyuRegisterCenterConfig"/>
    3.   </bean>
    6.   <bean id="shenyuRegisterCenterConfig" class="org.apache.shenyu.register.common.config.ShenyuRegisterCenterConfig">
    7.        <property name="registerType" value="http"/>
    8.        <property name="serverList" value="http://localhost:9095"/>
    9.        <property name="props">
    10.           <map>
    11.             <entry key="contextPath" value="/你的contextPath"/>
    12.             <entry key="appName" value="你的名字"/>
    13.             <entry key="ifFull" value="false"/>
    14.           </map>
    15.         </property>
    16.   </bean>

    dubbo 插件设置

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

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

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

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

    • 启动你的提供者，成功启动后，进入后台管理系统的插件列表 -> rpc proxy -> dubbo，会看到自动注册的选择器和规则信息。

    dubbo用户请求及参数说明

    可以通过 http 的方式来请求你的 dubbo 服务。Apache ShenYu 网关需要有一个路由前缀，这个路由前缀就是你接入项目进行配置 contextPath

    • 参数传递：

      • 通过 http协议， post 方式访问网关，通过在http body中传入json类型参数。

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

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

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

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

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

      • ``` public interface DubboParamResolveService {

    • 标签路由

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

    • 服务提供者直连

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

    • 参数验证和自定义异常

      • 指定 validation = "shenyuValidation"。

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

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

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

    Http —> 网关 —> Dubbo Provider

    实际上就是把 http 请求，转成 dubbo 协议，内部使用 dubbo 泛化来进行调用。 dubbo 服务在接入网关的时候，加上了 @ShenyuDubboClient 注解，并设置了 path 字段来指定请求路径。 然后在yml中配置了 contextPath。

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

    1. @Override
    2. @ShenyuDubboClient(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. {}