【spring boot】RestTemplate支持https配置方式及封装使用

本文介绍如何在SpringBoot项目中配置RestTemplate并使其支持HTTPS访问,包括配置细节、依赖引入及常见方法封装,适用于解决运维更改服务端访问方式导致的问题。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

最近运维突然抽风,把服务端访问方式改成https,但是RestTemplate默认是不支持https的,造成所有接口调用失败,经过一翻折腾后终于支持HTTPS,现将spring boot配置resttemplate及支持HTTPS的方法整理如下:

1.spring boot中集成resttemplate

在项目中导入如下的RestTemplate加载类

@Configuration
public class RestTemplateConfig {
    private Logger logger = LoggerFactory.getLogger(getClass().getName());
    @Bean
    public RestTemplate restTemplate(ClientHttpRequestFactory factory) {
        RestTemplate restTemplate = new RestTemplate(factory);
        restTemplate.setErrorHandler(new ResponseErrorHandler() {
            @Override
            public boolean hasError(ClientHttpResponse clientHttpResponse) throws IOException {
                return false;
            }

            @Override
            public void handleError(ClientHttpResponse clientHttpResponse) throws IOException {

            }
        });
        return restTemplate;
    }
    @Bean
    public ClientHttpRequestFactory simpleClientHttpRequestFactory() {
        SimpleClientHttpRequestFactory factory = new SimpleClientHttpRequestFactory();
        factory.setReadTimeout(15000);//读超时时间,单位为ms
        factory.setConnectTimeout(10000);//连接超时时间,单位为ms
        return factory;
    }
}

导入该配置类后,就可以在项目中正常使用restTmeplate了

一般的使用方法如下:

//get请求
public String getO(String url, Map<String, ?> paramMap) {
    logger.info("get-> url = " + url + " params: " + paramMap.toString());
    String s = restTemplate.getForObject(url, String.class, paramMap);
    logger.info("res->" + s);
    return s;
}

//pos请求
public String postO(String url, MultiValueMap paramMap) {
    HttpHeaders headers = new HttpHeaders();
    headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);
    HttpEntity<MultiValueMap<String, Object>> httpEntity = new HttpEntity<>(paramMap, headers);
    logger.info("post-> url = " + url + " params: " + paramMap.toString());
    String s = restTemplateConfig.restTemplate(restTemplateConfig.simpleClientHttpRequestFactory())
        .postForObject(url, httpEntity, String.class);
    logger.info("res->" + s);
    return s;
    }

2.支持https的配置方式

RestTemplateConfig中使用的是simpleClientHttpRequestFactory来构造RestTemplate实例的,但它是不支持https,要支持https需要替换simpleClientHttpRequestFactory为HttpComponentsClientHttpRequestFactory

第一步:引入依赖

<dependency>
    <groupId>org.apache.httpcomponents</groupId>
    <artifactId>httpclient</artifactId>
    <version>4.5.6</version>
</dependency>

第二步:修改后的RestTemplateConfig文件如下

@Configuration
public class RestTemplateConfig {
    private Logger logger = LoggerFactory.getLogger(getClass().getName());
    @Bean
    public RestTemplate restTemplate(ClientHttpRequestFactory factory) {
        RestTemplate restTemplate = new RestTemplate(factory);
        restTemplate.setErrorHandler(new ResponseErrorHandler() {
            @Override
            public boolean hasError(ClientHttpResponse clientHttpResponse) throws IOException {
                return false;
            }
            @Override
            public void handleError(ClientHttpResponse clientHttpResponse) throws IOException {
            }
        });
        return restTemplate;
    }
//为了支持https 改为下面的factory
    @Bean(name = "httpsFactory")
    public HttpComponentsClientHttpRequestFactory httpComponentsClientHttpRequestFactory()
              {
                  try {
                      CloseableHttpClient httpClient = HttpClientUtils.acceptsUntrustedCertsHttpClient();
                      HttpComponentsClientHttpRequestFactory httpsFactory =
                              new HttpComponentsClientHttpRequestFactory(httpClient);
                      httpsFactory.setReadTimeout(40000);
                      httpsFactory.setConnectTimeout(40000);
                      return httpsFactory;
                  }
                  catch (Exception e ){
                      logger.info(e.getMessage());
                      return  null;
                  }
    }
}

