com.github.dc.invoke.helper.RestTemplateHelper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of dc-invoke Show documentation
Show all versions of dc-invoke Show documentation
dc-invoke project for Spring Boot
package com.github.dc.invoke.helper;
import com.alibaba.fastjson2.JSON;
import com.alibaba.fastjson2.JSONObject;
import com.github.dc.invoke.aop.handler.IApiLogDataHandler;
import com.github.dc.invoke.pojo.ApiLogData;
import com.github.dc.invoke.pojo.DefaultApiLogDataHandler;
import com.github.dc.invoke.util.ApiLogSetupHelper;
import com.github.dc.invoke.util.IpAddressUtil;
import com.github.dc.invoke.util.ReflectUtil;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.io.FileUtils;
import org.apache.commons.lang3.ObjectUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.exception.ExceptionUtils;
import org.springframework.core.io.FileSystemResource;
import org.springframework.http.*;
import org.springframework.stereotype.Component;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;
import org.springframework.web.client.RequestCallback;
import org.springframework.web.client.RestTemplate;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URI;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.nio.file.StandardCopyOption;
import java.util.Arrays;
import java.util.Date;
import java.util.Map;
/**
*
* RestTemplate辅助类
*
*
* @author wangpeiyuan
* @date 2022/6/9 15:47
*/
@Component
@RequiredArgsConstructor
@Slf4j
public class RestTemplateHelper {
private final RestTemplate dcRestTemplate;
private final RestTemplate downBigFileRestTemplate;
private final RestTemplate uploadBigFileRestTemplate;
/**
* get请求
*
* @param url
* @param responseType
* @return
*/
public ResponseEntity get(String url, Class responseType) {
return dcRestTemplate.getForEntity(url, responseType);
}
/**
* get请求
*
* @param url
* @param headers
* @param responseType
* @return
*/
public ResponseEntity get(String url, HttpHeaders headers, Class responseType) {
HttpEntity> httpEntity = new HttpEntity<>(headers);
return dcRestTemplate.exchange(url, HttpMethod.GET, httpEntity, responseType);
}
/**
* 根据下载链接获取文件字节数组
*
* @param url
* @return
*/
public byte[] getBytes(String url) {
ResponseEntity response = this.getBytesForEntity(url);
if (response.getStatusCode().is2xxSuccessful()) {
return response.getBody();
}
log.warn("下载资源失败，GET {}，response: {}", url, response);
return null;
}
/**
* 根据下载链接获取文件字节数组
*
* @param url
* @param headers
* @return
*/
public byte[] getBytes(String url, HttpHeaders headers) {
ResponseEntity response = this.getBytesForEntity(url, headers);
if (response.getStatusCode().is2xxSuccessful()) {
return response.getBody();
}
log.warn("下载资源失败，GET {}，response: {}", url, response);
return null;
}
/**
* 根据下载链接获取文件字节数组并写入输出流
*
* @param url
* @param os
*/
public void getBytesToOutputStream(String url, OutputStream os) {
try {
os.write(this.getBytes(url));
} catch (IOException e) {
log.warn("下载资源失败，GET {}" + url, e);
}
}
/**
* 根据下载链接获取文件字节数组并写入输出流
*
* @param url
* @param headers
* @param os
*/
public void getBytesToOutputStream(String url, HttpHeaders headers, OutputStream os) {
try {
os.write(this.getBytes(url, headers));
} catch (IOException e) {
log.warn("下载资源失败，GET {}" + url, e);
}
}
/**
* 根据下载链接获取文件字节数组
*
* @param url
* @return
*/
public ResponseEntity getBytesForEntity(String url) {
return this.getBytesForEntity(url, new HttpHeaders());
}
/**
* 根据下载链接获取文件字节数组
*
* @param url
* @return
*/
public File getFile(String url) {
return this.getFileForEntity(url, new HttpHeaders()).getBody();
}
/**
* 根据下载链接获取文件字节数组
*
* @param url
* @return
*/
public ResponseEntity getFileForEntity(String url) {
return this.getFileForEntity(url, new HttpHeaders());
}
/**
* 根据下载链接获取文件字节数组
*
* @param url
* @param headers
* @return
*/
public ResponseEntity getFileForEntity(String url, HttpHeaders headers) {
/**
* 对响应进行流式处理而不是将其全部加载到内存中
* 设置了请求头APPLICATION_OCTET_STREAM，表示以流的形式进行数据加载
*/
headers.setAccept(Arrays.asList(MediaType.APPLICATION_OCTET_STREAM, MediaType.ALL));
HttpEntity> httpEntity = new HttpEntity<>(headers);
RequestCallback requestCallback = downBigFileRestTemplate.httpEntityCallback(httpEntity);
ApiLogSetupHelper.setFileDownload(true);
File responseFile = downBigFileRestTemplate.execute(url, HttpMethod.GET, requestCallback, clientHttpResponse -> {
File tempFile = File.createTempFile("download", ".tmp");
try (InputStream inputStream = clientHttpResponse.getBody()) {
Files.copy(inputStream, Paths.get(tempFile.getAbsolutePath()), StandardCopyOption.REPLACE_EXISTING);
}
return tempFile;
});
return ResponseEntity.ok(responseFile);
}
/**
* 根据下载链接获取文件字节数组
*
* @param url
* @param headers
* @return
*/
public ResponseEntity getBytesForEntity(String url, HttpHeaders headers) {
ResponseEntity response = this.getFileForEntity(url, headers);
try {
return ResponseEntity.ok(FileUtils.readFileToByteArray(response.getBody()));
} catch (IOException e) {
throw new RuntimeException("文件下载成功后转存到内存发生异常", e);
}
}
/**
* post x-www-form-urlencoded格式内容请求
*
* @param url 请求地址
* @param param 请求内容
* @param responseType 返回值类型
* @param
* @return 返回内容
*/
public ResponseEntity postFormUrlencoded(String url, LinkedMultiValueMap param, Class responseType) {
return this.post(url, MediaType.APPLICATION_FORM_URLENCODED, null, param, responseType);
}
/**
* post x-www-form-urlencoded格式内容请求
*
* @param url 请求地址
* @param headers 请求头
* @param param 请求内容
* @param responseType 返回值类型
* @param
* @return 返回内容
*/
public ResponseEntity postFormUrlencoded(String url, HttpHeaders headers, LinkedMultiValueMap param, Class responseType) {
return this.post(url, MediaType.APPLICATION_FORM_URLENCODED, headers, param, responseType);
}
/**
* post json格式内容请求
*
* @param url 请求地址
* @param bodyJson 请求内容json字符串
* @param responseType 返回值类型
* @param
* @return 返回内容
*/
public ResponseEntity postJson(String url, String bodyJson, Class responseType) {
return this.post(url, MediaType.APPLICATION_JSON, null, bodyJson, responseType);
}
/**
* post json格式内容请求
*
* @param url 请求地址
* @param headers 请求头
* @param bodyJson 请求内容json字符串
* @param responseType 返回值类型
* @param
* @return 返回内容
*/
public ResponseEntity postJson(String url, HttpHeaders headers, String bodyJson, Class responseType) {
return this.post(url, MediaType.APPLICATION_JSON, headers, bodyJson, responseType);
}
/**
* post form-data格式内容请求(小文件上传，大文件有OOM风险)
*
* @param url 请求地址
* @param param 请求form内容
* @param responseType 返回值类型
* @param
* @return 返回内容
*/
public ResponseEntity postFormData(String url, LinkedMultiValueMap param, Class responseType) {
return this.post(url, MediaType.MULTIPART_FORM_DATA, null, param, responseType);
}
/**
* post form-data格式内容请求(小文件上传，大文件有OOM风险)
*
* @param url 请求地址
* @param headers 请求头
* @param param 请求form内容
* @param responseType 返回值类型
* @param
* @return 返回内容
*/
public ResponseEntity postFormData(String url, HttpHeaders headers, LinkedMultiValueMap param, Class responseType) {
return this.post(url, MediaType.MULTIPART_FORM_DATA, headers, param, responseType);
}
/**
* post form-data格式内容请求(大文件上传)
*
* @param url 请求地址
* @param param 请求form内容
* @param fileParamName 请求form的文件变量名
* @param file 请求form的文件
* @param responseType 返回值类型
* @param
* @return 返回内容
*/
public ResponseEntity postFormData(String url, LinkedMultiValueMap param, String fileParamName, File file, Class responseType) {
return this.postFormData(url, null, param, fileParamName, file, responseType);
}
/**
* post form-data格式内容请求(大文件上传)
*
* @param url 请求地址
* @param headers 请求头
* @param param 请求form内容
* @param fileParamName 请求form的文件变量名
* @param file 请求form的文件
* @param responseType 返回值类型
* @param
* @return 返回内容
*/
public ResponseEntity postFormData(String url, HttpHeaders headers, LinkedMultiValueMap param, String fileParamName, File file, Class responseType) {
// 此处记录日志，避免写大文件到日志拦截器出现OOM
FileSystemResource fileResource = new FileSystemResource(file);
param.add(fileParamName, fileResource);
RequestEntity requestEntity = RequestEntity
.post(URI.create(url))
.contentType(MediaType.MULTIPART_FORM_DATA)
.accept(MediaType.ALL)
.acceptCharset(StandardCharsets.UTF_8)
.headers(headers)
.body(param);
ApiLogData apiLogData = this.recordFileUploadInvokeLogBefore(param, fileParamName, file, requestEntity);
try {
ResponseEntity response = uploadBigFileRestTemplate.postForEntity(url, requestEntity, responseType);
apiLogData = this.recordFileUploadInvokeLogReturn(apiLogData, response);
return response;
} catch (Throwable e) {
apiLogData = this.recordFileUploadInvokeLogException(apiLogData, e);
throw e;
} finally {
this.recordFileUploadInvokeLogFinally(apiLogData);
}
}
/**
* post请求
*
* @param url 请求地址
* @param contentType 请求contentType
* @param body 请求body 根据contenType不同，类型不同
* @param responseType 返回值类型
* @param
* @param
* @return 返回内容
*/
public ResponseEntity post(String url, MediaType contentType, B body, Class responseType) {
return this.post(url, contentType, null, body, responseType);
}
/**
* post请求
*
* @param url 请求地址
* @param contentType 请求contentType
* @param headers 请求头
* @param body 请求body 根据contenType不同，类型不同
* @param responseType 返回值类型
* @param
* @param
* @return 返回内容
*/
public ResponseEntity post(String url, MediaType contentType, HttpHeaders headers, B body, Class responseType) {
RequestEntity requestEntity = RequestEntity
.post(url)
.contentType(contentType)
.accept(MediaType.ALL)
.acceptCharset(StandardCharsets.UTF_8)
.headers(headers)
.body(body);
return dcRestTemplate.postForEntity(url, requestEntity, responseType);
}
/**
* delete请求
*
* @param url 请求地址
*/
public void delete(String url) {
dcRestTemplate.delete(url);
}
/**
* delete请求
*
* @param url 请求地址
* @param headers 请求头
* @return 返回内容
*/
public void delete(String url, HttpHeaders headers) {
HttpEntity> httpEntity = new HttpEntity<>(headers);
dcRestTemplate.exchange(url, HttpMethod.DELETE, httpEntity, void.class);
}
/**
* delete请求
*
* @param url 请求地址
* @param responseType 返回类型
* @param
* @return 返回内容
*/
public ResponseEntity delete(String url, Class responseType) {
RequestEntity requestEntity = RequestEntity
.delete(url)
.accept(MediaType.ALL)
.acceptCharset(StandardCharsets.UTF_8)
.build();
return dcRestTemplate.exchange(requestEntity, responseType);
}
/**
* delete请求
*
* @param url 请求地址
* @param headers 请求头
* @param responseType 返回类型
* @param
* @return 返回内容
*/
public ResponseEntity delete(String url, HttpHeaders headers, Class responseType) {
RequestEntity requestEntity = RequestEntity
.delete(url)
.accept(MediaType.ALL)
.acceptCharset(StandardCharsets.UTF_8)
.headers(headers)
.build();
return dcRestTemplate.exchange(requestEntity, responseType);
}
/**
* put x-www-form-urlencoded格式内容请求
*
* @param url 请求地址
* @param param 请求内容
* @param responseType 返回值类型
* @param
* @return 返回内容
*/
public ResponseEntity putFormUrlencoded(String url, LinkedMultiValueMap param, Class responseType) {
return this.put(url, MediaType.APPLICATION_FORM_URLENCODED, null, param, responseType);
}
/**
* put x-www-form-urlencoded格式内容请求
*
* @param url 请求地址
* @param headers 请求头
* @param param 请求内容
* @param responseType 返回值类型
* @param
* @return 返回内容
*/
public ResponseEntity putFormUrlencoded(String url, HttpHeaders headers, LinkedMultiValueMap param, Class responseType) {
return this.put(url, MediaType.APPLICATION_FORM_URLENCODED, headers, param, responseType);
}
/**
* put json格式内容请求
*
* @param url 请求地址
* @param bodyJson 请求内容json字符串
* @param responseType 返回值类型
* @param
* @return 返回内容
*/
public ResponseEntity putJson(String url, String bodyJson, Class responseType) {
return this.put(url, MediaType.APPLICATION_JSON, null, bodyJson, responseType);
}
/**
* put json格式内容请求
*
* @param url 请求地址
* @param headers 请求头
* @param bodyJson 请求内容json字符串
* @param responseType 返回值类型
* @param
* @return 返回内容
*/
public ResponseEntity putJson(String url, HttpHeaders headers, String bodyJson, Class responseType) {
return this.put(url, MediaType.APPLICATION_JSON, headers, bodyJson, responseType);
}
/**
* put form-data格式内容请求
*
* @param url 请求地址
* @param param 请求form内容
* @param responseType 返回值类型
* @param
* @return 返回内容
*/
public ResponseEntity putFormData(String url, LinkedMultiValueMap param, Class responseType) {
return this.put(url, MediaType.MULTIPART_FORM_DATA, null, param, responseType);
}
/**
* put form-data格式内容请求
*
* @param url 请求地址
* @param headers 请求头
* @param param 请求form内容
* @param responseType 返回值类型
* @param
* @return 返回内容
*/
public ResponseEntity putFormData(String url, HttpHeaders headers, LinkedMultiValueMap param, Class responseType) {
return this.put(url, MediaType.MULTIPART_FORM_DATA, headers, param, responseType);
}
/**
* put form-data格式内容请求
*
* @param url 请求地址
* @param param 请求form内容
* @param fileParamName 请求form的文件变量名
* @param file 请求form的文件
* @param responseType 返回值类型
* @param
* @return 返回内容
*/
public ResponseEntity putFormData(String url, LinkedMultiValueMap param, String fileParamName, File file, Class responseType) {
FileSystemResource fileResource = new FileSystemResource(file);
param.add(fileParamName, fileResource);
return this.put(url, MediaType.MULTIPART_FORM_DATA, null, param, responseType);
}
/**
* put form-data格式内容请求
*
* @param url 请求地址
* @param headers 请求头
* @param param 请求form内容
* @param fileParamName 请求form的文件变量名
* @param file 请求form的文件
* @param responseType 返回值类型
* @param
* @return 返回内容
*/
public ResponseEntity putFormData(String url, HttpHeaders headers, LinkedMultiValueMap param, String fileParamName, File file, Class responseType) {
FileSystemResource fileResource = new FileSystemResource(file);
param.add(fileParamName, fileResource);
return this.put(url, MediaType.MULTIPART_FORM_DATA, headers, param, responseType);
}
/**
* put请求
*
* @param url 请求地址
* @param contentType 请求contentType
* @param body 请求body 根据contenType不同，类型不同
* @param responseType 返回值类型
* @param
* @param
* @return 返回内容
*/
public ResponseEntity put(String url, MediaType contentType, B body, Class responseType) {
return this.put(url, contentType, null, body, responseType);
}
/**
* put请求
*
* @param url 请求地址
* @param contentType 请求contentType
* @param headers 请求头
* @param body 请求body 根据contenType不同，类型不同
* @param responseType 返回值类型
* @param
* @param
* @return 返回内容
*/
public ResponseEntity put(String url, MediaType contentType, HttpHeaders headers, B body, Class responseType) {
RequestEntity requestEntity = RequestEntity
.put(url)
.contentType(contentType)
.accept(MediaType.ALL)
.acceptCharset(StandardCharsets.UTF_8)
.headers(headers)
.body(body);
return dcRestTemplate.exchange(requestEntity, responseType);
}
/**
* 实例，用于调用原有未封装的方法
*
* @return
*/
public RestTemplate instance() {
return this.dcRestTemplate;
}
private ApiLogData recordFileUploadInvokeLogBefore(LinkedMultiValueMap param, String fileParamName, File file, RequestEntity requestEntity) {
URI uri = requestEntity.getUrl();
if (log.isTraceEnabled()) {
log.trace("=========>>>> start 接口请求>>>> {} \"{}\", headers: {}, body: {}, 文件名：{}, 文件大小：{}", requestEntity.getMethod(),
uri, requestEntity.getHeaders(), param, file.getName(), FileUtils.byteCountToDisplaySize(file.length()));
}
Object businessKey = ApiLogSetupHelper.getBusinessKey();
String apiCode = ApiLogSetupHelper.getApiCode();
String apiDesc = ApiLogSetupHelper.getApiDesc();
Map context = ApiLogSetupHelper.getContext();
String ip = IpAddressUtil.getIp();
String contentType = ObjectUtils.defaultIfNull(requestEntity.getHeaders().getContentType(), "").toString();
LinkedMultiValueMap body = param.deepCopy();
body.put(fileParamName, Arrays.asList(file.getName(), FileUtils.byteCountToDisplaySize(file.length())));
return ApiLogData.builder()
.businessKey(businessKey)
.apiCode(StringUtils.defaultIfBlank(apiCode, "缺省"))
.apiDesc(StringUtils.defaultIfBlank(apiDesc, "缺省"))
.url(uri.getScheme() + "://" + uri.getAuthority() + uri.getPath())
.method(String.valueOf(requestEntity.getMethod()))
.ip(ip)
.requestHeaders(JSON.toJSONString(requestEntity.getHeaders()))
.requestQuery(uri.getQuery())
.requestBody(JSON.toJSONString(body))
.requestContentType(contentType)
.isInner(false)
.requestDate(new Date())
.context(context)
.consumeTime(System.currentTimeMillis())
.build();
}
private ApiLogData recordFileUploadInvokeLogReturn(ApiLogData apiLogData, ResponseEntity response) {
String responseContent = null;
if (response.getBody() instanceof String || response.getBody() instanceof Number || response.getBody() instanceof Boolean) {
responseContent = response.getBody().toString();
} else {
responseContent = JSON.toJSONString(response.getBody());
}
if (log.isTraceEnabled()) {
log.trace("=========<<<< end 接口请求<<<< 耗时: {}ms {}, {} \"{}\" 返回body: {}", (System.currentTimeMillis() - apiLogData.getConsumeTime()),
response.getStatusCode(), apiLogData.getMethod(), apiLogData.getUrl(), responseContent);
}
apiLogData = apiLogData.toBuilder()
.isSuccess(response.getStatusCode().is2xxSuccessful())
.responseContent(responseContent)
.responseCode(response.getStatusCode().toString())
.responseHeaders(JSONObject.toJSONString(response.getHeaders()))
.build();
return apiLogData;
}
private ApiLogData recordFileUploadInvokeLogException(ApiLogData apiLogData, Throwable e) {
apiLogData = apiLogData.toBuilder()
.isSuccess(false)
.exceptionStack(StringUtils.join(ExceptionUtils.getRootCauseStackTrace(e), StringUtils.LF))
.build();
return apiLogData;
}
private void recordFileUploadInvokeLogFinally(ApiLogData apiLogData) {
Class logHandler = ApiLogSetupHelper.getHandler();
try {
apiLogData = apiLogData.toBuilder()
.consumeTime(System.currentTimeMillis() - apiLogData.getConsumeTime())
.build();
IApiLogDataHandler handler = this.getHandler(logHandler);
handler.handle(apiLogData);
} catch (Exception e) {
log.warn("接口日志记录异常", e);
} finally {
ApiLogSetupHelper.clear();
}
}
/**
* 获取处理器，优先从获取spring bean，如没有则是单纯的对象，不含注入bean
* @param handleClazz 处理器class
* @return 处理器
*/
public IApiLogDataHandler getHandler(Class handleClazz) {
if (handleClazz == null) {
return new DefaultApiLogDataHandler();
}
IApiLogDataHandler apiLogDataHandler = ApplicationContextHelper.getBean(handleClazz);
if (apiLogDataHandler != null) {
return apiLogDataHandler;
}
return ReflectUtil.instance(handleClazz);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy