一、簡(jiǎn)介
在Spring-Boot項(xiàng)目開發(fā)中,存在著本模塊的代碼需要訪問外面模塊接口,或外部url鏈接的需求忽妒,針對(duì)這一需求目前存在著三種解決方案,下面將對(duì)這三種方案進(jìn)行整理和說(shuō)明兼贸。
二段直、Spring-Boot項(xiàng)目中訪問外部接口
2.1 方案一 采用原生的Http請(qǐng)求
在代碼中采用原生的http請(qǐng)求,代碼參考如下:
@RequestMapping("/doPostGetJson")
public String doPostGetJson() throws ParseException {
? //此處將要發(fā)送的數(shù)據(jù)轉(zhuǎn)換為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();
? // 要調(diào)用的接口方法
? 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進(jìn)行消費(fèi)
1溶诞、在maven項(xiàng)目中添加依賴
<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地址和端口號(hào)
decisionEngine.url=http://10.2.1.148:3333
/decision/person 是接口名字
3螺垢、在Java的啟動(dòng)類上加上@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喧务、在代碼中調(diào)用接口即可
@Autowired
? ? private DecisionEngineService decisionEngineService ;
? ? decisionEngineService.getEngineMesasge("uid" ,? "productCode");
2.3颜及、方案三 采用RestTemplate方法
在Spring-Boot開發(fā)中,RestTemplate同樣提供了對(duì)外訪問的接口API蹂楣,這里主要介紹Get和Post方法的使用。Get請(qǐng)求提供了兩種方式的接口getForObject 和 getForEntity讯蒲,getForEntity提供如下三種方法的實(shí)現(xiàn)痊土。
Get請(qǐng)求之——getForEntity(Stringurl,Class responseType,Object…urlVariables)
該方法提供了三個(gè)參數(shù),其中url為請(qǐng)求的地址墨林,responseType為請(qǐng)求響應(yīng)body的包裝類型赁酝,urlVariables為url中的參數(shù)綁定,該方法的參考調(diào)用如下:
//http://USER-SERVICE/user?name={1}
getForEntity("http://USER-SERVICE/user?name={1}",String.class,"didi")
Get請(qǐng)求之——getForEntity(String url,Class responseType,Map urlVariables)
該方法提供的參數(shù)中urlVariables的參數(shù)類型使用了Map類型旭等,因此在使用該方法進(jìn)行參數(shù)綁定時(shí)需要在占位符中指定Map中參數(shù)的key值酌呆,該方法的參考調(diào)用如下:
// 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請(qǐng)求之——getForEntity(URI url,Class responseType)
該方法使用URI對(duì)象來(lái)替代之前的url和urlVariables參數(shù)來(lái)指定訪問地址和參數(shù)綁定。URI是JDK java.net包下的一個(gè)類搔耕,表示一個(gè)統(tǒng)一資源標(biāo)識(shí)符(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請(qǐng)求之——getForObject
getForObject方法可以理解為對(duì)getForEntity的進(jìn)一步封裝,它通過HttpMessageConverterExtractor對(duì)HTTP的請(qǐng)求響應(yīng)體body內(nèi)容進(jìn)行對(duì)象轉(zhuǎn)換,實(shí)現(xiàn)請(qǐng)求直接返回包裝好的對(duì)象內(nèi)容。getForObject方法有如下:
getForObject(String url,Class responseType,Object...urlVariables)
getForObject(String url,Class responseType,Map urlVariables)
getForObject(URI url,Class responseType)
Post請(qǐng)求提供有三種方法常侣,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內(nèi)容為user對(duì)象,請(qǐng)求的返回的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ù)大體相同在此不做介紹箱舞。
1.Spring Boot 調(diào)用另外項(xiàng)目的接口方法,傳遞json參數(shù)
2.spring boot 訪問外部http請(qǐng)求
3.Spring學(xué)習(xí)筆記之RestTemplate使用小結(jié)