# consul-retry-starter

**Repository Path**: lxw804/consul-retry-starter

## Basic Information

- **Project Name**: consul-retry-starter
- **Description**: consul自动进行服务的重新注册:
当由于网络波动等原因，服务被consul踢出后， 本组件可以自动进行服务的重新注册。

具体来说，就是 当服务由于断网或者其他原因，造成consul agant感知不到service的心跳，在尝试对service端进行心跳检测并超过设定的时间后会将该service端踢出。

当service网络恢复或者服务恢复后不会自动注册到consul agent，除非重启
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 3
- **Created**: 2022-11-16
- **Last Updated**: 2022-11-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# consul-retry-starter

#### 介绍
consul自动进行服务的重新注册:

当由于网络波动等原因，服务被consul踢出后， 本组件可以自动进行服务的重新注册。

具体来说，就是 当服务由于断网或者其他原因，造成consul agant感知不到service的心跳，在尝试对service端进行心跳检测并超过设定的时间后会将该service端踢出。

当service网络恢复或者服务恢复后不会自动注册到consul agent，除非重启再次启动注册流程可以重新注册上consul。

在重启前服务一直处于不可用的状态，所以接入consul的服务应当具备重新注册的功能。

目前针对spring boot 1.5.x 和2.x的项目可用。


#### 软件架构
软件架构说明

##### 技术验证&设计
在服务启动的时候启动一个线程，每隔一段时间去consul拉取注册在service下面所有instance-id，如果不包括当前app的instance-id话则注册consul。

设计流程：
      
      通过线程轮询发现不存在的实例并使用consul API注册上去。


![输入图片说明](https://images.gitee.com/uploads/images/2021/0717/231138_fbc9427d_1425724.png "运行原理.png") 

#### 安装教程

1.  xxxx
2.  xxxx
3.  xxxx

#### 使用说明

只需在pom.xml文件中加入以下的依赖：
POM文件

``` 
<dependency>
     <groupId>easy.spring.boot</groupId>
        <artifactId>consul-retry-register-spring-boot-starter</artifactId>
        <version>1.0-SNAPSHOT</version>
</dependency>
```


在bootstrap.yml文件中加入以下的配置信息：
bootstrap.yml
```

spring:
  cloud:
    consul:
      discovery:
        register: true
      retry:
        enable: true
        retryInterval: 15000
```
其中：
enable：表示启用注册重试功能。
retryInterval: 重试检查的 间隔， 毫秒。  15000表示15秒。不得小于1秒。


#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)