其中HttpClientUtils的代码如下:

public class HttpClientUtils {

    public static CloseableHttpClient acceptsUntrustedCertsHttpClient() throws KeyStoreException, NoSuchAlgorithmException, KeyManagementException {
        HttpClientBuilder b = HttpClientBuilder.create();

        // setup a Trust Strategy that allows all certificates.
        SSLContext sslContext = new SSLContextBuilder().loadTrustMaterial(null, new TrustStrategy() {
            @Override
            public boolean isTrusted(X509Certificate[] arg0, String arg1) throws CertificateException {
                return true;
            }
        }).build();
        b.setSSLContext(sslContext);

        // don't check Hostnames, either.
        //      -- use SSLConnectionSocketFactory.getDefaultHostnameVerifier(), if you don't want to weaken
        HostnameVerifier hostnameVerifier = NoopHostnameVerifier.INSTANCE;

        // here's the special part:
        //      -- need to create an SSL Socket Factory, to use our weakened "trust strategy";
        //      -- and create a Registry, to register it.
        //
        SSLConnectionSocketFactory sslSocketFactory = new SSLConnectionSocketFactory(sslContext, hostnameVerifier);
        Registry<ConnectionSocketFactory> socketFactoryRegistry = RegistryBuilder.<ConnectionSocketFactory>create()
                .register("http", PlainConnectionSocketFactory.getSocketFactory())
                .register("https", sslSocketFactory)
                .build();

        // now, we create connection-manager using our Registry.
        //      -- allows multi-threaded use
        PoolingHttpClientConnectionManager connMgr = new PoolingHttpClientConnectionManager( socketFactoryRegistry);
        connMgr.setMaxTotal(200);
        connMgr.setDefaultMaxPerRoute(100);
        b.setConnectionManager( connMgr);

        // finally, build the HttpClient;
        //      -- done!
        CloseableHttpClient client = b.build();

        return client;
    }

}

经过上述修改后,RestTmplate就能同时支持http和https了

3.RestTemplate常用方法的简单封装

下面这个HttpClient是我对RestTemplate常用调用方法的一个封装,喜欢的直接拿去。。。。

@Component
public class HttpClient {
    private Logger logger = LoggerFactory.getLogger(getClass().getName());
    @Autowired
    private RestTemplate restTemplate;
    @Autowired
    private RestTemplateConfig restTemplateConfig;

    public HttpClient() {
        //this.restTemplate = new RestTemplate();
    }
     /////////////////////////////////////////get//////////////////////////////////////////////

    /**
     * 一般的GET请求,封装getForEntity接口
     * */
    public <T> ResponseEntity<T> getE(String url, Class<T> responseType, Object... uriVariables) {
        return restTemplate.getForEntity(url, responseType, uriVariables);
    }

    /**
    * 一般的GET请求
    * */
    public String getO(String url, Map<String, ?> paramMap) {
        logger.info("get-> url = " + url + " params: " + paramMap.toString());
        String s = restTemplate.getForObject(url, String.class, paramMap);
        logger.info("res->" + s);
        return s;
    }
    /**
     * 一般的GET请求,并返回header
     * */
    public String getWithHeader(String url, Map<String, ?> paramMap,HttpHeaders headers ) {
        logger.info("get-> url = " + url + " params: " + paramMap.toString());
        HttpEntity<String> entity = new HttpEntity<String>("parameters", headers);
        ResponseEntity<String> results =  restTemplate.exchange(url,HttpMethod.GET, entity, String.class, paramMap);
        String s = results.getBody();
        logger.info("res->" + s);
        return s;
    }
    
