SpringCloud核心教程 | 第四篇：服务注册与发现 Consul篇

Xufc 发布于2019-08-19 10:56 / 2083人阅读

摘要：下一篇介绍基于的服务注册与调用。服务提供者工程配置这里服务提供者是使用之前进阶教程第三篇整合连接池以及监控改造而来，这里一样的部分就不再重复说明，下面将说明新增的部分。

Spring Cloud简介

Spring Cloud是一个基于Spring Boot实现的云应用开发工具，它为基于JVM的云应用开发中涉及的配置管理、服务发现、断路器、智能路由、微代理、控制总线、全局锁、决策竞选、分布式会话和集群状态管理等操作提供了一种简单的开发方式。

Spring Cloud包含了多个子项目（针对分布式系统中涉及的多个不同开源产品），比如：Spring Cloud Config、Spring Cloud Netflix、Spring Cloud CloudFoundry、Spring Cloud AWS、Spring Cloud Security、Spring Cloud Commons、Spring Cloud Zookeeper、Spring Cloud CLI等项目。

微服务架构

“微服务架构”在这几年非常的火热，以至于关于微服务架构相关的开源产品被反复的提及（比如： netflix、dubbo），Spring Cloud也因Spring社区的强大知名度和影响力也被广大架构师与开发者备受关注。

那么什么是“微服务架构”呢？简单的说，微服务架构就是将一个完整的应用从数据存储开始垂直拆分成多个不同的服务，每个服务都能独立部署、独立维护、独立扩展，服务与服务间通过诸如RESTful API的方式互相调用。

对于“微服务架构”，大家在互联网可以搜索到很多相关的介绍和研究文章来进行学习和了解。也可以阅读始祖Martin Fowler的《Microservices》（中文版翻译点击查看），本文不做更多的介绍和描述。

服务治理

在简单介绍了Spring Cloud和微服务架构之后，下面回归本文的主旨内容，如何使用Spring Cloud来实现服务治理。

由于Spring Cloud为服务治理做了一层抽象接口，所以在Spring Cloud应用中可以支持多种不同的服务治理框架，比如：Netflix Eureka、Consul、Zookeeper。在Spring Cloud服务治理抽象层的作用下，我们可以无缝地切换服务治理实现，并且不影响任何其他的服务注册、服务发现、服务调用等逻辑。

所以，下面我们通过Eureka这种种服务治理的实现来体会Spring Cloud这一层抽象所带来的好处。
下一篇介绍基于Consul的服务注册与调用。

Spring Cloud Consul

首先，我们来尝试使用Spring Cloud Consul来实现服务治理。

Consul 是一套开源的分布式服务发现和配置管理系统，由 HashiCorp 公司用 Go 语言开发。

它具有很多优点。包括：基于 raft 协议，比较简洁；支持健康检查, 同时支持 HTTP 和 DNS 协议支持跨数据中心的 WAN 集群提供图形界面跨平台，支持 Linux、Mac、Windows

下面，就来具体看看如何使用Spring Cloud Consul实现服务治理，这里使用Consul为服务注册中心工程、consul-provider服务提供者工程、consul-consumer服务消费者工程。

准备工作

环境：

windows
jdk 8
maven 3.0
IDEA

构建工程

首先构建父工程，引入父工程依赖：



    4.0.0
    
    
        cn.zhangbox
        spring-cloud-study
        1.0-SNAPSHOT
    
    
    cn.zhangbox
    spring-cloud-consul
    pom
    1.0-SNAPSHOT
    
    
    
        consul-provider
        consul-consumer

