OpenFeign的服务调用

OpenFeign是什么?

OpenFeign是一个声明式的web服务客户端,让编写web服务客户端变的非常容易,只需要创建一个接口并在接口上添加注解即可,openFeign的前身是Feign,后者目前已经停更了,openFeign是SpringCloud在Feign的基础上支持了Spring MVC的注解,并通过动态代理的方式产生实现类来做负载均衡并进行调用其他服务。

Feign目的就是为了使编写Java Http客户端变的更加容易。使用Ribbon+RestTemplate时,利用了RestTemplate对http请求的封装处理,形成了一套模版化的调用方法。但是在实际开发中,由于对服务依赖的调用可能不止一处,往往一个接口会被多处调用, 所以通常都会针对每个微服务自行封装-些客户端类来包装这些依赖服务的调用。所以,Feign在此基础上做了进一步封装, 由他来帮助我们定义和实现依赖服务接口的定义。在Feign的实现下,我们只需创建一 个接口并使用注解的方式来配置它(以前是Dao接口 上面标注Mapper注解,现在是一个微服务接口上面标注一个Feign注解即可,即可完成对服务提供方的接口绑定,简化了使用Spring cloud Ribbon时,自动封装服务调用客户端的开发量。

Ribbon、Feign和OpenFeign

Ribbon

Ribbon 是Netflix开源的基于HTTP和TCP等协议负载均衡组件,可以用来做客户端负载均衡来调用注册中心的服务,但是Ribbon的使用需要代码里面手动调用所需服务。

Feign

Feign是SpringCloud组件中的一个轻量级RESTFulHTTP服务客户端,内置了Ribbon来做客户端负载均衡去调注册中心的服务,它的使用就是使用Feign的注解定义接口,然后调用这个接口就可以调用注册中心的服务。

Feign使用的是自己的一套注解,本身不支持Spring MVC的注解。

OpenFeign

OpenFeign是Spring Cloud在Feign的基础上支持了Spring MVC的注解,列如@RequestMapping等,OpenFeign的@FeignClient可以解析SpringMVC的@RequestMapping注解下的接口,并通过动态代理的方式产生实现类,实现类中做负载均衡并调用其他服务。

需要注意,@RequesMapping不能在类名上与@FeignClient同时使用

使用

基本环境

  • 注册中心

    已启动了一个Eureka注册中心,地址为本机8080端口,当然,如果是其他注册中心也可以。

  • 服务注册

    已经注册了两个服务名为CLOUD-EUREKA-PROVIDE-USERINFO-SERVICE的服务,地址分别为本机8081和8082端口。

  • 提供的服务

    提供getUserByIdsayHi的接口

    @RestController
    @RequestMapping("/user")
    public class UserAdminController {
    
     @Autowired
     IUserAdminService userAdminService;
    
     @Value("${server.port}")
     private String serverPort;
    
     @GetMapping("/getUserById/{userId}")
     public BaseResponse<UserVO> getUserById(@PathVariable Integer userId){ 
       ...
         return BaseResponse.success(userVO);
     }
    
     @GetMapping("/sayHi")
     public String sayHi(){
       String number= UUID.randomUUID().toString();
       return "service,port:"+serverPort+",number:"+ number;
     }
     
    }
    

添加依赖

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

修改yml

因为使用的是Eureka,所以这里需要配置Eureka的注册中心

server:
  port: 80 
spring:
  application:
    name: cloud-eureka-consumer-openfeign-useradmin
eureka:
  client:
    #表示是否将自己注册进EurekaServer默认为true
    register-with-eureka: true
    #是否从EurekaServer抓取已有的注册消息,默认为true,单节点无所谓,集群必须设置为true才能配合ribbon使用负载均衡
    fetch-registry: true
    service-url:
      defaultZone: http://localhost:8080/eureka/

接口注册

使用openFeign需要先将接口注册了,注册时讲接口和服务绑定好,后面需要调用服务的时候直接调用改接口接口。这里创建了一个service文件夹,并在该文件夹下创建了UserInfoService

@Component
@FeignClient(value = "CLOUD-EUREKA-PROVIDE-USERINFO-SERVICE")
public interface UserInfoService {

    @GetMapping("/user/sayHi")
    String sayHi();

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

}

@FeignClient注解这里指定了CLOUD-EUREKA-PROVIDE-USERINFO-SERVICE服务名称。

下面的接口绑定了服务调用地址

@GetMapping("/user/sayHi")@GetMapping("/user/getUser/{userId}")

服务调用

@RestController
@RequestMapping("/user")
public class UserAdminController {

    @Resource
    UserInfoService userInfoService;

    @GetMapping("/getUser/{userId}")
    public BaseResponse getUser(@PathVariable String userId){
        return userInfoService.getUser(userId);
    } 

    @GetMapping("/sayHi")
    public String sayHi(){
        return userInfoService.sayHi();
    }
}

如果要调用服务的话,我们只需要使用@Resource或者@Autowired注解来引入之前我们添加的注册接口,然后要调用服务的时候,调用该接口即可。

启动OpenFeign

启动OpenFeign需要在启动类上添加@EnableFeignClients注解

@SpringBootApplication
@EnableFeignClients
public class EurekaConsumeOpenFeignApplication80 {
    public static void main(String[] args) {
        SpringApplication.run(EurekaConsumeOpenFeignApplication80.class,args);
    }
}

总结

因为之前学习过Dubbo,当然,Dubbo的服务调用更加简单,不过OpenFeignDubbo之前,所以学习到这里感慨颇深,程序员真是个会偷懒,把框架做的越来越方便,使用越来越简单~

参考文献

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,602评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,442评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,878评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,306评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,330评论 5 373
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,071评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,382评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,006评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,512评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,965评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,094评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,732评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,283评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,286评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,512评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,536评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,828评论 2 345