Spring Cloud与Consul搭建微服务

概述

  • 前阵子项目中要用到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;
    }

}

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

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;
    }

}

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

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 211,884评论 6赞 492
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 90,347评论 3赞 385
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 157,435评论 0赞 348
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 56,509评论 1赞 284
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 65,611评论 6赞 386
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 49,837评论 1赞 290
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 38,987评论 3赞 408
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 37,730评论 0赞 267
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,194评论 1赞 303
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,525评论 2赞 327
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,664评论 1赞 340
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 34,334评论 4赞 330
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 39,944评论 3赞 313
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,764评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,997评论 1赞 266
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 46,389评论 2赞 360
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 43,554评论 2赞 349