Spring Cloud 5：Consul 服务注册/发现

服务注册是指服务提供者向注册中心注册服务实例，主要将其服务信息如服务名称、IP 地址、端口等注册到注册中心。

服务发现是指服务消费者需要调用其他服务时，注册中心将服务提供者的服务信息如服务名称、IP 地址、端口等告知服务消费者。

微服务开发过程中，注册中心至关重要，可以说它是整个微服务架构系统的心脏。当前常用的注册中心有 Consul、Zookeeper、Eureka、etcd 等，各常用注册中心的关键特点见下图所示。

从上表可以看出，无论是 Consul 提供的主要功能，还是 Spring Cloud 对其集成的支持，都比较完善，且运维的复杂度也较低，比如对容器化技术 Docker 有比较好的支持。而 Eureka 在设计上比较符合场景，但仍需持续的完善。

Consul

consul是分布式的、高可用、横向扩展的。consul提供的一些关键特性：

service discovery：consul通过DNS或者HTTP接口使服务注册和服务发现变的很容易，一些外部服务，例如saas提供的也可以一样注册。
health checking：健康检测使consul可以快速的告警在集群中的操作。和服务发现的集成，可以防止服务转发到故障的服务上面。
key/value storage：一个用来存储动态配置的系统。提供简单的HTTP接口，可以在任何地方操作。
multi-datacenter：无需复杂的配置，即可支持任意数量的区域。

yang-diver

pom.xml

        <!--Consul-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-consul-discovery</artifactId>
        </dependency>

bootstrap.yml

spring:
  application:
    name: yang-diver
  cloud:
    consul:
      host: 127.0.0.1
      port: 8500
      discovery:
        register: true # 配置服务注册到Consul上
        healthCheckPath: /server/consul/health # 配置服务健康检查地址，供Consul调用。检查默认为“/ health”
        healthCheckInterval: 60s # Consul 健康检查频率
        instance-id: ${spring.application.name} # 配置注册到Consul服务id
        enabled: true # 不禁用Consul Discovery Client
        prefer-ip-address: true

Application.java

@SpringBootApplication
// 添加注解 @EnableDiscoveryClient，只有这样，服务注册、心跳检测相关配置信息才能被自动加载
@EnableDiscoveryClient
public class DiverApplication {

    public static void main(String[] args) {
        SpringApplication.run(DiverApplication.class, args);

        //System.out.println("application start");
        //
        //SpringApplication application = new SpringApplication(DiverApplication.class);
        //// 添加监听器，此时监听器类不需要标注是一个Bean
        ////application.addListeners(new BaseListener());
        //application.setBannerMode(Banner.Mode.OFF);
        //application.run(args);
        //
        //System.out.println("application started");
    }

}

health check

@RestController
@RequestMapping("/server")
public class ServerController {

    /**
     * 配置服务健康检查地址，供Consul调用，需要和配置文件中保持一致
     *
     * @return
     * @Author YangXuyue
     * @Date 2018/09/22 20:55
     */
    @GetMapping("/consul/health")
    public BaseResult healthCheck() {
        return BaseResult.ok();
    }

}

yang-web

pom.xml

        <!--Consul-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-consul-discovery</artifactId>
        </dependency>

bootstrap.yml

spring:
  application:
    name: yang-web
  cloud:
    consul:
      host: localhost
      port: 8500
      discovery:
        # 不需要注册到consul上
        register: false
server:
  tomcat:
    uri-encoding: UTF-8
    max-threads: 1000
    min-spare-threads: 30
  port: 1001
feign:
  hystrix:
    enabled: true

UserClient.java

/**
 * 用户Client
 *
 * @Author YangXuyue
 * @Date 2018/09/23 17:39
 */
@FeignClient(name = AppNames.YANG_DIVER, path = "/user"/*, fallback = UserClientFallbackHandler.class*/)
public interface UserClient {

    /*
    1、只能用注解 @RequestMapping 注解映射，不能使用 @GetMapping，@PostMapping、@PutMapping 等注解

    2、在定义参数绑定时，@RequestParam、@RequestHeader 等可以指定参数名称的注解，其 value 属性不能缺少

    3、在定义一个接口时，请求参数中利用注解 @RequestBody 的次数不能多于一次
     */

    /**
     * 用户列表查询
     *
     * @return
     * @Author YangXuyue
     * @Date 2018/09/23 17:41
     */
    @RequestMapping("/list")
    BaseResult listUsers();
}

controller.java

/**
 * 用户Controller
 *
 * @Author YangXuyue
 * @Date 2018/09/23 12:20
 */
@Controller
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserClient userClient;

    /**
     * 用户列表查询
     *
     * @return
     * @Author YangXuyue
     * @Date 2018/09/23 17:44
     */
    @RequestMapping(value = "/list", method = {RequestMethod.GET, RequestMethod.POST})
    @ResponseBody
    public BaseResult getOrderDetailInfoById() {
        return userClient.listUsers();
    }
}

访问地址

http://localhost:1001/user/list

pom.xml 部分

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.0.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8
        </project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <!--版本号配置-->
        <spring-cloud.version>Greenwich.M3</spring-cloud.version>
    </properties>

    <dependencies>
        ...
        <!--Consul-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-consul-discovery</artifactId>
        </dependency>

        <!--Hystrix-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
        </dependency>

        <!--Feign-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>

        <!--Actuator-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

    <repositories>
        <repository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://repo.spring.io/milestone</url>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </repository>
    </repositories>