SpringCloud学习笔记（十）声明式客户端Feign的简单调用

最新推荐文章于 2022-09-28 18:27:04 发布

原创最新推荐文章于 2022-09-28 18:27:04 发布 · 311 阅读

0 ·

CC 4.0 BY-SA版权

SpringCloud学习日志专栏收录该内容

20 篇文章

订阅专栏

本文介绍了如何在SpringCloud中使用Feign进行声明式客户端调用，以简化开发步骤。通过创建Feign接口，指定目标微服务，并在Controller中注入并调用接口，成功实现了无须实现类的远程调用。同时，文章提到了带参数调用的初步尝试，为后续的详细讲解奠定了基础。

专辑目录：SpringCloud学习日志

借鉴了https://blog.youkuaiyun.com/github_39577257/article/details/81842234的文章

在之前的开发中，我们使用RestTemplate是非常不方便的，在工作中也不会用RestTemplate。

我们来学习一下声明式客户端来简化开发步骤。

首先，什么是“声明式”？以我的理解，就是由开发人员进行申明接口，然后由工具自行实现。

我举个例子，就像Hibernate和Mybatis，只需要创建接口。

接下来回到代码开发讲解。

我重新建了个文件夹，拷贝了之前的3个工程

server和member都没有修改。我们在order上去简单实用Feign客户端。

先加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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.1.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.study</groupId>
    <artifactId>springcloud2-eureka-order</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springcloud-eureka-order</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Finchley.M7</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <!-- 依赖 -->
    <dependencies>
        <!-- SpringBoot 整合Web 组件 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- SpringBoot 整合 Eureka 客户端 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>

        <!-- SpringCloud 整合feign客户端-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
    </dependencies>

    <!-- 仓库 -->
    <repositories>
        <repository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://repo.spring.io/libs-milestone</url>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </repository>

    </repositories>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

其实只是加了openfeign这个依赖而已。

然后建一个包用来放置feign的申明接口

然后创建接口

package com.study.feign;

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.RequestMapping;
// name-调用其他微服务的名称
@FeignClient(name="app-member")
public interface MemberApiFeign {

    // Feign 已SpringMVC接口格式书写
    @RequestMapping("getMember")
    public String getMember();
}

@FeignClient 中的name 申明的是要调用的微服务别名，就是Member的application.yaml中配置的spring.application.name结点的值，指向了Member服务。

然后写了一个接口方法，方法名不重要，重要的是@RequestMapping要和Member中你要调用的方法的RequestMapping对应

这样就指向了Member服务中的getMember方法。

然后我们无需写实现类，Feign会自动帮我们实现。

接下来我们想办法测试一下这个调用。

在Order 的Controller中写一个接口进行调用测试

package com.study.api.controller;

import com.study.feign.MemberApiFeign;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;


@RestController
public class OrderController{

    @Autowired
    private MemberApiFeign memberApiFeign;

    @RequestMapping("/getOrder")
    public String getOrder(){
        return memberApiFeign.getMember();
    }
}

MemberApiFeign接口通过Autowired自动注入，然后直接调用接口方法。

在启动项目之前，我们还有声明Feign客户端的开启，在启动类Application中：

package com.study.api.controller;

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

@SpringBootApplication
@EnableEurekaClient
// 开启feign客户端
@EnableFeignClients(basePackages = "com.study.feign")
public class AppEurekaOrder {

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

    }


}

我去掉了RestTemplate的代码，然后加了一个注解@EnableFeignClients，声明要开启Feign客户端，然后basePackages填的是feign接口所在的包。

接下来启动Server、Member、Order