父工程取名为：spring-cloud-consul
构建子工程，分别创建工程名为：、consul-provider、consul-consumer并在pom中加入以下依赖：



    4.0.0

    
        cn.zhangbox
        spring-cloud-consul
        1.0-SNAPSHOT
    

    cn.zhangbox
    consul-provider
    0.0.1-SNAPSHOT
    jar

    consul-provider
    this project for Spring Boot

    
        UTF-8
        UTF-8
        1.8
        
        3.4
        1.10
        1.2.0
        1.16.14
        1.2.41
        1.1.2
    

    
        
        
            aliyunmaven
            http://maven.aliyun.com/nexus/content/groups/public/
        
    

    

        
        
            org.mybatis.spring.boot
            mybatis-spring-boot-starter
            ${mybatis-spring-boot.version}
        
        

        
        
            org.springframework.cloud
            spring-cloud-starter-consul-discovery
        
        
            org.springframework.boot
            spring-boot-starter-actuator
        
        

        
        
            org.springframework.boot
            spring-boot-starter-web
        
        

        
        
            io.springfox
            springfox-swagger2
            2.6.1
        
        
            io.springfox
            springfox-swagger-ui
            2.6.1
        
        

        
        
            mysql
            mysql-connector-java
            runtime
        
        

        
        
            org.springframework.boot
            spring-boot-starter-test
            test
        
        

        
        
            org.apache.commons
            commons-lang3
            ${commons-lang3.version}
        
        
            commons-codec
            commons-codec
            ${commons-codec.version}
        
        

        
        
            com.alibaba
            fastjson
            ${fastjson.version}
        
        

        
        
            com.alibaba
            druid-spring-boot-starter
            ${druid.version}
        
        

        
        
            org.projectlombok
            lombok
            ${lombok.version}
        
        
    

    
    
        
            
                org.springframework.cloud
                spring-cloud-dependencies
                Dalston.SR1
                pom
                import
            
        
    
    

    
        eureka-provider
        
            
            
                org.springframework.boot
                spring-boot-maven-plugin



    4.0.0

    
        cn.zhangbox
        spring-cloud-consul
        1.0-SNAPSHOT
    

    cn.zhangbox
    consul-consumer
    0.0.1-SNAPSHOT
    jar

    consul-consumer
    this project for Spring Boot

    
        UTF-8
        UTF-8
        1.8
        
        3.4
        1.10
        1.2.0
        1.16.14
        1.2.41
        1.1.2
    

    
        
        
            aliyunmaven
            http://maven.aliyun.com/nexus/content/groups/public/
        
    

    
        
        
            org.springframework.cloud
            spring-cloud-starter-consul-discovery
        
        
            org.springframework.boot
            spring-boot-starter-actuator
        
        

        
        
            org.springframework.cloud
            spring-cloud-starter-feign
        
        

        
        
            org.springframework.boot
            spring-boot-starter-web
        
        

        
        
            io.springfox
            springfox-swagger2
            2.6.1
        
        
            io.springfox
            springfox-swagger-ui
            2.6.1
        
        

        
        
            org.springframework.boot
            spring-boot-starter-test
            test
        
        

        
        
            org.apache.commons
            commons-lang3
            ${commons-lang3.version}
        
        
            commons-codec
            commons-codec
            ${commons-codec.version}
        
        

        
        
            com.alibaba
            fastjson
            ${fastjson.version}
        
        

        
        
            org.projectlombok
            lombok
            ${lombok.version}
        
        
    

    
    
        
            
                org.springframework.cloud
                spring-cloud-dependencies
                Dalston.SR1
                pom
                import
            
        
    
    

    
        eureka-provider
        
            
            
                org.springframework.boot
                spring-boot-maven-plugin

工程构建完成。

服务注册中心搭建

Window下安装：
window下安装Consul
Linux下安装：
CentOS 安装 Consul 服务注册和发现软件
Consul安装 linux环境
至此consul注册中心创建完成，window下本机安装的consul浏览器输入地址：http://localhost:8500
linux下安装的只需要把localhost换成对应的ip即可
可以看到如下页面，表示服务启动OK

这里这看到还没有服务暴露出来，是因为还没创建服务提供者工程。

服务提供者工程配置

这里服务提供者是使用之前SpringBoot进阶教程 | 第三篇：整合Druid连接池以及Druid监控改造而来，这里一样的部分就不再重复说明，下面将说明新增的部分。
首先：修改application.yml配置为如下：

