【Spring Boot】使用Feign作为HTTP客户端调用远程HTTP服务

简介: 【Spring Boot】使用Feign作为HTTP客户端调用远程HTTP服务

一、背景简介

最近做的一个公司项目,由于功能需求,需要在两个springboot项目间的进行远程调用,我使用的是通过Feign的方式。而springboot本身封装了两种方法HTTP调用方式:

  1. feign的远程调用(http接口调用)
  2. RestTemplate

下面记录一下我使用的过程(项目A调用项目B):

二、调用方(项目A)

首先是调用方(项目A):

项目技术架构:Spring boot(2.0.0.RELEASE) + Mybatis-plus(3.1.1) + druid(1.1.9)

第一步:添加Maven依赖

<!-- openfein的依赖 -->
<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-openfeign</artifactId>
  <version>2.0.4.RELEASE</version>
</dependency>

第二步:添加@EnableFeignClients注解

在启动类上添加@EnableFeignClients(basePackages = {“com..”}),其中****号代表你实际的项目目录结构,可以根据你的项目实际填写;

第三步:创建FeignClient接口

package com.iot.flowapplication.feign;
import com.iot.flowapplication.common.domain.vo.JsonResult;
import com.iot.flowapplication.organization.entity.User;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
/**
 * <p>此类用于流程管理服务调用日报服务查询日报列表</p>
 * <p>@author:xzj</p>
 * <p>@date:2019/8/29</p>
 * <p>@remark</p>
 */
@FeignClient(url = "${dailyServer}", name = "daily")
public interface DailyService {
    /**
     * 日报统计
     *
     * @param currUser 当前登录用户
     * @return 日报列表
     */
    @RequestMapping(value = "/api/statistics/getNoSubmitList", method = RequestMethod.POST)
    JsonResult dailyStatistics(@RequestBody User currUser);
}

说明:

