Spring Cloud与Consul搭建微服务

作者: 太2真人R | 来源:发表于2019-06-28 22:43 被阅读0次

consul集群搭建及spring cloud集成
服务发现与配置工具Consul安装
动态代理@Controller注册失败
Spring Cloud从Consul中获取服务状态
【consul】consul register service
spring cloud 产品
Spring Cloud Consul服务注册发现
Spring Cloud与Consul搭建微服务
consul部署
Spring Cloud构建微服务之一服务注册与发现

概述

前阵子项目中要用到Spring Cloud来作微服务框架，由于某些原因，需要结合Consul而非Zookeeper，但网上关于Spring Cloud跟Consul的结合搭建资料较少，因此想将搭建过程记录下来。

概念

Spring Cloud

根据百度百科上的定义：Spring Cloud是一系列框架的有序集合。它利用Spring Boot的开发便利性巧妙地简化了分布式系统基础设施的开发，如服务发现注册、配置中心、消息总线、负载均衡、断路器、数据监控等，都可以用Spring Boot的开发风格做到一键启动和部署。Spring Cloud并没有重复制造轮子，它只是将目前各家公司开发的比较成熟、经得起实际考验的服务框架组合起来，通过Spring Boot风格进行再封装屏蔽掉了复杂的配置和实现原理，最终给开发者留出了一套简单易懂、易部署和易维护的分布式系统开发工具包。
简而言之，Spring Cloud可以说是实现微服务架构的全家桶，拥有各种组件，这里主要使用Spring Cloud来当作RPC框架。
至于为什么不用其他RPC框架，比如国内比较流行的，阿里的Dubbo，或者国外Facebook的Thrfit（目前属于Apache）等，这里不再进行赘述。简单说下：Thrift是支持跨语言的，如果所用的微服务有各种不同的语言实现，那Thrift将是一个选择，但当时项目模块全都采用Java开发，所以这个优势就不明显。之前有简单试用了下Thrift，发现不是那么好用(当然，可能也是不熟悉的关系)，而且Thrift自身未实现负载均衡。gPRC的话则了解不深，跟Thrift一样支持跨语言。Dubbo相对比较成熟稳定，资料也多，但是其对API层的jar依赖比较严重，且容易产生序列化问题，而Spring Cloud是基于HTTP的，相对而言在可维护性和可扩展性方面较好。

Consul

