從RestTemplate到Feign精簡之路

前言

SpringCloud 中，默認是使用HTTP進行微服務間通信，其中最常用的有兩種實現形式。主要是RestTemplate和Feign。在SpringWeb裏面，已經原生支持了 RestTemplate，只不過我們一般使用的是把請求URL直接寫死，而不是通過服務名的形式來調用，但是在微服務架構中，因爲註冊中心的存在，我們的負載均衡可以不需要使用第三方軟件或者硬件實現了，所以，我們最佳的方式是經過服務名訪問，請求到那個實例，由 Ribbon 的負載均衡策略來替我們決定。這時候RestTemplate漸漸不適合這種通過域名訪問的形式了，下面介紹下從RestTemplate到Feign的演變過程。便於我們理解爲啥現在服務中用的都是Feign,而不是RestTemplate。

階段一

 @GetMapping("/RibbonServer/1")
    public Map getRibbonServer1() {
        // 新建對象
        RestTemplate restTemplate = new RestTemplate();
        //請求目標地址
        String requestMsg = "方式一 GET 請求 RibbonServer";
        Map response = restTemplate.getForObject("http://localhost:9999/RibbonServer/RibbonTest?requestMsg="
 + requestMsg, Map.class);
        log.info("response={}", response);
        return response;
    }
    
    @PostMapping("/RibbonServer/1")
    public Map postRibbonServer1() {
        // 新建對象
        RestTemplate restTemplate = new RestTemplate();
        //請求目標地址
        String requestMsg = "方式一 POST 請求 RibbonServer";
        Map<String, Object> requestParam = new HashMap<>(16);
        requestParam.put("requestMsg", requestMsg);
        Map response = restTemplate.postForObject("http://localhost:9999/RibbonServer/RibbonTest", 
requestParam, Map.class);
        log.info("response={}", response);
        return response;
    }

直接使用 RestTemplate , Url寫死。

階段二

  @Autowired
    private LoadBalancerClient loadBalancerClient;
    
    @GetMapping("/RibbonServer/2")
    public Map getRibbonServer2() {
        // 獲取IP地址
        ServiceInstance choose = loadBalancerClient.choose("RIBBON-SERVER");
        String requestMsg = "方式二 GET 請求 RibbonServer";
        String url = String.format("http://%s:%s", choose.getHost(), choose.getPort() + 
        "/RibbonServer/RibbonTest?requestMsg=" + requestMsg);
        RestTemplate restTemplate = new RestTemplate();
        Map response = restTemplate.getForObject(url, Map.class);
        log.info("response={}", response);
        return response;
    }
    
    @PostMapping("/RibbonServer/2")
    public Map postRibbonServer2() {
        // 獲取IP地址
        ServiceInstance choose = loadBalancerClient.choose("RIBBON-SERVER");
        // 組裝URL
        String url = String.format("http://%s:%s", choose.getHost(), choose.getPort() + 
        "/RibbonServer/RibbonTest");
        RestTemplate restTemplate = new RestTemplate();
        String requestMsg = "方式二 POST 請求 RibbonServer";
        Map<String, Object> requestParam = new HashMap<>(16);
        requestParam.put("requestMsg", requestMsg);
        Map response = restTemplate.postForObject(url, requestParam, Map.class);
        log.info("response={}", response);
        return response;
    }

利用 LoadBalancerClient 通過應用名獲取 url，然後再使用 RestTemplate 請求。

階段三

import org.springframework.cloud.client.loadbalancer.LoadBalanced;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;
import org.springframework.web.client.RestTemplate;

@Component
public class RestTemplateConfig {

    @Bean
    @LoadBalanced //添加該註解，可以直接通過服務名找到對應的IP地址
    public RestTemplate restTemplate() {

        return new RestTemplate();
    }
}

RestTemplate配置類，加上 @LoadBalanced，這樣在服務調用的時候，就可以在 RestTemplate 裏面直接使用應用名字 

 @Autowired
    private RestTemplate restTemplate;
    
    @GetMapping("/RibbonServer/3")
    public Map getRibbonServer3() {
        String requestMsg = "方式三 GET 請求 RibbonServer";
        Map response = restTemplate.getForObject("http://RIBBON-SERVER/RibbonServer/RibbonTest?
        requestMsg=" + requestMsg, Map.class);
        log.info("response={}", response);
        return response;
    }
    
    @PostMapping("/RibbonServer/3")
    public Map postRibbonServer3() {
        String requestMsg = "方式三 POST 請求 RibbonServer";
        Map response = restTemplate.postForObject("http://RIBBON-SERVER/RibbonServer/RibbonTest",
         getRequestParam(requestMsg), Map.class);
        log.info("response={}", response);
        return response;
    }

階段四

Feign 是 Netflix 開發的聲明式、模板化的 HTTP客戶端, Feign 可以幫助我們更快捷、優雅地調用 HTTP API

• 導入 OpenFeign 的包(SpringCloud2以後，Feign改名爲OpenFeign)

<!--可以不導入ribbon，因爲feign裏面依賴了ribbon-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

• 啓動類添加 @EnableFeignClients

@SpringBootApplication
@EnableFeignClients
public class SpringCloudRibbonClientApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringCloudRibbonClientApplication.class, args);
    }
}

• 寫一個接口，用來調用指定的微服務(可以由接口提供方寫好SDK，我們直接調用)

@FeignClient(name = "ribbon-server") //調用的服務名
public interface RibbonServerClient {
    /**
     * 測試請求 RibbonServer
     * @Method: GET
     * @author show
     * @date 16:26 2019/6/9
     * @param requestMsg 接口請求參數
     * @return java.util.Map 接口返回值，建議用對象接收
     */
    @GetMapping("/RibbonServer/RibbonTest")
    Map getRibbonServer(@RequestParam("requestMsg") String requestMsg);

    /**
     * 測試請求 RibbonServer
     * @Method: POST
     * @author show
     * @date 16:26 2019/6/9
     * @param requestMsg 接口請求參數
     * @return java.util.Map 接口返回值，建議用對象接收
     */
    @PostMapping("/RibbonServer/RibbonTest")
    Map PostRibbonServer(@RequestBody Map requestMsg);
}

• 利用Spring的依賴注入，直接調用該接口方法，即可調用到 ribbon-server 服務的接口

@RestController
@RequestMapping("/Feign")
@Slf4j
public class FeignController {
    @Autowired
    private RibbonServerClient ribbonServerClient;

    /**
     * Feign 訪問微服務測試
     * @author show
     * @date 16:42 2019/6/9
     * @return java.util.Map
     */
    @GetMapping("/RibbonServer")
    public Map getRibbonServer() {
        String requestMsg = "Feign GET 請求 RibbonServer";
        Map response = ribbonServerClient.getRibbonServer(requestMsg);
        log.info("response={}", response);
        return response;
    }

    /**
     * Feign 訪問微服務測試
     * @author show
     * @date 16:42 2019/6/9
     * @return java.util.Map
     */
    @PostMapping("/RibbonServer")
    public Map postRibbonServer1() {
        String requestMsg = "Feign Post 請求 RibbonServer";
        Map<String, Object> map = new HashMap<>(16);
        map.put("requestMsg", requestMsg);
        Map response = ribbonServerClient.PostRibbonServer(map);
        log.info("response={}", response);
        return response;
    }
}

在實際項目中，Feign調用的入參，返回結果可以自己封裝成DTO，不需要用Map。可以結合自己項目中的實際使用。

原文鏈接

https://www.jianshu.com/p/b64451435126