SpringCloud微服務實戰——搭建企業級開發框架（十二）：OpenFeign+Ribbon實現負載均衡

全棧程式猿發表於2021-11-02
SpringGCCloud微服務框架負載

  Ribbon是Netflix下的負載均衡專案，它主要實現中間層應用程式的負載均衡。為Ribbon配置服務提供者地址列表後，Ribbon就會基於某種負載均衡演算法，自動幫助服務呼叫者去請求。Ribbon預設提供的負載均衡演算法有多種，例如輪詢、隨即、加權輪訓等，也可以為Ribbon實現自定義的負載均衡演算法。

Ribbon有以下特性：

  • 負載均衡器，可支援插拔式的負載均衡規則
  • 對多種協議提供支援，如HTTP、TCP、UDP
  • 整合了負載均衡功能的客戶端

Feign利用Ribbon實現負載均衡的過程:

  • 通過在啟動類加@EnableFeignCleints註解開啟FeignCleint
  • 根據Feign的規則實現介面，並加在介面定義處新增@FeignCleint註解
  • 服務啟動後，掃描帶有@ FeignCleint的註解的類，並將這些資訊注入到ioc容器中
  • 當介面的方法被呼叫，通過jdk的代理，來生成具體的RequesTemplate
  • RequesTemplate再生成Request
  • Request交給Client去處理，其中Client可以是HttpUrlConnection、HttpClient也可以是Okhttp
    最後Client被封裝到LoadBalanceClient類，這個類結合類Ribbon做到了負載均衡。

OpenFeign 中使用 Ribbon 進行負載均衡，所以 OpenFeign 直接內建了 Ribbon。在匯入OpenFeign 依賴後，無需再專門匯入 Ribbon 依賴。接下來，我們把gitegg-service-base作為服務的呼叫方，啟動兩個不同埠的gitegg-service-system作為服務的被呼叫方，測試Ribbon的負載均衡。

1、首先在gitegg-service-system工程中，新建被呼叫的controller方法，返回系統配置的埠號以區分是哪個服務被呼叫了。

package com.gitegg.service.system.controller;

import com.gitegg.platform.boot.common.base.Result;
import com.gitegg.service.system.dto.SystemDTO;
import com.gitegg.service.system.service.ISystemService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.*;

import javax.validation.Valid;

@RestController
@RequestMapping(value = "system")
@RequiredArgsConstructor(onConstructor_ = @Autowired)
@Api(tags = "gitegg-system")
@RefreshScope
public class SystemController {

    private final ISystemService systemService;

    @Value("${spring.datasource.maxActive}")
    private String nacosMaxActiveType;

    @Value("${server.port}")
    private Integer serverPort;

    @GetMapping(value = "list")
    @ApiOperation(value = "system list介面")
    public Object list() {
        return systemService.list();
    }


    @GetMapping(value = "page")
    @ApiOperation(value = "system page介面")
    public Object page() {
        return systemService.page();
    }

    @GetMapping(value = "exception")
    @ApiOperation(value = "自定義異常及返回測試介面")
    public Result<string> exception() {
        return Result.data(systemService.exception());
    }

    @PostMapping(value = "valid")
    @ApiOperation(value = "引數校驗測試介面")
    public Result<systemdto> valid(@Valid @RequestBody SystemDTO systemDTO) {
        return Result.data(systemDTO);
    }

    @PostMapping(value = "nacos")
    @ApiOperation(value = "Nacos讀取配置檔案測試介面")
    public Result<string> nacos() {
        return Result.data(nacosMaxActiveType);
    }

    @GetMapping(value = "api/by/id")
    @ApiOperation(value = "Fegin Get呼叫測試介面")
    public Result<object> feginById(@RequestParam("id") String id) {
        return Result.data(systemService.list());
    }

    @PostMapping(value = "api/by/dto")
    @ApiOperation(value = "Fegin Post呼叫測試介面")
    public Result<object> feginByDto(@Valid @RequestBody SystemDTO systemDTO) {
        return Result.data(systemDTO);
    }

    @GetMapping("/api/ribbon")
    @ApiOperation(value = "Ribbon呼叫測試介面")
    public Result<string> testRibbon() {
        return Result.data("現在訪問的服務埠是:" + serverPort);
    }
}

2、在gitegg-service-system-api工程中，編寫使用OpenFeign呼叫testRibbon的公共方法

package com.gitegg.service.system.api.feign;

import com.gitegg.platform.boot.common.base.Result;
import com.gitegg.service.system.api.dto.ApiSystemDTO;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestParam;

@FeignClient(name = "gitegg-service-system")
public interface ISystemFeign {

