Spring-Boot 访问外部接口的几种方案总结

一、简介

在Spring-Boot项目开发中,存在着本模块的代码需要访问外面模块接口,或外部url链接的需求,针对这一需求目前存在着三种解决方案,下面将对这三种方案进行整理和说明。

二、Spring-Boot项目中访问外部接口

2.1 方案一 采用原生的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;

}


2.2 方案二 采用Feign进行消费

1、在maven项目中添加依赖

<dependency>

      <groupId>org.springframework.cloud</groupId>

      <artifactId>spring-cloud-starter-feign</artifactId>

      <version>1.2.2.RELEASE</version>

</dependency>


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

@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);

}


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

decisionEngine.url=http://10.2.1.148:3333

/decision/person 是接口名字

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

@EnableFeignClients //参见此处

@EnableDiscoveryClient

@SpringBootApplication

@EnableResourceServer

public 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、在代码中调用接口即可

@Autowired

    private DecisionEngineService decisionEngineService ;

    decisionEngineService.getEngineMesasge("uid" ,  "productCode");


2.3、方案三 采用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={1}

getForEntity("http://USER-SERVICE/user?name={1}",String.class,"didi")


Get请求之——getForEntity(String url,Class responseType,Map urlVariables)

该方法提供的参数中urlVariables的参数类型使用了Map类型,因此在使用该方法进行参数绑定时需要在占位符中指定Map中参数的key值,该方法的参考调用如下:

// http://USER-SERVICE/user?name={name)

RestTemplate restTemplate=new RestTemplate();

Map<String,String> params=new HashMap<>();

params.put("name","dada");  //

ResponseEntity<String> responseEntity=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();

ResponseEntity<String> responseEntity=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请求提供有三种方法,postForEntity、postForObject和postForLocation。其中每种方法都存在三种方法,postForEntity方法使用如下:

RestTemplate restTemplate=new RestTemplate();

User user=newUser("didi",30);

ResponseEntity<String> responseEntity=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)


postForEntity中的其它参数和getForEntity的参数大体相同在此不做介绍。


参考文献

1.Spring Boot 调用另外项目的接口方法,传递json参数

2.spring boot 访问外部http请求

3.Spring学习笔记之RestTemplate使用小结

4.Spring RestTemplate中几种常见的请求方式

5.spring boot单元测试之RestTemplate(三)——api详解

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,214评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,307评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,543评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,221评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,224评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,007评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,313评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,956评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,441评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,925评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,018评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,685评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,234评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,240评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,464评论 1 261
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,467评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,762评论 2 345

推荐阅读更多精彩内容