springcloud之FeignClient使用详解_Java

前言

在微服务项目中会存在多个微服务之间互相调用的情况，如何高效便捷的进行远程过程调用便成为新的议论话题。spring-cloud中提供的feign方式可以有效解决该问题。

feign是一种声明式、模板化的http客户端。在spring cloud中使用feign, 我们可以做到使用http请求远程服务时能与调用本地方法一样的编码体验，开发者完全感知不到这是远程方法，更感知不到这是个http请求。

如下testmicroserviceaccess方法便是feignclient调用，但是外部看起来和普通方法无二。

业务场景

假设同一个注册中心上有两个微服务：a和b，为完成某个业务功能，b微服务需要调用a微服务中的某个方法逻辑获取返回结果，并且二者是不能作为jar互相依赖的，按照传统方式只能如下处理：

请求——>外部网关——>应用层——>内部网关——>b微服务——>外部网关——>应用层——>内部网关——>a微服务——>结束

即便是拆掉外部网关和应用层，也需要通过内部网关中转才能访问到a微服务，况且还要考虑超时熔断、路由负载等问题。

引入feign后简化流程，并且其结合ribbon实现路由负载超时熔断等措施，具体流程如下：

请求——>外部网关——>应用层——>内部网关——>b微服务——>feignclient——>a微服务——>结束

架构说明

按照上述业务假设进行架构说明：

1、为保持系统良好的可扩展性，降低模块耦合度，新建a-feignclient模块，用于提供feign接口和相关实体类。后期作为jar文件推送到maven私服中，供a、b微服务各自引用。

2、a微服务中仅需要在启动类上增加开启feign的注解，可以考虑增加a-feignclient依赖，这样三个模块使用同一份实体类，保证一致性。

3、b微服务中增加a-feignclient模块的依赖，编写客户端调用代码。

调用逻辑

1、a-feignclient

a、在a-feignclient中增加接口，通过spring注解标识其提供服务的真正接口路径。
b、@feignclient注解中name值目标微服务名，contextid用于标识feignclient名。
c、方法名上的postmapping用于标识该方法需要转发的接口路径。下图代码示例中意思即：调用该方法后会代理到a微服务的/demoserver/testmicroserviceaccess接口中。
d、通过实现该接口的方式新建一个类，可以用于feign调用失败后的容错处理。

package com.demo.demofeignclient;

/**
 * 微服务之间调用的核心接口     aikes
 * 注解@feignclient中contextid参数用于标识client，防止多个接口共用同一个目标feignclient冲突
 */
@feignclient(name = "a-server" ,contextid = "demofeignclient", fallback = demofeignclientfallback.class )
public interface demofeignclient{

    @postmapping("/demoserver/testmicroserviceaccess")
    public apiresponse<string> testmicroserviceaccess(@requestbody serveraccessrequest<demopo> cserveraccessrequest);
}

/**
 * 增加访问失败时的处理逻辑
 */
@component
class demofeignclientfallback implements demofeignclient{

    @override
    public apiresponse<string> testmicroserviceaccess(serveraccessrequest<demopo> cserveraccessrequest) {
        apiresponse<string> tapiresponse = new apiresponse<>();
        tapiresponse.setstatus(apiresponse.busy);
        return tapiresponse;
    }
}

2、a微服务

作为服务提供方，只需要正常编写业务逻辑即可，重点需要考虑请求入参的实体类把控，建议引用a-feignclient中，保证一致性。

package com.demo.demofeignservercontroller;

/**
 * 服务提供方    aikes
 */
@controller
@requestmapping("demoserver")
@restcontroller
@slf4j
public class demofeignservercontroller {

    @postmapping("/testmicroserviceaccess")
    public apiresponse<string> testmicroserviceaccess(@requestbody serveraccessrequest<demopo> cserveraccessrequest) {
        log.info(cserveraccessrequest.tostring());
        log.info("this is feignservercontroller");
        apiresponse<string> tapiresponse = new apiresponse<string>();
        tapiresponse.setstatus(apiresponse.success);
        tapiresponse.setstatustext(apiresponse.success_text);
        tapiresponse.setdata(cserveraccessrequest.getdata().getdemoname());
        return tapiresponse;
    }
}

3、b微服务

作为服务消费方，在核心逻辑处理中，通过调用引入的a-feignclient模块的接口，由feign负责代理转发到a微服务，实现调用a微服务的相关逻辑。

package com.demo.demofeignclientcontroller;

/**
 * 服务消费方    aikes
 */
public class demofeignclientcontroller {

    @autowired
    private demofeignclient mdemofeignclient;

    public void doservice() {
        //todo 业务处理
        apiresponse<string> tapiresponse = this.testfeign();//调用 a微服务 处理逻辑
        //todo 处理返回结果
    }

    public apiresponse<string> testfeign() {
        serveraccessrequest<demopo> tserveraccessrequest = new serveraccessrequest<demopo>();
        tserveraccessrequest.setbusinessno("test001");
        return mdemofeignclient.testmicroserviceaccess(tserveraccessrequest);
    }
}