springcloud简单微服务框架 | 第三章 服务消费者(集群)

该层可做断路器，断路器监控，负载均衡

一. 创建两个服务消费者

1. 创建第一个服务消费者

右键点击父项目，点击new，选择module)，再选择maven，然后点击next
出现：

填写artifactid，然后点击next，最后点击finish

2. 创建第二个服务消费者

右键点击父项目，点击new，选择module)，再选择maven，然后点击next
出现：

填写artifactid，然后点击next，最后点击finish

二. 两个服务消费者依赖及配置

本次引入两种

1. 第一个消费者依赖及配置（RestTemplate调用）

1.1 pom依赖

<?xml version="1.0" encoding="UTF-8"?>
<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/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>study-springcloudframework</artifactId>
        <groupId>com.lzr</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>study-service-consume1</artifactId>
    <description>服务消费者1</description>
    <name>服务消费者1</name>

    <properties>
        <swagger-api-version>1.9.0.RELEASE</swagger-api-version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- 断路器 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
        </dependency>
        <!-- 断路器监控(Hystrix Dashboard) -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-hystrix-dashboard</artifactId>
        </dependency>
        <!-- 在springcloud中 swagger依赖 使在zuul网关访问该服务器的接口-->
        <dependency>
            <groupId>com.spring4all</groupId>
            <artifactId>swagger-spring-boot-starter</artifactId>
            <version>${swagger-api-version}</version>
            <exclusions>
                <exclusion>
                    <groupId>com.google.guava</groupId>
                    <artifactId>guava</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <!-- 在该swagger 1.9.0.RELEASE版本中依赖guava冲突，所以踢除，然后单独引入 -->
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>20.0</version>
        </dependency>
    </dependencies>

</project>

1.2 application.yml文件配置

##服务消费者服务器端口
server:
  port: 3111
eureka:
  instance:
    ##服务消费者主机名，会在控制页面中显
    hostname: localhost
    prefer-ip-address: true
    ## 心跳检测，检测与持续时间
    ## 发送心跳间隔时间 单位秒 (测试的时候设置小一点，让eureka服务端及时踢出该服务)
    lease-renewal-interval-in-seconds: 10
    ## eureka服务端收到最后一次心跳后等待时间上限 单位秒 (告诉eureka服务端按照规则执行)
    lease-expiration-duration-in-seconds: 20
    ##服务消费者页面中status的请求路径（配置为断路器监控面板路径）
    status-page-url: http://${eureka.instance.hostname}:${server.port}/hystrix
  client:
    service-url:
      ##eureka服务注册中心的地址(配置eureka-server security的账户信息)
      defaultZone: http://lzr:123456@localhost:1111/eureka/
hystrix:
  command:
    default:
      execution:
        timeout:
          ## 关闭/开启超时
          enabled: true
        isolation:
          thread:
            ## 超时时间
            timeoutInMilliseconds: 1000
##服务名
spring:
  application:
    name: study-service-consumer
## 日志配置文件
logging:
  config: classpath:logback.xml
##swagger扫包
swagger:
  base-package: com.lzr.controller

1.3 日志文件logback.xml文件配置

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <contextName>logback</contextName>
    <property name="log.path" value="logs/study-service-consume1/logback/" />
    <property name="log.file" value="logs/study-service-consume1/logback.log" />
    <!--输出到控制台 -->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <!-- <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> <level>ERROR</level>
            </filter> -->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <!--输出到文件 -->
    <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.file}</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${log.path}%d{yyyy-MM-dd_HH}.log</fileNamePattern>
            <maxHistory>30</maxHistory>
            <!-- 指定日志文件的上限大小，例如设置为1GB的话，那么到了这个值，就会删除旧的日志 -->
            <totalSizeCap>1GB</totalSizeCap>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="info">
        <appender-ref ref="console" />
        <appender-ref ref="file" />
    </root>

</configuration>

1.4 启动类

package com.lzr;

import com.netflix.hystrix.contrib.metrics.eventstream.HystrixMetricsStreamServlet;
import com.spring4all.swagger.EnableSwagger2Doc;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.cloud.client.circuitbreaker.EnableCircuitBreaker;
import org.springframework.cloud.client.loadbalancer.LoadBalanced;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
import org.springframework.cloud.netflix.hystrix.EnableHystrix;
import org.springframework.cloud.netflix.hystrix.dashboard.EnableHystrixDashboard;
import org.springframework.context.annotation.Bean;
import org.springframework.web.client.RestTemplate;

