[Java知识库]Spring Cloud（一）：OpenFeign使用

1、概述

大家好，我是欧阳方超。
在Java项目中实现接口调用的方式有很多，如HttpClient、OkHttp、HttpURLConnection、RestTemplate等，在SpringCloud技术栈中如果有调用其他接口的需求，可能OpenFeign使用的会比较多一些，本文就来讲一下OpenFeign的使用。本文涉及到的工程代码在此处下载

2、场景描述

本文通过以下场景来实现通过OpenFeign调用其他服务的接口，call-service、save-service分别是两个单独的服务，它们都会注册到Nacos注册中心， save-service提供一个存储文件间的接口（并未实现对文件的实际存储），在call-service中通过OpenFeign调用save-service的存储文件的接口，示意图如下：

3、工程搭建

3.1、创建父工程

首页创建一个空的父工程，说它空是因为无需往父工程中写源代码，当然pom文件还是需要有的，由于要使用OpenFeign所以必须依赖org.springframework.cloud，又由于要使用Nacos作为服务注册中心，所以还需要依赖spring-cloud-alibaba-dependencies，因此父工程的pom文件内容如下：

<?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>
    <parent>
        <artifactId>spring-boot-starter-parent</artifactId>
        <groupId>org.springframework.boot</groupId>
        <version>2.3.11.RELEASE</version>
        <relativePath/>
    </parent>
    <groupId>org.example</groupId>
    <artifactId>OpenFeignUsage</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>pom</packaging>

    <modules>
        <module>call-service</module>
        <module>save-service</module>
    </modules>
    
    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <spring-cloud-version>Hoxton.SR12</spring-cloud-version>
        <spring-cloud-alibaba-version>2.2.9.RELEASE</spring-cloud-alibaba-version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <dependencyManagement>
        <dependencies>
            <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>

            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud-version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>

3.2、创建save-service子工程

该子工程的作用是提供一个保存文件的接口供其他服务调用，代码如下，虽然实际上并没有对文件做存储，只是演示可以接收到文件和字符串：

package com.futuretech.saveservice;

import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;

@RestController
@RequestMapping(value = "/file")
public class SaveController {

    @PostMapping(value = "save")
    public String saveFile(@RequestParam("file") MultipartFile file, @RequestParam("names") String names) {
        System.out.println(names);
        String originalFilename = file.getOriginalFilename();
        System.out.println("接收到：" + originalFilename);
        return "success";
    }
}

application.yml文件内容如下：

spring:
  application:
    name: saveservice
  cloud:
    nacos:
      discovery:
        service-addr: localhost:8848
server:
  port: 8082

子工程的pom文件内容如下：

<?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.example</groupId>
        <artifactId>OpenFeignUsage</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <groupId>com.futuretech</groupId>
    <artifactId>save-service</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>save-service</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
    </dependencies>

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

</project>

3.3、创建call-service子工程

在call-service子工程中使用OpenFeign调用save-service模块中的方法，因此需要在call-service模块中增加一个接口——这里定义为CallFeignService，代码如下：

package com.futuretech.callservice;

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;

@FeignClient(name = "saveservice")
public interface CallFeignService {

    @PostMapping(value = "file/save", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
    String saveFile(@RequestPart("file") MultipartFile file, @RequestParam("names") String names);

}

@FeignClient后的name的值指明了被调用服务（这里指save-service）的服务名（在application.yml文件中），@PostMapping的value值指明了被调用接口的请求地址，接着就能在call-service中使用该接口了，如下：

package com.futuretech.callservice;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;

@RestController
@RequestMapping(value = "/call")
public class CallController {

    @Autowired
    private CallFeignService callFeignService;

    @PostMapping(value = "test")
    public String callOtherAPI(@RequestParam("file") MultipartFile file, @RequestParam("names") String names) {
        String s = callFeignService.saveFile(file, names);
        System.out.println(s);
        return "";
    }
}

注入CallFeignService并调用其中的saveFile()方法，下面贴出call-service的pom文件及application.yml文件：

<?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.example</groupId>
        <artifactId>OpenFeignUsage</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <groupId>com.futuretech</groupId>
    <artifactId>call-service</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>call-service</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>

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

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

</project>

application.yml

spring:
  application:
    name: callservice
  cloud:
    nacos:
      discovery:
        service-addr: localhost:8848
server:
  port: 8081
ribbon:
  ConnectTimeout: 10000 # 连接超时时间(ms)
  ReadTimeout: 10000 # 通信超时时间(ms)

3.4、通过OpenFeign调用保存文件接口

接着就是测试call-service中的call/test接口了，传了一个文件和字符串

在save-service中，将接收到的文件及字符串打印在了控制台：

至此，在call-service中通过OpenFeign调用save-service中的接口已经全部走通。

4、使用OpenFeign注意事项

4.1、关于read time out

使用OpenFeign时可能经常遇到一个错误：“java.net.SocketTimeoutException: Read timed out”，尤其是在打断点调试的过程中，这是服务之间调用超时的现象，原因是Feign底层其实还是使用Ribbon，默认是1秒，所以超过1秒就报错，可以通过在application.yml中增加ribbon配置（在调用方）进行解决：

ribbon:
    ConnectTimeout: 6000 # 连接超时时间(单位为ms)
    ReadTimeout: 6000 # 通信超时时间(单位为ms)

5、总结

上述讲述了微服务中openfeign的使用，以及一个简单的注意事项，关于openfeign的内容还有很多，下次见。
我是欧阳方超，把事情做好了自然就有兴趣了，如果你喜欢我的文章，欢迎点赞、转发、评论加关注。