天天看點

SpringCloud Alibaba實戰(8:使用OpenFeign服務調用)1、Feign簡介2、Feign使用3、意外狀況

源碼位址: https://gitee.com/fighter3/eshop-project.git 持續更新中……

在上一個章節,我們已經成功地将服務注冊到了Nacos注冊中心,實作了服務注冊和服務發現,接下來我們要做的是服務間調用。

想一下,我們日常調用接口有哪些方式呢?常見有的有JDK自帶的網絡連接配接類

HttpURLConnection

、Apache Common封裝的

HttpClient

、Spring封裝的

RestTemplate

。這些調用接口工具也許在你看來都并不困難那,但是如果引入feign,使用聲明式調用,調用遠端服務像調用本地api一樣絲滑。

OpenFeign項目位址: https://github.com/OpenFeign/feign

1、Feign簡介

Feign是一種聲明式、模闆化的HTTP用戶端。使用Feign,可以做到聲明式調用。

盡管Feign目前已經不再疊代,處于維護狀态,但是Feign仍然是目前使用最廣泛的遠端調用架構之一。

在SpringCloud Alibaba的生态體系内,有另一個應用廣泛的遠端服務調用架構Dubbo,在後面我們會接觸到。

接下來,我們開始學習Feign的使用,非常簡單!

2、Feign使用

2.1、引入OpenFeign

在前面的章節裡,我們已經引入了SpringCloud,現在我們隻需要在需要引入的子子產品中添加依賴:

<dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>      

2.2、Feign遠端調用

我們現在來完成一個業務:

添加商品

SpringCloud Alibaba實戰(8:使用OpenFeign服務調用)1、Feign簡介2、Feign使用3、意外狀況

這個業務涉及兩個子服務,添加商品的時候同時要添加庫存,查詢商品的時候,同時要查詢庫存。商品服務作為消費者,庫存服務作為生産者。

2.2.1、服務提供者

作為服務提供者的庫存服務很簡單,提供兩個接口

添加庫存

根據商品ID擷取庫存量

  • 控制層
@RestController
@RequestMapping("/shop-stock/api")
@Slf4j
@Api(value = "商品服務對外接口", tags = "商品服務對外接口")
public class ShopStockApiController {
    @Autowired
    private IShopStockService shopStockService;

    @PostMapping(value = "/add")
    @ApiOperation("添加庫存")
    public Integer addStock(@RequestBody StockAddDTO stockAddDTO) {
        log.info("client call add stock interface,param:{}", stockAddDTO);
        return this.shopStockService.addStockApi(stockAddDTO);
    }

    @GetMapping(value = "/account/get")
    @ApiOperation("根據商品ID擷取庫存量")
    public Integer getAccountById(@RequestParam Integer goodsId) {
        return this.shopStockService.getAccountById(goodsId);
    }
}      

注意看,為了示範出本地調用類似的效果,這兩個接口和普通的前後端接口不同。

我們沒有傳回之前定下的統一傳回結果

CommonResult

,而是直接傳回了資料。

  • 業務層

    普通的增、查而已

/**
     * 添加庫存-直接傳回主鍵
     *
     * @param stockAddDTO
     * @return
     */
    public Integer addStockApi(StockAddDTO stockAddDTO) {
        ShopStock stock = new ShopStock();
        stock.setGoodsId(stockAddDTO.getGoodsId());
        stock.setInventory(stockAddDTO.getAccount());
        log.info("準備添加庫存,參數:{}", stock.toString());
        this.baseMapper.insert(stock);
        Integer stockId =stock.getStockId();
        log.info("添加庫存成功,stockId:{}", stockId);
        return stockId;
    }

    /**
     * 根據商品ID擷取商品庫存
     *
     * @param goodsId
     * @return
     */
    public Integer getAccountById(Integer goodsId) {
        ShopStock stock = this.getOne(Wrappers.<ShopStock>lambdaQuery().eq(ShopStock::getGoodsId, goodsId));
        Integer account = stock.getInventory();
        return account;
    }
      
  • 添加庫存實體類
@Data
@EqualsAndHashCode(callSuper = false)
@ApiModel(value = "庫存添加", description = "")
public class StockAddDTO implements Serializable {
    private static final long serialVersionUID = 1L;

    @ApiModelProperty(value = "商品主鍵")
    private Integer goodsId;

