Admin属性配置

本篇主要讲解如何在 admin端配置 ShenYu 的相关属性。

Admin属性配置 - 图1

属性配置

  1. shenyu:
  2. register:
  3. registerType: http #http #zookeeper #etcd #nacos #consul
  4. serverLists: #localhost:2181 #http://localhost:2379 #localhost:8848
  5. props:
  6. sessionTimeout: 5000
  7. connectionTimeout: 2000
  8. checked: true
  9. zombieCheckTimes: 5
  10. scheduledTime: 10
  11. nacosNameSpace: ShenyuRegisterCenter
  12. database:
  13. dialect: mysql
  14. init_script: "META-INF/schema.sql"
  15. init_enable: true
  16. sync:
  17. websocket:
  18. enabled: true
  19. # zookeeper:
  20. # url: localhost:2181
  21. # sessionTimeout: 5000
  22. # connectionTimeout: 2000
  23. # http:
  24. # enabled: true
  25. # nacos:
  26. # url: localhost:8848
  27. # namespace: 1c10d748-af86-43b9-8265-75f487d20c6c
  28. # username:
  29. # password:
  30. # acm:
  31. # enabled: false
  32. # endpoint: acm.aliyun.com
  33. # namespace:
  34. # accessKey:
  35. # secretKey:
  36. # etcd:
  37. # url: http://localhost:2379
  38. # consul:
  39. # url: http://localhost:8500
  40. aes:
  41. secret:
  42. key: 2095132720951327
  43. iv: 6075877187097700
  44. ldap:
  45. enabled: false
  46. url: ldap://xxxx:xxx
  47. bind-dn: cn=xxx,dc=xxx,dc=xxx
  48. password: xxxx
  49. base-dn: ou=xxx,dc=xxx,dc=xxx
  50. object-class: person
  51. login-field: cn
  52. jwt:
  53. expired-seconds: 86400000
  54. shiro:
  55. white-list:
  56. - /
  57. - /favicon.*
  58. - /static/**
  59. - /index**
  60. - /plugin
  61. - /platform/**
  62. - /websocket
  63. - /configs/**
  64. - /shenyu-client/**
  65. - /error
  66. - /actuator/health
  67. - /swagger-ui.html
  68. - /webjars/**
  69. - /swagger-resources/**
  70. - /v2/api-docs
  71. - /csrf
  72. swagger:
  73. enable: true

属性详解

shenyu.register 配置

这是客户端接入的相关配置,客户端接入原理请参考:客户端接入原理 ,客户端接入配置请参考: 客户端接入配置

名称类型默认值是否必填说明
registerTypeStringhttp必填使用哪种方式进行服务注册,当前支持 httpzookeeperetcdconsulnacos
serverListsString非必填配置中心的地址。使用http方式时,不需要填写,其他类型需要填写。集群时,多个地址用 , 分开 。
props使用不同注册类型时,属性取值不同。
  • props配置

使用不同的注册类型时,属性取值不同。

当注册类型为http时,支持的属性配置如下:

名称类型默认值是否必填说明
checkedbooleanfalse是否开启检测
zombieCheckTimesint5失败几次后剔除服务
scheduledTimeint10定时检测间隔时间 (秒)

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

名称类型默认值是否必填说明
sessionTimeoutint30000session超时时间(毫秒)
connectionTimeoutint3000连接超时时间(毫秒)

当注册类型为etcd时,暂时没有属性配置。

当注册类型为nacos时,支持的属性配置如下:

名称类型默认值是否必填说明
nacosNameSpaceString命名空间
usernameString空字符串用户名
passwordString空字符串密码
accessKeyString空字符串accessKey
secretKeyString空字符串secretKey

当注册类型为consul时,支持的属性配置如下:

名称类型默认值是否必填说明
delayint1Metadata的监控每次轮询的间隔时长,单位为秒,默认1秒。
wait-timeint55Metadata的监控单次请求的等待时间(长轮询机制),单位为秒,默认55秒。
metadata-pathStringshenyu/registerMetadata路径名称,默认是shenyu/register
shenyu.database 配置

shenyu-admin启动时,数据库的相关配置。

名称类型默认值是否必填说明
dialectStringh2admin启动时,使用哪种数据库。
init_scriptStringMETA-INF/schema.h2.sql数据库初始化脚本
init_enablebooleantrue是否进行初始化
shenyu.sync 配置

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

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

名称类型默认值是否必填说明
enabledbooleantrue是否启用websocket进行数据同步

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

名称类型默认值是否必填说明
urlStringzookeeper的连接地址
sessionTimeoutintsession的超时时间(毫秒)
connectionTimeoutint连接超时时间(毫秒)

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

名称类型默认值是否必填说明
enabledbooleantrue是否启用
refreshIntervalint5 (分钟)定时从数据库获取数据并加载到内存
notifyBatchSizeint100批量通知客户端

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

名称类型默认值是否必填说明
urlStringnacos连接地址
namespaceString命名空间
usernameString用户名
passwordString密码
acm阿里云ACM服务配置
  • acm配置
名称类型默认值是否必填说明
enabledbooleanfalse是否启用
endpointStringACM服务地址
namespaceStringnamespace
accessKeyStringaccessKey
secretKeyStringsecretKey

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

名称类型默认值是否必填说明
urlStringetcd连接地址

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

名称类型默认值是否必填说明
urlStringconsul连接地址
shenyu.aes.secret 配置

aes加密算法的相关配置。

名称类型默认值是否必填说明
keyString2095132720951327key
ivString初始向量
shenyu.ldap 配置

Springldap的相关配置。

名称类型默认值是否必填说明
enabledbooleantrue是否启用
urlStringldap连接地址
bind-dnStringUserDn
passwordString密码
base-dnStringsearchBase
object-classStringpersonfilter
login-fieldStringcnsearchBase
connectTimeoutint3000连接超时时间(毫秒)
readTimeoutint3000读取操作超时时间(毫秒)
shenyu.jwt 配置

jwt的相关配置如下:

名称类型默认值是否必填说明
expired-secondslong24 60 60 * 1000L过期时间(毫秒)
shenyu.shiro 配置

shiro的相关配置如下:

名称类型默认值是否必填说明
white-listList白名单列表