|
在日常开发中，经常会用到请求第三方接口的方式，在C#中使用的是HttpClient的方式发起请求，如果在Java中，则需要使用FeignClient的方式来进行请求接口。
本次主要以两种方式使用Feign进行接口访问请求
引用Meven包：Maven: org.springframework.cloud:spring-cloud-openfeign-core:3.0.3
pom.xml文件中添加引用：
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
<version>3.0.3</version>
</dependency>
一、直接请求第三方接口。此方式请求需要自定义传入实体和返回实体。
application.properties文件中添加配置：
# 统一日志记录接口API
ms.service.adminlog.name=ms-service-adminlog
ms.service.adminlog.url=http://service-adminlog.test.com
FeignClient请求具体代码：
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.cloud.openfeign.FallbackFactory;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.PostMapping;
/**
* 后台日志记录 API Client
*
* @author suxuelian
*/
@FeignClient(value = "${ms.service.adminlog.name}-log", url = "${ms.service.adminlog.url}"
, fallbackFactory = AdminOperationLogApiClientFallbackFactory.class)
public interface AdminOperationLogApiClient {
@PostMapping(value = "/api/adminlog/SaveOperationLog")
ApiResult<String> saveAdminOperationLog(SaveOperationLogReqDTO reqDTO);
}
@Component
class AdminOperationLogApiClientFallbackFactory implements FallbackFactory<AdminOperationLogApiClient> {
private static final AdminOperationLogApiClient ADMIN_OPERATION_LOG_API_CLIENT = new AdminOperationLogApiClient() {
@Override
public ApiResult<String> saveAdminOperationLog(SaveOperationLogReqDTO reqDTO) {
return null;
}
};
private final Logger logger = LogManager.getLogger(AdminOperationLogApiClientFallbackFactory.class);
@Override
public AdminOperationLogApiClient create(Throwable cause) {
LogTrace groupIdLogTrace = new LogTrace( "", "AdminOperationLogApiClientFallbackFactory");
groupIdLogTrace.setError(cause);
return ADMIN_OPERATION_LOG_API_CLIENT;
}
}
/**
* 新增日志记录 Request DTO
*
* @author suxuelian
*/
@Data
@Accessors(chain = true)
public class SaveOperationLogReqDTO {
/**
* 统一用户中心ID
*/
@ApiModelProperty("统一用户中心ID")
private Integer centerUserId;
/**
* 新内容（当操作类型为编辑、删除、审核时需要填写）
*/
@ApiModelProperty("新内容（当操作类型为编辑、删除、审核时需要填写）")
private String newContent;
/**
* 老内容（当操作类型为编辑、删除、审核时需要填写）
*/
@ApiModelProperty("老内容（当操作类型为编辑、删除、审核时需要填写）")
private String oldContent;
/**
* 操作类型 (1:查看 2：添加 4：编辑 8：删除 16：审核 32：搜索 64：特权)
*/
@ApiModelProperty("操作类型 (1:查看 2：添加 4：编辑 8：删除 16：审核 32：搜索 64：特权)")
private Integer powerType;
/**
}
在使用过程中，如果发现了缺少Meven，请自行引用。
二、第二种方式是引用包的方式请求，虽然同样需要配置请求地址，但是不用重复在项目中编写请求参数和返回参数，从一定程度上减轻了工作量。
首先需要在pom.xml文件中引用需要使用的项目及对应的包，大概引用方式如下：
<properties>
<test_adminlog.api.version>1.0.0</test_adminlog.api.version>
</properties>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.myapi</groupId>
<artifactId>service-admin-log-api-contract</artifactId>
<version>${test_adminlog.api.version}</version>
</dependency>
</dependencies>
</dependencyManagement>
application.properties文件中依然要添加接口地址，配置方式如方法一中的配置方式
具体代码编写方式如下：
import com.hualv.bigdataframework.common.pojo.ApiResult;
import com.hualv.bigdataframework.common.utils.log.LogTrace;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.cloud.openfeign.FallbackFactory;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.stereotype.Component;
import javax.validation.Valid;
import 这是需要引用刚刚在pom文件中设置的项目代码命名空间
/**
* 订单投诉 API Client
*
* @author suxuelian
*/
@FeignClient(value = "${ms.service.adminlog.name}", url = "${ms.service.adminlog.url}"
, fallbackFactory = OrderComplaintApiClientFallbackFactory.class, path = "/api")
public interface OrderComplaintApiClient extends OrderComplaintApi {
//OrderComplaintApi 这里的此类就是需要引用的包中的接口类
}
@Component
class OrderComplaintApiClientFallbackFactory implements FallbackFactory<OrderComplaintApi> {
private static final OrderComplaintApi ORDER_API_CLIENT_FALLBACK_FACTORY = new OrderComplaintApi() {
@Override
public ApiResult<String> insertComplaint(@Valid ComplaintAddReqDto complaintAddReqDto) {
return null;
}
};
private final Logger logger = LogManager.getLogger(OrderComplaintApiClientFallbackFactory.class);
@Override
public OrderComplaintApi create(Throwable cause) {
LogTrace groupIdLogTrace = new LogTrace( "", "OrderComplaintApiClientFallbackFactory");
groupIdLogTrace.setError(cause);
logger.info(LogTrace.BIZ_TRACE_MARKER, groupIdLogTrace);
return ORDER_API_CLIENT_FALLBACK_FACTORY;
}
}
以上是在开发中使用过FeignClient的两种使用方式，变标不变本，一般情况，使用第一种方式即可，第二种在协同开发时需要注意信息同步的及时性，否则容易经常发生报错的情况。
欢迎各位大佬指出其中的不足，在开发中的日常积累，或许不够完美，希望能帮助到需要的码友。
精选文案|一点一点去靠近梦想，不抱侥幸的奢望，用踏实浇灌，用努力证明，你可以！
|