网关属性配置
- 属性配置
- 属性详解

网关属性配置

本篇主要讲解如何在 Apache Shenyu 网关配置 ShenYu 的相关属性。

属性配置

shenyu:
  netty:
    tcp:
      webServerFactoryEnabled: true
      selectCount: 1
      workerCount: 4
      serverSocketChannel:
        soRcvBuf: 87380
        soBackLog: 128
        soReuseAddr: false
        connectTimeoutMillis: 10000
        writeBufferHighWaterMark: 65536
        writeBufferLowWaterMark: 32768
        writeSpinCount: 16
        autoRead: true
        allocType: "pooled"
      socketChannel:
        soKeepAlive: false
        soReuseAddr: false
        soLinger: -1
        tcpNoDelay: true
        soRcvBuf: 87380
        soSndBuf: 16384
        ipTos: 0
        allowHalfClosure: false
        connectTimeoutMillis: 10000
        writeBufferHighWaterMark: 65536
        writeBufferLowWaterMark: 32768
        writeSpinCount: 16
        autoRead: true
        allocType: "pooled"
  instance:
    enabled: false
    registerType: zookeeper #etcd #consul
    serverLists: localhost:2181 #http://localhost:2379 #localhost:8848
    props:
#  httpclient:
#    strategy: webClient
#    connectTimeout: 45000
#    responseTimeout: 3000
#    readerIdleTime: 3000
#    writerIdleTime: 3000
#    allIdleTime: 3000
#    readTimeout: 3000
#    writeTimeout: 3000
#    wiretap: false
#    keepAlive: false
#    pool:
#      type: ELASTIC
#      name: proxy
#      maxConnections: 16
#      acquireTimeout: 45000
#      maxIdleTime: 3000  
#    proxy:
#      host:
#      port:
#      username:
#      password:
#      nonProxyHostsPattern:
#    ssl:
#      useInsecureTrustManager: false
#      keyStoreType: PKCS12
#      keyStorePath: classpath:keystore.p12
#      keyStorePassword: 123456
#      keyStoreProvider:   
#      keyPassword: 123456
#      trustedX509Certificates:
#      handshakeTimeout:
#      closeNotifyFlushTimeout:
#      closeNotifyReadTimeout:
#      defaultConfigurationType:
  sync:
    websocket:
      urls: ws://localhost:9095/websocket
#    zookeeper:
#      url: localhost:2181
#      sessionTimeout: 5000
#      connectionTimeout: 2000
#    http:
#      url: http://localhost:9095
#    nacos:
#      url: localhost:8848
#      namespace: 1c10d748-af86-43b9-8265-75f487d20c6c
#      username:
#      password:
#      acm:
#        enabled: false
#        endpoint: acm.aliyun.com
#        namespace:
#        accessKey:
#        secretKey:
#    etcd:
#      url: http://localhost:2379
#    consul:
#      url: http://localhost:8500
#      waitTime: 1000
#      watchDelay: 1000
  cross:
    enabled: true
    allowedHeaders:
    allowedMethods: "*"
    allowedOrigin: "*"
    allowedExpose: "*"
    maxAge: "18000"
    allowCredentials: true
  switchConfig:
    local: true
  file:
    enabled: true
    maxSize : 10
  exclude:
    enabled: false
    paths:
      - /favicon.ico
  extPlugin:
    path:
    enabled: true
    threads: 1
    scheduleTime: 300
    scheduleDelay: 30
  scheduler:
    enabled: false
    type: fixed
    threads: 16
  upstreamCheck:
    enabled: false
    timeout: 3000
    healthyThreshold: 1
    unhealthyThreshold: 1
    interval: 5000
    printEnabled: true
    printInterval: 60000

属性详解

shenyu.NettyTcpProperties 配置

ShenYu Netty 配置

Name	Type	Default	Required	Description
webServerFactoryEnabled	Boolean	true	No	是否开启自定义参数，true-开启，false-可以自行配置NettyReactiveWebServerFactory
selectCount	Integer	1	No	Netty 选择器数
workerCount	Integer	4	No	Netty 工作线程数
ServerSocketChannelConfig
soRcvBuf	Integer	87380	No	Socket参数，TCP数据接收缓冲区大小
soBackLog	Integer	128	No	Socket参数，服务端接受连接的队列长度
soReuseAddr	Boolean	false	No	Socket 参数，是否复用地址
connectTimeoutMillis	Integer	10000	No	Netty 参数，连接超时时间
writeBufferHighWaterMark	Integer	65536	No	Netty 参数，通道水位线上限
writeBufferLowWaterMark	Integer	32768	No	Netty 参数，通道水位线下限
writeSpinCount	Integer	16	No	Netty参数，一个Loop写操作执行的最大次数
autoRead	Boolean	true	No	Netty参数，自动读取
allocType	String	pooled	No	Netty参数，ByteBuf的分配器
SocketChannelConfig
soKeepAlive	Boolean	false	No	Socket 参数，是否启用心跳保活机制
soReuseAddr	Boolean	false	No	Socket 参数，是否复用地址
soLinger	Integer	-1	No	Socket 参数，关闭 Socket 的延迟时间
tcpNoDelay	Boolean	true	No	Socket 参数，是否启用 Nagle 算法
soRcvBuf	Integer	87380	No	Socket参数，TCP数据接收缓冲区大小
soSndBuf	Integer	128	No
ipTos	Integer	0	No	IP参数，设置IP头部的Type-of-Service字段，用于描述IP包的优先级和QoS选项
allowHalfClosure	Boolean	false	No	Netty参数，一个连接的远端关闭时本地端是否关闭
connectTimeoutMillis	Integer	10000	No	Netty 参数，连接超时时间
writeBufferHighWaterMark	Integer	65536	No	Netty 参数，通道水位线上限
writeBufferLowWaterMark	Integer	32768	No	Netty 参数，通道水位线下限
writeSpinCount	Integer	16	No	Netty参数，一个Loop写操作执行的最大次数
autoRead	Boolean	true	No	Netty参数，自动读取
allocType	String	pooled	No	Netty参数，ByteBuf的分配器

shenyu.instance 配置

这是 ShenYu 网关注册到注册中心的相关配置，注册中心配置请参考注册中心配置。

名称	类型	默认值	是否必填	说明
enabled	boolean	false	是	是否启动
registerType	String	zookeeper	是	使用哪个注册中心，目前支持zookeeper、etcd
serverLists	String	localhost:2181	是	注册中心的地址。若使用集群，用 `,` 分隔
props				使用不同注册类型时，属性取值不同。

props配置

使用不同的注册中心时，属性取值不同。

当注册类型为 zookeeper 时，支持的属性配置如下：

名称	类型	默认值	是否必填	说明
sessionTimeout	int	30000	否	session超时时间（毫秒）
connectionTimeout	int	3000	否	连接超时时间（毫秒）

当注册类型为 etcd 时，支持的属性配置如下：

名称	类型	默认值	是否必填	说明
etcdTimeout	int	30000	否	etcd超时时间（毫秒）
etcdTTL	int	5	否	租约生存时间（秒）

shenyu.httpclient 配置

这是 ShenYu 网关中代理Http及SpringCloud协议后，用于发送代理请求的HttpClient配置。

Name	Type	Default	Required	Description
strategy	String	webClient	No	HttpClientPlugin实现策略（默认使用webClietnt）： - `webClient`：使用WebClientPlugin - `netty`：使用NettyHttpClientPlugin
connectTimeout	int	45000	No	连接超时时间 (毫秒)，默认值为 `45000`。
responseTimeout	int	3000	No	结果超时时间 (毫秒)，默认值为 `3000`。
readerIdleTime	int	3000	No	指定读空闲超时时间 (毫秒)，默认值为 `3000`。
writerIdleTime	int	3000	No	指定写空闲超时时间 (毫秒)，默认值为 `3000`。
allIdleTime	int	3000	No	指定读和写超时时间 (毫秒)，默认值为 `3000`。
readTimeout	int	3000	No	读取超时 (毫秒)，默认值为 `3000`。
writeTimeout	int	3000	No	输出超时 (millisecond)，默认值为 `3000`。
wiretap	Boolean	false	No	启用 Netty HttpClient 的窃听调试，默认值为 `false`。
keepAlive	Boolean	false	No	启用或禁用请求的 Keep-Alive 支持，默认值为 `false`。
pool				HttpClient 连接池配置
proxy				HttpClient 代理配置
ssl				HttpClient SSL配置

