在使用之前我们需要先搭建Nacos和Sentinel，再准备一个被调用的服务，使用之前的nacos-user-service即可。
首先从官网下载Nacos，这里下载的是nacos-server-1.3.0.zip文件，下载地址：github.com/alibaba/nac…
Retrofit的基本使用，包括服务间调用、服务限流和熔断降级 - 图1

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

Retrofit的基本使用，包括服务间调用、服务限流和熔断降级 - 图2

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

Retrofit的基本使用，包括服务间调用、服务限流和熔断降级 - 图3

  • 下载完成后输入如下命令运行Sentinel控制台；

    1. java -jar sentinel-dashboard-1.6.3.jar

  • Sentinel控制台默认运行在8080端口上，登录账号密码均为sentinel，通过如下地址可以进行访问：http://localhost:8080

Retrofit的基本使用，包括服务间调用、服务限流和熔断降级 - 图4

  • 接下来启动nacos-user-service服务，该服务中包含了对User对象的CRUD操作接口，启动成功后它将会在Nacos中注册。 ```go /**

    • Created by macro on 2019/8/29. */ @RestController @RequestMapping(“/user”) public class UserController {

      private Logger LOGGER = LoggerFactory.getLogger(this.getClass());

      @Autowired private UserService userService;

      @PostMapping(“/create”) public CommonResult create(@RequestBody User user) {

      1. userService.create(user);
      2. return new CommonResult("操作成功", 200);

      }

      @GetMapping(“/{id}”) public CommonResult getUser(@PathVariable Long id) {

      1. User user = userService.getUser(id);
      2. LOGGER.info("根据id获取用户信息，用户名称为：{}",user.getUsername());
      3. return new CommonResult<>(user);

      }

      @GetMapping(“/getUserByIds”) public CommonResult> getUserByIds(@RequestParam List ids) {

      1. List<User> userList= userService.getUserByIds(ids);
      2. LOGGER.info("根据ids获取用户信息，用户列表为：{}",userList);
      3. return new CommonResult<>(userList);

      }

      @GetMapping(“/getByUsername”) public CommonResult getByUsername(@RequestParam String username) {

      1. User user = userService.getByUsername(username);
      2. return new CommonResult<>(user);

      }

      @PostMapping(“/update”) public CommonResult update(@RequestBody User user) {

      1. userService.update(user);
      2. return new CommonResult("操作成功", 200);

      }

      @PostMapping(“/delete/{id}”) public CommonResult delete(@PathVariable Long id) {

      1. userService.delete(id);
      2. return new CommonResult("操作成功", 200);

      } }

  1. <a name="Jkn4k"></a>
  2. ## 使用
  3. 接下来我们来介绍下Retrofit的基本使用，包括服务间调用、服务限流和熔断降级。
  4. <a name="Tq9WD"></a>
  5. ### 集成与配置
  7. - 首先在pom.xml中添加Nacos、Sentinel和Retrofit相关依赖；
  8. ```go
  9. <dependencies>
  10.     <!--Nacos注册中心依赖-->
  11.      <dependency>
  12.          <groupId>com.alibaba.cloud</groupId>
  13.          <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
  14.      </dependency>
  15.     <!--Sentinel依赖-->
  16.      <dependency>
  17.          <groupId>com.alibaba.cloud</groupId>
  18.          <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
  19.      </dependency>
  20.      <!--Retrofit依赖-->
  21.      <dependency>
  22.          <groupId>com.github.lianjiatech</groupId>
  23.          <artifactId>retrofit-spring-boot-starter</artifactId>
  24.          <version>2.2.18</version>
  25.      </dependency>
  26.  </dependencies>

  • 然后在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

  • 再添加一个Retrofit的Java配置，配置好选择服务实例的Bean即可。 ```go /**

    • Retrofit相关配置

    • Created by macro on 2022/1/26. */ @Configuration public class RetrofitConfig {

      @Bean @Autowired public ServiceInstanceChooser serviceInstanceChooser(LoadBalancerClient loadBalancerClient) {

      1. return new SpringCloudServiceInstanceChooser(loadBalancerClient);

      } }

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

Retrofit的基本使用，包括服务间调用、服务限流和熔断降级 - 图5

Retrofit的基本使用，包括服务间调用、服务限流和熔断降级 - 图6

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

Retrofit的基本使用，包括服务间调用、服务限流和熔断降级 - 图7

服务限流

  • Retrofit的限流功能基本依赖Sentinel，和直接使用Sentinel并无区别，我们创建一个测试类RateLimitController来试下它的限流功能； ```go /**

    • 限流功能

    • Created by macro on 2019/11/7. */ @Api(tags = “RateLimitController”,description = “限流功能”) @RestController @RequestMapping(“/rateLimit”) public class RateLimitController {

      @ApiOperation(“按资源名称限流，需要指定限流处理逻辑”) @GetMapping(“/byResource”) @SentinelResource(value = “byResource”,blockHandler = “handleException”) public CommonResult byResource() {

      1. return new CommonResult("按资源名称限流", 200);

      }

      @ApiOperation(“按URL限流，有默认的限流处理逻辑”) @GetMapping(“/byUrl”) @SentinelResource(value = “byUrl”,blockHandler = “handleException”) public CommonResult byUrl() {

      1. return new CommonResult("按url限流", 200);

      }

      @ApiOperation(“自定义通用的限流处理逻辑”) @GetMapping(“/customBlockHandler”) @SentinelResource(value = “customBlockHandler”, blockHandler = “handleException”,blockHandlerClass = CustomBlockHandler.class) public CommonResult blockHandler() {

      1. return new CommonResult("限流成功", 200);

      }

      public CommonResult handleException(BlockException exception){

      1. return new CommonResult(exception.getClass().getCanonicalName(),200);

      }

}

  2. - 接下来在Sentinel控制台创建一个根据资源名称进行限流的规则；
  4. ![](https://cdn.nlark.com/yuque/0/2022/webp/317882/1644990146007-daf0fcef-daf7-41f4-ad2d-6f64b0a07388.webp#clientId=uedd87311-e399-4&crop=0&crop=0&crop=1&crop=1&from=paste&id=uc996c917&margin=%5Bobject%20Object%5D&originHeight=733&originWidth=1205&originalType=url&ratio=1&rotation=0&showTitle=false&status=done&style=none&taskId=ua80bcc22-dd77-4a93-b318-e1664495d4f&title=)
  6. - 之后我们以较快速度访问该接口时，就会触发限流，返回如下信息。
  8. ![](https://cdn.nlark.com/yuque/0/2022/webp/317882/1644990146025-118ce681-da59-42e2-a80a-9aa85423c58e.webp#clientId=uedd87311-e399-4&crop=0&crop=0&crop=1&crop=1&from=paste&id=u7d0a3d2e&margin=%5Bobject%20Object%5D&originHeight=807&originWidth=1174&originalType=url&ratio=1&rotation=0&showTitle=false&status=done&style=none&taskId=u880b780a-5782-4f88-b8af-1214a0c86e9&title=)
  9. <a name="KklUg"></a>
  10. ### 熔断降级
  12. - Retrofit的熔断降级功能也基本依赖于Sentinel，我们创建一个测试类CircleBreakerController来试下它的熔断降级功能；
  13. ```go
  14. /**
  15.  * 熔断降级
  16.  * Created by macro on 2019/11/7.
  17.  */
  18. @Api(tags = "CircleBreakerController",description = "熔断降级")
  19. @RestController
  20. @RequestMapping("/breaker")
  21. public class CircleBreakerController {
  23.     private Logger LOGGER = LoggerFactory.getLogger(CircleBreakerController.class);
  24.     @Autowired
  25.     private UserService userService;
  27.     @ApiOperation("熔断降级")
  28.     @RequestMapping(value = "/fallback/{id}",method = RequestMethod.GET)
  29.     @SentinelResource(value = "fallback",fallback = "handleFallback")
  30.     public CommonResult fallback(@PathVariable Long id) {
  31.         return userService.getUser(id);
  32.     }
  34.     @ApiOperation("忽略异常进行熔断降级")
  35.     @RequestMapping(value = "/fallbackException/{id}",method = RequestMethod.GET)
  36.     @SentinelResource(value = "fallbackException",fallback = "handleFallback2", exceptionsToIgnore = {NullPointerException.class})
  37.     public CommonResult fallbackException(@PathVariable Long id) {
  38.         if (id == 1) {
  39.             throw new IndexOutOfBoundsException();
  40.         } else if (id == 2) {
  41.             throw new NullPointerException();
  42.         }
  43.         return userService.getUser(id);
  44.     }
  46.     public CommonResult handleFallback(Long id) {
  47.         User defaultUser = new User(-1L, "defaultUser", "123456");
  48.         return new CommonResult<>(defaultUser,"服务降级返回",200);
  49.     }
  51.     public CommonResult handleFallback2(@PathVariable Long id, Throwable e) {
  52.         LOGGER.error("handleFallback2 id:{},throwable class:{}", id, e.getClass());
  53.         User defaultUser = new User(-2L, "defaultUser2", "123456");
  54.         return new CommonResult<>(defaultUser,"服务降级返回",200);
  55.     }
  56. }
  • 由于我们并没有在nacos-user-service中定义id为4的用户，调用过程中会产生异常，所以访问如下接口会返回服务降级结果，返回我们默认的用户信息。

Retrofit的基本使用，包括服务间调用、服务限流和熔断降级 - 图8

总结

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