Feign 开源项目安装与使用指南

Feign 开源项目安装与使用指南

feignFeign makes writing java http clients easier项目地址:https://gitcode.com/gh_mirrors/fe/feign

目录结构概览

在克隆或下载Feign项目之后, 你会看到以下主要目录和文件:

• src: 主要代码源目录

  • main: 包含编译资源的主要源代码目录
    • java: Java源码所在位置, 这里是Feign的主要实现部分.
  • test: 测试资源和测试代码的位置.

• pom.xml: Maven项目构建文件. 它包含了所有依赖, 插件以及项目的其他元数据.

此外还有一些额外的工具脚本和文件, 如.gitignore, .travis.yml等用于持续集成(CI), 版本控制等.

启动与运行

Feign本身并不是一个可独立运行的应用程序, 而是一套用于创建HTTP客户端的库. 因此没有特定的“启动”过程. 但在你的项目中引入并使用Feign十分简单:

添加Maven依赖

在你的Maven工程中添加Feign依赖到pom.xml:

<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-core</artifactId>
    <version>版本号(例如: 12.3)</version>
</dependency>

或者如果你选择使用BOM来管理Feign及其依赖项的版本, 可以这样做:

<!-- 在dependencyManagement标签内 -->
<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-bom</artifactId>
    <version>版本号(例如: 12.3)</version>
    <type>pom</type>
    <scope>import</scope>
</dependency>

创建接口定义

Feign通过注解API接口来进行调用:

@FeignClient(name="name")
public interface YourService {
  
  @RequestLine("GET /users/{id}")
  User getUser(@Param("id") String id);
}

然后你可以像下面这样注入和使用:

@Autowired
private YourService service;
...
User user = service.getUser(userId);

配置说明

使用application.yml 或 application.properties进行配置

Feign可以通过Spring Boot自动配置. 在你的application.yml或application.properties中添加以下示例配置:

spring:
  cloud:
    openfeign:
      feignclients.default:
        config:
          feignclientconfig:
            connectTimeout: 5000
            readTimeout: 5000

或者在.properties文件中:

spring.cloud.openfeign.feignclients.default.config.feignclientconfig.connectTimeout=5000
spring.cloud.openfeign.feignclients.default.config.feignclientconfig.readTimeout=5000

以上指导应该能帮助你在自己的项目中顺利地集成并使用Feign!

feignFeign makes writing java http clients easier项目地址:https://gitcode.com/gh_mirrors/fe/feign