pool config

HttpClient连接池配置：

Name	Type	Default	Required	Description
type	String	ELASTIC	No	HttpClient连接池类型，默认值为`ELASTIC`。 - `ELASTIC`: 连接池可以按需缓存和增长。 - `FIXED`: 连接池缓存并重用，有固定的最大连接数。 - `DISABLED`: 连接池总是会创建一个新的连接。
name	String	proxy	No	连接池映射名称，默认为`proxy`。
maxConnections	int	2可用处理器数，最小值为16	No	仅适用于 `FIXED` 类型，在现有连接上开始挂起获取之前的最大连接数。默认值为可用处理器数2。 (最小值为 16)
acquireTimeout	int	45000	No	仅适用于 `FIXED` 类型，等待获取连接的最长时间（毫秒）。默认值为 45000
maxIdleTime	int	NULL	No	Channel 空闲多久关闭，如果为空，没有最大空闲关闭时间。

Proxy config

Netty HttpClient 代理的相关配置：

Name	Type	Default	Required	Description
host	String	null	No	Netty HttpClient 代理配置的主机名。
port	String	null	No	Netty HttpClient 的代理配置端口。
username	String	null	No	Netty HttpClient 代理配置的用户名。
password	String	null	No	Netty HttpClient 代理配置的密码。
nonProxyHostsPattern	String	null	No	直连的主机列表的正则表达式 (Java)。

SSL config

网关路由可以同时支持路由到http和https的后端服务，以下为SSL相关配置：

Name	Type	Default	Required	Description
useInsecureTrustManager	Boolean	false	No	是否信任所有下游证书，默认`false`。
keyStoreType	String	PKCS12	No	SSL 证书类型。
keyStorePath	String		No	SSL 证书路径，可以放在 classpath 下。
keyStorePassword	String		No	SSL 证书密码。
keyStoreProvider	String		No	SSL 证书提供者。
keyPassword	String		No	SSL 证书Key的密码。
trustedX509Certificates	Array	Null	No	配置自己的信任的证书列表。
handshakeTimeout	int	10000	No	SSL握手超时时间（毫秒），默认值为 `10000`。
closeNotifyFlushTimeout	int	3000	No	SSL close_notify 刷新超时（毫秒）默认值为 `3000`。
closeNotifyReadTimeout	int	0	No	SSL close_notify 读取超时（毫秒）默认值为 `0`。
defaultConfigurationType	String	TCP	No	SslContextBuilder 的默认配置，默认为 TCP. - H2: SslProvider 将根据 OpenSsl.isAlpnSupported()、SslProvider.HTTP2_CIPHERS、ALPN 支持、HTTP/1.1 和 HTTP/2 支持进行设置 - TCP: SslProvider 将根据 OpenSsl.isAvailable() 设置 - NONE: 不会有默认配置

过滤器相关配置

shenyu.file 配置

文件过滤器的相关配置。

名称	类型	默认值	是否必填	说明
enabled	Boolean	false	否	是否开启文件大小过滤
maxSize	Integer	10	No	上传文件最大值，（单位:MB）

shenyu.cross 配置

跨域相关配置。

名称	类型	默认值	是否必填	说明
enabled	Boolean	false	否	是否支持跨域请求
allowedHeaders	String	x-requested-with, authorization, Content-Type, Authorization, credential, X-XSRF-TOKEN, token, username, client	No	允许的Header头，多个请用 “,” 分割。新的”allowedHeaders”会在默认值基础上，去除重复的追加到”Access-Control-Allow-Headers”。
allowedMethods	String	““	No	允许的方法
allowedOrigin	String	““	No	允许的Origin，当取值为””时，使用`request.getHeaders().getOrigin()`设置`Access-Control-Allow-Origin`
allowedExpose	String	“*”	No	允许的Expose
maxAge	String	“18000”	No	最大年龄 (ms)
allowCredentials	Boolean	true	No	允许认证