/**
 * @author lzr
 * @date 2019/11/16 0016 17:03
 */
@SpringBootApplication
@EnableHystrix// 使用断路器(方法一)
@EnableEurekaClient// 注入到注册中心
@EnableHystrixDashboard//启用Hystrix Dashboard(断路器监控)功能
//@EnableCircuitBreaker//(@EnableCircuitBreaker + @HystrixCommand 注解启动Hystrix断路器的功能)(方法二)
@EnableSwagger2Doc// 开启swagger功能
public class ServiceConsume1Application {

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

    @LoadBalanced //使用负载均衡机制( 使用这个服务器才能知道请求服务名对应的ip，不使用则会报域名错误 )
    @Bean
    public RestTemplate restTemplate(){
        return new RestTemplate();
    }

    /**
     * 设置监控面板路径(版本2.0之后需要,这样设置,不需要引入(spring-boot-starter-actuator)包)
     */
    @Bean
    public ServletRegistrationBean getServlet() {
        HystrixMetricsStreamServlet streamServlet = new HystrixMetricsStreamServlet();
        ServletRegistrationBean registrationBean = new ServletRegistrationBean(streamServlet);
        registrationBean.setLoadOnStartup(1);//系统启动时加载顺序
        registrationBean.addUrlMappings("/actuator/hystrix.stream");
        registrationBean.setName("HystrixMetricsStreamServlet");
        return registrationBean;
    }

}

1.5 Controller类

package com.lzr.controller;

import com.lzr.response.HttpResponse;
import com.netflix.hystrix.contrib.javanica.annotation.HystrixCommand;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.extern.log4j.Log4j2;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

/**
 * @author lzr
 * @date 2019/11/16 0016 17:39
 */
@Log4j2
@RestController
@Api(value = "服务消费者1",description = "第一种方法！这是获取服务生产者信息的接口")
public class ProviderInfoController {

    @Autowired
    private RestTemplate restTemplate;

    @GetMapping("/getProviderInfo")
    @HystrixCommand(fallbackMethod = "error")
    @ApiOperation("获取生产者信息")
    public HttpResponse getProviderInfo(){
        return HttpResponse.success(restTemplate.getForObject("http://study-service-provider/getInfo",String.class));
    }

    public HttpResponse error(){
        HttpResponse httpResponse = new HttpResponse();
        httpResponse.setCode("-1");
        httpResponse.setMsg("error");
        httpResponse.setData("服务器忙");
        log.info(httpResponse);
        return httpResponse;
    }

}

1.6 HttpResponse类

package com.lzr.response;

import lombok.AllArgsConstructor;
import lombok.Data;

import java.io.Serializable;

/**
 *  @author lzr
 *  @date 2019/11/16 0016 17:40
 */
@Data
@AllArgsConstructor
public class HttpResponse implements Serializable {

    /**
     * 无参构造，jackson的反序列化需要无参构造函数
     */
    public HttpResponse(){
    }

    private String code;

    private String msg;

    private Object data;

    public static HttpResponse success(Object data){
        HttpResponse httpResponse = new HttpResponse();
        httpResponse.setMsg("请求成功");
        httpResponse.setCode("1");
        httpResponse.setData(data);
        return httpResponse;
    }

}

1.7 项目结构图

2. 第二个消费者依赖及配置（Feign调用）

2.1 pom依赖

<?xml version="1.0" encoding="UTF-8"?>
<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/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>study-springcloudframework</artifactId>
        <groupId>com.lzr</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>study-service-consume2</artifactId>
    <description>服务消费者2</description>
    <name>服务消费者2</name>

    <properties>
        <swagger-api-version>1.9.0.RELEASE</swagger-api-version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- feign客户端工具 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
        <!-- 断路器 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
        </dependency>
        <!-- 开启监控相关的端点依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <!-- 断路器监控(Hystrix Dashboard) -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-hystrix-dashboard</artifactId>
        </dependency>
        <!-- 由于feign自带的http客户端实现是HttpURLConnection，没有连接池功能，可配置能力也比较差，因此我们使用okhttp作为底层的http客户端的具体实现 -->
        <dependency>
            <groupId>io.github.openfeign</groupId>
            <artifactId>feign-okhttp</artifactId>
        </dependency>
        <!-- 在springcloud中 swagger依赖 使在zuul网关访问该服务器的接口-->
        <dependency>
            <groupId>com.spring4all</groupId>
            <artifactId>swagger-spring-boot-starter</artifactId>
            <version>${swagger-api-version}</version>
            <exclusions>
                <exclusion>
                    <groupId>com.google.guava</groupId>
                    <artifactId>guava</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <!-- 在该swagger 1.9.0.RELEASE版本中依赖guava冲突，所以踢除，然后单独引入 -->
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>20.0</version>
        </dependency>
    </dependencies>