#公共配置
server:
    port: 80
    tomcat:
      uri-encoding: UTF-8
spring:
  application:
      name: consul-provider
  #激活哪一个环境的配置文件
  profiles:
    active: dev
  #连接池配置
  datasource:
    driver-class-name: com.mysql.jdbc.Driver
    # 使用druid数据源
    type: com.alibaba.druid.pool.DruidDataSource
    druid:
      # 配置测试查询语句
      validationQuery: SELECT 1 FROM DUAL
      # 初始化大小，最小，最大
      initialSize: 10
      minIdle: 10
      maxActive: 200
      # 配置一个连接在池中最小生存的时间，单位是毫秒
      minEvictableIdleTimeMillis: 180000
      testOnBorrow: false
      testWhileIdle: true
      removeAbandoned: true
      removeAbandonedTimeout: 1800
      logAbandoned: true
      # 打开PSCache，并且指定每个连接上PSCache的大小
      poolPreparedStatements: true
      maxOpenPreparedStatements: 100
      # 配置监控统计拦截的filters，去掉后监控界面sql无法统计，"wall"用于防火墙
      filters: stat,wall,log4j
      # 通过connectProperties属性来打开mergeSql功能；慢SQL记录
      connectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=5000

  #配置consul获取服务地址，这里使用的是本地提供的注册中心
  cloud:
    consul:
      #consul服务地址
      host: localhost
      #consul端口号
      port: 8500
      discovery:
        #配置注册中心显示当前服务的ip
        prefer-ip-address: true
        #配置当前服务的ip和端口号
        #instance-id: ${spring.cloud.client.ipAddress}:${server.port}
        #配置该项点击ip会跳转至对应的接口swagger页面
        health-check-url: http://${spring.cloud.client.ipAddress}:${server.port}/swagger-ui.html  # ${server.port}为该服务的端口号

