Spring Cloud OpenFeign模版化客户端


Posted in Java/Android onJune 25, 2022

OpenFeign是什么?

OpenFeign是一个显示声明式的WebService客户端。使用OpenFeign能让编写Web Service客户端更加简单。使用时只需定义服务接口,然后在上面添加注解。OpenFeign也支持可拔插式的编码和解码器。spring cloud对feign进行了封装,使其支持MVC注解和HttpMessageConverts。和eureka(服务注册中心)和ribbon组合可以实现负载均衡。在Spring Cloud中使用OpenFeign,可以做到使用HTTP请求访问远程服务,就像调用本地方法一样的,开发者完全感知不到这是在调用远程方法,更感知不到在访问HTTP请求,非常的方便。

OpenFeign能干啥?

  • OpenFeign的设计宗旨式简化Java Http客户端的开发。Feign在restTemplate的基础上做了进一步的封装,由其来帮助我们定义和实现依赖服务接口的定义。在OpenFeign的协助下,我们只需创建一个接口并使用注解的方式进行配置(类似于Dao接口上面的Mapper注解)即可完成对服务提供方的接口绑定,大大简化了Spring cloud Ribbon的开发,自动封装服务调用客户端的开发量。
  • OpenFeign集成了Ribbon,利用ribbon维护了服务列表,并且通过ribbon实现了客户端的负载均衡。与ribbon不同的是,通过OpenFeign只需要定义服务绑定接口且以申明式的方法,优雅而简单的实现了服务调用。

OpenFeign使用

使用OpenFeign之前,我们首先将之前的工程还原,为了操作简单,我们只采用单节点的eureka。

API服务模块搭建

由于我们使用openfeign之后,需要暴露相关接口给外部服务,所以我们需要写一个api服务。

我这里为了方便所以直接在外部创建了一个ms-service-api服务,实际开发过程中我们基本都是将其写在对应的模块中。

Spring Cloud OpenFeign模版化客户端

整体模块创建完成后,我们便可以定义相关接口供外部调用了,每个服务一一对应即可。

这里只演示一个goods-service-api项目的搭建,项目代码在文末会给出。

引入依赖

引入 open feign的相关依赖。

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

创建接口

这里对应的是goods-service项目中的GoodsService类,这里定义了其中的方法。

public interface IGoodsService {
    @GetMapping("/goods")
    String getGoodsById();
}

这个时候还需要将goods-service项目的类继承该接口:

首先需要将我们创建的api服务依赖添加到项目中:

<dependency>
    <groupId>com.example</groupId>
    <artifactId>goods-service-api</artifactId>
</dependency>

然后开始修改:

@Slf4j
@RestController
public class GoodsService implements IGoodsService  {

    @Value("${server.port}")
    private String port;

    /**
     * 根据ID查询商品信息
     *
     * @return
     */
    @GetMapping("/goods")
    public String getGoodsById() {
        log.info("收到请求,端口为:{}", port);
        return "返回商品信息";
    }
}

这里为了区分职责,类似我们写mapper和service这种,又额外写了一个对外暴露的接口。

FeignClient中的name不能随意写,它对应各个服务在eureka中注册的名字。如果不写该接口的话,可以将该注解加在IGoodsService上。

@FeignClient(name = "goods-service")
public interface IGoodsServiceFeignClient extends IGoodsService {
}

以上便是一个api服务的搭建过程。

外部调用

当我们的API服务调用完成之后,如何在聚合服务中调用呢?

首先我们需要在聚合服务中引入openfeign以及各api服务的依赖:

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

        <dependency>
            <groupId>com.example</groupId>
            <artifactId>goods-service-api</artifactId>
        </dependency>
        <dependency>
            <groupId>com.example</groupId>
            <artifactId>marking-service-api</artifactId>
        </dependency>
        <dependency>
            <groupId>com.example</groupId>
            <artifactId>order-service-api</artifactId>
        </dependency>

引入相关依赖后,我们就可以不需要之前的代码了,全面采用面向接口的形式来开发。

@RestController
@RequestMapping("/order")
@Slf4j
public class OrderController {

    // 代理对象
    @Autowired
    private IGoodsService goodsService;

    @Autowired
    private IPromotionService promotionService;

    @Autowired
    private IOrderService orderService;

    @GetMapping
    public String order() {
        log.info("begin do order");
//        使用openfiegn
        String goods = goodsService.getGoodsById();
        String promotion = promotionService.getPromotionById();
        String result = orderService.createOrder(goods, promotion);
        return result;
    }
}

这个时候还没有完全结束,我们还需要在启动类上配置扫码相关的feign类。

@EnableFeignClients(basePackages = "com.example.feignclient")
@SpringBootApplication
public class MallProtalApplication {

    public static void main(String[] args) {
        SpringApplication.run(MallProtalApplication.class, args);
    }
}

以上便是我们集成openfeign的全部步骤。

项目代码

cloud-demo

OpenFeign相关特性 Gzip压缩Looger底层通信框架:(sun.net.www.protocol.http.HttpURLConnection)也可以自定义替换为OKHttp Logger 日志使用

使用OpenFeign的日志功能,我们需要进行如下几个操作:

创建配置类

