spring-cloud-openfeign

//// 请勿编辑此文件。它是自动生成的。 对此文件的手动更改将在重新生成时丢失。 请编辑 src/main/asciidoc/ 目录中的文件。 ////

image::https://github.com/spring-cloud/spring-cloud-openfeign/workflows/Build/badge.svg?branch=main&style=svg["构建",link="https://github.com/spring-cloud/spring-cloud-openfeign/actions"]

[[features]] == 特性

• 声明式REST客户端：Feign创建一个动态实现，该实现基于带有JAX-RS或Spring MVC注解的接口

[[building]] == 构建

:jdkversion: 17

[[basic-compile-and-test]] == 基本编译和测试

要构建源代码，您需要安装JDK {jdkversion}。

Spring Cloud主要使用Maven进行构建相关活动，您只需克隆感兴趣的项目并输入以下命令即可快速开始：

$ ./mvnw install

注意：您也可以自行安装Maven（>=3.3.3）并在以下示例中使用mvn命令替代./mvnw。如果这样做，您可能还需要添加-P spring参数，以防您的本地Maven设置中不包含spring预发布制品的仓库声明。

注意：请注意，您可能需要通过设置MAVEN_OPTS环境变量来增加Maven可用的内存，例如设置为-Xmx512m -XX:MaxPermSize=128m。我们尝试在.mvn配置中涵盖这一点，因此如果您发现需要这样做才能成功构建，请提交一个票据以将这些设置添加到源代码控制中。

需要中间件（如Redis）进行测试的项目通常要求安装并运行本地Docker实例。

[[documentation]] == 文档

spring-cloud-build模块有一个"docs"配置文件，如果您启用它，它将尝试使用https://docs.antora.org/antora/latest/[Antora]从`modules/ROOT/`构建asciidoc源文件。

作为该过程的一部分，它将查找docs/src/main/asciidoc/README.adoc文件并处理它，加载所有包含的内容，但不解析或渲染它，只是将其复制到${main.basedir}（默认为${basedir}，即项目根目录）。如果README中有任何更改，那么在Maven构建后，它将在正确的位置显示为修改过的文件。只需提交并推送更改即可。

[[working-with-the-code]] == 使用代码

如果您没有IDE偏好，我们建议您在使用代码时使用https://www.springsource.com/developer/sts[Spring Tools Suite]或https://eclipse.org[Eclipse]。我们使用https://eclipse.org/m2e/[m2eclipse] eclipse插件来支持maven。其他IDE和工具也应该可以正常工作，只要它们使用Maven 3.3.3或更高版本。

[[activate-the-spring-maven-profile]] === 激活Spring Maven配置文件

Spring Cloud项目需要激活'spring' Maven配置文件以解析spring里程碑和快照仓库。使用您首选的IDE将此配置文件设置为活动状态，否则可能会遇到构建错误。

[[importing-into-eclipse-with-m2eclipse]] === 使用m2eclipse导入Eclipse

在使用eclipse时，我们推荐使用https://eclipse.org/m2e/[m2eclipse] eclipse插件。如果您还没有安装m2eclipse，可以从"eclipse marketplace"获取。

注意：较旧版本的m2e不支持Maven 3.3，因此一旦将项目导入Eclipse，您还需要告诉m2eclipse为项目使用正确的配置文件。如果您看到许多与项目POM相关的不同错误，请检查您是否有最新的安装。如果无法升级m2e，请将"spring"配置文件添加到您的settings.xml中。或者，您可以将父pom中"spring"配置文件的仓库设置复制到您的settings.xml中。

[[importing-into-eclipse-without-m2eclipse]] === 不使用m2eclipse导入Eclipse

如果您不想使用m2eclipse，可以使用以下命令生成eclipse项目元数据：

[indent=0]

$ ./mvnw eclipse:eclipse

生成的eclipse项目可以通过从file菜单中选择import existing projects来导入。

[[contributing]] == 贡献

注意：Spring Cloud以非限制性的Apache 2.0许可证发布。如果您想为本文档的这一部分做出贡献，或者发现了错误，请在{github-project}[github]上的项目中查找源代码和问题跟踪器。

[[license]] == 许可证

项目许可证文件可在https://raw.githubusercontent.com/spring-cloud/spring-cloud-openfeign/main/LICENSE.txt[此处]获取。