SpringCloud入门 —— Feign服务调用

前言

紧接上文，本文记录多个服务使用feign远程调用。

一、feign是什么？

Feign是一个声明性web服务客户端。

Feign远程调用，核心就是通过一系列的封装和处理，将以JAVA注解的方式定义的远程调用API接口，最终转换成HTTP的请求形式，然后将HTTP的请求的响应结果，解码成JAVA Bean，返回给调用者。

二、代码示例

1.服务提供者

新建测试接口

@RestController
@RequestMapping("api")
public class ProviderController {

	@GetMapping("/user/{id}")
	public String user(@PathVariable(value = "id") String id) {
	    return "我是服务提供者==>用户id:" + id;
	}
}

2.服务消费者

引入feign依赖

 <!--feign依赖-->
<dependency>
	<groupId>org.springframework.cloud</groupId>
	<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

调用接口MyFeign.java

package com.local.springboot.client.clientcustomer.feign;

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;

@FeignClient(value = "client-provider-server", path = "/api", fallback = MyFeignFallback.class
        , fallbackFactory = MyFeignFallbackFactory.class)
public interface MyFeign {

    @GetMapping("/user/{id}")
    String getUser(@PathVariable("id") String id);
}

client-provider-server是服务提供者在eureka注册的名字，也可以直接指定url
@FeignClient(name = “client-provider-server”, path = “/api”,url = “http://localhost:8081”)
url可以直接指定第三方服务地址，path指定路径，接口的方法指定接口

controller

/**
 * feign远程调用
 */
@GetMapping("/query/{id}")
public String getUser(@PathVariable(value = "id") String id) {
	return myFeign.getUser(id);
}

/**
 * feign远程调用
 */
@GetMapping("/exception")
public String exception() {
	return myFeign.exception();
}

3.测试

启动程序，可以看到服务已注册

访问http://localhost:8082/query/imid

成功调用

4.Fallback熔断

在网络请求或者服务提供者发生异常，如果还想再异常情况下使系统可用，那么就需要容错处理。

需要配置fallback来处理异常，如果需要获取到报错信息，则要配置fallbackFactory

@FeignClient(value = "client-provider-server", path = "/api", fallback = MyFeignFallback.class
        , fallbackFactory = MyFeignFallbackFactory.class)

指定Feign接口的实现类，和FallbackFactory工厂接口类，如下：

MyFeignFallback.java

package com.local.springboot.client.clientcustomer.feign;

import org.springframework.stereotype.Component;

/**
 * feign调用容错处理
 */
@Component
public class MyFeignFallback implements MyFeign {

    @Override
    public String getUser(String id) {
        return null;
    }

    @Override
    public String exception() {
        return "网络请求超时，请稍后重试！";
    }
}

MyFeignFallbackFactory.java

package com.local.springboot.client.clientcustomer.feign;

import org.springframework.cloud.openfeign.FallbackFactory;
import org.springframework.stereotype.Component;

/**
 * FallbackFactory工厂，获取HTTP请求错误状态码和信息
 * （只打印异常）
 */
@Component
public class MyFeignFallbackFactory implements FallbackFactory<MyFeign> {

    private final MyFeignFallback myFeignFallback;

    public MyFeignFallbackFactory(MyFeignFallback myFeignFallback) {
        this.myFeignFallback = myFeignFallback;
    }

    @Override
    public MyFeign create(Throwable cause) {
        // 打印异常
        cause.printStackTrace();
        return myFeignFallback;
    }
}

模拟异常

服务提供者

@GetMapping("/exception")
public String exception() {
	throw new RuntimeException("服务器异常");
}

服务消费者

@GetMapping("/exception")
String exception();

访问http://localhost:8082/exception

注意事项： 使用fallback，要开启Hystrix，配置feign.hystrix.enabled=true，如果springCloud 版本是2020.0.1或以上的，配置feign.circuitbreaker.enabled=true，
因为查看源代码，发现已修改为feign.circuitbreaker.enabled

问题：

打包出现如下报错：

Failed to execute goal org.apache.maven.plugins:maven-resources-plugin:3.2.0:resources (default-resources) on project client-customer: Input length = 1 -> [Help 1]

解决方法：
对应的pom将

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

改为：

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-resources-plugin</artifactId>
	<version>2.7</version>
	<dependencies>
		<dependency>
			<groupId>org.apache.maven.shared</groupId>
			<artifactId>maven-filtering</artifactId>
			<version>1.3</version>
		</dependency>
	</dependencies>
</plugin>

总结

通过Feign以及JAVA的动态代理机制，使得Java 开发人员，可以不用通过HTTP框架去封装HTTP请求报文的方式，完成远程服务的HTTP调用。

« 上一章：SpringCloud入门 —— Eureka服务注册与发现
» 下一章：SpringCloud入门 —— Ribbon负载均衡