    @ApiModelProperty(value = "數量")
    private Integer account;
}      

至此,我們的服務提供者的相關開發到此完成,打開位址 http://localhost:8050/doc.html ,可以看到我們開發的接口:

2.2.2、服務消費者

好了,接下裡要開始我們的服務消費者,也就是商品服務的開發。

  • 遠端調用Feign用戶端

聲明式調用——看一下Feign用戶端的代碼,你就知道什麼是聲明式調用:

/**
 * @Author: 三分惡
 * @Date: 2021/5/26
 * @Description: 庫存服務feign用戶端
 **/
@FeignClient(value = "stock-service")
public interface StockClientFeign {

    /**
     * 調用添加庫存接口
     *
     * @param stockAddDTO
     * @return
     */
    @PostMapping(value = "/shop-stock/api/add")
    Integer addStock(@RequestBody StockAddDTO stockAddDTO);

    /**
     * 調用根據商品ID擷取庫存量接口
     *
     * @param goodsId
     * @return
     */
    @GetMapping(value = "/shop-stock/api/account/get")
    Integer getAccountById(@RequestParam(value = "goodsId") Integer goodsId);
}      
  • 定義完成之後,我們還要在啟動類上加上注解

    @EnableFeignClients

    去掃描Feign用戶端。
@SpringBootApplication
@MapperScan("cn.fighter3.mapper")
@EnableDiscoveryClient
@EnableFeignClients(basePackages = "cn.fighter3.client")
public class EshopGoodsApplication {

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

使用Feign用戶端也很簡單,直接在需要使用的地方注入就行了。

@Autowired
private StockClientFeign stockClientFeign;      
  • 商品服務控制層
/**
 * <p>
 * 前端控制器
 * </p>
 *
 * @author 三分惡
 * @since 2021-05-18
 */
@RestController
@RequestMapping("/shop-goods")
@Api(value = "商品管理接口", tags = "商品接口")
@Slf4j
public class ShopGoodsController {

    @Autowired
    private IShopGoodsService goodsService;

    @PostMapping(value = "/add")
    @ApiOperation(value = "添加商品")
    public CommonResult addGoods(@RequestBody GoodsAddDTO goodsAddDTO) {
        return this.goodsService.addGoods(goodsAddDTO);
    }

    @GetMapping(value = "/get/by-id")
    @ApiOperation(value = "根據ID擷取商品")
    public CommonResult<GoodsVO> getGoodsById(@RequestParam Integer goodsId) {
        return this.goodsService.getGoodsById(goodsId);
    }

}      
  • 服務層

在服務層除了對商品庫的操作之外,還通過Feign用戶端遠端調用庫存服務的接口。

@Service
@Slf4j
public class ShopGoodsServiceImpl extends ServiceImpl<ShopGoodsMapper, ShopGoods> implements IShopGoodsService {

    @Autowired
    private StockClientFeign stockClientFeign;

    /**
     * 添加商品
     *
     * @param goodsAddDTO
     * @return
     */
    public CommonResult addGoods(GoodsAddDTO goodsAddDTO) {
        ShopGoods shopGoods = new ShopGoods();
        BeanUtils.copyProperties(goodsAddDTO, shopGoods);
        this.baseMapper.insert(shopGoods);
        log.info("添加商品,商品主鍵:{}", shopGoods.getGoodsId());
        log.info(shopGoods.toString());
        StockAddDTO stockAddDTO = StockAddDTO.builder().goodsId(shopGoods.getGoodsId()).account(goodsAddDTO.getAccount()).build();
        log.info("準備添加庫存,參數:{}", stockAddDTO.toString());
        Integer stockId = this.stockClientFeign.addStock(stockAddDTO);
        log.info("添加庫存結束,庫存主鍵:{}", stockId);
        return CommonResult.ok();
    }

    /**
     * 擷取商品
     *
     * @param goodsId
     * @return
     */
    public CommonResult<GoodsVO> getGoodsById(Integer goodsId) {
        GoodsVO goodsVO = new GoodsVO();
        //擷取商品基本資訊
        ShopGoods shopGoods = this.baseMapper.selectById(goodsId);
        BeanUtils.copyProperties(shopGoods, goodsVO);
        //擷取商品庫存數量
        Integer account = this.stockClientFeign.getAccountById(goodsId);
        log.info("商品數量:{}", account);
        goodsVO.setAccount(account);
        return CommonResult.ok(goodsVO);
    }
}      
  • 實體類