#mybatis
mybatis:
  # 实体类扫描
  type-aliases-package: cn.zhangbox.springboot.entity
  # 配置映射文件位置
  mapper-locations: classpath:mapper/*.xml
  # 开启驼峰匹配
  mapUnderscoreToCamelCase: true

---
#开发环境配置
server:
  #端口
  port: 8080
spring:
  profiles: dev
  # 数据源配置
  datasource:
    url: jdbc:mysql://101.132.66.175:3306/student?useUnicode=true&characterEncoding=utf8&useSSL=false&tinyInt1isBit=true
    username: root
    password: 123456
#日志
logging:
  config: classpath:log/logback.xml
  path: log/consul-provider

---
#测试环境配置
server:
  #端口
  port: 80
spring:
  profiles: test
  # 数据源配置
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/consul-provider?useUnicode=true&characterEncoding=utf8&useSSL=false&tinyInt1isBit=true
    username: root
    password: 123456
#日志
logging:
  config: classpath:log/logback.xml
  path: /home/log/consul-provider

---
#生产环境配置
server:
  #端口
  port: 8080
spring:
  profiles: prod
  # 数据源配置
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/consul-provider?useUnicode=true&characterEncoding=utf8&useSSL=false&tinyInt1isBit=true
    username: root
    password: 123456
#日志
logging:
  config: classpath:log/logback.xml
  path: /home/log/consul-provider

其次：在config目录下增加SwaggerConfig类加入以下代码：

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket userApi() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("cn.zhangbox.eureka.provider.controller"))//过滤的接口，有这扫描才会看到接口信息
                .paths(PathSelectors.any())
                .build();
        return docket;
    }


    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("eureka服务端提供者接口平台").description("服务相关数据接口")
                .termsOfServiceUrl("http://www.zhang.box.cn/").contact("技术开发部")
                .license("Licence Version 1.0").licenseUrl("#").version("1.0").build();
    }

}

这里如果不会使用swagger的整合可以参考这篇文章：
SpringBoot非官方教程 | 第十一篇：SpringBoot集成swagger2，构建优雅的Restful API

接着：创建核心启动类：

@EnableDiscoveryClient //使用该注解将注册服务到consul
@SpringBootApplication
@MapperScan("cn.zhangbox.consul.provider.dao")//配置mybatis接口包扫描
public class ConsulProviderApplication extends SpringBootServletInitializer {

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

至此consul-provider服务提供者创建完成，浏览器输入地址：http://localhost:8500/
可以看到如下页面，表示服务注册OK

浏览器输入地址：http://localhost:8080/swagger-ui.html后可以跳转看到swagger的页面并可是测试服务提供者的接口，如下：

服务消费者工程配置

这里构建的工程名为consul-consumer,上文已经构建了工程但是没有创建目录，这里只需要在java目录下创建config、controller，service，包即可，这里服务的消费是通过feign来进行服务调用的，后面会有专门以篇文章来讲feign。
首先：在consul-consumer工程下resource目录下添加application.yml文件并加入以下配置：

#公共配置
server:
    port: 80
    tomcat:
      uri-encoding: UTF-8
spring:
  #服务名称，更关键，使用feign进行服务消费将以此为依据
  application:
        name: consul-consumer
  #激活哪一个环境的配置文件
  profiles:
    active: dev

  #配置consul获取服务地址，这里使用的是本地提供的注册中心
  cloud:
    consul:
      #consul服务地址
      host: localhost
      #consul端口号
      port: 8500
      discovery:
        #配置注册中心显示当前服务的ip
        prefer-ip-address: true
        #配置当前服务的ip和端口号
        #instance-id: ${spring.cloud.client.ipAddress}:${server.port}
        #配置该项点击ip会跳转至对应的接口swagger页面
        health-check-url: http://${spring.cloud.client.ipAddress}:${server.port}/swagger-ui.html  # ${server.port}为该服务的端口号

---
#开发环境配置
server:
  #端口
  port: 8081
spring:
  profiles: dev
#日志
logging:
  config: classpath:log/logback.xml
  path: log/consul-consumer

---
#测试环境配置
server:
  #端口
  port: 8082
spring:
  profiles: test
#日志
logging:
  config: classpath:log/logback.xml
  path: /home/log/consul-consumer

---
#生产环境配置
server:
  #端口
  port: 8083
spring:
  profiles: prod
#日志
logging:
  config: classpath:log/logback.xml
  path: /home/log/consul-consumer

其次：在config目录下增加SwaggerConfig类加入以下代码：

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket userApi() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("cn.zhangbox.eureka.consumer.controller"))//过滤的接口，有这扫描才会看到接口信息
                .paths(PathSelectors.any())
                .build();
        return docket;
    }


    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("eureka服务端消费者接口平台").description("服务相关数据接口")
                .termsOfServiceUrl("http://www.zhang.box.cn/").contact("技术开发部")
                .license("Licence Version 1.0").licenseUrl("#").version("1.0").build();
    }

}

接着：在service包下创建StudentConsumerService类并加入以下代码：

@FeignClient(value = "consul-provider")
public interface StudentConsumerService {

    /**
     * 查询所有的学生信息
     *
     * @param sname
     * @param age
     * @return
     */
    @RequestMapping(value = "/student/list",method = RequestMethod.GET)
    String getStudentList(@RequestParam(value = "sname") String sname, @RequestParam(value = "age") Integer age);
}

然后：在controller包下创建StudentConteroller并加入如下代码：

@Controller
@RequestMapping("/student")
@Api(value = "eureka-consumer", description = "学生查询接口")
public class StudentConteroller {
    private static final Logger LOGGER = LoggerFactory.getLogger(StudentConteroller.class);

    @Autowired
    StudentConsumerService studentService;

