Spring Boot - 訪問外部介面最全總結
阿新 • • 發佈：2019-10-30
Spring Boot - 訪問外部介面
在Spring-Boot專案開發中，存在著本模組的程式碼需要訪問外面模組介面，或外部url連結的需求, 比如呼叫外部的地圖API或者天氣API。
- Spring Boot - 訪問外部介面
- 方案一： 採用原生的Http請求
- 方案二: 採用Feign進行消費
- 方案三: 採用RestTemplate方法
- Get請求之——getForEntity(Stringurl,Class responseType,Object…urlVariables)
- Get請求之——getForEntity(URI url,Class responseType)
- Get請求之——getForObject
- Post 請求
- 參考文章
最全的Java後端知識體系 https://www.pdai.tech, 每天更新中...。
方案一： 採用原生的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地址和埠號
@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
@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");方案三: 採用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();
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 請求
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的引數大體相同在此不做介紹。
參考文章
- 參考 https://blog.csdn.net/polo2044/article/details/85002282