    public ResponseEntity<String> getE2(String url, Map<String, ?> paramMap ) {
        logger.info("get-> url = " + url + " params: " + paramMap.toString());
        HttpEntity<String> entity = new HttpEntity<String>("parameters");
        ResponseEntity<String> results =  restTemplate.exchange(url,HttpMethod.GET, entity, String.class, paramMap);
        String s = results.getBody();
        logger.info("res->" + s);
        return results;
    }
    
    /**
     * 一般的GET请求,请求信息附带cookies
     * */
    public String getOCookie(String url, Map<String, ?> paramMap,List<String> cookies ) {
        logger.info("get-> url = " + url + " params: " + paramMap.toString() + " cookies: "+ cookies.toString());
        HttpHeaders headers = new HttpHeaders();
        headers.put(HttpHeaders.COOKIE,cookies);
        //headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
        HttpEntity<String> entity = new HttpEntity<String>("parameters", headers);
        ResponseEntity<String> results =  restTemplate.exchange(url,HttpMethod.GET, entity, String.class, paramMap);

        String s = results.getBody();
        //String s = restTemplate.getForObject(url, String.class, paramMap);
        logger.info("res->" + s);
        return s;
    }
    
    /////////////////////////////////////////post//////////////////////////////////////////////
     /**
     * 一般的POST请求
     * */
    public String postO(String url, MultiValueMap paramMap) {
        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);
        HttpEntity<MultiValueMap<String, Object>> httpEntity = new HttpEntity<>(paramMap, headers);

        logger.info("post-> url = " + url + " params: " + paramMap.toString());
        String s = restTemplateConfig.restTemplate(restTemplateConfig.httpComponentsClientHttpRequestFactory()).postForObject(url, httpEntity, String.class);
        logger.info("res->" + s);
        //logger.info("res->" + JsonFormatUtil.formatJson(s));
        return s;
    }
    /**
     * 一般的POST请求,请求信息为JSONObject
     * */
    public String post_json(String url,JSONObject msg)
    {
        RestTemplate restTemplate = new RestTemplate();
        //请求头
        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
        //请求体
        //封装成一个请求对象
        HttpEntity entity = new HttpEntity(msg.toJSONString(), headers);
        String result = restTemplateConfig.restTemplate(restTemplateConfig.httpComponentsClientHttpRequestFactory()).postForObject(url, entity, String.class);
        return result;
    }

    /**
     * 一般的POST请求,请求信息附带cookies
     * */
    public String postOCookie(String url, MultiValueMap paramMap, List<String> cookies ) {
        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);
        headers.put(HttpHeaders.COOKIE,cookies);
        HttpEntity<MultiValueMap<String, Object>> httpEntity = new HttpEntity<>(paramMap, headers);

        logger.info("post-> url = " + url + " params: " + paramMap.toString());
        String s = restTemplateConfig.restTemplate(restTemplateConfig.httpComponentsClientHttpRequestFactory()).postForObject(url, httpEntity, String.class);
        logger.info("res->" + JsonFormatUtil.formatJson(s));
        return s;
    }
}

4.简单使用

    @Autowired
    private HttpClient httpClient;

get请求:

public JSONObject getUserInfo(String userName,Long userId){
	String url = "http://localhost/demo/getUserInfo?userId={userId}&userName={userName}";
	HashMap<String, String> param = new HashMap<String, String>();
	param.put("userName", userName);
	param.put("userId", 14587);
	String re = httpClient.getO(url, param);
	JSONObject r = JSON.parseObject(re);
    return r;
}

post请求:

    public String updateUserInfo(Long userId,String nickName) {
        String url = "http://localhost/demo/updateNickName";
        MultiValueMap<String, Object> param = new LinkedMultiValueMap<String, Object>();
        param.add("nickName", nickName);
        param.add("userId", userId);
        String re = httpClient.postO(url, param);
        re = JSON.parseObject(re).get("result").toString();
        return re;
    }
