SpringBoot 调用外部接口的四种方式

原文：

blog.csdn.net/Chelsea__/article/details/126689495

1、简介

SpringBoot不仅继承了Spring框架原有的优秀特性，而且还通过简化配置来进一步简化了Spring应用的整个搭建和开发过程。在Spring-Boot项目开发中，存在着本模块的代码需要访问外面模块接口，或外部url链接的需求, 比如在apaas开发过程中需要封装接口在接口中调用apaas提供的接口（像发起流程接口submit等等）下面也是提供了四种方式（不使用dubbo的方式）供我们选择

2、方式一：使用原始httpClient请求

/* * @description get方式获取入参，插入数据并发起流程 * @params documentId * @return String *///@RequestMapping("/submit/{documentId}")public String submit1(@PathVariable String documentId) throws ParseException {    //此处将要发送的数据转换为json格式字符串    Map<String,Object> map =task2Service.getMap(documentId);    String jsonStr = JSON.toJSONString(map, SerializerFeature.WRITE_MAP_NULL_FEATURES,SerializerFeature.QuoteFieldNames);    JSONObject jsonObject = JSON.parseObject(jsonStr);    JSONObject sr = task2Service.doPost(jsonObject);    return sr.toString();}

/* * @description 使用原生httpClient调用外部接口 * @params date * @return JSONObject */public static JSONObject doPost(JSONObject date) {    String assessToken="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.……";    CloseableHttpClient client = HttpClients.createDefault();    // 要调用的接口url    String url = "http://127.0.0.1:30661/xdap-open/open/process/v1/submit";    HttpPost post = new HttpPost(url);    JSONObject jsonObject = null;    try {        //创建请求体并添加数据        StringEntity s = new StringEntity(date.toString());        //此处相当于在header里头添加content-type等参数        s.setContentType("application/json");        s.setContentEncoding("UTF-8");        post.setEntity(s);        //此处相当于在Authorization里头添加Bear token参数信息        post.addHeader("Authorization", "Bearer " +assessToken);        HttpResponse res = client.execute(post);        String response1 = EntityUtils.toString(res.getEntity());        if (res.getStatusLine()                .getStatusCode() == HttpStatus.SC_OK) {            // 返回json格式：            String result = EntityUtils.toString(res.getEntity());            jsonObject = JSONObject.parseObject(result);        }    } catch (Exception e) {        throw new RuntimeException(e);    }    return jsonObject;}

3、方式二：使用RestTemplate方法

Spring-Boot开发中，RestTemplate同样提供了对外访问的接口API，这里主要介绍Get和Post方法的使用。

Get请求

提供了getForObject 、getForEntity两种方式，其中getForEntity如下三种方法的实现：

Get--getForEntity，存在以下两种方式重载

1、getForEntity(Stringurl,Class responseType,Object…urlVariables)2、getForEntity(URI url,Class responseType)

Get--getForEntity(URI url,Class responseType)

//该方法使用URI对象来替代之前的url和urlVariables参数来指定访问地址和参数绑定。URI是JDK java.net包下的一个类，表示一个统一资源标识符(Uniform Resource Identifier)引用。参考如下：RestTemplate restTemplate=new RestTemplate();UriComponents uriComponents=UriComponentsBuilder.fromUriString("http://USER-SERVICE/user?name={name}").build().expand("dodo").encode();URI uri=uriComponents.toUri();ResponseEntityresponseEntity=restTemplate.getForEntity(uri,String.class).getBody();

Get--getForEntity(Stringurl,Class responseType,Object…urlVariables)

//该方法提供了三个参数，其中url为请求的地址，responseType为请求响应body的包装类型，urlVariables为url中的参数绑定，该方法的参考调用如下：// http://USER-SERVICE/user?name={name)RestTemplate restTemplate=new RestTemplate();Mapparams=new HashMap<>();params.put("name","dada"); //ResponseEntityresponseEntity=restTemplate.getForEntity("http://USERSERVICE/user?name={name}",String.class,params);

Get--getForObject，存在以下三种方式重载

1、getForObject(String url,Class responseType,Object...urlVariables)2、getForObject(String url,Class responseType,Map urlVariables)3、getForObject(URI url,Class responseType)

getForObject方法可以理解为对getForEntity的进一步封装，它通过HttpMessageConverterExtractor对HTTP的请求响应体body内容进行对象转换，实现请求直接返回包装好的对象内容。

Post 请求

Post请求提供有postForEntity、postForObject和postForLocation三种方式，其中每种方式都有三种方法，下面介绍postForEntity的使用方法。

Post--postForEntity，存在以下三种方式重载

1、postForEntity(String url,Object request,Class responseType,Object...  uriVariables) 2、postForEntity(String url,Object request,Class responseType,Map  uriVariables) 3、postForEntity(URI url,Object request，Class responseType)

如下仅演示第二种重载方式

/* * @description post方式获取入参，插入数据并发起流程 * @params * @return */@PostMapping("/submit2")public Object insertFinanceCompensation(@RequestBody JSONObject jsonObject) {    String documentId=jsonObject.get("documentId").toString();    return task2Service.submit(documentId);}

/* * @description 使用restTimeplate调外部接口 * @params documentId * @return String */public String submit(String documentId){    String assessToken="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJ4ZGFwYXBwaWQiOiIzNDgxMjU4ODk2OTI2OTY1NzYiLCJleHAiOjE2NjEyMjY5MDgsImlhdCI6MTY2MTIxOTcwOCwieGRhcHRlbmFudGlkIjoiMzAwOTgxNjA1MTE0MDUyNjA5IiwieGRhcHVzZXJpZCI6IjEwMDM0NzY2MzU4MzM1OTc5NTIwMCJ9.fZAO4kJSv2rSH0RBiL1zghdko8Npmu_9ufo6Wex_TI2q9gsiLp7XaW7U9Cu7uewEOaX4DTdpbFmMPvLUtcj_sQ";    RestTemplate restTemplate = new RestTemplate();    //创建请求头    HttpHeaders httpHeaders = new HttpHeaders();    //此处相当于在Authorization里头添加Bear token参数信息    httpHeaders.add(HttpHeaders.AUTHORIZATION, "Bearer " + assessToken);    //此处相当于在header里头添加content-type等参数    httpHeaders.add(HttpHeaders.CONTENT_TYPE,"application/json");    Map<String, Object> map = getMap(documentId);    String jsonStr = JSON.toJSONString(map);    //创建请求体并添加数据    HttpEntity<Map> httpEntity = new HttpEntity<Map>(map, httpHeaders);    String url = "http://39.103.201.110:30661/xdap-open/open/process/v1/submit";    ResponseEntity<String> forEntity = restTemplate.postForEntity(url,httpEntity,String.class);//此处三个参数分别是请求地址、请求体以及返回参数类型    return forEntity.toString();}

4、方式三：使用Feign进行消费

在maven项目中添加依赖

<dependency>    <groupId>org.springframework.cloud</groupId>    <artifactId>spring-cloud-starter-feign</artifactId>    <version>1.2.2.RELEASE</version></dependency>

启动类上加上@EnableFeignClients

@SpringBootApplication@EnableFeignClients@ComponentScan(basePackages = {"com.definesys.mpaas", "com.xdap.*" ,"com.xdap.*"})public class MobilecardApplication {     public static void main(String[] args) {        SpringApplication.run(MobilecardApplication.class, args);    } }

此处编写接口模拟外部接口供feign调用外部接口方式使用

定义controller

@AutowiredPrintService printService;
@PostMapping("/outSide")public String test(@RequestBody TestDto testDto) {    return printService.print(testDto);}

定义service

@Servicepublic interface PrintService {    public String print(TestDto testDto);}

定义serviceImpl

public class PrintServiceImpl implements PrintService {     @Override    public String print(TestDto testDto) {        return "模拟外部系统的接口功能"+testDto.getId();    }}

构建Feigin的Service

定义service

//此处name需要设置不为空，url需要在.properties中设置@Service@FeignClient(url = "${outSide.url}", name = "service2")public interface FeignService2 {    @RequestMapping(value = "/custom/outSide", method = RequestMethod.POST)    @ResponseBody    public String getMessage(@Valid @RequestBody TestDto testDto);}

定义controller

@AutowiredFeignService2 feignService2;//测试feign调用外部接口入口@PostMapping("/test2")public String test2(@RequestBody TestDto testDto) {    return feignService2.getMessage(testDto);}

postman测试

此处因为我使用了所在项目，所以需要添加一定的请求头等信息，关于Feign的请求头添加也会在后续补充

补充如下：

添加Header解决方法

将token等信息放入Feign请求头中，主要通过重写RequestInterceptor的apply方法实现

定义config

@Configurationpublic class FeignConfig implements RequestInterceptor {    @Override    public void apply(RequestTemplate requestTemplate) {        //添加token        requestTemplate.header("token", "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJ4ZGFwYXBwaWQiOiIzNDgxMjU4ODk2OTI2OTY1NzYiLCJleHAiOjE2NjEyMjY5MDgsImlhdCI6MTY2MTIxOTcwOCwieGRhcHRlbmFudGlkIjoiMzAwOTgxNjA1MTE0MDUyNjA5IiwieGRhcHVzZXJpZCI6IjEwMDM0NzY2MzU4MzM1OTc5NTIwMCJ9.fZAO4kJSv2rSH0RBiL1zghdko8Npmu_9ufo6Wex_TI2q9gsiLp7XaW7U9Cu7uewEOaX4DTdpbFmMPvLUtcj_sQ");    }}

定义service

@Service@FeignClient(url = "${outSide.url}",name = "feignServer", configuration = FeignDemoConfig.class)public interface TokenDemoClient {    @RequestMapping(value = "/custom/outSideAddToken", method = RequestMethod.POST)    @ResponseBody    public String getMessage(@Valid @RequestBody TestDto testDto);}

定义controller

//测试feign调用外部接口入口，加上token@PostMapping("/testToken")public String test4(@RequestBody TestDto testDto) {    return tokenDemoClient.getMessage(testDto);}

4、方式四：使用WebClient发起HTTP请求

import java.util.Arrays;import java.util.Date;import java.util.HashMap;import java.util.Map;import java.util.concurrent.TimeUnit;
import javax.net.ssl.SSLException;
import org.apache.commons.lang3.ObjectUtils;import org.apache.commons.lang3.StringUtils;import org.apache.commons.lang3.time.DateUtils;import org.springframework.beans.factory.annotation.Value;import org.springframework.http.MediaType;import org.springframework.http.client.reactive.ReactorClientHttpConnector;import org.springframework.stereotype.Component;import org.springframework.util.MultiValueMap;import org.springframework.web.reactive.function.BodyInserters;import org.springframework.web.reactive.function.client.WebClient;
import com.demo.test.api.exception.InternalErrorException;
import cn.hutool.json.JSONObject;import cn.hutool.json.JSONUtil;import cn.hutool.jwt.JWTUtil;import io.netty.channel.ChannelOption;import io.netty.handler.ssl.SslContext;import io.netty.handler.ssl.SslContextBuilder;import io.netty.handler.ssl.util.InsecureTrustManagerFactory;import io.netty.handler.timeout.ReadTimeoutHandler;import io.netty.handler.timeout.WriteTimeoutHandler;import lombok.extern.slf4j.Slf4j;import reactor.netty.http.client.HttpClient;
/** * 调用三方系统工具类 * * @author dong.zhao * @date 2022/10/15 16:08 **/@Component@Slf4jpublic class CallOtherSystemUtil {
    /**     * 成功响应码     */    private static final String SUCCESS_CODE = "0";    private static final String RETURN_MSG = "msg";    private static final String RETURN_CODE = "code";    private static final String ERROR_CODE = "1027";    private static final String ERROR_MSG = "调用终端系统异常,请联系管理员……";    /**     * token过期时间，30分钟     */    private static final int EXPIRE_TIME = 30;    /**     * 认证标识     */    private static final String AUTH_TOKEN = "token";    /**     * 系统Jwtoken秘钥     */    private static String secretKey;    /**     * 调用下游系统接口超时时间，单位毫秒，默认2分钟     */    private static int timeOut;
    @Value("${secretKey}")    public static void setSecretKey(String secretKey) {        CallOtherSystemUtil.secretKey = secretKey;    }
    public static String getSecretKey() {        return secretKey;    }
    @Value("${timeout:120000}")    public void setTimeOut(int timeOut) {        CallOtherSystemUtil.timeOut = timeOut;    }
    public static int getTimeOut() {        return timeOut;    }
    /**     * 发起Get请求     *     * @param url     *            接口访问地址,例如：http://127.0.0.1:8080/api     * @param authToken     *            认证Token     * @param interfaceName     *            接口名称，例如：/test/{Id}/detail<br/>     *            /test/task?start={start}&limit={limit}     * @param params     *            接口参数     * @return java.lang.String     * @author dong.zhao     * @date 2022/10/15 17:45     */    public static String sendForGet(String url, String authToken, String interfaceName, Object... params) {        try {            log.info("url：" + url + interfaceName);            log.info("request：" + Arrays.toString(params));            String rsp;            // 创建 WebClient 对象            WebClient webClient = createWebClient(url);            // 发送请求            if (ObjectUtils.isNotEmpty(params)) {                rsp = webClient.get().uri(interfaceName, params).header(AUTH_TOKEN, authToken).retrieve()                    .bodyToMono(String.class).block();            } else {                rsp = webClient.get().uri(interfaceName).header(AUTH_TOKEN, authToken).retrieve()                    .bodyToMono(String.class).block();            }            log.info("response：" + rsp);            // 解析响应报文            JSONObject jsonObject = JSONUtil.parseObj(rsp);            // 校验调用是否成功            if (SUCCESS_CODE.equals(String.valueOf(jsonObject.get(RETURN_CODE)))) {                return rsp;            } else {                throw new InternalErrorException(String.valueOf(jsonObject.get(RETURN_CODE)),                    String.valueOf(jsonObject.get(RETURN_MSG)));            }        } catch (InternalErrorException e) {            log.error(e.getMessage(), e);            throw new InternalErrorException(e.getCode(), e.getMsg());        } catch (Exception e) {            log.error(e.getMessage(), e);            throw new InternalErrorException(ERROR_CODE, ERROR_MSG);        }    }
    /**     * 发起Post请求     *     * @author dong.zhao     * @date 2022/10/17 13:20     * @param url     *            接口访问地址,例如：http://127.0.0.1:8080/api     * @param authToken     *            认证Token     * @param contentType     *            报文格式     * @param interfaceName     *            接口名称，例如：/test/task     * @param jsonStr     *            请求参数Json串     * @param map     *            fromData格式时，请求参数内容，其他格式时为null     * @return java.lang.String     */    public static String sendForPost(String url, String authToken, MediaType contentType, String interfaceName,        String jsonStr, MultiValueMap<String, String> map) {        try {            log.info("url：" + url + interfaceName);            log.info("request：" + jsonStr);            log.info("requestFromData：" + map);            String rsp;            // 创建 WebClient 对象            WebClient webClient = createWebClient(url);            // 发送请求            if (StringUtils.isNotBlank(jsonStr) || ObjectUtils.isNotEmpty(map)) {                // 单独处理下FormData格式入参                if (contentType.isCompatibleWith(MediaType.MULTIPART_FORM_DATA)) {                    rsp = webClient.post().uri(interfaceName).contentType(contentType)                        .body(BodyInserters.fromFormData(map)).header(AUTH_TOKEN, authToken).retrieve()                        .bodyToMono(String.class).block();                } else {                    rsp = webClient.post().uri(interfaceName).contentType(contentType)                        .body(BodyInserters.fromValue(jsonStr)).header(AUTH_TOKEN, authToken).retrieve()                        .bodyToMono(String.class).block();                }            } else {                rsp = webClient.post().uri(interfaceName).contentType(contentType).header(AUTH_TOKEN, authToken)                    .retrieve().bodyToMono(String.class).block();            }            log.info("response：" + rsp);            // 解析响应报文            JSONObject jsonObject = JSONUtil.parseObj(rsp);            // 校验调用是否成功            if (SUCCESS_CODE.equals(String.valueOf(jsonObject.get(RETURN_CODE)))) {                return rsp;            } else {                throw new InternalErrorException(String.valueOf(jsonObject.get(RETURN_CODE)),                    String.valueOf(jsonObject.get(RETURN_MSG)));            }        } catch (InternalErrorException e) {            log.error(e.getMessage(), e);            throw new InternalErrorException(e.getCode(), e.getMsg());        } catch (Exception e) {            log.error(e.getMessage(), e);            throw new InternalErrorException(ERROR_CODE, ERROR_MSG);        }    }
    /**     * 获取系统JWT认证的token,本地按照规则直接生成     *     * @author dong.zhao     * @date 2022/10/20 15:21     * @param secretKey     *            秘钥     * @param userName     *            认证用户     * @return java.lang.String authToken认证Token     */    public static String getJwTokenForLocal(String secretKey, String userName) {
        Map<String, Object> map = new HashMap<>(4);        // 用户        map.put("user", userName);        // 过期时间        map.put("expireTime", String.valueOf(DateUtils.addMinutes(new Date(), EXPIRE_TIME).getTime()));        return JWTUtil.createToken(map, secretKey.getBytes());    }
    /**     * 访问集群接口并忽略HTTPS证书     *     * @author dong.zhao     * @date 2022/11/07 11:51     * @param url     *            接口访问地址,例如：http://127.0.0.1:8080/api     * @return org.springframework.web.reactive.function.client.WebClient     * @throws SSLException     */    private static WebClient createWebClient(String url) throws SSLException {        // ChannelOption.CONNECT_TIMEOUT_MILLIS用来设置连接超时时长,单位是毫秒        // ReadTimeoutHandler(5000, TimeUnit.MILLISECONDS)用来设置读数据超时时长,单位是毫秒        // WriteTimeoutHandler(5000, TimeUnit.MILLISECONDS)用来设置写数据超时时长,单位是毫秒        SslContext context = SslContextBuilder.forClient().trustManager(InsecureTrustManagerFactory.INSTANCE).build();        HttpClient httpClient =            HttpClient.create().option(ChannelOption.CONNECT_TIMEOUT_MILLIS, getTimeOut()).doOnConnected(connection -> {                connection.addHandlerLast(new ReadTimeoutHandler(getTimeOut(), TimeUnit.MILLISECONDS));                connection.addHandlerLast(new WriteTimeoutHandler(getTimeOut(), TimeUnit.MILLISECONDS));            }).secure(t -> t.sslContext(context));        return WebClient.builder().baseUrl(url).clientConnector(new ReactorClientHttpConnector(httpClient)).build();    }}

import lombok.Data;import lombok.EqualsAndHashCode;
/** * 内部错误异常 *  * @author dong.zhao * @date 2022/10/14 20:17 **/@EqualsAndHashCode(callSuper = true)@Datapublic class InternalErrorException extends RuntimeException {    private static final long serialVersionUID = 7719015684656165646L;    /**     * 响应码     */    private String code;    /**     * 响应信息     */    private String msg;
    public InternalErrorException() {        super();    }
    public InternalErrorException(String message) {        super(message);    }
    public InternalErrorException(String code, String msg) {        this.code = code;        this.msg = msg;    }}

如喜欢本文，请点击右上角，把文章分享到朋友圈

因公众号更改推送规则，请点“在看”并加“星标”第一时间获取精彩技术分享

·END·

本篇文章来源于微信公众号: IT牛客

微信扫描下方的二维码阅读本文

雪影轻语·静谧之间

SpringBoot 调用外部接口的四种方式

1、简介

2、方式一：使用原始httpClient请求

3、方式二：使用RestTemplate方法

Get请求

Post 请求

4、方式三：使用Feign进行消费

添加Header解决方法

4、方式四：使用WebClient发起HTTP请求

Spring-14 AOP CGLIB 代理对象源码

告别卡顿困扰：IDEA 性能优化设置

Comments NOTHING

取消回复