Eureka配置文件说明

喜欢ヅ旅行 2023-10-18 15:12 91阅读 0赞

## [Spring Cloud Eureka配置文件例子与详细说明][Spring Cloud Eureka] ##

### Eureka服务端： ###

application.yml

# eureka(最)简单单点开发配置。支持yml与properties两种，yml文件后缀必须为yml，不能是yaml，否则找不到该文件，使用默认配置。
    # yml文件大小写敏感；
    # 每个级别至少用1个空格缩进，也可多个，但同级别的必须一致，不支持tab，本项目按照eclipse的插件（spring官方Spring Tool Suite3.9.3）统一使用两个空格；
    # 属性值与冒号间必须有一个空格。比如port:8761则不会生效。
    server: 
      port: 8761 # eureka服务器端口号。尽管无论官网还是大部分参考书都使用8761，但默认并不是，而是8080
    
    eureka:
      client:
        # 默认情况下，eureka server同时也是eureka client，用于相互注册形成高可用eureka服务。
        # 单点时，如果registerWithEureka配置为true，则eureka server会报错Cannot execute request on any known server
        registerWithEureka: false # 是否注册到eureka服务，默认为true，当前已为eureka server，且单点eureka，故配置为false
        fetchRegistry: false # 是否在本地缓存注册表信息，默认为true，当前为单点eureka server，不需要从其他eureka除获取注册表信息，更谈不上缓存，故配置为false
      #server:
        # 在服务器接收请求之前等待的初始时间，默认等待5min（John Carnell）
        #waitTimeInMsWhenSyncEmpty: 5 # John说开发时最好注释此配置，服务注册需要3次心跳，每次10s，也就是30s才能显示在eureka。但是为什么我这里马上就显示呢？
    
    # 指定生效的配置
    spring:
      profiles:
        active: dev
    
    # 用三个连接符进行profile分割，根据active的profiles选择执行哪一段，上面没有profiles的表示公共执行部分
    ---
    
    # 本地开发环境
    spring:
      profiles: dev
    
    security:                           # 开启服务注册认证机制
       basic:
          enabled: true                 # 是否开启认证，默认true，需开启时可省略。
       user:
          name: eureka                  # 认证时，使用的用户名
          password: eureka              # 认证时，使用的密码
    
    eureka:
      # 详见EurekaServerConfigBean，需要注意与Client和Instance在client的jar包不同，Server是在server的jar包。
      # eureka的各项配置可见EurekaXXXConfigBean。
      server:
        # 自我保护机制，默认true。打开后，心跳失败在15分钟内低于85%(renewalPercentThreshold)的服务，也不进行剔除。
        # 关闭后，主页提示：RENEWALS ARE LESSER THAN THE THRESHOLD. THE SELF PRESERVATION MODE IS TURNED OFF.
        # THIS MAY NOT PROTECT INSTANCE EXPIRY IN CASE OF NETWORK/OTHER PROBLEMS.
        enableSelfPreservation: true # 本地调试时可fasle关闭。但生产建议打开，可防止因网络不稳定等原因导致误剔除服务。
        renewalPercentThreshold: 0.85 # 默认85%
      client:
        serviceUrl:
          # registerWithEureka关闭后，defaultZone没有配置的必要。如果打开，即使配置为本机一样报错。
          # 也就是说defaultZone任何时候都没有配置为localhost的必要。这点上John的配置更好，永超和周立包括志朋的配置有点多余。
          # 但是周立说的对，这个属性默认配置是http://localhost:8761/eureka，也就是当你没有用户名密码安全认证时，本机调试时，客户端可以不配置，
          # 但对于server来说，这个默认没有什么作用。对于client来说，也只有调试的时候有点作用。
          # 但有一点很奇怪，既然默认了8761端口，为什么eureka server的默认端口要用8080而不是8761呢？
          defaultZone: http://${security.user.name}:${security.user.password}@localhost:${server.port}/eureka # 本配置应删除。
    
    ---
    
    # 测试环境。profiles配置为主机名，根据主机名进行激活，需在启动脚本中--spring.profiles.active=${HOST_NAME}，
    # 因为启动脚本的优先级比本文件的active优先级高。
    # 多台eureka高可用环境下，每台eureka的defaultZone配置都不一样，因为不能把自己也配置上，因为为了保证每台eureka的代码配置一致方便发布，
    # 需要采取yml的---分隔，然后通过主机名启动这种模式进行。
    spring:
      profiles: hifu-test1
    
    security:
      user:
        name: eureka
        password: eureka
    
    eureka:
      instance:
         hostname: hifu-test1
      server:
         # eureka server刷新readCacheMap的时间，注意，client读取的是readCacheMap，这个时间决定了多久会把readWriteCacheMap的缓存更新到readCacheMap上
         # 默认30秒，eclipse提示默认0应该是错误的，源代码中responseCacheUpdateIntervalMs = 30 * 1000。
         response-cache-update-interval-ms: 3000 # 网上很多专家的博客错误写成responseCacheUpdateInvervalMs，请注意。这里配置为3秒。
         # eureka server缓存readWriteCacheMap失效时间，这个只有在这个时间过去后缓存才会失效，失效前不会更新，
         # 过期后从registry重新读取注册服务信息，registry是一个ConcurrentHashMap。
         # 由于启用了evict其实就用不太上改这个配置了，默认180s
         responseCacheAutoExpirationInSeconds: 180
         # 启用主动失效，并且每次主动失效检测间隔为3s。源码evictionIntervalTimerInMs = 60 * 1000，默认一分钟。
         # 需要注意的是该配置会打印INFO日志，增加info日志量，修改后从每60秒打印一次变成3秒打印一次。
         evictionIntervalTimerInMs: 3000 # 注意不要写成EvictionIntervalTimerInMs，yml大小写敏感。
      client:
        serviceUrl:
          # 配置其他eureka的地址，如果多台则逗号分隔。
          defaultZone: http://${security.user.name}:${security.user.password}@10.13.22.19:${server.port}/eureka
        healthcheck:
          enabled: true
        registerWithEureka: true # eureka的高可用，需要互相注册，配置为true，覆盖本文件最上面的默认配置false。
        fetchRegistry: false # eureka之间如果网络不稳定，客户端一般也会缓存了注册列表，因此eureka服务可以不缓存，我觉得更能确保eureka之间的一致。
    
    ---
    spring:
      profiles: hifu-test2
    
    security:
      user:
        name: eureka
        password: eureka
    
    eureka:
      instance:
         hostname: hifu-test2
      server:
        responseCacheUpdateIntervalMs: 3000
        responseCacheAutoExpirationInSeconds: 180
        evictionIntervalTimerInMs: 3000
      client:
        serviceUrl:
           defaultZone: http://${security.user.name}:${security.user.password}@10.13.22.18:${server.port}/eureka
        healthcheck:
           enabled: true
        registerWithEureka: true
        fetchRegistry: false