### Spring Boot 实现钉钉消息推送 为了通过 Spring Boot 集成并实现钉钉机器人的消息推送功能,可以通过 HTTP 请求向钉钉服务器发送 POST 数据来完成。以下是具体的配置方法以及示例代码。 #### 1. 添加依赖项 在项目的 `pom.xml` 文件中引入必要的依赖库,主要是用于发起 HTTP 请求的工具包: ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!-- 如果使用 OkHttp --> <dependency> <groupId>com.squareup.okhttp3</groupId> <artifactId>okhttp</artifactId> <version>4.9.0</version> </dependency> ``` 上述依赖提供了 Web 功能支持,并允许开发者选择不同的 HTTP 工具(如 RestTemplate 或 OkHttpClient)。如果不想继续使用 RestTemplate,则可以选择其他替代方案[^1]。 --- #### 2. 创建服务类以封装钉钉消息推送逻辑 创建一个新的 Java 类作为服务层组件,负责处理与钉钉机器人交互的具体细节。 ```java import com.fasterxml.jackson.databind.ObjectMapper; import okhttp3.OkHttpClient; import okhttp3.Request; import okhttp3.RequestBody; import org.springframework.stereotype.Service; @Service public class DingTalkService { private static final String DINGTALK_WEBHOOK_URL = "https://oapi.dingtalk.com/robot/send?access_token=your_access_token_here"; public void sendMessage(String messageContent) throws Exception { ObjectMapper objectMapper = new ObjectMapper(); // 构建请求体 JSON 对象 var requestBodyJson = """ { "msgtype": "text", "text": { "content": "%s" } } """.formatted(messageContent); OkHttpClient client = new OkHttpClient(); RequestBody body = RequestBody.create(requestBodyJson, MediaType.get("application/json; charset=utf-8")); Request request = new Request.Builder() .url(DINGTALK_WEBHOOK_URL) .post(body) .build(); try (var response = client.newCall(request).execute()) { if (!response.isSuccessful()) { throw new RuntimeException("Failed to send message to DingTalk: " + response.body().string()); } } catch (Exception e) { System.err.println("Error occurred while sending the message: " + e.getMessage()); } } } ``` 此代码片段展示了如何构建一个简单的 RESTful API 调用来触发钉钉的消息通知。注意替换占位符 `"your_access_token_here"` 为实际有效的访问令牌。 --- #### 3. 处理异常情况下的重试机制 当遇到网络错误或其他不可控因素导致失败时,应考虑加入自动重试策略。这可通过定时器或者外部框架辅助完成。下面是一个基于自定义循环的方式实现简单重试的例子: ```java import java.util.concurrent.TimeUnit; // 修改后的sendMessage 方法增加 retryCount 参数控制最大尝试次数 public boolean sendMessageWithRetry(String messageContent, int maxRetries) { int attempt = 0; do { try { this.sendMessage(messageContent); return true; // 成功则返回true } catch (Exception ex) { attempt++; if(attempt >= maxRetries){ System.out.printf("Max retries (%d) reached.",maxRetries ); return false; } long sleepTimeMs = Math.min(5L * TimeUnit.SECONDS.toMillis(),Math.pow(2,attempt)*1000); try{ Thread.sleep(sleepTimeMs ); }catch(Exception ignored){} } }while(true); } ``` 这里实现了指数退避算法来进行逐步延长等待时间间隔再重新提交请求直到达到设定的最大重试数为止[^2]。 --- #### 4. 测试控制器接口 最后一步是在应用程序入口处暴露一个测试端点供调用者验证整个流程是否正常工作: ```java @RestController @RequestMapping("/dingtalk") public class DingTalkController { @Autowired private DingTalkService dingTalkService; @PostMapping("/send-message") public ResponseEntity<String> sendMessage(@RequestBody Map<String,String> payload){ String msg=payload.getOrDefault("message","Default Message"); Boolean success=this.dingTalkService.sendMessageWithRetry(msg ,3 ); return success ?ResponseEntity.ok("Message Sent Successfully!") :ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR ).body("Failed To Send After Retrying Three Times."); } } ``` 以上即完成了从零搭建到最终部署的一整套解决方案描述[^1]. ---
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值