    添加庫存實體類和庫存服務相同,略過,商品展示實體類

@Data
@EqualsAndHashCode(callSuper = false)
@ApiModel(value = "商品", description = "")
public class GoodsVO implements Serializable {
    private static final long serialVersionUID = 1L;

    @ApiModelProperty(value = "商品主鍵")
    private Integer goodsId;

    @ApiModelProperty(value = "商品名稱")
    private String goodsName;

    @ApiModelProperty(value = "價格")
    private BigDecimal price;

    @ApiModelProperty(value = "商品介紹")
    private String description;

    @ApiModelProperty(value = "數量")
    private Integer account;
}      

2.2.3、效果示範

接下來啟動nacos-server,商品服務,庫存服務。

通路位址

http://127.0.0.1:8848/nacos/index.html

,登入之後,可以在服務清單裡看到我們注冊的兩個服務:

通路商品服務Knife4j位址:http://localhost:8020/doc.html ,可以看到添加商品和根據商品ID查找商品的接口,分别調試調用:

  • 添加商品
SpringCloud Alibaba實戰(8:使用OpenFeign服務調用)1、Feign簡介2、Feign使用3、意外狀況
  • 根據ID擷取商品
SpringCloud Alibaba實戰(8:使用OpenFeign服務調用)1、Feign簡介2、Feign使用3、意外狀況

可以看到各自對應的資料庫也有資料生成:

SpringCloud Alibaba實戰(8:使用OpenFeign服務調用)1、Feign簡介2、Feign使用3、意外狀況

整體的遠端調用示意圖大概如下:

SpringCloud Alibaba實戰(8:使用OpenFeign服務調用)1、Feign簡介2、Feign使用3、意外狀況

2.3、Ribbon負載均衡

關于負載均衡,這裡偷個懶,就不再示範了。

感興趣的可以吧庫存服務打包,以不同的端口啟動,然後添加商品,通過日志檢視商品服務調用的負載情況。

Feign負載均衡是通過Ribbon實作,Ribbon是一種用戶端的負載均衡——也就是從注冊中心擷取服務清單,由用戶端自己決定調用哪一個遠端服務。

Ribbon的主要負載均衡政策有以下幾種:

規則名稱 特點
AvailabilityFilteringRule 過濾掉一直連接配接失敗的被标記為circuit tripped的後端Server,并 過濾掉那些高并發的後端Server或者使用一個AvailabilityPredicate 來包含過濾server的邏輯,其實就是檢查status裡記錄的各個server 的運作狀态
BestAvailableRule 選擇一個最小的并發請求的server,逐個考察server, 如果Server被tripped了,則跳過
RandomRule 随機選擇一個Server
ResponseTimeWeightedRule 已廢棄,作用同WeightedResponseTimeRule
WeightedResponseTimeRule 根據響應時間權重,響應時間越長,權重越小,被選中的可能性越低
RetryRule 對標明的負載均衡政策加上重試機制,在一個配置時間段内當 選擇Server不成功,則一直嘗試使用subRule的方式選擇一個 可用的Server
RoundRobinRule 輪詢選擇,輪詢index,選擇index對應位置的Server
ZoneAvoidanceRule 預設的負載均衡政策,即複合判斷Server所在區域的性能和Server的可用性 選擇Server,在沒有區域的環境下,類似于輪詢(RandomRule)

這裡就不再展開講了,感興趣的自行了解。

3、意外狀況

  • 發現遠端調用的時候出現讀取響應結果逾時的情況:
java.net.SocketTimeoutException: Read timed out      

修改Ribbon逾時配置就行了:

# ribbon逾時時間
ribbon:
  ReadTimeout: 30000
  ConnectTimeout: 30000      
  • Feign接口中,使用

    @RequestParam

    報錯

發現報錯:

Caused by: java.lang.IllegalStateException: RequestParam.value() was empty on parameter 0      

Feign聲明裡需要加上

value

Integer getAccountById(@RequestParam(value = "goodsId") Integer goodsId);      

“簡單的事情重複做,重複的事情認真做,認真的事情有創造性地做!”——

我是三分惡,可以叫我老三/三分/三哥/三子,一個能文能武的全棧開發,咱們下期見!