QOS 概述

QoS 命令的设计目的、使用方法说明，包括如何开启、关闭 qos 命令等，支持 HTTP/Telnet 访问方式，

如何使用

QoS 提供了一些启动参数，来对启动进行配置，他们主要包括：

参数说明默认值
qos-enable是否启动QoStrue
qos-port启动QoS绑定的端口22222
qos-accept-foreign-ip是否允许远程访问false
qos-accept-foreign-ip-whitelist支持的远端主机ip地址（段）(无)
qos-anonymous-access-permission-level支持的匿名访问的权限级别PUBLIC(1)

注意，从2.6.4/2.7.0开始，qos-accept-foreign-ip默认配置改为false，如果qos-accept-foreign-ip设置为true，有可能带来安全风险，请仔细评估后再打开。

telnet 与 http 协议

telnet 模块现在同时支持 http 协议和 telnet 协议，方便各种情况的使用 示例：

  1. ➜  ~ telnet localhost 22222
  2. Trying ::1...
  3. telnet: connect to address ::1: Connection refused
  4. Trying 127.0.0.1...
  5. Connected to localhost.
  6. Escape character is '^]'.
  7.   ████████▄  ███    █▄  ▀█████████▄  ▀█████████▄   ▄██████▄
  8.   ███   ▀███ ███    ███   ███    ███   ███    ███ ███    ███
  9.   ███    ███ ███    ███   ███    ███   ███    ███ ███    ███
  10.   ███    ███ ███    ███  ▄███▄▄▄██▀   ▄███▄▄▄██▀  ███    ███
  11.   ███    ███ ███    ███ ▀▀███▀▀▀██▄  ▀▀███▀▀▀██▄  ███    ███
  12.   ███    ███ ███    ███   ███    ██▄   ███    ██▄ ███    ███
  13.   ███   ▄███ ███    ███   ███    ███   ███    ███ ███    ███
  14.   ████████▀  ████████▀  ▄█████████▀  ▄█████████▀   ▀██████▀
  17. dubbo>ls
  18. As Provider side:
  19. +----------------------------------+---+
  20. |       Provider Service Name      |PUB|
  21. +----------------------------------+---+
  22. |org.apache.dubbo.demo.DemoService| N |
  23. +----------------------------------+---+
  24. As Consumer side:
  25. +---------------------+---+
  26. |Consumer Service Name|NUM|
  27. +---------------------+---+
  29. dubbo>

端口

新版本的 telnet 端口 与 dubbo 协议的端口是不同的端口，默认为 22222

可以通过配置文件dubbo.properties 修改:

  1. dubbo.application.qos-port=33333

或者

可以通过设置 JVM 参数:

  1. -Ddubbo.application.qos-port=33333

安全

默认情况下，dubbo 接收任何主机发起的命令

可以通过配置文件dubbo.properties 修改:

  1. dubbo.application.qos-accept-foreign-ip=false

或者

可以通过设置 JVM 参数:

  1. -Ddubbo.application.qos-accept-foreign-ip=false

拒绝远端主机发出的命令，只允许服务本机执行。

同时可以通过设置qos-accept-foreign-ip-whitelist来指定支持的远端主机ip地址（段），多个ip地址（段）之间用逗号分隔，如：

配置文件dubbo.properties

  1. dubbo.application.qos-accept-foreign-ip-whitelist=123.12.10.13, 132.12.10.13/24

设置 JVM 参数:

  1. -Ddubbo.application.qos-accept-foreign-ip-whitelist=123.12.10.13,132.12.10.13/24

权限

为了对生命周期探针的默认支持，QoS 提供了匿名访问的能力以及对权限级别的设置，目前支持的权限级别有：

  • PUBLIC(1)
    默认支持匿名访问的命令权限级别，目前只支持生命周期探针相关的命令
  • PROTECTED(2)
    命令默认的权限级别
  • PRIVATE(3)
    保留的最高权限级别，目前未支持
  • NONE(4) 最低权限级别，即不支持匿名访问

权限级别 PRIVATE> PROTECTED> PUBLIC> NONE, 高级别权限可访问同级别和低级别权限命令。 当前以下命令权限为PUBLIC, 其它命令默认权限别为PROTECTED。

