关于java:Spring-Boot-调用外部接口的-3-种方式还有谁不会

26次阅读

共计 7909 个字符，预计需要花费 20 分钟才能阅读完成。

1、简介

SpringBoot 不仅继承了 Spring 框架原有的优良个性，而且还通过简化配置来进一步简化了 Spring 利用的整个搭建和开发过程。

在 Spring-Boot 我的项目开发中，存在着本模块的代码须要拜访里面模块接口，或内部 url 链接的需要, 比方在 apaas 开发过程中须要封装接口在接口中调用 apaas 提供的接口（像发动流程接口 submit 等等）上面也是提供了三种形式（不应用 dubbo 的形式）供咱们抉择

举荐一个开源收费的 Spring Boot 实战我的项目：

https://github.com/javastacks/spring-boot-best-practice

2、形式一：应用原始 httpClient 申请

/*
 * @description get 形式获取入参，插入数据并发动流程
 * @author lyx
 * @date 2022/8/24 16:05
 * @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 调用内部接口
 * @author lyx
 * @date 2022/8/24 16:08
 * @params date
 * @return JSONObject
 */
public static JSONObject doPost(JSONObject date) {
    String assessToken="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJ4ZGFwYXBwaWQiOiIzNDgxMjU4ODk2OTI2OTY1NzYiLCJleHAiOjE2NjEyMjY5MDgsImlhdCI6MTY2MTIxOTcwOCwieGRhcHRlbmFudGlkIjoiMzAwOTgxNjA1MTE0MDUyNjA5IiwieGRhcHVzZXJpZCI6IjEwMDM0NzY2MzU4MzM1OTc5NTIwMCJ9.fZAO4kJSv2rSH0RBiL1zghdko8Npmu_9ufo6Wex_TI2q9gsiLp7XaW7U9Cu7uewEOaX4DTdpbFmMPvLUtcj_sQ";
    CloseableHttpClient client = HttpClients.createDefault();
    // 要调用的接口 url
    String url = "http://39.103.201.110: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 形式获取入参，插入数据并发动流程
 * @author lyx
 * @date 2022/8/24 16:07
 * @params
 * @return
 */
@PostMapping("/submit2")
public Object insertFinanceCompensation(@RequestBody JSONObject jsonObject) {String documentId=jsonObject.get("documentId").toString();
    return task2Service.submit(documentId);
}
/*
 * @description 应用 restTimeplate 调内部接口
 * @author lyx
 * @date 2022/8/24 16:02
 * @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

@Autowired
PrintService printService;

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

定义 service

@Service
public 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

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

postman 测试

此处因为我应用了所在我的项目，所以须要增加肯定的申请头等信息，对于 Feign 的申请头增加也会在后续补充

补充如下：

增加 Header 解决办法

将 token 等信息放入 Feign 申请头中，次要通过重写 RequestInterceptor 的 apply 办法实现

定义 config

@Configuration
public 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);
}

版权申明：本文为 CSDN 博主「Chelsea」的原创文章，遵循 CC 4.0 BY-SA 版权协定，转载请附上原文出处链接及本申明。原文链接：https://blog.csdn.net/Chelsea/article/details/126689495

近期热文举荐：

1.1,000+ 道 Java 面试题及答案整顿(2022 最新版)

2. 劲爆！Java 协程要来了。。。

3.Spring Boot 2.x 教程，太全了！

4. 别再写满屏的爆爆爆炸类了，试试装璜器模式，这才是优雅的形式！！

5.《Java 开发手册（嵩山版）》最新公布，速速下载！

感觉不错，别忘了顺手点赞 + 转发哦！

正文完
java
发表至： java
2023-06-25
 0
并发编程系列之深入理解volatile关键字
关于java:Java房屋出租系统
JDK18源码分析01之学习建议可以延伸其他源码学习
关于java:同事写了一个责任链模式bug-无数