SpringCloud OpenFeign基本介紹與實現示例

Posted on by

介紹

  在上面一篇介紹Nacos的文章最後，兩個服務的相互調用是用的RestTemplate類完成的。但這種方式不是很推薦，更佳的方式是用OpenFeign組件去調用。OpenFeign是官方推出的服務調用和負載均衡組件，基於Ribbon和Hystrix，前身是第一代Spring Cloud的Feign，對Feign進行瞭擴展，支持瞭SpringMvc的相關註解。

常用註解

  OpenFeign是使用接口+註解實現的，因此瞭解它的常用註解是必要的，有以下幾個：

@EnableFeignClients：在啟動類上添加，用於開啟OpenFeign功能。當項目啟動時，會掃描帶有@FeignClient的接口，生成代理類並註冊到Spring容器中

@FeignClient：通知OpenFeign組件對該註解下的接口進行解析，通過動態代理的方式產生實現類，完成服務調用

@RequestMapping：SpringMvc中的註解，不過此時該註解表示發起Request請求(默認Get方式)

@GetMapping：SpringMvc中的註解，不過此時該註解表示發起Get請求

@PostMapping：SpringMvc中的註解，不過此時該註解表示發起Post請求

代碼實現

  首先得把Nacos啟動

  服務提供方，

  bootstrap.yml：

server:
  port: 8083
  servlet:
    context-path: /nacosProvider

spring:
  application:
    name: nacos-provider
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848

  引入依賴：

<dependencies>
    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-discovery
        </artifactId>
        <version>2.2.0.RELEASE</version>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
    </dependency>
</dependencies>

  服務方法：

@Controller
@RequestMapping("/provide")
public class ProviderController {
    @RequestMapping("/distribute")
    @ResponseBody
    public String distribute() {
        return "吃雞胸肉";
    }
    @RequestMapping("/distribute1")
    @ResponseBody
    public String distribute1(String name, Integer age) {
        return "姓名：" + name + "，年齡：" + age;
    }
    @PostMapping("/distribute2")
    @ResponseBody
    public String distribute2(@RequestBody Person p) {
        return "身高：" + p.getHeight() + "，膚色：" + p.getSkin();
    }
}

import lombok.Data;
@Data
public class Person {
    private Integer height;
    private String skin;
}

  服務調用方，

  bootstrap.yml

server:
  port: 8082
  servlet:
    context-path: /nacosInvoke

spring:
  application:
    name: nacos-invoke
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848

  引入依賴：

<dependencies>
    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-discovery
        </artifactId>
        <version>2.2.0.RELEASE</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-openfeign</artifactId>
        <version>2.2.0.RELEASE</version>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
    </dependency>
</dependencies>

  啟動類上添加註解：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.openfeign.EnableFeignClients;
//開啟OpenFeign
@EnableFeignClients
@SpringBootApplication
public class NacosInvokeApplication {
    public static void main(String[] args) {
        SpringApplication.run(NacosConfigApplication.class, args);
    }
}

  創建@FeignClient修飾的接口：

import com.gs.nacos_invoke.dto.Person;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestParam;
/**
 * value值是服務提供方的服務名稱
 */
@FeignClient(value = "nacos-provider")
public interface InvokeClient {
    @GetMapping("/nacosProvider/provide/distribute")
    String distribute();
    @GetMapping("/nacosProvider/provide/distribute1")
    String distribute1(@RequestParam("name") String name, 
    @RequestParam("age") Integer age);
    @PostMapping("/nacosProvider/provide/distribute2")
    String distribute2(@RequestBody Person p);
}

  Person類(服務調用方再創建一個，不是同一個)：

import lombok.Data;
@Data
public class Person {
    private Integer height;
    private String skin;
}

  編寫控制器，使用接口請求提供方的服務：

import com.gs.nacos_invoke.dto.Person;
import com.gs.nacos_config.feign.InvokeClient;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
@RequestMapping("/user")
public class UserController {
    @Autowired
    private InvokeClient invokeClient;
    @GetMapping("/invoke")
    public void invoke(String name, Integer age) {
        String str = invokeClient.distribute();
        System.out.println(str);
    }
    @GetMapping("/invoke1")
    public void invoke1() {
        String str = invokeClient.distribute1("coder", 20);
        System.out.println(str);
    }
    @GetMapping("/invoke2")
    public void invoke2() {
        Person p = new Person();
        p.setHeight(183);
        p.setSkin("黃皮膚");
        String s = invokeClient.distribute2(p);
        System.out.println(s);
    }
}

註意事項

  OpenFeign是基於Ribbon的，所以它默認是負載均衡的。其次，它也是基於Hystrix的，有超時降級的處理：默認服務提供方的接口超時時間是1s，超過1s服務調用方會報錯。1s是可以配置的，按照業務需要調整。@FeignClient註解有個fallback屬性，當該屬性有值時，服務提供方超時，會返回程序所指定的降級值。

  服務調用方，bootstrap.yml添加(更規范的做法是引入spring-cloud-starter-alibaba-nacos-config依賴，nacos中新建配置，然後在這個配置中添加)：

feign:
  hystrix:
    enabled: true
ribbon:
    # 請求連接的超時時間
    ConnectionTimeout: 3000
    # 請求處理的超時時間
    ReadTimeout: 3000

hystrix:
    command:
        default:
            execution:
                isolation:
                    thread:
                        timeoutInMilliseconds: 3000

  接口修改為：

import com.gs.nacos_invoke.dto.Person;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestParam;
@FeignClient(value = "nacos-provider",
        fallback = InvokeClientFallback.class)
public interface InvokeClient {
    @GetMapping("/nacosProvider/provide/distribute")
    String distribute();
    @GetMapping("/nacosProvider/provide/distribute1")
    String distribute1(@RequestParam("name") String name, 
    @RequestParam("age") Integer age);
    @PostMapping("/nacosProvider/provide/distribute2")
    String distribute2(@RequestBody Person p);
}

  fallback指定的類：

import com.gs.nacos_invoke.dto.Person;
import org.springframework.stereotype.Component;
@Component
public class InvokeClientFallback implements InvokeClient {
    @Override
    public String distribute() {
        return "超時3s";
    }
    @Override
    public String distribute1(String name, Integer age) {
        return "超時3s";
    }
    @Override
    public String distribute2(Person p) {
        return "超時3s";
    }
}

  服務提供方ProviderController類的方法中，加入Thread.sleep(4000);或者throw new RuntimeException("拋異常");來觸發降級(拋出未捕獲的異常也能觸發)。

到此這篇關於SpringCloud OpenFeign基本介紹與實現示例的文章就介紹到這瞭,更多相關SpringCloud OpenFeign內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：