SpringCloud（第 013 篇）電影微服務使用定製化 Feign 在客戶端進行負載均衡排程併為 Feign 配置帳號密碼登入認證 Eureka

一、大致介紹

1、定製 Feign 實現訪問遠端微服務；
2、為 Feign 配置帳號密碼來登入認證 Eureka 服務發現模組；
3、修改 Feign 的日誌列印級別；
4、定製 Feign 也毫不掩飾的支援負載均衡排程功能；

二、實現步驟

2.1 新增 maven 引用包

<?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">
    <modelVersion>4.0.0</modelVersion>

    <artifactId>springms-consumer-movie-feign-custom</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>

    <parent>
        <groupId>com.springms.cloud</groupId>
        <artifactId>springms-spring-cloud</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <dependencies>
        <!-- web模組 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- 客戶端發現模組 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</artifactId>
        </dependency>

        <!-- Java HTTP 客戶端開發的工具的模組 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-feign</artifactId>
        </dependency>
    </dependencies>

</project>

2.2 新增應用配置檔案（springms-consumer-movie-feign-custom\src\main\resources\application.yml）

spring:
  application:
    name: springms-consumer-movie-feign-custom
server:
  port: 8050
eureka:
  client:
#    healthcheck:
#      enabled: true
    serviceUrl:
      defaultZone: http://admin:admin@localhost:8761/eureka
  instance:
    prefer-ip-address: true
    instance-id: ${spring.application.name}:${spring.cloud.client.ipAddress}:${spring.application.instance_id:${server.port}}

logging:
  level:
    com.springms.cloud.feign.UserFeignCustomClient: DEBUG


# 解決第一次請求報超時異常的方案，因為 hystrix 的預設超時時間是 1 秒，因此請求超過該時間後，就會出現頁面超時顯示 ：
#
# 這裡就介紹大概三種方式來解決超時的問題，解決方案如下：
#
# 第一種方式：將 hystrix 的超時時間設定成 5000 毫秒
# hystrix.command.default.execution.isolation.thread.timeoutInMilliseconds: 5000
#
# 或者：
# 第二種方式：將 hystrix 的超時時間直接禁用掉，這樣就沒有超時的一說了，因為永遠也不會超時了
# hystrix.command.default.execution.timeout.enabled: false
#
# 或者：
# 第三種方式：索性禁用feign的hystrix支援
feign.hystrix.enabled: false ## 索性禁用feign的hystrix支援

# 超時的issue：https://github.com/spring-cloud/spring-cloud-netflix/issues/768
# 超時的解決方案： http://stackoverflow.com/questions/27375557/hystrix-command-fails-with-timed-out-and-no-fallback-available
# hystrix配置： https://github.com/Netflix/Hystrix/wiki/Configuration#execution.isolation.thread.timeoutInMilliseconds

2.3 新增實體使用者類User（springms-consumer-movie-feign-custom\src\main\java\com\springms\cloud\entity\User.java）

package com.springms.cloud.entity;

import java.math.BigDecimal;

public class User {

    private Long id;

    private String username;

    private String name;

    private Short age;

    private BigDecimal balance;

