springboot如何调用外部接口?springboot调用外部接口方法

SpringBoot不仅继承了Spring框架原有的优秀特性,而且还通过简化配置来进一步简化了Spring应用的整个搭建和开发过程,所以在工作中被程序员广泛的使用,那springboot如何调用外部接口?下面来我们就来给大家讲解一下。

方案一: 采用原生的Http请求

在代码中采用原生的http请求,代码参考如下:

@RequestMapping("/doPostGetJson") public String doPostGetJson() throws ParseException
{
    //此处将要发送的数据转换为json格式字符串
    String jsonText = "{id:1}";
    JSONObject json = (JSONObject) JSONObject.parse(jsonText);
    JSONObject sr = this.doPost(json);
    System.out.println("返回参数:" + sr);
    return sr.toString();
}
public static JSONObject doPost(JSONObject date)
{
    HttpClient client = HttpClients.createDefault();
    // 要调用的接口方法
    String url = "http://192.168.1.101:8080/getJson";
    HttpPost post = new HttpPost(url);
    JSONObject jsonObject = null;
    try
    {
        StringEntity s = new StringEntity(date.toString());
        s.setContentEncoding("UTF-8");
        s.setContentType("application/json");
        post.setEntity(s);
        post.addHeader("content-type", "text/xml");
        HttpResponse res = client.execute(post);
        String response1 = EntityUtils.toString(res.getEntity());
        System.out.println(response1);
        if (res.getStatusLine()
            .getStatusCode() == HttpStatus.SC_OK)
        {
            String result = EntityUtils.toString(res.getEntity()); // 返回json格式:
            jsonObject = JSONObject.parseObject(result);
        }
    }
    catch (Exception e)
    {
        throw new RuntimeException(e);
    }
    return jsonObject;
}

方案二: 采用Feign进行消费

1、在maven项目中添加依赖

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

2、编写接口,放置在service层

这里的decisionEngine.url 是配置在properties中的 是ip地址和端口号

decisionEngine.url=http://10.2.1.148:3333/decision/person 是接口名字

@FeignClient(url = "${decisionEngine.url}", name = "engine") public interface DecisionEngineService
{
    @RequestMapping(value = "/decision/person", method = RequestMethod.POST)
    public JSONObject getEngineMesasge(@RequestParam("uid") String uid, @RequestParam("productCode") String productCode);
}

3、在Java的启动类上加上@EnableFeignClients

@EnableFeignClients //参见此处@EnableDiscoveryClient@SpringBootApplication@EnableResourceServerpublic class Application implements CommandLineRunner {
private static final Logger LOGGER = LoggerFactory.getLogger(Application.class);
@Autowired
private AppMetricsExporter appMetricsExporter;
@Autowired
private AddMonitorUnitService addMonitorUnitService;
public static void main(String[] args)
{
    new SpringApplicationBuilder(Application.class)
        .web(true)
        .run(args);
}
}

4、在代码中调用接口即可

@Autowiredprivate DecisionEngineService decisionEngineService ;// ...
decisionEngineService.getEngineMesasge("uid" , "productCode");

方案三: 采用RestTemplate方法

在Spring-Boot开发中,RestTemplate同样提供了对外访问的接口API,这里主要介绍Get和Post方法的使用。Get请求提供了两种方式的接口getForObject 和 getForEntity,getForEntity提供如下三种方法的实现。

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请求之——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请求之——getForObject

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

getForObject(String url,Class responseType,Object...urlVariables)
getForObject(String url,Class responseType,Map urlVariables)
getForObject(URI url,Class responseType)

Post 请求

Post请求提供有三种方法,postForEntity、postForObject和postForLocation。其中每种方法都存在三种方法,postForEntity方法使用如下:

RestTemplate restTemplate=new RestTemplate();
User user=newUser("didi",30);
ResponseEntityresponseEntity=restTemplate.postForEntity("http://USER-SERVICE/user",user,String.class); 
//提交的body内容为user对象,请求的返回的body类型为String
String body=responseEntity.getBody();

postForEntity存在如下三种方法的重载

postForEntity(String url,Object request,Class responseType,Object... 
uriVariables)
postForEntity(String url,Object request,Class responseType,Map 
uriVariables)
postForEntity(URI url,Object request,Class responseType)

这就是springboot调用外部接口就的方法,在Spring-Boot项目开发中,如果我们需要访问外部接口,就可以使用这些方法哦!最后大家如果想要了解更多其他工具教程知识,敬请关注奇Q工具网。

推荐阅读:

java主函数怎么写?java主函数有什么特殊之处?

java系统架构如何设计?java系统架构设计详解

json语法如何编写对象?json语法规则是什么?