@FeignClient(url = “${dailyServer}”, name = “daily”),其中url的值是被调用方的域名加端口,例如:(dailyServer: http://localhost:8006),而name的值可以写成被调用方的服务名称等。

写法总结:

  1. 在resources目录下的yml配置文件里写:dailyServer: http://localhost:8006
  2. 直接在url后面写上,例如:@FeignClient(url = “http://localhost:8006”, name =
    “daily”)

推荐使用第一种写法。

第四步:调用方使用

package com.iot.flowapplication.feign;
import com.iot.flowapplication.basics.web.BaseController;
import com.iot.flowapplication.common.domain.vo.JsonResult;
import com.iot.flowapplication.organization.entity.User;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.annotation.Resource;
/**
 * <p>DailyStatisticsController 此类用于:本项目对前端提供的接口映射</p>
 * <p>@author:hujm</p>
 * <p>@date:2021年04月29日 14:37</p>
 * <p>@remark:</p>
 */
@Api(tags = "首页日报统计", value = "daily")
@RestController
@RequestMapping(value = "daily")
public class DailyStatisticsController extends BaseController {
    @Resource
    private DailyService dailyService;
    @ApiOperation(value = "获取日报未提交人员列表")
    @GetMapping(value = "/getNoSubmitList")
    public JsonResult getList() {
        User currUser = getCurrUser();
        JsonResult jsonResult = dailyService.dailyStatistics(currUser);
        return jsonResult;
    }
}

至此调用方的步骤全部完成。

三、调用方(项目B)

以下是被调用方(项目B):

项目技术架构:Spring boot(2.0.0.RELEASE) + Mybatis-plus(3.1.1) + druid(1.1.9)

第一步:添加Maven依赖

<!--openfein的依赖-->
<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-openfeign</artifactId>
  <version>2.0.4.RELEASE</version>
</dependency>

第二步:添加@EnableFeignClients注解

在启动类上添加@EnableFeignClients(basePackages = {“com..”}),其中****号代表你实际的项目目录结构,可以根据你的项目实际填写;

@EnableFeignClients(basePackages = “com..”)

第三步:创建Controller控制层

此步骤按照正常的Spring MVC方式创建一个Controller路径映射即可。这个Controller和平时写的一样。

package com.iot.daily.module.web;
import com.iot.daily.common.domain.vo.JsonResult;
import com.iot.daily.common.web.BaseController;
import com.iot.daily.module.service.DailyStatisticsService;
import com.iot.daily.organization.entity.User;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.annotation.Resource;
/**
 * <p>DailyStatisticsController 此类用于:日报统计相关接口</p>
 * <p>@author:hujm</p>
 * <p>@date:2021年04月24日 9:14</p>
 * <p>@remark:</p>
 */
@Api(tags = "日报统计相关接口", value = "statistics")
@RestController
@RequestMapping(value = "/api/statistics")
public class DailyStatisticsController extends BaseController {
    @Resource
    private DailyStatisticsService dailyStatisticsService;
    @ApiOperation(value = "获取日报未提交人员列表,用于Portal页面日报统计未提交人员列表")
    @PostMapping(value = "/getNoSubmitList")
    public JsonResult getNoSubmitList(@RequestBody User user) {
        JsonResult jsonResult = dailyStatisticsService.getNoSubmitList(user);
        return jsonResult;
    }
}

说明:DailyStatisticsService接口,以及Mapper接口,都按照正常的业务流程处理即可。而方法接受的参数(User对象)则为调用方(项目A)传入过来的参数。

完结!


相关文章
|
3月前
|
JSON NoSQL Java
redis的java客户端的使用(Jedis、SpringDataRedis、SpringBoot整合redis、redisTemplate序列化及stringRedisTemplate序列化)
这篇文章介绍了在Java中使用Redis客户端的几种方法,包括Jedis、SpringDataRedis和SpringBoot整合Redis的操作。文章详细解释了Jedis的基本使用步骤,Jedis连接池的创建和使用,以及在SpringBoot项目中如何配置和使用RedisTemplate和StringRedisTemplate。此外,还探讨了RedisTemplate序列化的两种实践方案,包括默认的JDK序列化和自定义的JSON序列化,以及StringRedisTemplate的使用,它要求键和值都必须是String类型。
redis的java客户端的使用(Jedis、SpringDataRedis、SpringBoot整合redis、redisTemplate序列化及stringRedisTemplate序列化)
|
2月前
|
负载均衡 Java 开发者
Spring Cloud 远程调用:为何选择 HTTP 而非 RPC?
【10月更文挑战第1天】在微服务架构中,远程服务调用是一个核心环节。面对HTTP和RPC(Remote Procedure Call,远程过程调用)这两种通信协议,Spring Cloud 选择了HTTP作为其主要通信手段。本文将深入探讨Spring Cloud选择HTTP而非RPC的原因,以及这一选择在实际工作中的优势。
100 0
|
3月前
|
Java API 开发者
【已解决】Spring Cloud Feign 上传文件,提示:the request was rejected because no multipart boundary was found的问题
【已解决】Spring Cloud Feign 上传文件,提示:the request was rejected because no multipart boundary was found的问题
616 0
|
5月前
|
Java Spring
spring restTemplate 进行http请求的工具类封装
spring restTemplate 进行http请求的工具类封装
228 3
|
5月前
|
Java Spring
spring cloud gateway在使用 zookeeper 注册中心时,配置https 进行服务转发
spring cloud gateway在使用 zookeeper 注册中心时,配置https 进行服务转发
124 3
|
5月前
|
文字识别 前端开发 API
印刷文字识别操作报错合集之通过HTTPS连接到OCR服务的API时报错,该如何处理
在使用印刷文字识别(OCR)服务时,可能会遇到各种错误。例如:1.Java异常、2.配置文件错误、3.服务未开通、4.HTTP错误码、5.权限问题(403 Forbidden)、6.调用拒绝(Refused)、7.智能纠错问题、8.图片质量或格式问题,以下是一些常见错误及其可能的原因和解决方案的合集。
|
4月前
|
Java 开发工具 Spring
【Azure 事件中心】azure-spring-cloud-stream-binder-eventhubs客户端组件问题, 实践消息非顺序可达
【Azure 事件中心】azure-spring-cloud-stream-binder-eventhubs客户端组件问题, 实践消息非顺序可达
|
6月前
|
Java 应用服务中间件 微服务
spring boot 中Feign调用提示Request header is too large 解决方案
spring boot 中Feign调用提示Request header is too large 解决方案
253 1
|
6月前
|
缓存 负载均衡 Java
Java一分钟之-Spring Cloud Netflix Ribbon:客户端负载均衡
【6月更文挑战第9天】Spring Cloud Netflix Ribbon是客户端负载均衡器,用于服务间的智能路由。本文介绍了Ribbon的基本概念、快速入门步骤,包括添加依赖、配置服务调用和使用RestTemplate。此外,还讨论了常见问题,如服务实例选择不均、超时和重试设置不当、服务列表更新不及时,并提供了相应的解决策略。最后,展示了如何自定义负载均衡策略。理解并正确使用Ribbon能提升微服务架构的稳定性和效率。
229 3
|
6月前
|
Java API Spring
Spring Boot中使用Feign进行HTTP请求
Spring Boot中使用Feign进行HTTP请求