# ftpClientPool

**Repository Path**: tkwayne/ftpClientPool

## Basic Information

- **Project Name**: ftpClientPool
- **Description**: Ftp连接池
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 8
- **Forks**: 1
- **Created**: 2019-08-26
- **Last Updated**: 2024-11-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ftpClientPool

#### 介绍
Ftp连接池

#### 软件架构
FTPClientHelper为开放接口，进行FTP的操作。
FTPAbandonedConfig/FtpPoolConfig 为自定义客户端参数，具体还要结合FTP服务器参数进行调整。

#### 安装教程
Spring 项目直接注入成bean

	<beans>
		<!-- ftp连接池配置参数 -->
		<bean id="ftpPoolConfig" class="com.vedeng.ftpclient.config.FtpPoolConfig">
			<property name="host" value="${ftp_url}"/>
			<property name="port" value="${ftp_port}"/>
			<property name="userName" value="${ftp_user}"/>
			<property name="password" value="${ftp_password}"/>
			<property name="connectTimeOut" value="${ftp_connectTimeOut}"/>
			<property name="controlEncoding" value="${ftp_controlEncoding}"/>
			<property name="bufferSize" value="${ftp_bufferSize}"/>
			<property name="fileType" value="${ftp_fileType}"/>
			<property name="dataTimeout" value="${ftp_dataTimeout}"/>
			<property name="useEPSVWithIPv4" value="${ftp_useEPSVWithIPv4}"/>
			<property name="passiveMode" value="${ftp_passiveMode}"/>
			<!--空闲链接数目 与FTP服务器设置的单个IP最大链接数有关-->
			<property name="maxIdle" value="${ftp_maxIdle}"/>
			<!--最大链接数目 与FTP服务器设置的单个IP最大链接数有关-->
			<property name="maxTotal" value="${ftp_maxTotal}"/>
			<!--连接池满的时候超时时间 当池满的时候新的链接阻塞多少ms后超时-->
			<property name="maxWaitMillis" value="${ftp_maxWait}"/>
			<!--每多少ms运行一次空闲连接回收器 -->
			<property name="timeBetweenEvictionRunsMillis" value="${ftp_evictionRunTime}"/>
			<!--池中的连接空闲多少ms后被回收-->
			<property name="minEvictableIdleTimeMillis" value="${ftp_minEvictionTime}"/>
			<!--指明连接是否被空闲连接回收器(如果有)进行检验.
			如果检测失败[检测代码是FTPClientFactory.validateObject(),及发送一个命令去FTP服务器验证是否有效],
			则连接将被从池中去除 -->
			<property name="testWhileIdle" value="${ftp_testWhileIdle}"/>
		</bean>

		<!-- ftp连接池对象丢弃策略配置参数 -->
		<bean id="ftpAbandonedConfig" class="com.vedeng.ftpclient.config.FTPAbandonedConfig">
			<!--当前ftp 连接池内正在使用的链接是否需要被检测回收-->
			<property name="removeAbandonedOnMaintenance" value="${ftp_removeFlag}"/>
			<!--当前ftp 连接池内正在使用的链接占用多少时间后被回收-->
			<property name="removeAbandonedTimeout" value="${ftp_removeTimeOut}"/>
		</bean>

		<!-- ftp客户端工厂 -->
		<bean id="ftpClientFactory" class="com.vedeng.ftpclient.core.FTPClientFactory">
			<property name="ftpPoolConfig" ref="ftpPoolConfig"></property>
			<property name="ftpAbandonedConfig" ref="ftpAbandonedConfig"></property>
		</bean>
		<!-- ftp客户端连接池对象 -->
		<bean id="ftpClientPool" class="com.vedeng.ftpclient.core.FTPClientPool" init-method="initPool">
			<constructor-arg index="0" ref="ftpClientFactory"></constructor-arg>
		</bean>
		<!-- ftp客户端辅助bean-->
		<bean id="ftpClientHelper" class="com.vedeng.ftpclient.client.FTPClientHelper">
			<property name="ftpClientPool"  ref="ftpClientPool"/>
		</bean>
	</beans>

#### 使用说明

1. FTPClientPool.initPool() Spring配置时提供初始化链接。
   不建议直接使用FTPClientPool，需要手动申请和关闭链接。
2. FTPClientHelper.downloadFile(); 下载。
3. FTPClientHelper.storeFile(); 上传。