AI 助理
文档备案控制台
开发者社区 开发与运维 文章 正文

Spring-Cloud | openfeign使用细节

2018-09-15 4907
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介：

写在前面的话

各位，下午好！

我比较喜欢用 fegin 来实现微服务之间的调用，但是feign使用的那些细节，是get到了吗？本节我将使用Spring Boot 2.0.5.RELEASE + Spring Cloud SR1 + openfeign并结合实际的使用，教你使用feign的姿势。

项目架构

我们先对测试架构一番，看图

针对Feign的使用测试架构图

简单来说，就是服务模块化分为：model层、API层、service层，其他服务就可以依赖API层。

另外，我们看一下，Spring官网提供的一段关于Feign Inheritance Support代码：

Feign Inheritance Support

下面我们就动手写例子。

测试实例

1、先看一下完成后的目录截图

测试项目目录结构

我们看 api、 model、 service、 feign-use之间的依赖关系。
api依赖model
service依赖api，实现api接口
feign-use依赖api，client继承api，并注入spring bean

2、使用公益eureka，这样我们就省略构建服务注册中心了

eureka:
  client:
    service-url:
      defaultZone: http://eureka.fengwenyi.com/eureka/

3、关于项目多模块化，看这里：https://github.com/fengwenyi/multi-module。

4、model中的代码：

import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.experimental.Accessors;

/**
 * @author Wenyi Feng
 * @since 2018-09-15
 */
@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
public class User {

    /** 标识 */
    private String uuid;

    /** 姓名 */
    private String name;

    /** 年龄 */
    private Integer age;
}

5、API接口

import com.fengwenyi.data.model.User;
import org.springframework.web.bind.annotation.*;

import java.util.List;

/**
 * @author Wenyi Feng
 * @since 2018-09-15
 */
public interface API {

    /**
     * 获取users
     * @return
     */
    @GetMapping("/getUsers")
    List<User> getUsers();

    /**
     * 根据用户ID获取user
     * @param uuid 用户ID
     * @return
     */
    @GetMapping("/getUserById/{uuid}")
    User getUserById(@PathVariable("uuid") String uuid);

    /**
     * 添加用户
     * @param user 用户对象
     * @return
     */
    @PostMapping("/addUser")
    boolean addUser(@RequestBody User user);

    /**
     * 根据用户ID修改用户信息
     * @param uuid 用户ID
     * @param user
     * @return
     */
    @PostMapping("/updateUserById/{uuid}")
    boolean updateUserById(@PathVariable("uuid") String uuid, @RequestBody User user);

    /**
     * 根据用户ID修改用户信息
     * @param uuid 用户ID
     * @param age 用户年龄
     * @return
     */
    @PostMapping("/updateById/{uuid}")
    boolean updateUserAgeById(@PathVariable("uuid") String uuid, @RequestBody Integer age);

    /**
     * 根据用户ID删除用户
     * @param uuid 用户ID
     * @return
     */
    @DeleteMapping("/deleteUserById/{uuid}")
    boolean deleteUserById(@PathVariable("uuid") String uuid);
}

6、API实现

import com.fengwenyi.data.API;
import com.fengwenyi.data.model.User;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.util.StringUtils;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

@SpringBootApplication
@EnableDiscoveryClient
@RestController
@Slf4j
public class FeignAPIApplication implements API {

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

//        ApplicationContextAware
//        BeanUtils
    }

    Map<String, User> userMap = new HashMap<>();

    @Override
    public List<User> getUsers() {
        if (userMap == null || userMap.isEmpty())
            return null;
        List<User> userList = new ArrayList<>();
        for (String uuid : userMap.keySet()) {
            userList.add(userMap.get(uuid));
        }
        return userList;
    }

    @Override
    public User getUserById(@PathVariable String uuid) {
        if (userMap == null || userMap.isEmpty() || StringUtils.isEmpty(uuid))
            return null;
        return userMap.get(uuid);
    }

    @Override
    public boolean addUser(@RequestBody User user) {
        if (user == null)
            return false;

        String uuid = user.getUuid();

        if (uuid == null)
            return false;

        if (userMap.get(uuid) != null)
            return false;

        User lastUser = userMap.put(uuid, user);
        if (lastUser != null)
            log.warn("uuid对应的user已被替换，uuid={}, lastUser={}, user={}", uuid, lastUser, user);

        return true;
    }

    @Override
    public boolean updateUserById(@PathVariable String uuid, @RequestBody User user) {
        if (user == null || uuid == null)
            return false;

        if (userMap.get(uuid) == null)
            return false;

        User lastUser = userMap.put(uuid, user);
        if (lastUser != null)
            log.warn("uuid对应的user已被替换，uuid={}, lastUser={}, user={}", uuid, lastUser, user);

        return true;
    }

    @Override
    public boolean updateUserAgeById(@PathVariable String uuid, @RequestBody Integer age) {
        if (age == null || uuid == null || age < -1)
            return false;

        User user = userMap.get(uuid);
        if (user == null)
            return false;

        User lastUser = userMap.put(uuid, user.setAge(age));
        if (lastUser != null)
            log.warn("uuid对应的user已被替换，uuid={}, lastUser={}, user={}", uuid, lastUser, user);

        return true;
    }

    @Override
    public boolean deleteUserById(@PathVariable String uuid) {
        if (uuid == null)
            return false;

        if (userMap.get(uuid) == null)
            return false;

        User lastUser = userMap.remove(uuid);

        if (lastUser != null)
            log.warn("uuid对应的user已被删除，uuid={}, lastUser={}", uuid, lastUser);

        return true;
    }
}

