快捷導(dǎo)航

Spring?Cloud?OpenFeign實例介紹使用方法

更新時間：2022年09月10日 11:23:01 作者：C陳三歲

Spring?Cloud?OpenFeign?對?Feign?進(jìn)行了二次封裝，使得在?Spring?Cloud?中使用?Feign?的時候，可以做到使用?HTTP?請求訪問遠(yuǎn)程服務(wù)，就像調(diào)用本地方法一樣的，開發(fā)者完全感知不到這是在調(diào)用遠(yuǎn)程訪問，更感知不到在訪問?HTTP?請求

一. OpenFeign概述

OpenFeign 可以將提供者提供的 Restful 服務(wù)偽裝為接口進(jìn)行消費，消費者只需使用“ feign 接口 + 注解 ”的方式即可直接調(diào)用提供者提供的 Restful 服務(wù)，而無需再使用 RestTemplate 。

注意：

Feign 只涉及到消費者端，與提供者端無關(guān)
Feign 僅僅是一個偽客戶端，其不會對請求做任何處理。即其與使用 RestTemplate 效果是一樣的
Feign 是通過注解實現(xiàn)RESTful 請求的

二. 使用步驟

2.1 feign接口模塊

單獨將feign接口放在模塊中，方便后續(xù)為各個服務(wù)使用。

2.1.1依賴配置

springCloud版本使用

<properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>Hoxton.SR6</spring-cloud.version>
        <spring-cloud-alibaba.version>2.2.1.RELEASE</spring-cloud-alibaba.version>
    </properties>
    <dependencies>
        <!--fegin-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
    </dependencies>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>${spring-cloud-alibaba.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>

2.1.2編寫FeignClient的接口, 并加@FeignCleint 注解

url寫死在接口中不方便，可以使用動態(tài)參數(shù)配置，只需要在配置文件中添加key為feign.client.url的路徑。這里使用是單體模式，如果分布式項目中配置多個url管理起來非常費事，就需要升級使用注冊中心來解決。

import com.example.vo.DepartVO;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.*;
import java.util.List;
// 注意，接口名與方法名可以隨意
// 參數(shù)指定了要訪問的提供者微服務(wù)名稱
//@FeignClient(url ="http://127.0.0.1:8081", value="abcmsc-provider-depart", path = "/provider/depart")
@FeignClient(url ="${feign.client.url}", value="abcmsc-provider-depart", path = "/provider/depart")
public interface DepartService {
    @PostMapping("/save")
    boolean saveDepart(@RequestBody DepartVO depart);
    @DeleteMapping("/del/{id}")
    boolean removeDepartById(@PathVariable("id") int id);
    @PutMapping("/update")
    boolean modifyDepart(@RequestBody DepartVO depart);
    @GetMapping("/get/{id}")
    DepartVO getDepartById(@PathVariable("id") int id);
    @GetMapping("/list")
    List<DepartVO> listAllDeparts();
}

2.2 消費端使用fegin接口

2.2.1在消費者端添加feign接口依賴

2.2.2在消費者端配置文件中添加 feign.client.url

指定服務(wù)端的url和端口

2.2.3在消費者端啟動類中添加@EnableFeignClients

開啟Feign功能：此注解會掃描啟動類所在的包及其子包下面@FeignClient標(biāo)注的接口，將其交給spring容器管理，方便后續(xù)使用。

2.2.4在消費者端使用fegin接口

需要在哪里使用接口直接注入后即可使用

import com.example.providerapi.DepartService;
import com.example.vo.DepartVO;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import java.util.List;
@RestController
@RequestMapping("/consumer/depart")
public class DepartController {
    @Autowired
    private DepartService departService;
    @PostMapping("/save")
    public boolean saveHandle(@RequestBody DepartVO depart) {
 
        return departService.saveDepart(depart);
    }
    @DeleteMapping("/del/{id}")
    public void deleteHandle(@PathVariable("id") int id) {
        departService.removeDepartById(id);
    }
    @PutMapping("/update")
    public void updateHandle(@RequestBody DepartVO depart) {
        departService.modifyDepart(depart);
    }
    @GetMapping("/get/{id}")
    public DepartVO getHandle(@PathVariable("id") int id) {
        return departService.getDepartById(id);
    }
    @GetMapping("/list")
    public List<DepartVO> listHandle() {
        return departService.listAllDeparts();
    }
}