命令权限等级
LivePUBLIC (1)
StartupPUBLIC (1)
ReadyPUBLIC (1)
QuitPUBLIC (1)

默认情况下，dubbo 允许匿名主机发起匿名访问，只有PUBLIC权限级别的命令可以执行，其他更高权限的命令会被拒绝。

关闭匿名访问
可以通过设置qos-anonymous-access-permission-level=NONE来关闭匿名访问。

设置权限级别
可以通过配置文件dubbo.properties 修改:

  1. dubbo.application.qos-anonymous-access-permission-level=PROTECTED

或者

可以通过设置 JVM 参数:

  1. -Ddubbo.application.qos-anonymous-access-permission-level=PROTECTED

来允许匿名访问更高级别的权限的命令。

  1. ➜  ~ curl "localhost:22222/ls?arg1=xxx&arg2=xxxx"
  2. As Provider side:
  3. +----------------------------------+---+
  4. |       Provider Service Name      |PUB|
  5. +----------------------------------+---+
  6. |org.apache.dubbo.demo.DemoService| N |
  7. +----------------------------------+---+
  8. As Consumer side:
  9. +---------------------+---+
  10. |Consumer Service Name|NUM|
  11. +---------------------+---+

配置方式

优先顺序: 系统属性 > dubbo.properties > XML/Spring-boot 自动装配

系统属性

  1. -Ddubbo.application.qos-enable=true
  2. -Ddubbo.application.qos-port=33333
  3. -Ddubbo.application.qos-accept-foreign-ip=false
  4. -Ddubbo.application.qos-accept-foreign-ip-whitelist=123.12.10.13,132.12.10.13/24
  5. -Ddubbo.application.qos-anonymous-access-permission-level=PUBLIC

dubbo.properties

在项目的src/main/resources目录下添加 dubbo.properties文件，内容如下:

  1. dubbo.application.qos-enable=true
  2. dubbo.application.qos-port=33333
  3. dubbo.application.qos-accept-foreign-ip=false
  4. dubbo.application.qos-accept-foreign-ip-whitelist=123.12.10.13, 132.12.10.13/24
  5. dubbo.application.qos-anonymous-access-permission-level=PUBLIC

XML

如果要通过 XML 配置响应的QoS相关的参数，可以进行如下配置：

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <beans xmlns="http://www.springframework.org/schema/beans"
  3.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.        xmlns:dubbo="http://dubbo.apache.org/schema/dubbo"
  5.        xsi:schemaLocation="http://www.springframework.org/schema/beans
  6.        http://www.springframework.org/schema/beans/spring-beans.xsd
  7.        http://dubbo.apache.org/schema/dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd">
  8.   <dubbo:application name="demo-provider">
  9.     <dubbo:parameter key="qos-enable" value="true"/>
  10.     <dubbo:parameter key="qos-accept-foreign-ip" value="false"/>
  11.     <dubbo:parameter key="qos-accept-foreign-ip-whitelist" value="123.12.10.13,132.12.10.13/24"/>
  12.     <dubbo:parameter key="qos-anonymous-access-permission-level" value="NONE"/>
  13.     <dubbo:parameter key="qos-port" value="33333"/>
  14.   </dubbo:application>
  15.   <dubbo:registry address="multicast://224.5.6.7:1234"/>
  16.   <dubbo:protocol name="dubbo" port="20880"/>
  17.   <dubbo:service interface="org.apache.dubbo.demo.provider.DemoService" ref="demoService"/>
  18.   <bean id="demoService" class="org.apache.dubbo.demo.provider.DemoServiceImpl"/>
  19. </beans>

spring-boot 自动装配

如果是 spring-boot 的应用，可以在application.properties或者application.yml上配置:

  1. dubbo.application.qos-enable=true
  2. dubbo.application.qos-port=33333
  3. dubbo.application.qos-accept-foreign-ip=false
  4. dubbo.application.qos-accept-foreign-ip-whitelist=123.12.10.13, 132.12.10.13/24
  5. dubbo.application.qos-anonymous-access-permission-level=NONE

最后修改 September 13, 2024: Refactor website structure (#2860) (1a4b998f54b)