注册中心接入配置

说明

说明然后使用不同的注册方式，快速接入。

HTTP方式注册

Soul-Admin配置

在 application.yml 配置注册中心为HTTP即可，如下：

  1. soul:
  2.   register:
  3.     registerType: http
  4.     props:
  5.       checked: true  #是否开启检测
  6.       zombieCheckTimes: 5 #失败几次后剔除服务
  7.       scheduledTime: 10 #定时检测间隔时间 （秒）

Soul-Client配置

在 application.yml 中配置注册方式为HTTP，并填写Soul-Admin服务地址列表，如下：

  1. soul:
  2.   client:
  3.     registerType: http
  4.     serverLists: http://localhost:9095
  5.     props:
  6.       contextPath: /http
  7.       appName: http
  8.       port: 8188  
  9.       isFull: false
  10. # registerType : 服务注册类型，填写 http
  11. # serverList: 为http注册类型时，填写Soul-Admin项目的地址，注意加上http://，多个地址用英文逗号分隔
  12. # port: 你本项目的启动端口，目前springmvc/tars/grpc需要进行填写
  13. # contextPath: 为你的这个mvc项目在soul网关的路由前缀，这个你应该懂意思把？ 比如/order ，/product 等等，网关会根据你的这个前缀来进行路由.
  14. # appName：你的应用名称，不配置的话，会默认取 `spring.application.name` 的值
  15. # isFull: 设置true 代表代理你的整个服务，false表示代理你其中某几个controller；目前适用于springmvc/springcloud

Zookeeper方式注册

Soul-Admin配置

  • 首先在 pom.xml 文件中加入相关的依赖（默认已经引入）：
  1.         <dependency>
  2.             <groupId>org.dromara</groupId>
  3.             <artifactId>soul-register-server-zookeeper</artifactId>
  4.             <version>${project.version}</version>
  5.         </dependency>
  • 在 application.yml 配置注册中心为Zookeeper，填写相关zookeeper服务地址和参数，如下：
  1. soul:
  2.   register:
  3.     registerType: zookeeper
  4.     serverLists : localhost:2181
  5.     props:
  6.       sessionTimeout: 5000
  7.       connectionTimeout: 2000

Soul-Client配置

  • 首先在 pom.xml 文件中加入相关的依赖（默认已经引入）：
  1.         <dependency>
  2.             <groupId>org.dromara</groupId>
  3.             <artifactId>soul-register-client-zookeeper</artifactId>
  4.             <version>${project.version}</version>
  5.         </dependency>
  • 在 application.yml 中配置注册方式为Zookeeper，并填写Zookeeper服务地址和相关参数，如下：
  1. soul:
  2.   client:
  3.     registerType: zookeeper
  4.     serverLists: localhost:2181
  5.     props:
  6.       contextPath: /http
  7.       appName: http
  8.       port: 8188  
  9.       isFull: false
  10. # registerType : 服务注册类型，填写 zookeeper
  11. # serverList: 为zookeeper注册类型时，填写zookeeper地址，多个地址用英文分隔
  12. # port: 你本项目的启动端口,目前springmvc/tars/grpc需要进行填写
  13. # contextPath: 为你的这个mvc项目在soul网关的路由前缀，这个你应该懂意思把？ 比如/order ，/product 等等，网关会根据你的这个前缀来进行路由.
  14. # appName：你的应用名称，不配置的话，会默认取 `spring.application.name` 的值
  15. # isFull: 设置true 代表代理你的整个服务，false表示代理你其中某几个controller；目前适用于springmvc/springcloud

Etcd方式注册

Soul-Admin配置

  • 首先在 pom.xml 文件中加入相关的依赖（默认已经引入）：
  1.         <dependency>
  2.             <groupId>org.dromara</groupId>
  3.             <artifactId>soul-register-server-etcd</artifactId>
  4.             <version>${project.version}</version>
  5.         </dependency>
  • 在 application.yml 配置注册中心为etcd, 填写相关etcd服务地址和参数，如下：
  1. soul:
  2.   register:
  3.     registerType: etcd
  4.     serverLists : http://localhost:2379
  5.     props:
  6.       etcdTimeout: 5000
  7.       etcdTTL: 5