shenyu.exclude 配置

拒绝指定请求经过网关的相关配置

名称	类型	默认值	是否必填	说明
enabled	Boolean	false	否	是否拒绝指定请求经过网关
paths	Array	无	是	匹配该列表的请求不经过网关（支持路径匹配）

shenyu.sync 配置

网关和Admin端使用数据同步的相关配置。

使用websocket进行数据同步的属性配置如下：

名称	类型	默认值	是否必填	说明
urls	String	无	是	`Admin`的websocket服务地址，多个地址用 `,` 分开。

使用zookeeper进行数据同步的属性配置如下：

名称	类型	默认值	是否必填	说明
url	String	无	是	`zookeeper`的连接地址
sessionTimeout	int	无	是	`session`的超时时间（毫秒）
connectionTimeout	int	无	是	连接超时时间（毫秒）

使用http长轮询进行数据同步的属性配置如下：

名称	类型	默认值	是否必填	说明
url	String	无	是	`Admin`的服务地址

使用nacos进行数据同步的属性配置如下：

名称	类型	默认值	是否必填	说明
url	String	无	是	`nacos`连接地址
namespace	String	无	是	命名空间
username	String	无	否	用户名
password	String	无	否	密码
acm			否	阿里云ACM服务配置

acm配置

名称	类型	默认值	是否必填	说明
enabled	boolean	false	否	是否启用
endpoint	String	无	是	ACM服务地址
namespace	String	无	否	namespace
accessKey	String	无	否	accessKey
secretKey	String	无	否	secretKey

使用etcd进行数据同步的属性配置如下：

名称	类型	默认值	是否必填	说明
url	String	无	是	`etcd`连接地址

使用consul进行数据同步的属性配置如下：

名称	类型	默认值	是否必填	说明
url	String	无	是	`consul`连接地址
waitTime	int	无	是	请求consul服务拉取配置信息的超时时间（毫秒）
watchDelay	int	无	是	同步间隔（毫秒）

shenyu.extPlugin config

Apache ShenYu对于动态加载自定义插件的配置

Name	Type	Default	Required	Description
enabled	Boolean	true	No	是否开启动态加载自定义插件，默认开启
path	String		False	动态加载自定义插件的路径，如果没配，默认为相对于当前网关路径下的：/ext/lib，用户也可以使用-Dplugin-ext指定
threads	Integer	1	False	动态加载自定义插件的线程数
scheduleTime	Integer	300	False	动态加载自定义插件的间隔时间，单元：秒
scheduleDelay	Integer	30	False	网关启动多久后去动态加载，单元：秒

shenyu.scheduler config

Apache ShenYu 调度线程模型配置

Name	Type	Default	Required	Description
enabled	Boolean	false	No	是否开启使用调度线程
type	String	fixed	False	调度线程池类型，默认为fixed，不配置或者其他则为弹性线程池
threads	Integer	Math.max((Runtime.getRuntime().availableProcessors() << 1) + 1, 16)	False	固定线程池类型时候的线程数量

shenyu.upstreamCheck config

Apache ShenYu动态检测upstream的配置

Name	Type	Default	Required	Description
enabled	Boolean	false	No	是否检测
timeout	Integer	3000	False	超时配置（ms）
healthyThreshold	Integer	1	False	健康因子
unhealthyThreshold	Integer	1	False	不健康因子
interval	Integer	5000	False	检测的调度间隔时间
printEnabled	Boolean	true	No	是否打印日志
printInterval	Integer	60000	False	打印日志的间隔调度时间

shenyu.switchConfig config

Apache ShenYu开关配置

Name	Type	Default	Required	Description
local	Boolean	true	No	是否开启本地模式，如果开启，本地操作数据，默认开启