7、API继承

import com.fengwenyi.data.API;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.stereotype.Component;

/**
 * @author Wenyi Feng
 * @since 2018-09-15
 */
@FeignClient("feignapi")
public interface APIClient extends API {
}

8、写调用测试代码

import com.fengwenyi.data.model.User;
import com.fengwenyi.javalib.util.StringUtil;
import com.fengwenyi.javalib.util.Utils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.openfeign.EnableFeignClients;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients
@RestController
public class FeignUseApplication {

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

    @Autowired
    private APIClient apiClient;


    @GetMapping("/add/{name}/{age}")
    public Object add(@PathVariable("name") String name, @PathVariable("age") Integer age) {
        if (StringUtil.isEmpty(name)
                || age == null
                || age < 0)
            return false;
        return apiClient.addUser(new User()
                .setUuid(Utils.getUUID())
                .setName("张三")
                .setAge(20));
    }

    @GetMapping("/updateUser/{uuid}")
    public Object updateUser(@PathVariable("uuid") String uuid) {
        if (StringUtil.isEmpty(uuid))
            return false;
        User user = apiClient.getUserById(uuid);
        if (user == null)
            return false;
        return apiClient.updateUserById(uuid,
                user.setName("张三 - Zhangsan")
                        .setAge(21));
    }

    @GetMapping("/update/{uuid}")
    public Object update(@PathVariable("uuid") String uuid) {
        if (StringUtil.isEmpty(uuid))
            return false;
        User user = apiClient.getUserById(uuid);
        if (user == null)
            return false;
        return apiClient.updateUserAgeById(uuid, 23);
    }

    @GetMapping("/delete/{uuid}")
    public Object delete(@PathVariable("uuid") String uuid) {
        if (StringUtil.isEmpty(uuid))
            return false;
        User user = apiClient.getUserById(uuid);
        if (user == null)
            return false;
        return apiClient.deleteUserById(uuid);
    }

    @GetMapping("gets")
    public Object gets() {
        return apiClient.getUsers();
    }

    @GetMapping("/get/{uuid}")
    public Object get(@PathVariable("uuid") String uuid) {
        if (StringUtil.isEmpty(uuid))
            return null;
        return apiClient.getUserById(uuid);
    }
}

关于测试

使用测试工具测试API

1、添加操作

http://localhost:8080/add/张三/19
http://localhost:8080/add/李四/18
http://localhost:8080/add/王五/17

2、查询

我们通过这个接口，看一下添加的情况：

http://localhost:8080/gets

响应
不好意思，上面代码有点问题。修改了下。

[
    {
        "uuid":"fddde49a35fe4947950571a93ebfaa1d",
        "name":"张三",
        "age":19
    },
    {
        "uuid":"e136860677a7463d8bcc3c88e0801931",
        "name":"王五",
        "age":17
    },
    {
        "uuid":"b440ebdf36964b62aea2025549409d4a",
        "name":"李四",
        "age":18
    }
]

单个查询

http://localhost:8080/get/e136860677a7463d8bcc3c88e0801931

响应

{
    "uuid":"e136860677a7463d8bcc3c88e0801931",
    "name":"王五",
    "age":17
}

3、修改操作