Soul-Client配置

  • 首先在 pom.xml 文件中加入相关的依赖（默认已经引入）：
  1.         <dependency>
  2.             <groupId>org.dromara</groupId>
  3.             <artifactId>soul-register-client-etcd</artifactId>
  4.             <version>${project.version}</version>
  5.         </dependency>
  • 在 application.yml 中配置注册方式为etcd, 并填写etcd服务地址和相关参数，如下：
  1. soul:
  2.   client:
  3.     registerType: etcd 
  4.     serverLists: http://localhost:2379
  5.     props:
  6.       contextPath: /http
  7.       appName: http
  8.       port: 8188  
  9.       isFull: false
  10. # registerType : 服务注册类型，填写 etcd
  11. # serverList: 为etcd注册类型时，填写etcd地址，多个地址用英文分隔
  12. # port: 你本项目的启动端口,目前springmvc/tars/grpc需要进行填写
  13. # contextPath: 为你的这个mvc项目在soul网关的路由前缀，这个你应该懂意思把？ 比如/order ，/product 等等，网关会根据你的这个前缀来进行路由.
  14. # appName：你的应用名称，不配置的话，会默认取 `spring.application.name` 的值
  15. # isFull: 设置true 代表代理你的整个服务，false表示代理你其中某几个controller；目前适用于springmvc/springcloud

Consul方式注册

Soul-Admin配置

  • 首先在 pom.xml 文件中加入相关的依赖：
  1.                <!--soul-register-server-consul默认已经引入-->
  2.                <dependency>
  3.                    <groupId>org.dromara</groupId>
  4.                    <artifactId>soul-register-server-consul</artifactId>
  5.                    <version>${project.version}</version>
  6.                </dependency>
  9.                <!--spring-cloud-starter-consul-discovery需要用户自行引入，建议选用2.2.6.RELEASE版本，其他版本不保证正常工作-->
  10.                <dependency>
  11.                    <groupId>org.springframework.cloud</groupId>
  12.                    <artifactId>spring-cloud-starter-consul-discovery</artifactId>
  13.                    <version>2.2.6.RELEASE</version>
  14.                </dependency>
  • 在 application.yml 配置注册中心为consul, 额外还需要配置spring.cloud.consul, 如下：
  1. soul:
  2.   register:
  3.     registerType: consul
  4.     props:
  5.       delay: 1
  6.       wait-time: 55
  9. spring:
  10.   cloud:
  11.     consul:
  12.       discovery:
  13.         instance-id: soul-admin-1
  14.         service-name: soul-admin
  15.         tags-as-metadata: false
  16.       host: localhost
  17.       port: 8500
  20. # registerType : 服务注册类型，填写 consul
  21. # delay: 对Metadata的监控每次轮询的间隔时长，单位为秒，默认1秒
  22. # wait-time: 对Metadata的监控单次请求的等待时间（长轮询机制），单位为秒，默认55秒
  23. # instance-id: consul服务必填，consul需要通过instance-id找到具体服务
  24. # service-name 服务注册到consul时所在的组名，不配置的话，会默认取 `spring.application.name` 的值
  25. # host: 为 consul 注册类型时，填写 consul 地址，默认localhost
  26. # port: 为 consul 注册类型时，填写 consul 端口， 默认是8500
  27. # tags-as-metadata: false， 必填，如果不填默认为true，则无法读取metadata里的URI信息导致selector的upstream数据更新失败。

Soul-Client配置

