文档章节

Spring-Cloud | openfeign使用细节

冯文议
 冯文议
发布于 2018/09/15 14:12
字数 1344
阅读 383
收藏 5

写在前面的话

各位,下午好!

我比较喜欢用 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、先看一下完成后的目录截图

测试项目目录结构

我们看 apimodelservicefeign-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)

警告提醒

测试代码

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

大抵就是这样子,感谢。

© 著作权归作者所有

冯文议
粉丝 11
博文 47
码字总数 47895
作品 0
成都
高级程序员
私信 提问
Spring Cloud OpenFeign集成Protocol Buffer

本文作者张天,著有《Spring Cloud 微服务架构进阶》一书。 背景  在之前的文章中,我们介绍过基于Spring Cloud微服务架构,其中,微服务实例之间的交互方式一般为RESTful HTTP请求或RPC调用...

aoho
2018/10/07
0
0
Spring Cloud Finchley.M7 发布,兼容 Spring Boot 2.0

Spring Cloud Finchley.M7 已发布,可从 Spring Milestone 仓库获得。 此版本与 Spring Boot 2.0.0.RC2 兼容,可查阅 Finchley 发行说明以获取更多信息。 显著更新: Spring Cloud Netflix 所...

王练
2018/02/28
2.4K
1
聊聊spring cloud openfeign的Targeter

序 本文主要研究一下spring cloud openfeign的Targeter Targeter spring-cloud-openfeign-core-2.2.0.M1-sources.jar!/org/springframework/cloud/openfeign/Targeter.java Targeter定义了t......

go4it
07/18
30
0
聊聊spring cloud的CachingSpringLoadBalancerFactory

序 本文主要研究一下spring cloud的CachingSpringLoadBalancerFactory CachingSpringLoadBalancerFactory spring-cloud-openfeign-core-2.2.0.M1-sources.jar!/org/springframework/cloud/o......

go4it
07/21
30
0
聊聊spring cloud的FeignLoadBalancer

序 本文主要研究一下spring cloud的FeignLoadBalancer FeignLoadBalancer spring-cloud-openfeign-core-2.2.0.M1-sources.jar!/org/springframework/cloud/openfeign/ribbon/FeignLoadBalan......

go4it
07/11
34
0

没有更多内容

加载失败,请刷新页面

加载更多

OSChina 周日乱弹 —— 我,小小编辑,食人族酋长

Osc乱弹歌单(2019)请戳(这里) 【今日歌曲】 @宇辰OSC :分享娃娃的单曲《飘洋过海来看你》: #今日歌曲推荐# 《飘洋过海来看你》- 娃娃 手机党少年们想听歌,请使劲儿戳(这里) @宇辰OSC...

小小编辑
今天
484
10
MongoDB系列-- SpringBoot 中对 MongoDB 的 基本操作

SpringBoot 中对 MongoDB 的 基本操作 Database 库的创建 首先 在MongoDB 操作客户端 Robo 3T 中 创建数据库: 增加用户User: 创建 Collections 集合(类似mysql 中的 表): 后面我们大部分都...

TcWong
今天
20
0
spring cloud

一、从面试题入手 1.1、什么事微服务 1.2、微服务之间如何独立通讯的 1.3、springCloud和Dubbo有哪些区别 1.通信机制:DUbbo基于RPC远程过程调用;微服务cloud基于http restFUL API 1.4、spr...

榴莲黑芝麻糊
今天
10
0
Executor线程池原理与源码解读

线程池为线程生命周期的开销和资源不足问题提供了解决方 案。通过对多个任务重用线程,线程创建的开销被分摊到了多个任务上。 线程实现方式 Thread、Runnable、Callable //实现Runnable接口的...

小强的进阶之路
昨天
31
0
maven 环境隔离

解决问题 即 在 resource 文件夹下面 ,新增对应的资源配置文件夹,对应 开发,测试,生产的不同的配置内容 <resources> <resource> <directory>src/main/resources.${deplo......

之渊
昨天
29
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部