    /**
     * 查询所有的学生信息
     *
     * @param sname
     * @param age
     * @param modelMap
     * @return
     */
    @ResponseBody
    @GetMapping("/consumer/list")
    public String list(
            @ApiParam(value = "学生姓名") @RequestParam(required = false) String sname,
            @ApiParam(value = "年龄") @RequestParam(required = false) Integer age,
            ModelMap modelMap) {
        String json = null;
        try {
            json = studentService.getStudentList(sname, age);
        } catch (Exception e) {
            e.printStackTrace();
            modelMap.put("ren_code", "0");
            modelMap.put("ren_msg", "查询失败===>" + e);
            LOGGER.error("查询失败===>" + e);
            json = JSON.toJSONString(modelMap);
        }
        return json;
    }
}

接着：创建核心启动类：

@EnableFeignClients//开启Feign调用接口
@EnableDiscoveryClient//开启客户端服务，没有这个注解会报Feign找不到对应服务的错误
@SpringBootApplication
public class ConsulConsumerApplication extends SpringBootServletInitializer {

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

至此consul-consumer服务提供者创建完成，浏览器输入地址：http://127.0.0.1:8081/swagger-ui.html
consul注册中心可以看到服务提供和消费者都在：

跳转看到swagger的页面并可是测试服务消费者的接口,可以看到如下页面，并点击try it out按钮，返回了正确的学生信息数据

返回数据如下：

{
    "ren_code": "0",
    "ren_msg": "查询成功",
    "studentList": [{
        "age": "17",
        "birth": "2010-07-22",
        "dept": "王同学学习成绩很不错",
        "sex": "1",
        "sname": "王同学",
        "sno": 1
    }, {
        "age": "17",
        "birth": "2010-07-22",
        "dept": "李同学学习成绩很不错",
        "sex": "1",
        "sname": "李同学",
        "sno": 2
    }]
}

以上就是spring cloud基于consul实现分布式服务注册与消费的整合流程，是不是很简单，你也来小试牛刀一把吧。

源码地址

SpringCloud核心教程 | 第四篇：服务注册与发现 Consul篇

写在最后

欢迎关注、喜欢、和点赞后续将推出更多的spring cloud教程，敬请期待。
欢迎关注我的微信公众号获取更多更全的学习资源，视频资料，技术干货！

GPU云服务器云服务器第四篇 springcloud教程服务治理与发现 c核心编程视频教程

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/76721.html

2021 年最新基于 Spring Cloud 的微服务架构分析

摘要：是一个相对比较新的微服务框架，年才推出的版本虽然时间最短但是相比等框架提供的全套的分布式系统解决方案。提供线程池不同的服务走不同的线程池，实现了不同服务调用的隔离，避免了服务器雪崩的问题。通过互相注册的方式来进行消息同步和保证高可用。 Spring Cloud 是一个相对比较新的微服务框架，...

cikenerd 2021-11-19 09:40 评论0 收藏0
史上最简单的SpringCloud教程 | 第四篇:断路器（Hystrix）

摘要：为了保证其高可用，单个服务又必须集群部署。为了解决这个问题，就出现断路器模型。一断路器简介摘自官网已经创建了一个名为的库来实现断路器模式。较底层的服务如果出现故障，会导致连锁故障。当对特定的服务的调用达到一个阀值是秒次断路器将会被打开。转载请标明出处： http://blog.csdn.net/forezp/a...本文出自方志朋的博客在微服务架构中，我们将业务拆分成一个个的服务，...

Hydrogen 2019-08-16 10:32 评论0 收藏0
Spring Cloud Alibaba到底坑不坑？

摘要：我没有能力去控制那些自媒体发布这些不实的内容，但是在我了解的范围内，还是尽力输出一些我的理解。之前我发过一篇《说说我为什么看好Spring Cloud Alibaba》，然后这两天有网友给我转了这篇文章《坑爹项目spring-cloud-alibaba，我们也来一个》，问我的看法是怎么样的，聊天时候简单说了一下。今天在家休息，抽空整理一下内容，逐点说一下我的看法，主要还是觉得这篇文章...

娣辩孩 2019-08-19 11:35 评论0 收藏0