按Consul官网定义，Consul是一个分布式服务网格，用于连接、保护跨运行平台的公共或私有云配置服务。E文不太好，翻译的可能不太准确，以下贴出Consul官网原文：Consul is a distributed service mesh to connect, secure, and configure services across any runtime platform and public or private cloud。
这里使用Consul来作为注册发现服务，对分布式系统进行服务治理。Consul的架构图如下： Consul架构
那又为什么要选择Consul而不用Zookeeper、Eureka、Etcd呢，这个当时有很多原因，不一定是技术上的原因。当然，Consul也确实有跨数据中心的优点，这个对高可用要求较高的项目是个很大的吸引力。另外，Consul集群部署也比较简单，还自带Web UI管理界面。这里附上这几种服务的比较图(参考CSDN博客【Etcd、Eureka、Consul、Zookeeper 之间的比较】https://blog.csdn.net/qq_34395857/article/details/89212566)
Etcd、Eureka、Consul、Zookeeper比较图

实现

应用划分

这里有两个项目sc_server和sc_client，sc_server作为服务端，即被调用方，sc_client作为客户端，即调用方。

实现步骤

1、部署好Consul并启动

本地开发可用命令consul agent -dev简单启动Consul，启动后在浏览器访问：http://localhost:8500/
如出现如下界面则表示启动成功 Consul管理界面

2、新建Maven Web服务端工程sc_server

2.1 pom.xml配置如下：

<project xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.sc.server</groupId>
    <artifactId>sc_server</artifactId>
    <packaging>war</packaging>
    <version>0.0.1-SNAPSHOT</version>
    <name>sc_server Maven Webapp</name>
    <url>http://maven.apache.org</url>

    <!-- SpringBoot -->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.2.RELEASE</version>
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <!-- Spring Cloud -->
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Greenwich.SR1</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <dependencies>
        <!-- SpringBoot整合Web组件 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- SpringBoot系统健康情况监控工具 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

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

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

</project>

2.2 在src/main/resources源码目录下新建application.yml文件，配置如下：

server:
  port: 8081

spring:
  application:
    name: sc-server
  cloud:
    consul:
      host: 127.0.0.1
      port: 8500
      enabled:  true
      discovery:
        enabled: true
        serviceName: sc-server

spring.cloud.consul.host需修改为实际的Consul服务地址。
spring.cloud.consul.discovery.serviceName是服务名，在客户端的调用中会用到。

2.3 新建启动类ScServerApp.java，代码如下：

package com.sc.server;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

@EnableDiscoveryClient
@SpringBootApplication
public class ScServerApp {

    public static void main(String[] args) {
        try {
            SpringApplication.run(ScServerApp.class, args);
            System.out.println("服务端启动成功");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

}

PS：注意要加上@EnableDiscoveryClient注解。

2.4 新建服务提供类DemoService，其实是个Controller，暴露HTTP接口：

package com.sc.server;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/demo")
public class DemoService {

    @RequestMapping(value = "/hello")
    public String hello(@RequestParam("name") String name) {
        System.out.println("服务被调用了");
        return "Hello " + name;
    }

}

至此，服务端工程搭建完成。

2.5 启动服务端，用浏览器访问http://localhost:8081/demo/hello?name=world，如显示"Hello world"则启动服务成功。服务端响应结果

3、新建Maven Web客户端工程sc_client

3.1 pom.xml配置如下：

<project xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.sc.client</groupId>
    <artifactId>sc_client</artifactId>
    <packaging>war</packaging>
    <version>0.0.1-SNAPSHOT</version>
    <name>sc_client Maven Webapp</name>
    <url>http://maven.apache.org</url>

    <!-- SpringBoot -->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.2.RELEASE</version>
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <!-- Spring Cloud -->
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Greenwich.SR1</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <dependencies>
        <!-- SpringBoot整合Web组件 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- SpringBoot系统健康情况监控工具 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

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

        <!-- SpringCloud Feign 声明式服务调用框架 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>

    </dependencies>

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

</project>

其中集成了OpenFeign，即采用了微服务架构下服务之间声明式的调用方案。

3.2 在src/main/resources源码目录下新建application.yml文件，配置如下：

server:
  port: 8082

spring:
  application:
    name: sc-client
  cloud:
    consul:
      host: 127.0.0.1
      port: 8500
      discovery:
        register: false

spring.cloud.consul.host需改为实际的Consul服务所在地址。
spring.cloud.consul.discovery.register设置为false，即该服务是客户端，不需要向Consul服务发现中心注册服务。

3.3 新建启动类ScClientApp.java，代码如下：

package com.sc.client;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.openfeign.EnableFeignClients;

@EnableFeignClients
@EnableDiscoveryClient
@SpringBootApplication
public class ScClientApp {

    public static void main(String[] args) {
        try {
            SpringApplication.run(ScClientApp.class, args);
            System.out.println("客户端启动成功");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

}

PS：需注意加上@EnableFeignClients注解。

3.4 新建DemoServiceClient类，代码如下：

package com.sc.client;

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;

/**
 * FeignClient的value取自服务端的配置spring.cloud.consul.discovery.serviceName
 */
@FeignClient(value = "sc-server")
@RequestMapping("/demo")
public interface DemoServiceClient {

    @RequestMapping(value = "/hello")
    String hello(@RequestParam("name") String name);

}

@FeignClient注解完成对服务提供方的接口绑定，
其中sc-server是服务注册名，即sc_server工程中spring.cloud.consul.discovery.serviceName的配置。

3.5 新建客户端调用服务端微服务接口示例ClientController，代码如下：

package com.sc.client;

import javax.annotation.Resource;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/client")
public class ClientController {

    @Resource
    private DemoServiceClient demoService;

    @RequestMapping(value = "/hello")
    @ResponseBody
    public String hello() {
        String name = "客户端";
        String res = demoService.hello(name);
        System.out.println("客户端成功调用了服务端并得到响应结果：" + res);
        return res;
    }

}

至此，客户端工程搭建完成。

3.6 启动客户端，用浏览器访问http://localhost:8082/client/hello，如显示"Hello 客户端"则调用服务端成功。客户端调用服务端响应结果

consul集群搭建及spring cloud集成
consul概念解析，集群搭建及作为配置中心与spring cloud集成 Consul是什么? Consul 官...
服务发现与配置工具Consul安装
Spring cloud Consul 一. 简介封装了Consul操作，consul是一个服务发现与配置工具，...
动态代理@Controller注册失败
maven依赖中引用了consul的spring-cloud-starter-consul-discovery服务...
Spring Cloud从Consul中获取服务状态
Spring Cloud使用consul作为服务注册发现配置中心，服务会在consul中注册健康检测地址，所以直接...
【consul】consul register service
consul 注册服务主要两种方式内部服务注册（推荐，反熵） spring cloud 集成consul 在应...
spring cloud 产品
服务注册与发现（服务注册中心）1 eureka2 zookeeper3 consul4 spring cloud...
Spring Cloud Consul服务注册发现
简介文章翻译整理自Spring Cloud Consul官方文档。 Spring Cloud Consul项目通...
Spring Cloud与Consul搭建微服务
概述前阵子项目中要用到Spring Cloud来作微服务框架，由于某些原因，需要结合Consul而非Zookee...
consul部署
Spring Cloud服务治理 Consul Consul是由HashiCrop基于Go语言开发的，支持多数据中...
Spring Cloud构建微服务之一服务注册与发现
Spring Cloud是最近比较流行的微服务架构框架，本文介绍如何使用Spring Cloud搭建服务注册与发现...

Spring Cloud与Consul搭建微服务

概述

概念

Spring Cloud

Consul

实现

应用划分

实现步骤

1、部署好Consul并启动

2、新建Maven Web服务端工程sc_server

3、新建Maven Web客户端工程sc_client

相关文章

consul集群搭建及spring cloud集成

服务发现与配置工具Consul安装

动态代理@Controller注册失败

Spring Cloud从Consul中获取服务状态

【consul】consul register service

spring cloud 产品

Spring Cloud Consul服务注册发现

Spring Cloud与Consul搭建微服务

consul部署

Spring Cloud构建微服务之一服务注册与发现

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读