</project>

2.2 application.yml文件配置

##服务消费者服务器端口
server:
  port: 3112
eureka:
  instance:
    ##服务消费者主机名，会在控制页面中显
    hostname: localhost
    prefer-ip-address: true
    ## 心跳检测，检测与持续时间
    ## 发送心跳间隔时间 单位秒 (测试的时候设置小一点，让eureka服务端及时踢出该服务)
    lease-renewal-interval-in-seconds: 10
    ## eureka服务端收到最后一次心跳后等待时间上限 单位秒 (告诉eureka服务端按照规则执行)
    lease-expiration-duration-in-seconds: 20
    ##服务消费者页面中status的请求路径（配置为断路器监控面板路径）
    status-page-url: http://${eureka.instance.hostname}:${server.port}/hystrix
  client:
    service-url:
      ##eureka服务注册中心的地址(配置eureka-server security的账户信息)
      defaultZone: http://lzr:123456@localhost:1111/eureka/
## feign默认开启支持ribbon
ribbon:
  ## 是否对所有操作请求都进行重试(注意,接口幂等性问题,若开启，可使用redis存储key)
  OkToRetryOnAllOperations: false
  ## 对当前实例的重试次数(两个都有数据时才生效)(使用的时候，注意接口幂等性问题)
  MaxAutoRetries: 1
  ## 切换实例的重试次数(使用的时候，注意接口幂等性问题)
  MaxAutoRetriesNextServer: 1
  ## 建立连接最大时间
  ConnectTimeout: 2000
  ## 连接之后读取到可用资源所用时间
  ReadTimeout: 1000
  eureka:
    enabled: true
  ## 使用okhttp请求
  okhttp:
    enabled: true
## feign中配置开启hystrix(默认是关闭的，需要手动开启)
feign:
  hystrix:
    enabled: true
  httpclient:
    enabled: false
    ## 默认连接超时时间：2000毫秒
    connection-timeout: 2000
    ## 连接池管理定时器执行频率：默认 3000毫秒
    connection-timer-repeat: 3000
  okhttp:
    enabled: true
hystrix:
  command:
    default:
      execution:
        timeout:
          ## 关闭/开启超时
          enabled: true
        isolation:
          thread:
            ## 超时时间(若配置了重试则总(最大)超时时间= (1 + MaxAutoRetries + MaxAutoRetriesNextServer) * ReadTimeout)
            timeoutInMilliseconds:3000
##服务名
spring:
  application:
    name: study-service-consumer
  cloud:
    loadbalancer:
      retry:
        ## 开启重连机制(默认开启,注意：版本不同，这里的默认值可能会不一样)
        enabled: true
## 设置监控面板监控单实例节点(endpoints中会包含很多敏感信息，除了health和info两个支持web访问外，其他的默认不支持web访问)
## 需要引入包(spring-boot-starter-actuator)
management:
  endpoints:
    web:
      exposure:
        include: hystrix.stream
## 日志配置文件
logging:
  config: classpath:logback.xml
##swagger扫包
swagger:
  base-package: com.lzr.controller

2.3 日志文件logback.xml文件配置

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <contextName>logback</contextName>
    <property name="log.path" value="logs/study-service-consume2/logback/" />
    <property name="log.file" value="logs/study-service-consume2/logback.log" />
    <!--输出到控制台 -->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <!-- <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> <level>ERROR</level>
            </filter> -->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <!--输出到文件 -->
    <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.file}</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${log.path}%d{yyyy-MM-dd_HH}.log</fileNamePattern>
            <maxHistory>30</maxHistory>
            <!-- 指定日志文件的上限大小，例如设置为1GB的话，那么到了这个值，就会删除旧的日志 -->
            <totalSizeCap>1GB</totalSizeCap>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="info">
        <appender-ref ref="console" />
        <appender-ref ref="file" />
    </root>

