Spring-Boot 訪問外部接口的方案總結

更新時間：2022年12月05日 10:30:26 作者：polo2044

在Spring-Boot項目開發(fā)中，存在著本模塊的代碼需要訪問外面模塊接口，或外部url鏈接的需求，針對這一需求目前存在著三種解決方案，下面將對這三種方案進行整理和說明，對Spring-Boot 訪問外部接口方案感興趣的朋友跟隨小編一起看看吧

一、簡介

在Spring-Boot項目開發(fā)中，存在著本模塊的代碼需要訪問外面模塊接口，或外部url鏈接的需求，針對這一需求目前存在著三種解決方案，下面將對這三種方案進行整理和說明。

二、Spring-Boot項目中訪問外部接口

2.1 方案一采用原生的Http請求

在代碼中采用原生的http請求，代碼參考如下：

@RequestMapping("/doPostGetJson")
public String doPostGetJson() throws ParseException {
   //此處將要發(fā)送的數(shù)據(jù)轉換為json格式字符串
   String jsonText = "{id：1}";
   JSONObject json = (JSONObject) JSONObject.parse(jsonText);
   JSONObject sr = this.doPost(json);
   System.out.println("返回參數(shù)：" + 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開發(fā)中，RestTemplate同樣提供了對外訪問的接口API，這里主要介紹Get和Post方法的使用。Get請求提供了兩種方式的接口getForObject 和 getForEntity，getForEntity提供如下三種方法的實現(xiàn)。
Get請求之——getForEntity(Stringurl,Class responseType,Object…urlVariables)
該方法提供了三個參數(shù)，其中url為請求的地址，responseType為請求響應body的包裝類型，urlVariables為url中的參數(shù)綁定，該方法的參考調用如下：

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

Get請求之——getForEntity(String url,Class responseType,Map urlVariables)
該方法提供的參數(shù)中urlVariables的參數(shù)類型使用了Map類型，因此在使用該方法進行參數(shù)綁定時需要在占位符中指定Map中參數(shù)的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參數(shù)來指定訪問地址和參數(shù)綁定。URI是JDK java.net包下的一個類，表示一個統(tǒng)一資源標識符(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內容進行對象轉換，實現(xiàn)請求直接返回包裝好的對象內容。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中的其它參數(shù)和getForEntity的參數(shù)大體相同在此不做介紹。