@Configurationpublic class FeignClientLogConfiguration {    /**     * NONE     * BASIC     * HEAD     * FULL     * @return     */    @Bean    Logger.Level feignLogger(){        return Logger.Level.FULL;    }}

指定配置类

@FeignClient(name = "goods-service",configuration = FeignClientLogConfiguration.class)public interface IGoodsServiceFeignClient extends IGoodsService {}

最后还需要在聚合服务出添加相关日志配置

feignclient所在的路径

# openfeign 日志logging.level.[com.example.feignclient]=DEBUG

Spring Cloud OpenFeign模版化客户端

使用OKHttp通信

引入依赖

<!--        ophttp-->        <dependency>            <groupId>io.github.openfeign</groupId>            <artifactId>feign-okhttp</artifactId>        </dependency>

修改配置

# openfeign替换底层通信框架feign.httpclient.enabled=falsefeign.okhttp.enabled=true

Tags in this post...

Java/Android 相关文章推荐
浅谈Java实现分布式事务的三种方案
Jun 11 Java/Android
Java 将PPT幻灯片转为HTML文件的实现思路
Jun 11 Java/Android
spring boot项目application.properties文件存放及使用介绍
Jun 30 Java/Android
Java使用httpRequest+Jsoup爬取红蓝球号码
Jul 02 Java/Android
Java使用jmeter进行压力测试
Jul 09 Java/Android
MyBatis自定义SQL拦截器示例详解
Oct 24 Java/Android
Java中API的使用方法详情
Apr 06 Java/Android
JAVA长虹键法之建造者Builder模式实现
Apr 10 Java/Android
Spring Boot 实现 WebSocket
Apr 30 Java/Android
Spring Boot优化后启动速度快到飞起技巧示例
Jul 23 Java/Android
HttpClient实现文件上传功能
Aug 14 Java/Android
Java中的Kafka为什么性能这么快及4大核心详析
Sep 23 Java/Android
Java服务调用RestTemplate与HttpClient的使用详解
Jun 21 #Java/Android
springboot创建的web项目整合Quartz框架的项目实践
Jun 21 #Java/Android
springboot读取resources下文件的方式详解
Jun 21 #Java/Android
java实现自定义时钟并实现走时功能
Jun 21 #Java/Android
SpringBoot使用ip2region获取地理位置信息的方法
Jun 21 #Java/Android
Android基础入门之dataBinding的简单使用教程
Jun 21 #Java/Android
一文搞懂Java中的注解和反射
Jun 21 #Java/Android
You might like
php学习 字符串课件
2008/06/15 PHP
php实现网站插件机制的方法
2009/11/10 PHP
php 生成随机验证码图片代码
2010/02/08 PHP
php 图片加水印与上传图片加水印php类
2010/05/12 PHP
PHP实现的oracle分页函数实例
2016/01/25 PHP
PHP表单数据写入MySQL数据库的代码
2016/05/31 PHP
Thinkphp微信公众号支付接口
2016/08/04 PHP
ThinkPHP3.2框架使用addAll()批量插入数据的方法
2017/03/16 PHP
捕获关闭窗口的脚本
2009/01/10 Javascript
浅谈JavaScript Date日期和时间对象
2014/12/29 Javascript
调试JavaScript中正则表达式中遇到的问题
2015/01/27 Javascript
JavaScript实现自动对页面上敏感词进行屏蔽的方法
2015/07/27 Javascript
jquery ajax分页插件的简单实现
2016/01/27 Javascript
easyui-edatagrid.js实现回车键结束编辑功能的实例
2017/04/12 Javascript
AngularJS模态框模板ngDialog的使用详解
2018/05/11 Javascript
jQuery事件blur()方法的使用实例讲解
2019/03/30 jQuery
nodejs简单抓包工具使用详解
2019/08/23 NodeJs
js定时器出现第一次延迟的原因及解决方法
2021/01/04 Javascript
Python过滤函数filter()使用自定义函数过滤序列实例
2014/08/26 Python
Python制作钉钉加密/解密工具
2016/12/07 Python
Python pyinotify模块实现对文档的实时监控功能方法
2018/10/13 Python
pyqt5对用qt designer设计的窗体实现弹出子窗口的示例
2019/06/19 Python
python数据挖掘需要学的内容
2019/06/23 Python
Python实现不规则图形填充的思路
2020/02/02 Python
PyQt5实现画布小程序
2020/05/30 Python
Python图像处理之膨胀与腐蚀的操作
2021/02/07 Python
利用CSS3参考手册和CSS3代码生成工具加速来学习网页制
2012/07/11 HTML / CSS
SheIn俄罗斯:时尚女装网上商店
2017/02/28 全球购物
介绍一下如何利用路径遍历进行攻击及如何防范
2014/01/19 面试题
简历自我评价模版
2014/01/31 职场文书
乡镇纠风工作实施方案
2014/03/22 职场文书
机电一体化专业毕业生自荐信
2014/06/19 职场文书
南京市纪委监察局整改方案
2014/09/16 职场文书
销售经理岗位职责
2015/01/31 职场文书
员工辞职信范文大全
2015/05/12 职场文书
忘记Grafana不要紧2种Grafana重置admin密码方法详细步骤
2022/04/07 Servers