springboot项目 报错: org.influxdb.InfluxDBIOException: java.net.SocketTimeoutException: timeout

项目版本

springboot: 2.1.3

问题描述

查询Influxdb时因为网络等原因查询超时

解决方案

实现接口org.springframework.boot.autoconfigure.influx.InfluxDbOkHttpClientBuilderProvider
自定义OkHttpClient.Builder手动设置超时时间
代码如下

package com.kstsixeam.config;

import okhttp3.OkHttpClient;
import org.springframework.context.annotation.Configuration;

import java.util.concurrent.TimeUnit;

@Configuration
public class InfluxDbOkHttpClientBuilderProvider implements org.springframework.boot.autoconfigure.influx.InfluxDbOkHttpClientBuilderProvider {

    @Override
    public OkHttpClient.Builder get() {
    	// 设置超时时间为100秒
        return new OkHttpClient.Builder()
                .connectTimeout(100, TimeUnit.SECONDS)
                .readTimeout(100, TimeUnit.SECONDS)
                .writeTimeout(100, TimeUnit.SECONDS);
    }
}

解决思路

1. 查看报错信息

org.influxdb.InfluxDBIOException: java.net.SocketTimeoutException: timeout
	at org.influxdb.impl.InfluxDBImpl.execute(InfluxDBImpl.java:514)
	at org.influxdb.impl.InfluxDBImpl.query(InfluxDBImpl.java:390)
    ...

2. 查看org.influxdb.impl.InfluxDBImpl.execute(InfluxDBImpl.java:514)代码
   
   这里发现是这行代码出错，查看代码发现call由influxDBService生成
   
   继续查找，找到influxDBService的实例化代码
   
   可以看到它的超时时长由这个构造方法传入的clicent来决定的。
3. 查看springboot实例化该类的代码
   点击Endpoints=>Beans=>myModule
   搜索influxdb，点击，即可跳转到springboot实例化该bean的代码
   贴一下源码

/*
* Copyright 2012-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.springframework.boot.autoconfigure.influx;

import okhttp3.OkHttpClient;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.influxdb.InfluxDB;
import org.influxdb.impl.InfluxDBImpl;

import org.springframework.beans.factory.ObjectProvider;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
* {@link EnableAutoConfiguration Auto-configuration} for InfluxDB.
*
* @author Sergey Kuptsov
* @author Stephane Nicoll
* @author Eddú Meléndez
* @since 2.0.0
*/
@Configuration
@ConditionalOnClass(InfluxDB.class)
@EnableConfigurationProperties(InfluxDbProperties.class)
public class InfluxDbAutoConfiguration {

   private static final Log logger = LogFactory.getLog(InfluxDbAutoConfiguration.class);

   private final InfluxDbProperties properties;

   private final OkHttpClient.Builder builder;

   public InfluxDbAutoConfiguration(InfluxDbProperties properties,
   		ObjectProvider<InfluxDbOkHttpClientBuilderProvider> builder,
   		ObjectProvider<OkHttpClient.Builder> deprecatedBuilder) {
   	this.properties = properties;
   	this.builder = determineBuilder(builder.getIfAvailable(),
   			deprecatedBuilder.getIfAvailable());
   }

   @Deprecated
   private static OkHttpClient.Builder determineBuilder(
   		InfluxDbOkHttpClientBuilderProvider builder,
   		OkHttpClient.Builder deprecatedBuilder) {
   	if (builder != null) {
   		return builder.get();
   	}
   	else if (deprecatedBuilder != null) {
   		logger.warn(
   				"InfluxDB client customizations using a OkHttpClient.Builder is deprecated, register a "
   						+ InfluxDbOkHttpClientBuilderProvider.class.getSimpleName()
   						+ " bean instead");
   		return deprecatedBuilder;
   	}
   	return new OkHttpClient.Builder();
   }

   @Bean
   @ConditionalOnMissingBean
   @ConditionalOnProperty("spring.influx.url")
   public InfluxDB influxDb() {
   	return new InfluxDBImpl(this.properties.getUrl(), this.properties.getUser(),
   			this.properties.getPassword(), this.builder);
   }

}

查看这部分代码，发现springboot会先去找InfluxDbOkHttpClientBuilderProvider的实例化对象，如果没有，就使用OkHttpClient.Builder的实例化对象。
换言之，如果我们只想自定义InfluxDb的OkHttpClient.Builder的属性，那么我们就可以实现InfluxDbOkHttpClientBuilderProvider接口就可以了
5. 实现InfluxDbOkHttpClientBuilderProvider。

• InfluxDbOkHttpClientBuilderProvider的代码
  
• 实现
  见解决方案

最后

其实关于此解决方案springboot早有提示

WARN [main] org.springframework.boot.autoconfigure.influx.InfluxDbAutoConfiguration

InfluxDB client customizations using a OkHttpClient.Builder is deprecated, 
register a InfluxDbOkHttpClientBuilderProvider bean instead