### Eureka客户端： ###

server:
       port: 8010 #设置当前服务端口
       context-path: /api #设置服务上下文路径
    
    #debug: true   
    
    eureka:
      # 详见EurekaClientConfigBean（实现EurekaClientConfig）
      client:
        # 是否启用eureka客户端。默认true
        enabled: true # 本地调试时，若不想启动eureka，可配置false即可，而不需要注释掉@EnableDiscoveryClient这么麻烦。感谢永超，从他的书知道这个属性。
        # 支持registerWithEureka(John、周立)和register-with-eureka(翟永超)两种写法，eclipse的STS默认使用后者。
        # 基本所有配置使用横杠或者驼峰都可以，鼠标放在上面，eclipse都可以显示详细注解和默认值（如果有）。
        registerWithEureka: true # 默认true，因此也可省略。
        fetchRegistry: true # 默认true，此处可不配置。
        # 缓存清单更新时间，默认30秒。见EurekaClientConfigBean，其中DefaultEurekaClientConfig可不看（前者spring实现，后者Netflix实现）
        registry-fetch-interval-seconds: 30 # 如果想eureka server剔除服务后尽快在client体现，我觉得可缩短此时间。
        # eureka服务的位置，如配置错误，则：Cannot execute request on any known server
        # 详见：com.netflix.discovery.endpoint.EndpointUtils
        serviceUrl:
          defaultZone: http://eureka:eureka@localhost:8761/eureka # 如果需要注册多个服务器，可用逗号隔开，例如：,
        # 周立在Camden SR4（对应eureka-client.jar1.2.6）中说有该属性，但我在SR6（对应1.2.4）和SR4中都找不到；
        # 又查找了Brixton SR7（对应1.1.7，其实不光eureka-client，整个spring-cloud-netflix都是这个版本），也是没有。
        # 这是因为该属性IDE确实不能提示，但写法是正确的。作用是修改eureka的健康检查方式（心跳），改为用actuator，详见HealthCheckHandler HealthIndicator。
        # 周立写的不是太详细，可详见这博客：https://blog.csdn.net/xiao_jun_0820/article/details/77991963
        # 若配置healthcheck，需引入actuator。
        healthcheck:
          enabled: true # 我建议配置为true。心跳机制有个问题，如当客户端的数据库连接出现问题导致不可用时，心跳机制不能反映，但actuator的health可以。
      # 详见EurekaInstanceConfigBean。或com.netflix.appinfo.InstanceInfo（与spring大致相同）
      instance:
        # 是否以IP注册到Eureka Server上，如果false则不是IP而是服务器名称
        # 但我设置了false，eureka主页仍显示192.168.100.16:client-microservice:8010
        preferIpAddress: true # 默认false。应该始终设置为true。如果基于Docker等容器的部署，容器会生成一个随机的主机名，此时DNS不存在该名，无法解析 - John Carnell
        # 实例名。
        instanceId: ${spring.cloud.client.hostname}:${spring.application.name}:${spring.application.instance_id:${server.port}}
        # 服务续约的两个重要属性
        leaseRenewalIntervalInSeconds: 30 # 服务续约间隔时间。默认每隔30秒，客户端会向服务端发送心跳。见DiscoveryClient.initScheduledTasks
        leaseExpirationDurationInSeconds: 90 # 服务失效时间。缺省为90秒服务端接收不到客户端的心跳，则剔除该客户端服务实例。
        # 端点配置。若配置了context-path，actuator的监控端点会增加前缀，此时eureka也需要相应增加
        status-page-url-path: ${server.context-path}/info
        health-check-url-path: ${server.context-path}/health

[Spring Cloud Eureka]: https://www.cnblogs.com/ouyida3/p/9747423.html