http://localhost:8080/updateUser/e136860677a7463d8bcc3c88e0801931

修改之后，数据是这样子的

[
    {
        "uuid":"fddde49a35fe4947950571a93ebfaa1d",
        "name":"张三",
        "age":19
    },
    {
        "uuid":"e136860677a7463d8bcc3c88e0801931",
        "name":"张三 - Zhangsan",
        "age":21
    },
    {
        "uuid":"b440ebdf36964b62aea2025549409d4a",
        "name":"李四",
        "age":18
    }
]

4、删除

http://localhost:8080/delete/b440ebdf36964b62aea2025549409d4a

删除之后，数据是这样子的

[
    {
        "uuid":"fddde49a35fe4947950571a93ebfaa1d",
        "name":"张三",
        "age":19
    },
    {
        "uuid":"e136860677a7463d8bcc3c88e0801931",
        "name":"张三 - Zhangsan",
        "age":21
    }
]

5、看一下控制台

控制台打印日志（部分截图）

2018-09-15 13:54:34.304  WARN 9732 --- [qtp489047267-34] c.fengwenyi.service.FeignAPIApplication  : 
uuid对应的user已被替换，uuid=e136860677a7463d8bcc3c88e0801931, 
lastUser=User(uuid=e136860677a7463d8bcc3c88e0801931, name=王五, age=17), 
user=User(uuid=e136860677a7463d8bcc3c88e0801931, name=张三 - Zhangsan, age=21)

2018-09-15 13:56:18.367  WARN 9732 --- [qtp489047267-35] c.fengwenyi.service.FeignAPIApplication  : 
uuid对应的user已被删除，uuid=b440ebdf36964b62aea2025549409d4a, 
lastUser=User(uuid=b440ebdf36964b62aea2025549409d4a, name=李四, age=18)

警告提醒

测试代码

点击这里，查看本节测试代码。

大抵就是这样子，感谢。

文章标签：
API
Java
测试技术
Spring
冯文议
目录
相关文章
lingeringfear
|
Java Spring
Spring Cloud OpenFeign 远程调用传递请求头信息
import feign.RequestInterceptor; import feign.RequestTemplate; import lombok.extern.slf4j.Slf4j; import org.springframework.util.Assert; import org.springframework.web.context.request.RequestContextHolder; import org.springframework.web.context.request.ServletRequestAttributes;
lingeringfear
734 0
蓝易云
|
Java 开发者 微服务
Spring Cloud OpenFeign详解与实践
总结起来说,Spring Cloud OpenFeign提供了一种简单易懂且高效的方式去实现微服务之间通信.它隐藏了许多复杂性，并且允许开发者以声明式方式编写HTTP客户端代码.如果你正在开发基于Spring Cloud 的微服务架构系统,Spring Cloud Open Feign是一个非常好用且强大工具.
蓝易云
923 33
长梦
|
负载均衡 Java API
Java一分钟之-Spring Cloud OpenFeign：声明式服务调用
【6月更文挑战第9天】Spring Cloud OpenFeign是声明式服务调用库，简化了微服务间调用。通过动态代理，它允许开发者用Java接口调用HTTP服务，支持服务发现、负载均衡。本文介绍了OpenFeign的基本概念，展示了如何添加依赖、开启客户端和定义服务接口。还讨论了接口调用失败、超时重试和日志配置等问题及其解决方案，并提供了自定义Feign配置的代码示例。通过学习，读者可以更好地在微服务架构中使用OpenFeign进行服务通信。
长梦
893 4
小王老师呀
|
负载均衡 前端开发 Java
OpenFeign：Spring Cloud声明式服务调用组件
该文本是关于OpenFeign在Spring Cloud中的使用的问答总结。涉及的问题包括：OpenFeign是什么，Feign与OpenFeign的区别，如何使用OpenFeign进行远程服务调用，OpenFeign的超时控制以及日志增强。OpenFeign被描述为Spring官方的声明式服务调用和负载均衡组件，它支持使用注解进行接口定义和服务调用，如@FeignClient和@EnableFeignClients。OpenFeign与Feign的主要区别在于OpenFeign支持Spring MVC注解。超时控制通过Ribbon进行设置，默认超时时间为1秒。
小王老师呀
306 1
不会编程的小孩子
|
负载均衡 前端开发 Java
Spring Cloud 之 OpenFeign
Spring Cloud OpenFeign是Spring官方的声明式服务调用组件，简化了远程服务调用，使其如同调用本地方法。核心注解包括`@FeignClient`、`@EnableFeignClients`、`@GetMapping`和`@PostMapping`。实践中，通过在`pom.xml`添加依赖，创建Feign接口，配置`@FeignClient`，在启动类启用Feign，以及自定义超时设置来实现远程调用和负载均衡。
不会编程的小孩子
772 0
请回答1024
|
负载均衡 前端开发 Java
第六章 Spring Cloud 之 OpenFeign
第六章 Spring Cloud 之 OpenFeign
请回答1024
566 0
hhzz
|
SpringCloudAlibaba 负载均衡 Java
【Springcloud Alibaba微服务分布式架构 | Spring Cloud】之学习笔记（五）OpenFeign的使用
【Springcloud Alibaba微服务分布式架构 | Spring Cloud】之学习笔记（五）OpenFeign的使用
hhzz
993 0
星辰醉天河ii-25383
|
SpringCloudAlibaba 负载均衡 前端开发
Spring Cloud实战 | 第五篇：Spring Cloud整合OpenFeign实现微服务之间的调用
Spring Cloud实战 | 第五篇：Spring Cloud整合OpenFeign实现微服务之间的调用
星辰醉天河ii-25383
1053 0
wei_shuo
|
Java 微服务 Spring
Spring Cloud OpenFeign：基于Ribbon和Hystrix的声明式服务调用
Spring Cloud OpenFeign：基于Ribbon和Hystrix的声明式服务调用
wei_shuo
295 0
_江南一点雨
|
Dubbo Java 应用服务中间件
Spring Boot+Nacos+gRPC，一个区别于 OpenFeign 的微服务通信方案！
Spring Boot+Nacos+gRPC，一个区别于 OpenFeign 的微服务通信方案！
_江南一点雨
2029 0