注意，consul注册中心目前和SpringCloud服务不兼容，会和Eureka/Nacos注册中心冲突

  • 首先在 pom.xml 文件中加入相关的依赖（需要自行引入）：
  1.             <dependency>
  2.                <groupId>org.springframework.cloud</groupId>
  3.                <artifactId>spring-cloud-starter-consul-discovery</artifactId>
  4.                <version>2.2.6.RELEASE</version>
  5.            </dependency>
  • 在 application.yml 中配置注册方式为consul, 额外还需要配置spring.cloud.consul, 如下：
  1. soul:
  2.   client:
  3.     registerType: consul 
  4.     props:
  5.       contextPath: /http
  6.       appName: http
  7.       port: 8188  
  8.       isFull: false
  11. spring:
  12.   cloud:
  13.     consul:
  14.       discovery:
  15.         instance-id: soul-http-1
  16.         service-name: soul-http
  17.       host: localhost
  18.       port: 8500
  19. # registerType : 服务注册类型，填写 consul
  20. # soul.client.props.port: 你本项目的启动端口,目前springmvc/tars/grpc需要进行填写
  21. # contextPath: 为你的这个mvc项目在soul网关的路由前缀，这个你应该懂意思把？ 比如/order ，/product 等等，网关会根据你的这个前缀来进行路由.
  22. # appName：你的应用名称，不配置的话，会默认取 `spring.application.name` 的值
  23. # isFull: 设置true 代表代理你的整个服务，false表示代理你其中某几个controller；目前适用于springmvc
  24. # instance-id: consul服务必填，consul需要通过instance-id找到具体服务
  25. # service-name 服务注册到consul时所在的组名，不配置的话，会默认取 `spring.application.name` 的值
  26. # host: 为 consul 注册类型时，填写 consul 地址，默认localhost
  27. # spring.cloud.consul.port: 为 consul 注册类型时，填写 consul 端口， 默认是8500

Nacos方式注册

Soul-Admin配置

  • 首先在 pom.xml 文件中加入相关的依赖（默认已经引入）：
  1.         <dependency>
  2.             <groupId>org.dromara</groupId>
  3.             <artifactId>soul-register-server-nacos</artifactId>
  4.             <version>${project.version}</version>
  5.         </dependency>
  • 在 application.yml 配置注册中心为nacos, 填写相关nacos服务地址和参数，还有Nacos的命名空间（需要和Soul-Client保持一致），如下：
  1. soul:
  2.   register:
  3.     registerType: nacos
  4.     serverLists : localhost:8848
  5.     props:
  6.       nacosNameSpace: SoulRegisterCenter

Soul-Client配置

  • 首先在 pom.xml 文件中加入相关的依赖（默认已经引入）：
  1.         <dependency>
  2.             <groupId>org.dromara</groupId>
  3.             <artifactId>soul-register-client-nacos</artifactId>
  4.             <version>${project.version}</version>
  5.         </dependency>
  • 在 application.yml 中配置注册方式为nacos, 并填写nacos服务地址和相关参数，需要命名空间（需要和Soul-Admin端保持一致），IP（可不填，则自动获取本机ip）和端口，如下：
  1. soul:
  2.   client:
  3.     registerType: nacos
  4.     serverLists: localhost:8848
  5.     props:
  6.       contextPath: /http
  7.       appName: http
  8.       port: 8188  
  9.       isFull: false
  10.       nacosNameSpace: SoulRegisterCenter
  11. # registerType : 服务注册类型，填写 etcd
  12. # serverList: 为etcd注册类型时，填写etcd地址，多个地址用英文分隔
  13. # port: 你本项目的启动端口,目前springmvc/tars/grpc需要进行填写
  14. # contextPath: 为你的这个mvc项目在soul网关的路由前缀，这个你应该懂意思把？ 比如/order ，/product 等等，网关会根据你的这个前缀来进行路由.
  15. # appName：你的应用名称，不配置的话，会默认取 `spring.application.name` 的值
  16. # isFull: 设置true 代表代理你的整个服务，false表示代理你其中某几个controller；目前适用于springmvc/springcloud
  17. # nacosNameSpace: nacos的命名空间