• 还在用Feign？推荐一款微服务间调用神器，跟SpringCloud绝配！

    在微服务项目中，如果我们想实现服务间调用，一般会选择Feign。之前介绍过一款HTTP客户端工具Retrofit，配合SpringBoot非常好用！其实Retrofit不仅支持普通的HTTP调用，还能支持微服务间的调用，负载均衡和熔断限流都能实现。今天我们来介绍下Retrofit在Spring Cloud Alibaba下的使用，希望对大家有所帮助！

    SpringBoot实战电商项目mall（50k+star）地址：github.com/macrozheng/…

    前置知识

    本文主要介绍Retrofit在Spring Cloud Alibaba下的使用，需要用到Nacos和Sentinel，对这些技术不太熟悉的朋友可以先参考下之前的文章。

    搭建

    在使用之前我们需要先搭建Nacos和Sentinel，再准备一个被调用的服务，使用之前的nacos-user-service即可。

    • 解压安装包到指定目录，直接运行bin目录下的startup.cmd，运行成功后访问Nacos，账号密码均为nacos，访问地址：http://localhost:8848/nacos

    • 接下来从官网下载Sentinel，这里下载的是sentinel-dashboard-1.6.3.jar文件，下载地址：github.com/alibaba/Sen…

    • 下载完成后输入如下命令运行Sentinel控制台；
    1. java -jar sentinel-dashboard-1.6.3.jar
    2. 复制代码
    • Sentinel控制台默认运行在8080端口上，登录账号密码均为sentinel，通过如下地址可以进行访问：http://localhost:8080

    • 接下来启动nacos-user-service服务，该服务中包含了对User对象的CRUD操作接口，启动成功后它将会在Nacos中注册。
    1. /**
    2.  * Created by macro on 2019/8/29.
    3.  */
    4. @RestController
    5. @RequestMapping("/user")
    6. public class UserController {
    7.  
    8.     private Logger LOGGER = LoggerFactory.getLogger(this.getClass());
    9.  
    10.     @Autowired
    11.     private UserService userService;
    12.  
    13.     @PostMapping("/create")
    14.     public CommonResult create(@RequestBody User user) {
    15.         userService.create(user);
    16.         return new CommonResult("操作成功", 200);
    17.     }
    18.  
    19.     @GetMapping("/{id}")
    20.     public CommonResult<User> getUser(@PathVariable Long id) {
    21.         User user = userService.getUser(id);
    22.         LOGGER.info("根据id获取用户信息，用户名称为：{}",user.getUsername());
    23.         return new CommonResult<>(user);
    24.     }
    25.  
    26.     @GetMapping("/getUserByIds")
    27.     public CommonResult<List<User>> getUserByIds(@RequestParam List ids) {
    28.         List<User> userList= userService.getUserByIds(ids);
    29.         LOGGER.info("根据ids获取用户信息，用户列表为：{}",userList);
    30.         return new CommonResult<>(userList);
    31.     }
    32.  
    33.     @GetMapping("/getByUsername")
    34.     public CommonResult<User> getByUsername(@RequestParam String username) {
    35.         User user = userService.getByUsername(username);
    36.         return new CommonResult<>(user);
    37.     }
    38.  
    39.     @PostMapping("/update")
    40.     public CommonResult update(@RequestBody User user) {
    41.         userService.update(user);
    42.         return new CommonResult("操作成功", 200);
    43.     }
    44.  
    45.     @PostMapping("/delete/{id}")
    46.     public CommonResult delete(@PathVariable Long id) {
    47.         userService.delete(id);
    48.         return new CommonResult("操作成功", 200);
    49.     }
    50. }
    51. 复制代码

    使用

    接下来我们来介绍下Retrofit的基本使用，包括服务间调用、服务限流和熔断降级。

    集成与配置

    • 首先在pom.xml中添加Nacos、Sentinel和Retrofit相关依赖；
    1. <dependencies>
    2.     <!--Nacos注册中心依赖-->
    3.      <dependency>
    4.          <groupId>com.alibaba.cloud</groupId>
    5.          <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    6.      </dependency>
    7.     <!--Sentinel依赖-->
    8.      <dependency>
    9.          <groupId>com.alibaba.cloud</groupId>
    10.          <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
    11.      </dependency>
    12.      <!--Retrofit依赖-->
    13.      <dependency>
    14.          <groupId>com.github.lianjiatech</groupId>
    15.          <artifactId>retrofit-spring-boot-starter</artifactId>
    16.          <version>2.2.18</version>
    17.      </dependency>
    18.  </dependencies>
    19. 复制代码
    • 然后在application.yml中对Nacos、Sentinel和Retrofit进行配置，Retrofit配置下日志和开启熔断降级即可；
    1. server:
    2.   port: 8402
    3. spring:
    4.   application:
    5.     name: nacos-retrofit-service
    6.   cloud:
    7.     nacos:
    8.       discovery:
    9.         server-addr: localhost:8848 #配置Nacos地址
    10.     sentinel:
    11.       transport:
    12.         dashboard: localhost:8080 #配置sentinel dashboard地址
    13.         port: 8719
    14. retrofit:
    15.   log:
    16.     # 启用日志打印
    17.     enable: true
    18.     # 日志打印拦截器
    19.     logging-interceptor: com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultLoggingInterceptor
    20.     # 全局日志打印级别
    21.     global-log-level: info
    22.     # 全局日志打印策略
    23.     global-log-strategy: body
    24.   # 熔断降级配置
    25.   degrade:
    26.     # 是否启用熔断降级
    27.     enable: true
    28.     # 熔断降级实现方式
    29.     degrade-type: sentinel
    30.     # 熔断资源名称解析器
    31.     resource-name-parser: com.github.lianjiatech.retrofit.spring.boot.degrade.DefaultResourceNameParser
    32. 复制代码
    • 再添加一个Retrofit的Java配置，配置好选择服务实例的Bean即可。
    1. /**
    2.  * Retrofit相关配置
    3.  * Created by macro on 2022/1/26.
    4.  */
    5. @Configuration
    6. public class RetrofitConfig {
    7.  
    8.     @Bean
    9.     @Autowired
    10.     public ServiceInstanceChooser serviceInstanceChooser(LoadBalancerClient loadBalancerClient) {
    11.         return new SpringCloudServiceInstanceChooser(loadBalancerClient);
    12.     }
    13. }
    14. 复制代码

    服务间调用

    • 使用Retrofit实现微服务间调用非常简单，直接使用@RetrofitClient注解，通过设置serviceId为需要调用服务的ID即可；
    1. /**
    2.  * 定义Http接口，用于调用远程的User服务
    3.  * Created by macro on 2019/9/5.
    4.  */
    5. @RetrofitClient(serviceId = "nacos-user-service", fallback = UserFallbackService.class)
    6. public interface UserService {
    7.     @POST("/user/create")
    8.     CommonResult create(@Body User user);
    9.  
    10.     @GET("/user/{id}")
    11.     CommonResult getUser(@Path("id") Long id);
    12.  
    13.     @GET("/user/getByUsername")
    14.     CommonResult getByUsername(@Query("username") String username);
    15.  
    16.     @POST("/user/update")
    17.     CommonResult update(@Body User user);
    18.  
    19.     @POST("/user/delete/{id}")
    20.     CommonResult delete(@Path("id") Long id);
    21. }
    22. 复制代码
    • 我们可以启动2个nacos-user-service服务和1个nacos-retrofit-service服务，此时Nacos注册中心显示如下；

    • 查看nacos-retrofit-service服务打印的日志，两个实例的请求调用交替打印，我们可以发现Retrofit通过配置serviceId即可实现微服务间调用和负载均衡。

    服务限流

    • Retrofit的限流功能基本依赖Sentinel，和直接使用Sentinel并无区别，我们创建一个测试类RateLimitController来试下它的限流功能；
    1. /**
    2.  * 限流功能
    3.  * Created by macro on 2019/11/7.
    4.  */
    5. @Api(tags = "RateLimitController",description = "限流功能")
    6. @RestController
    7. @RequestMapping("/rateLimit")
    8. public class RateLimitController {
    9.  
    10.     @ApiOperation("按资源名称限流，需要指定限流处理逻辑")
    11.     @GetMapping("/byResource")
    12.     @SentinelResource(value = "byResource",blockHandler = "handleException")
    13.     public CommonResult byResource() {
    14.         return new CommonResult("按资源名称限流", 200);
    15.     }
    16.  
    17.     @ApiOperation("按URL限流，有默认的限流处理逻辑")
    18.     @GetMapping("/byUrl")
    19.     @SentinelResource(value = "byUrl",blockHandler = "handleException")
    20.     public CommonResult byUrl() {
    21.         return new CommonResult("按url限流", 200);
    22.     }
    23.  
    24.     @ApiOperation("自定义通用的限流处理逻辑")
    25.     @GetMapping("/customBlockHandler")
    26.     @SentinelResource(value = "customBlockHandler", blockHandler = "handleException",blockHandlerClass = CustomBlockHandler.class)
    27.     public CommonResult blockHandler() {
    28.         return new CommonResult("限流成功", 200);
    29.     }
    30.  
    31.     public CommonResult handleException(BlockException exception){
    32.         return new CommonResult(exception.getClass().getCanonicalName(),200);
    33.     }
    34.  
    35. }
    36. 复制代码
    • 接下来在Sentinel控制台创建一个根据资源名称进行限流的规则；

    • 之后我们以较快速度访问该接口时，就会触发限流，返回如下信息。

    熔断降级

    • Retrofit的熔断降级功能也基本依赖于Sentinel，我们创建一个测试类CircleBreakerController来试下它的熔断降级功能；
    1. /**
    2.  * 熔断降级
    3.  * Created by macro on 2019/11/7.
    4.  */
    5. @Api(tags = "CircleBreakerController",description = "熔断降级")
    6. @RestController
    7. @RequestMapping("/breaker")
    8. public class CircleBreakerController {
    9.  
    10.     private Logger LOGGER = LoggerFactory.getLogger(CircleBreakerController.class);
    11.     @Autowired
    12.     private UserService userService;
    13.  
    14.     @ApiOperation("熔断降级")
    15.     @RequestMapping(value = "/fallback/{id}",method = RequestMethod.GET)
    16.     @SentinelResource(value = "fallback",fallback = "handleFallback")
    17.     public CommonResult fallback(@PathVariable Long id) {
    18.         return userService.getUser(id);
    19.     }
    20.  
    21.     @ApiOperation("忽略异常进行熔断降级")
    22.     @RequestMapping(value = "/fallbackException/{id}",method = RequestMethod.GET)
    23.     @SentinelResource(value = "fallbackException",fallback = "handleFallback2", exceptionsToIgnore = {NullPointerException.class})
    24.     public CommonResult fallbackException(@PathVariable Long id) {
    25.         if (id == 1) {
    26.             throw new IndexOutOfBoundsException();
    27.         } else if (id == 2) {
    28.             throw new NullPointerException();
    29.         }
    30.         return userService.getUser(id);
    31.     }
    32.  
    33.     public CommonResult handleFallback(Long id) {
    34.         User defaultUser = new User(-1L, "defaultUser", "123456");
    35.         return new CommonResult<>(defaultUser,"服务降级返回",200);
    36.     }
    37.  
    38.     public CommonResult handleFallback2(@PathVariable Long id, Throwable e) {
    39.         LOGGER.error("handleFallback2 id:{},throwable class:{}", id, e.getClass());
    40.         User defaultUser = new User(-2L, "defaultUser2", "123456");
    41.         return new CommonResult<>(defaultUser,"服务降级返回",200);
    42.     }
    43. }
    44. 复制代码
    • 由于我们并没有在nacos-user-service中定义id为4的用户，调用过程中会产生异常，所以访问如下接口会返回服务降级结果，返回我们默认的用户信息。

    总结

    Retrofit给了我们除Feign和Dubbo之外的第三种微服务间调用选择，使用起来还是非常方便的。记得之前在使用Feign的过程中，实现方的Controller经常要抽出一个接口来，方便调用方来实现调用，接口实现方和调用方的耦合度很高。如果当时使用的是Retrofit的话，这种情况会大大改善。总的来说，Retrofit给我们提供了更加优雅的HTTP调用方式，不仅是在单体应用中，在微服务应用中也一样！

  • 相关阅读:
    java学习之SpringCloud Alibaba
    OpenResty
    es6新特性（超详细）
    C++DAY 结构体·结构体与函数
    深入OpenCV Android应用开发
    torchvision中的标准ResNet50网络结构
    Linux基础命令行操作
    Android setTheme设置透明主题无效
    刷题第一天——链表
    Java InputStreamReader类的简介说明
  • 原文地址：https://blog.csdn.net/BASK2311/article/details/127844638