热门文章

最新文章

  • 1
    如何在SpringBoot中集成JWT(JSON Web Token)鉴权
  • 2
    Spring Boot+Netty+Websocket实现后台向前端推送信息
  • 3
    Spring事务传播行为
  • 4
    SpringMVC中类型转换器Converter＜S,T＞详解
  • 5
    Spring Security-退出登录和CSRF
  • 6
    spring boot 2以上版本整合mybatis
  • 7
    一个基于 Spring Boot 的项目骨架，少造轮子！
  • 8
    使用Spring缓存的简单Demo
  • 9
    对ORM的支持 之 8.4 集成JPA ——跟我学spring3
  • 10
    使用Spring Cloud Stream集成消息中间件
  • 1
    基于 Spring AI Alibaba + Nacos 的分布式 Multi-Agent 构建指南
    5526
  • 2
    Spring AI Alibaba Admin 开源！以数据为中心的 Agent 开发平台
    8402
  • 3
    Spring Boot自动装配
    739
  • 4
    【Spring Boot实战】EasyPoi神技：一篇搞定“一对多+图片”导入！
    2228
  • 5
    《深入理解Spring》性能监控与优化——构建高性能应用的艺术
    583
  • 6
    《深入理解Spring》单元测试——高质量代码的守护神
    1436
  • 7
    《深入理解Spring》定时任务——自动化调度的时间管理者
    1102
  • 8
    《深入理解Spring》事务管理——数据一致性的守护者
    613
  • 9
    《深入理解Spring》过滤器（Filter）——Web请求的第一道防线
    1710
  • 10
    《深入理解Spring》拦截器（Interceptor）——请求处理的艺术
    928

    • 相关课程

    更多
  • 全面讲解Spring Cloud Alibaba技术栈（知识精讲+项目实战）第三阶段
  • 精通Spring Cloud Alibaba
  • 微服务框架 Spring Cloud 快速入门
  • Java Web开发系列课程 - Spring框架入门
  • Spring Boot 2.5.x开发实战
  • Spring Cloud微服务架构设计与开发实战

    • 相关电子书

    更多
  • 云栖社区特邀专家徐雷Java Spring Boot开发实战系列课程（第20讲）：经典面试题与阿里等名企内部招聘求职面试技巧
  • 微服务架构模式与原理Spring Cloud开发实战
  • 阿里特邀专家徐雷Java Spring Boot开发实战系列课程（第18讲）：制作Java Docker镜像与推送到DockerHub和阿里云Docker仓库
    • 下一篇
    一条命令迁移，帮你实现 OpenClaw 与 Hermes Agent 记忆互通！