高级框架第十天OpenFeign:声明式服务调用

主要内容

1.OpenFeign简介

2.第一个OpenFeign项目

3.使用OpenFeign访问带有参数的控制器

4.OpenFeign通讯优化

一.OpenFeign简介

1.什么是OpenFeign

OpenFeign目前是Spring Cloud二级子项目.平时说的Feign

指的是Netflix下的Feign,现在我们学习的是OpenFeign,是Spring提供的

OpenFeign目前是Spring Cloud二级子项目.平时说的Feign指的是Netflix下的Feign,现在我们学习的是OpenFeign,是Spring提供的.

OpenFeign是一种声明式,模板化的HTTP客户端(仅在Application Client中使用)(称OpenFeign作用:声明式服务调用).声明式调用是指.就像调用本地方法一样调用远程方法,无需感知操作远程http请求.学习完OpenFeign后可以不使用RestTemplate进行调用

Spring Cloud的声明式调用,可以做到使用HTTP请求远程服务时能就像调用本地方法一样的体验,开发者完全感知不到这是远程方法,更感知不到这是个HTTP请求.Feign的应用,让Spring Cloud微服务调用像Dubbo一样,Application Client直接通过接口方法调用Application Service,而不需要通过常规的RestTemplate构造请求再解析返回数据.它解决了让开发者调用远程接口就跟调用本地方法一样,无需关注与远程的交互细节,更无需关注分布式环境开发

使用OpenFeign时就好像在写控制器方法,OpenFeign都是写在接口中,在声明的方法上添加SpringMVC注解或声明的参数上添加SpringMVC注解就可以完成调用远程的控制器方法

2.使用OpenFeign时程序执行流程

OpenFeign代替之前的RestTemplate代码.也是写在Application Client中.把OpenFeign接口单独放在feign包中,表示服务调用层.当需要调用其他服务时,直接注入OpenFeign接口对象就可以像调用本地方法一样调用远程服务

整体流程说明:

1.ApplicationService向Eureka Server注册服务

2.Application Client从Eureka Server中发现服务信息

3.在Application Client中调用OpenFeign接口中方法

4.Application Client中OpenFeign通过应用程序名调用Application Service

流程说明图

二.第一个OpenFeign项目

前提:

    保证有Eureka Server(以单机版举例,端口为8761)

1.新建Applicaiton Service项目

先进一个项目名称任意(示例中叫做applicationservice)

1.1.添加依赖

添加了Spring Boot和Spring Cloud版本声明

添加了web环境和eureka client依赖

<parent>

    <groupId>org.springframework.boot</groupId>

    <artifactId>spring-boot-starter-parent</artifactId>

    <version>2.2.5.RELEASE</version>

</parent>

<dependencyManagement>

    <dependencies>

        <dependency>

            <groupId>org/springframework.cloud</groupId>

            <artifactId>spring-cloud-dependencies</artifactId>

            <version>Hoxton.SR3</version>

            <type>pom</type>

            <scope>import</scope>

        </dependency>

    </dependencies>

</dependencyManagement>

<dependencies>

    <dependency>

        <groupId>org.springframework.cloud</groupId>

        <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>

    </dependency>

</dependencies>

1.2编写配置文件

必须要有应用程序名,因为OpenFeign是通过应用程序名进行调用

spring.application.name=applicationservice

1.3新建控制器

先进com.bjsxt.controller.ServiceController

@RestController

public class ServiceController{

    @RequestMapping("/service1")

    public String service1(){

        return "service1的返回内容";

    }

}

1.4新建启动类

新建com.bjsxt.ApplicationserviceApplication

@SpringBootApplication

public class ApplicationserviceApplication{

    public static vid main(String[] args){

                SpringApplication.run(ApplicationserviceApplication.class,args);

    }

}

2.新建Application Client项目

新建项目.名称任意(示例中叫做application)

2.1添加依赖

比application service项目多了openfeign的依赖

<parent>

    <groupId>org.springframework.boot</groupId>

    <artifactId>spring-boot-starter-parent</artifactId>

    <version>2.2.5.RELEASE</version>

</parent>

<dependencies>

    <dependency>

        <groupId>org.springframework.boot</groupId>

        <artifactId>spring-boot-starter-web</artifactId>

    </dependency>

    <dependency>

        <groupId>org.springframework.cloud</groupId>

        <artifactId>spring-cloud-starter-nerflix-eureka-client</artifactId>

    </dependency>

    <dependency>

        <groupId>org.springframework.cloud</groupId>

        <artifactId>spring-cloud-starter-openfeign</artifactId>

    </dependency>

</dependencies>

<dependencyManagement>

    <dependencies>

        <dependency>

            <groupId>org.springframework.cloud</groupId>

            <artifactId>spring-cloud-dependencies</artifactId>

            <version>Hoxton.SR3</version>

            <type>pom</type>

            <scope>import</scope>

        </dependency>

    </depenencies>

</dependencyManagement>

2.2新建配制文件

新建application.properties

spring.application.name=applicationclient

server.port=8081

2.3新建OpenFeign

OpenFeign接口命令:

    调用应用程序+Feign

新建了com.bjsxt.feign.ApplicationServiceFeign

注意:

    @FeignClient参数要写调用的Application Service的应用程序名

    @RequestMapping中值要和需要调用的控制器方法URL相同

方法返回值要和调用控制器方法返回值相同

方法名称随意,没有要求

@FeignClient("APPLICATIONSERVICE")

public interface ApplicationServiceFeign{

    @RequestMapping("/service1")

    String suiyi();

}

2.4新建service及实现类

新建com.bjsxt.service.ClientService及实现类

在实现类中直接注入OpenFeign接口对象即可.没有在启动类上添加@EnableFeignClients时此处可能会报编译错误