    /**
     * OpenFeign測試Get
     *
     * @param id
     * @return
     */
    @GetMapping("/system/api/by/id")
    Result<object> querySystemById(@RequestParam("id") Long id);

    /**
     * OpenFeign測試Post
     *
     * @param apiSystemDTO
     * @return ApiSystemDTO
     */
    @PostMapping("/system/api/by/dto")
    Result<apisystemdto> querySystemByDto(@RequestBody ApiSystemDTO apiSystemDTO);

    /**
     * OpenFeign測試Ribbon負載均衡功能
     * @return
     */
    @GetMapping("/system/api/ribbon")
    Result<string> testRibbon();

}

3、在gitegg-service-base中新增測試Ribbon負載均衡的Feign呼叫方法

package com.gitegg.service.base.controller;

import com.gitegg.platform.boot.common.base.Result;
import com.gitegg.service.system.api.dto.ApiSystemDTO;
import com.gitegg.service.system.api.feign.ISystemFeign;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.*;

import javax.validation.Valid;

@RestController
@RequestMapping(value = "base")
@RequiredArgsConstructor(onConstructor_ = @Autowired)
@Api(tags = "gitegg-base")
@RefreshScope
public class BaseController {

    private final ISystemFeign systemFeign;

    @GetMapping(value = "api/by/id")
    @ApiOperation(value = "Fegin Get呼叫測試介面")
    public Result<object> feginById(@RequestParam("id") Long id) {
        return Result.data(systemFeign.querySystemById(id));
    }

    @PostMapping(value = "api/by/dto")
    @ApiOperation(value = "Fegin Post呼叫測試介面")
    public Result<object> feginByDto(@Valid @RequestBody ApiSystemDTO systemDTO) {
        return Result.data(systemFeign.querySystemByDto(systemDTO));
    }

    @PostMapping(value = "api/ribbon")
    @ApiOperation(value = "Ribbon呼叫測試介面")
    public Result<object> testRibbon() {
        return Result.data(systemFeign.testRibbon());
    }
}

4、先啟動gitegg-service-base服務，再啟動gitegg-service-system服務，服務啟動成功之後，將gitegg-service-system下bootstrap.yml裡面server.port改為8011，然後再點選啟動，這樣就啟動了兩個gitegg-service-system服務（如果執行兩個服務時提示：gitegg-service-system is not allowed to run in parallel. Would you like to stop the running one? 這時，在IDEA中點選Run-Edit configurations-勾選Allow parallel run即可），服務全部啟動完畢之後，可以在Console視窗裡面看到三個服務的Console

image.png

三個服務：

image.png

5、開啟瀏覽器訪問：http://127.0.0.1:8001/doc.html，點選Ribbon呼叫測試介面
選單，進行測試，點選請求，我們可以看到每次返回的埠都是變化的，一會兒是8001一會兒是8011，因為Ribbon負載均衡預設是使用的輪詢策略

image.png
image.png

6、如果我們需要修改負載均衡策略或者自定義負載均衡策略，根據我們的架構設計，我們在GitEgg-Platform的子工程gitegg-platform-cloud中設定公共的負載均衡策略，然後每個微服務需要不同的策略的話，可以在自己的工程中新增配置檔案。接下來，在gitegg-platform-cloud中新建Ribbon配置類

package com.gitegg.platform.cloud.ribbon.config;

import com.netflix.loadbalancer.IRule;
import com.netflix.loadbalancer.RandomRule;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @Description Ribbon公共負載均衡策略配置
 */
@Configuration
public class RibbonConfig {

    /**
     * 負載均衡策略配置
     * @return
     */
    @Bean
    public IRule rule(){
        //隨機策略  從所有可用的提供者中隨機選擇一個
        return new RandomRule();
    }

}

7、修改完成之後，GitEgg_Platform工程重新執行install，GitEgg_Cloud重新整理匯入的包，參照步驟5再執行測試，這時我們發現微服務返回的埠，不再是有規律的切換，而是隨機不確定的出現。

注意：

這裡RibbonConfig只用於測試負載均衡策略，請不要在生產環境中這樣使用，否則會出現問題：在微服務A中呼叫微服務B和微服務C，然後再呼叫微服務B，這是RibbonLoadBalancerClient在獲取微服務時，渠到的serviceId為null，就會獲取到上次的微服務，進而導致404錯誤。因為OpenFeign預設使用的是Ribbon提供的負載均衡策略，我們在實際應用中可以選擇Nacos提供的NacosRule策略，利用Nacos權重進行負載均衡：
  #負載均衡策略
  NFLoadBalancerRuleClassName: com.alibaba.cloud.nacos.ribbon.NacosRule

本文原始碼在https://gitee.com/wmz1930/GitEgg 的chapter-12分支。

相關文章