</configuration>

2.4 启动类

package com.lzr;

import com.spring4all.swagger.EnableSwagger2Doc;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.SpringCloudApplication;
import org.springframework.cloud.client.circuitbreaker.EnableCircuitBreaker;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
import org.springframework.cloud.netflix.hystrix.EnableHystrix;
import org.springframework.cloud.netflix.hystrix.dashboard.EnableHystrixDashboard;
import org.springframework.cloud.openfeign.EnableFeignClients;

/**
 * @author lzr
 * @date 2019/11/16 0016 17:31
 */
//@SpringBootApplication
//@EnableEurekaClient// 注入到注册中心(也可使用 @EnableDiscoveryClient，对eureka作为注册中心，最好使用@EnableEurekaClient注解)
//@EnableCircuitBreaker//（@EnableHystrix 使用断路器(方法一)）（(@EnableCircuitBreaker 注解启动Hystrix断路器的功能)(方法二)）
@SpringCloudApplication// 这个注解代替上面三种注解
@EnableHystrixDashboard//启用Hystrix Dashboard(断路器监控)功能(http://localhost:3112/hystrix)
@EnableSwagger2Doc// 开启swagger功能
@EnableFeignClients// 开启feign客户端(默认开启负载均衡)
public class ServiceConsume2Application {

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

}

2.5 controller类

package com.lzr.controller;

import com.lzr.RequestFeignInterface.RequestProviderInterface;
import com.lzr.response.HttpResponse;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.extern.log4j.Log4j2;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;

/**
 * @author lzr
 * @date 2019/11/16 0016 17:39
 */
@Log4j2
@RestController
@Api(value = "服务消费者2",description = "第二种方法！这是获取服务生产者信息的接口")
public class ProviderInfoController {

    //@Autowired(在这个方式中，idea使用这个会报红线，但不是错误！程序能正常运行)
    @Resource
    private RequestProviderInterface requestProviderInterface;

    @GetMapping("/getProviderInfo")
    @ApiOperation("获取生产者信息")
    public HttpResponse getProviderInfo(){
        return HttpResponse.success(requestProviderInterface.getProviderInfo());
    }

}

2.6 HttpResponse类

package com.lzr.response;

import lombok.AllArgsConstructor;
import lombok.Data;

import java.io.Serializable;

/**
 * @author lzr
 * @date 2019/11/16 0016 17:40
 */
@Data
@AllArgsConstructor
public class HttpResponse implements Serializable {

    /**
     * 无参构造，jackson的反序列化需要无参构造函数
     */
    public HttpResponse(){
    }

    private String code;

    private String msg;

    private Object data;

    public static HttpResponse success(Object data){
        HttpResponse httpResponse = new HttpResponse();
        httpResponse.setMsg("请求成功");
        httpResponse.setCode("1");
        httpResponse.setData(data);
        return httpResponse;
    }

}

2.7 feign调用接口类

package com.lzr.RequestFeignInterface;

import com.lzr.RequestFeignInterface.fallback.RequestProviderInterfaceImpl;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;

/**
 * @author lzr
 * @date 2019/11/16 0016 18:13
 */
@FeignClient(value = "study-service-provider",fallback = RequestProviderInterfaceImpl.class)
public interface RequestProviderInterface {

    @GetMapping("/getInfo")
    String getProviderInfo();

}

2.8 服务降级回调类

package com.lzr.RequestFeignInterface.fallback;

import com.lzr.RequestFeignInterface.RequestProviderInterface;
import org.springframework.stereotype.Component;

/**
 * @author lzr
 * @date 2019/11/16 0016 18:14
 */
@Component
public class RequestProviderInterfaceImpl implements RequestProviderInterface {
    @Override
    public String getProviderInfo() {
        return "服务器忙！";
    }
}

2.9 项目结构图

三. 注意事项

1. 服务降级回调类需要 实现 feign调用接口类（并注入到上下文）
2. 微服务中只要涉及到重连，都要处理接口幂等性问题，若开启，可使用redis存储key
3. …

四. 项目地址

项目 git地址 将在最后一章附上。
若有疑问，请在评论区留言，谢谢