    public Long getId() {
        return this.id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getUsername() {
        return this.username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getName() {
        return this.name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Short getAge() {
        return this.age;
    }

    public void setAge(Short age) {
        this.age = age;
    }

    public BigDecimal getBalance() {
        return this.balance;
    }

    public void setBalance(BigDecimal balance) {
        this.balance = balance;
    }

}

2.4 新增訪問遠端服務 Feign 客戶端（springms-consumer-movie-feign-custom\src\main\java\com\springms\cloud\feign\UserFeignCustomClient.java）

package com.springms.cloud.feign;

import com.springms.cloud.entity.User;
import com.springms.config.TestFeignCustomConfiguration;
import feign.Param;
import feign.RequestLine;
import org.springframework.cloud.netflix.feign.FeignClient;

/**
 * 使用者Http請求的客戶端，FeignClient 註解地方採用了自定義的配置。
 *
 * 註解FeignClient的傳參：表示的是註冊到 Eureka 服務上的模組名稱。
 *
 * @author hmilyylimh
 *
 * @version 0.0.1
 *
 * @date 2017/9/19
 *
 */
@FeignClient(name = "springms-provider-user", configuration = TestFeignCustomConfiguration.class)
public interface UserFeignCustomClient {

    /**
     * 這裡的註解 RequestLine、Param 是 Feign 的配置新的註解，詳細請參考連結：https://github.com/OpenFeign/feign
     *
     * @param id
     * @return
     */
    @RequestLine("GET /simple/{id}")
    public User findById(@Param("id") Long id);
}


/****************************************************************************************
 參考程式碼如下：

    interface GitHub {
        @RequestLine("GET /repos/{owner}/{repo}/contributors")
        List<Contributor> contributors(@Param("owner") String owner, @Param("repo") String repo);
    }

    static class Contributor {
        String login;
        int contributions;
    }

    public static void main(String... args) {
        GitHub github = Feign.builder().decoder(new GsonDecoder()).target(GitHub.class, "https://api.github.com");

        // Fetch and print a list of the contributors to this library.
        List<Contributor> contributors = github.contributors("OpenFeign", "feign");
        for (Contributor contributor : contributors) {
            System.out.println(contributor.login + " (" + contributor.contributions + ")");
        }
    }
 ****************************************************************************************/

2.5 新增登入認證Eureka服務 Feign 客戶端（springms-consumer-movie-feign-custom\src\main\java\com\springms\cloud\feign\UserFeignCustomSecondClient.java）

package com.springms.cloud.feign;

import com.springms.config.TestEurekaAuthConfiguration;
import org.springframework.cloud.netflix.feign.FeignClient;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;

/**
 * 使用者Http請求的客戶端，FeignClient 註解地方採用了自定義的配置。
 *
 * 註解FeignClient的傳參：表示的是註冊到 Eureka 服務上的模組名稱。
 *
 * @author hmilyylimh
 *
 * @version 0.0.1
 *
 * @date 2017/9/19
 *
 */
@FeignClient(name = "xxx", url = "http://localhost:8761/", configuration = TestEurekaAuthConfiguration.class)
public interface UserFeignCustomSecondClient {

    @RequestMapping(value = "/eureka/apps/{serviceName}")
    public String findEurekaInfo(@PathVariable("serviceName") String serviceName);
}

2.6 新增訪問遠端服務配置類（springms-consumer-movie-feign-custom\src\main\java\com\springms\config\TestFeignCustomConfiguration.java）

package com.springms.config;

import feign.Contract;
import feign.Logger;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * 自定義配置。
 *
 * 不和 com.springms.cloud 在同級目錄，因為文件有說明，該配置檔案不需要被掃描到。
 *
 * @author hmilyylimh
 *
 * @version 0.0.1
 *
 * @date 2017/9/19
 *
 */
@Configuration
public class TestFeignCustomConfiguration {

    @Bean
    public Contract feignContract(){
        return new feign.Contract.Default();
    }

    /**
     * 日誌級別配置
     *
     * @return
     */
    @Bean
    Logger.Level feignLoggerLevel(){
        return Logger.Level.FULL;
    }
}

2.7 新增登入認證Eureka服務配置（springms-consumer-movie-feign-custom\src\main\java\com\springms\config\TestEurekaAuthConfiguration.java）

package com.springms.config;

import feign.auth.BasicAuthRequestInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * 認證配置，由於 UserFeignCustomSecondClient 訪問 http://localhost:8761/ 需要密碼登入，所以才有了此配置的出現。
 *
 * @author hmilyylimh
 *
 * @version 0.0.1
 *
 * @date 2017/9/19
 *
 */
@Configuration
public class TestEurekaAuthConfiguration {

    /**
     * 此方法主要配置登入 Eureka 伺服器的帳號與密碼。
     *
     * @return
     */
    @Bean
    public BasicAuthRequestInterceptor basicAuthRequestInterceptor(){
        return new BasicAuthRequestInterceptor("admin", "admin");
    }
}

2.8 新增Web訪問層Controller（springms-consumer-movie-feign-custom\src\main\java\com\springms\cloud\controller\MovieFeignCustomController.java）

package com.springms.cloud.controller;

import com.springms.cloud.entity.User;
import com.springms.cloud.feign.UserFeignCustomClient;
import com.springms.cloud.feign.UserFeignCustomSecondClient;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

/**
 * 自定義 Feign 控制器。
 *
 * @author hmilyylimh
 *
 * @version 0.0.1
 *
 * @date 2017/9/19
 *
 */
@RestController
public class MovieFeignCustomController {

    @Autowired
    private UserFeignCustomClient userFeignCustomClient;

    @Autowired
    private UserFeignCustomSecondClient userFeignCustomSecondClient;

    @GetMapping("/movie/{id}")
    public User findById(@PathVariable Long id) {
        return userFeignCustomClient.findById(id);
    }

    @GetMapping("/{serviceName}")
    public String findEurekaInfo(@PathVariable String serviceName){
        return userFeignCustomSecondClient.findEurekaInfo(serviceName);
    }
}

2.9 新增電影微服務啟動類（springms-consumer-movie-feign-custom\src\main\java\com\springms\cloud\MsConsumerMovieFeignCustomApplication.java）

package com.springms.cloud;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
import org.springframework.cloud.netflix.feign.EnableFeignClients;

/**
 *
 * 電影微服務使用定製化 Feign 在客戶端進行負載均衡排程併為 Feign 配置帳號密碼登入認證 Eureka。
 *
 * Feign: Java HTTP 客戶端開發的工具。
 *
 * 註解 EnableFeignClients 表示該電影微服務已經接入 Feign 模組。
 *
 * @author hmilyylimh
 *
 * @version 0.0.1
 *
 * @date 2017/9/19
 *
 */
@SpringBootApplication
@EnableEurekaClient
@EnableFeignClients
public class MsConsumerMovieFeignCustomApplication {

    public static void main(String[] args) {
        SpringApplication.run(MsConsumerMovieFeignCustomApplication.class, args);
        System.out.println("【【【【【【 電影自定義Feign微服務 】】】】】】已啟動.");
    }
}

三、測試

/****************************************************************************************
 一、電影微服務使用定製化Feign在客戶端進行負載均衡排程併為Feign配置帳號密碼登入認證Eureka（測試接入 Feign 模組）：

 1、註解：EnableFeignClients
 2、啟動 springms-discovery-eureka 模組服務，啟動1個埠；
 3、啟動 springms-provider-user 模組服務，啟動1個埠；
 4、啟動 springms-consumer-movie-feign-custom 模組服務；
 5、在瀏覽器輸入地址http://localhost:8050/movie/1 可以看到資訊成功的被列印出來；

 總結：說明接入 Feign 已經成功通過測試；
 ****************************************************************************************/

/****************************************************************************************
 二、電影微服務使用定製化Feign在客戶端進行負載均衡排程併為Feign配置帳號密碼登入認證Eureka（測試登入 Eureka 伺服器需要認證配置）：

 1、註解：EnableFeignClients
 2、啟動 springms-discovery-eureka 模組服務，啟動1個埠；
 3、啟動 springms-provider-user 模組服務，啟動1個埠；
 4、啟動 springms-consumer-movie-feign-custom 模組服務；
 5、在瀏覽器輸入地址 http://localhost:8050/springms-provider-user 可以看到資訊成功的被列印出來；

 總結：說明 TestEurekaAuthConfiguration 類中配置的帳號密碼已經生效，可以正常訪問 Eureka 服務；
 ****************************************************************************************/

/****************************************************************************************
 三、電影微服務使用定製化Feign在客戶端進行負載均衡排程併為Feign配置帳號密碼登入認證Eureka（測試接入 Feign 模組進行負載均衡）：

 1、註解：EnableFeignClients
 2、啟動 springms-discovery-eureka 模組服務，啟動1個埠；
 3、啟動 springms-provider-user 模組服務，啟動3個埠（7900、7899、7898）；
 4、啟動 springms-consumer-movie-feign-custom 模組服務；
 5、在瀏覽器輸入地址http://localhost:8050/movie/1 連續重新整理9次，正常情況可以看到 springms-provider-user 的3個埠輪詢列印使用者日誌資訊；

 總結：1、說明接入 Feign 已經成功的在客戶端進行了負載均衡處理；
 2、之所以會在客戶端進行輪詢列印日誌資訊，是因為沒有配置排程演算法，而預設的排程演算法就是輪詢，所以會出現輪詢列印日誌資訊；
 ****************************************************************************************/

/****************************************************************************************
 四、電影微服務使用定製化Feign在客戶端進行負載均衡排程併為Feign配置帳號密碼登入認證Eureka（配置日誌級別）：

 1、application.yml 修改：logging.level.com.springms.cloud.feign.UserFeignCustomClient: DEBUG
 2、編寫 TestFeignCustomConfiguration 新增日誌級別的方法
 3、啟動 springms-discovery-eureka 模組服務，啟動1個埠；
 4、啟動 springms-provider-user 模組服務，啟動1個埠；
 5、啟動 springms-consumer-movie-feign-custom 模組服務；
 6、在瀏覽器輸入地址http://localhost:8050/springms-provider-user 可以看到控制檯中 DEBUG 日誌級別的資訊成功的被列印出來；
 ****************************************************************************************/

四、下載地址

https://gitee.com/ylimhhmily/SpringCloudTutorial.git

SpringCloudTutorial交流QQ群: 235322432

SpringCloudTutorial交流微信群: 微信溝通群二維碼圖片連結

歡迎關注，您的肯定是對我最大的支援!!!

<上一篇        首頁        下一篇>