项目亮点之第三方接口

项目亮点之第三方接口第三方接口实际项目中经常会与第三方网站交互,例如提交支付宝请求支付,或者获取合作方的各类信息(比如行政码、气象股票信息,或者模拟登录获取信息等等),这个时候一般都是基于http协议提供接口,这时候就需要能与第三方的http接口交互数据,httpclient就是实际项目干这个的(也可以直接使用Res

大家好,欢迎来到IT知识分享网。项目亮点之第三方接口"

第三方接口

实际项目中经常会与第三方网站交互,例如提交支付宝请求支付,或者获取合作方的各类信息(比如行政码、气象股票信息,或者模拟登录获取信息等等),这个时候一般都是基于http协议提供接口,这时候就需要能与第三方的http接口交互数据,httpclient就是实际项目干这个的(也可以直接使用RestTemplate,但是因为经常有验证,并且可能需要支持Cookie等,所以一般使用HttpClient多一些)。

实际访问http接口的方式(像上面,有get和post两种方式),httpclient就是模拟post或者get请求,把参数提交过去,然后获取第三方的返回内容。
使用httpclient模拟与第三方交互有以下注意事项:

  • 为请求第三方接口都会有比较大的开销,为了避免打开数量过多导致系统崩溃,现在在httpclient中都使用了连接池的样式
  • 使用连接池,如果对方支持http长连接的话(http1.1中,在请求Header中增加keep-alive字段),可以省略一部分连接建立开销
  • 对方的服务可能不稳定,因此一定要设置连接超时时间,避免连接一直卡顿着

HttpConfig

@Configuration
public class HttpClientConfig {
    //最大连接数
    @Value("${http.maxTotal}")
    private Integer maxTotal;
    //并发数
    @Value("${http.defaultMaxPerRoute}")
    private Integer defaultMaxPerRoute;
    //设置连接超时时间
    @Value("${http.connectTimeout}")
    private Integer connectTimeout;
    //设置连接请求最长时间 
    @Value("${http.connectionRequestTimeout}")
    private Integer connectionRequestTimeout;
    //数据传输的最长时间 
    @Value("${http.socketTimeout}")
    private Integer socketTimeout;
    //提交请求前测试连接是否可用 
    @Value("${http.staleConnectionCheckEnabled}")
    private boolean staleConnectionCheckEnabled;
    /**
     * 首先实例化一个连接池管理器,设置最大连接数、并发连接数
     * 
     * @return
     */
    @Bean(name = "httpClientConnectionManager")
    public PoolingHttpClientConnectionManager getHttpClientConnectionManager() {
        PoolingHttpClientConnectionManager httpClientConnectionManager = new PoolingHttpClientConnectionManager();
        // 最大连接数
        httpClientConnectionManager.setMaxTotal(maxTotal);
        // 并发数
        httpClientConnectionManager.setDefaultMaxPerRoute(defaultMaxPerRoute);
        return httpClientConnectionManager;
    }
    /**
     * 实例化连接池,设置连接池管理器。 这里需要以参数形式注入上面实例化的连接池管理器
     * 
     * @param httpClientConnectionManager
     * @return
     */
    @Bean(name = "httpClientBuilder")
    public HttpClientBuilder getHttpClientBuilder(@Qualifier("httpClientConnectionManager") PoolingHttpClientConnectionManager httpClientConnectionManager) {
        // HttpClientBuilder中的构造方法被protected修饰,所以这里不能直接使用new来实例化一个HttpClientBuilder,可以使用HttpClientBuilder提供的静态方法create()来获取HttpClientBuilder对象
        HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();
        httpClientBuilder.setConnectionManager(httpClientConnectionManager);
        return httpClientBuilder;
    }
    /**
     * 注入连接池,用于获取httpClient
     * 
     * @param httpClientBuilder
     * @return
     */
    @Bean
    public CloseableHttpClient getCloseableHttpClient(@Qualifier("httpClientBuilder") HttpClientBuilder httpClientBuilder) {
        return httpClientBuilder.build();
    }
    /**
     * Builder是RequestConfig的一个内部类 通过RequestConfig的custom方法来获取到一个Builder对象
     * 设置builder的连接信息 这里还可以设置proxy,cookieSpec等属性。有需要的话可以在此设置
     * 
     * @return
     */
    @Bean(name = "builder")
    public RequestConfig.Builder getBuilder() {
        RequestConfig.Builder builder = RequestConfig.custom();
        return builder.setConnectTimeout(connectTimeout).setConnectionRequestTimeout(connectionRequestTimeout).setSocketTimeout(socketTimeout).setStaleConnectionCheckEnabled(staleConnectionCheckEnabled);
    }
    /**
     * 使用builder构建一个RequestConfig对象
     * 
     * @param builder
     * @return
     */
    @Bean
    public RequestConfig getRequestConfig(@Qualifier("builder") RequestConfig.Builder builder) {
        return builder.build();
    }
}

HttpClientUtil

@Component
public class HttpClientUtil {
    @Autowired
    private CloseableHttpClient httpClient;
    @Autowired
    private RequestConfig config;
    /**
     * 不带参数的get请求,如果状态码为200,则返回body,如果不为200,则返回null
     *
     * @param url
     * @return
     * @throws Exception
     */
    public String doGet(String url) throws Exception {
        // 声明 http get 请求
        HttpGet httpGet = new HttpGet(url);
        // 装载配置信息
        httpGet.setConfig(config);
        // 发起请求
        CloseableHttpResponse response = this.httpClient.execute(httpGet);
        // 判断状态码是否为200
        if (response.getStatusLine().getStatusCode() == 200) {
            // 返回响应体的内容
            return EntityUtils.toString(response.getEntity(), "UTF-8");
        }
        return null;
    }
    /**
     * 带参数的get请求,如果状态码为200,则返回body,如果不为200,则返回null
     *
     * @param url
     * @return
     * @throws Exception
     */
    public String doGet(String url, Map<String, Object> map) throws Exception {
        URIBuilder uriBuilder = new URIBuilder(url);
        if (map != null) {
            // 遍历map,拼接请求参数
            for (Map.Entry<String, Object> entry : map.entrySet()) {
                uriBuilder.setParameter(entry.getKey(), entry.getValue().toString());
            }
        }
        // 调用不带参数的get请求
        return this.doGet(uriBuilder.build().toString());
    }
    /**
     * 带参数的post请求
     *
     * @param url
     * @param map
     * @return
     * @throws Exception
     */
    public HttpResult doPost(String url, Map<String, Object> map) throws Exception {
        // 声明httpPost请求
        HttpPost httpPost = new HttpPost(url);
        // 加入配置信息
        httpPost.setConfig(config);
        // 判断map是否为空,不为空则进行遍历,封装from表单对象
        if (map != null) {
            List<NameValuePair> list = new ArrayList<NameValuePair>();
            for (Map.Entry<String, Object> entry : map.entrySet()) {
                list.add(new BasicNameValuePair(entry.getKey(), entry.getValue().toString()));
            }
            // 构造from表单对象
            UrlEncodedFormEntity urlEncodedFormEntity = new UrlEncodedFormEntity(list, "UTF-8");
            // 把表单放到post里
            httpPost.setEntity(urlEncodedFormEntity);
        }
        // 发起请求
        CloseableHttpResponse response = this.httpClient.execute(httpPost);
        return new HttpResult(response.getStatusLine().getStatusCode(), EntityUtils.toString(response.getEntity(), "UTF-8"));
    }
    /**
     * 不带参数post请求
     *
     * @param url
     * @return
     * @throws Exception
     */
    public HttpResult doPost(String url) throws Exception {
        return this.doPost(url, null);
    }
}

HttpResult

public class HttpResult {
    // 响应码
    private Integer code;
    // 响应体
    private String body;
    public HttpResult() {
        super();
    }
    public HttpResult(Integer code, String body) {
        super();
        this.code = code;
        this.body = body;
    }
    public Integer getCode() {
        return code;
    }
    public void setCode(Integer code) {
        this.code = code;
    }
    public String getBody() {
        return body;
    }
    public void setBody(String body) {
        this.body = body;
    }
}

application.yml

http:
  maxTotal: 300
  defaultMaxPerRoute: 50
  connectTimeout: 1000
  connectionRequestTimeout: 500
  socketTimeout: 5000
  staleConnectionCheckEnabled: true

免责声明:本站所有文章内容,图片,视频等均是来源于用户投稿和互联网及文摘转载整编而成,不代表本站观点,不承担相关法律责任。其著作权各归其原作者或其出版社所有。如发现本站有涉嫌抄袭侵权/违法违规的内容,侵犯到您的权益,请在线联系站长,一经查实,本站将立刻删除。 本文来自网络,若有侵权,请联系删除,如若转载,请注明出处:https://yundeesoft.com/32037.html

(0)

相关推荐

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

关注微信