public interface ClientService{

    String show();

}

@Service

public class ClientServiceImpl implements ClientService{

    @Autowired

    private ApplicationServiceFeign applicationServiceFeign;

    @Override

    public String show(){

        return applicationServiceFeign.suiyi();

    }

}

2.5新建控制器

新建com.bjsxt.controller.ClientController

@RestController

public class ClientController{

    @Autowired

    private ClientService clientService;

    @RequestMapping("/client")

    public String show(){

        return clientService.show();

    }

}

3.测试结果

在浏览器中输入http://localhost:8081/client如果打印"service1的返回内容"说明OpenFeign调用成功

三.使用OpenFeign访问带有参数的控制器

1.带有简单数据类型参数

1.1applicationservice项目中天啊及控制器方法

@RequestMapping("/service2")

public String service2(String name,int age){

    System.out.println("name:"+name+",age:"+age);

    return "name:"+name+",age:"+age;

}

1.2applicationclient中Feign接口添加方法

@RequestParam注解必须有

如果Feign接口方法参数名和调用控制器参数名相同可以省略@RequestParam的参数.

@RequestMapping("/service2")

String suiyi2(@RequestParam("name")String name123,@RequestParam int age);

1.2.1applicationclient其他代码省略

service及controller代码省略

2.传递请求体数据

如果Feign接口中方法擦书没有写注解,表示把该参数值设置到请求体中,在Application Service方参数必须添加@RequestBody接收

但是由于请求体数据特性,Feign接口方法最多只能出现一个不带有注解的参数.否则出现违法状态异常

但是允许Feign接口方法参数列表中,一个参数不带有注解,其他都带有注解,表示不带有注解的参数设置到请求体中,其他参数为普通表单参数

2.1传递请求体数据

2.1.1application service方

请求体中数据可以是一个实体类,也可以是集合,根可以是简单数据类型

@RequestMapping("/service3")

public String service3(@RequestBody Map<String,Object>map){

    System.out.println(map);

    return map.toString();

}

@RequestMapping("/service4")

public String service4(@RequestBody String name){

    System.out.println("name:"+name);

    return "name:"+name;

}

2.1.2application client方

Feign接口中方法参数都没有@RequestParam注解

@RequestMapping("/service3")

String suiyi3(Map<String,Object>map);

@RequestMapping("/service4")

String suiyi4(String name);

2.2既包含请求体数据,又包含普通表单数据

2.2.1application service方

请求体数据必须有@RequestBody

@RequestMapping("/service999")

public String service999(@RequestBody String name,int age,Stirng address){

    System.out.println(name+","+age+","+address);

    return name+","+age+","+address;

}

2.2.2application client方

name表示设置到请求体中,其他参数为普通表单数据

@RequestMapping("/service999")

String suiyi999(String name,@RequestParam int age,@RequestParam String address);

3.Restful方式

由于SpringMVC支持Restful请求方式,所以在Feign接口中可以按照restful传递参数

3.1application service方

@RequestMapping("/service5/{name}/{age}")

oublic String service5(@PathVariable String name.@PathVariable int age){

    return name+","+age;

}

3.2application client方

@RequestMapping("/service5/{name}/{age}")

String suiyi5(@PathVariable String name,@PathVariable int age);

四.OpenFeign铜须优化

1.GZIP简介

gzip介绍:gzip是一种数据格式,采用deflate算法压缩数据;gzip是一种流行的数据压缩算法,因公十分广泛,尤其是在Linux平台

gzip能力:当Gzip压缩到一个出文本数据时,效果是非常明显的,大约可以减少70%以上的数据大小.

gzip作用:网络数据经过压缩后实际上降低了网络传输的字节数,最明显的好处就是可以加快网页加载的速度.网页加载速度加快的好处不言而喻,除了节省流量,改善用户的浏览体验外,另一个潜在的好处是Gzip与搜索引擎的抓取工具有着更好的关系.例如Google就可以通过直接读取gzip文件来比普通手工抓取更快的检索网页

2.HTTP协议中关于压缩传输的规定(原理)

第一:客户端向服务端请求头中带有:Accept-Encoding:gzip,deflate字段,向服务器表示,客户端支持的压缩格式(gzip或者deflate),如果不发送该消息头,服务器是不会压缩的

第二:服务端在收到请求之后,如果发现请求头中含有Accept-Encoding字段,并且支持费类型的压缩,就对响应报文压缩之后返回给客户端,并且携带Content-Encoding:gzip消息头,表示响应报文是根据该格式压缩过的

第三:客户端接收到响应之后,先判断是否有Content-Encoding消息头,如果有,按该格式解压报文.否则按正常报文处理

3.在OpenFeign技术中应用GZIP压缩

在Spring Cloud微服务体系中,一次请求的完整流程如下:

在整体流程中,如果使用GZIP压缩来传输数据,涉及到两次请求-应答.而这两次请求-应答的连接点是Application Client,那么我们需要在Application Client中配置开启GZIP压缩,来实现压缩数据传输

4.只配置OpenFeign请求-应答的GZIP压缩

在交互数据量级不够的时候,看不到压缩内容

这里指开启Feign请求-应答过程中的GZIP,也就是浏览器-Application Client之间的请求应答不开启GZIP压缩

在全局配置文件中,使用下述配置来实现OpenFeign请求-应答的GZIP压缩

#feign gzip

#开启请求GZIP

feign.compression.request.enabled=true

#开启响应GZIP

feign.compression.response.enabled=true

# 设置支持GZIP压缩的MIME类型,及请求/响应类型

feign.compression.request.mime-types=text/xml.application/xml,application/json

# 配置启动压缩数据的最小阈值,单位字节.默认为2048

feign.compression.request.min-request-size=512

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