ApacheFtpServer 集成java项目开发

Apache FtpServer 是一个100%纯Java的FTP服务器。它的设计旨在提供基于目前可用的开放协议的一个完整的、便携的FTP服务器引擎解决方案,除了能嵌入到Java应用程序,还可以作为 Windows 服务或 Unix/Linux 的守护进程独立运行。此外FtpServer还提供集成Spring应用程序的支持…… ——摘自 Apache FtpServer 官网

ftp服务器的下载和安装我就不多说了,这些网上信息太多了,百度一大把。但其它要注意一点的事,下下来的ftp服务器不能马上运行使用,会出现Ftp服务器启动正常,但是客户端链接不上,原因是ftp服务器中的匿名用户并没有提供使用,可通过以下方式进行修改添加用户即可。
找到ftp解压目录下的bin/ftpd.bat文件,修改其中第60行,将CommandLine改为AddUser并另存为addUser-ftpd.bat文件;
rem ----- call java.. -----------------------------------------------
set MAIN_CLASS=org.apache.ftpserver.main.CommandLine
set JAVA_CMD=%JAVA_HOME%\bin\java

修改为
rem ----- call java.. -----------------------------------------------
set MAIN_CLASS=org.apache.ftpserver.main.AddUser
set JAVA_CMD=%JAVA_HOME%\bin\java


执行cmd bat命令或将以下内容记录到一个bat脚本中并放在bin目录中,双击即可启动apache ftp服务器。
addUser-ftpd.bat res/conf/my-ftpd-typical.xml

在启动之后,会提示你输入用户名、密码、域、最多链接IP、上传下载速度等,请按需填入即行。
User name:
test
Password:
test
Home directory:
D:/test
Enabled (Y/N):
y
Max idle time in seconds (0 for none):
3000
Write permission (Y/N):
Y
Maximum number of concurrent logins (0 for no restriction)
20
Maximum number of concurrent logins per IP (0 for no restriction)
2
Maximum download rate (0 for no restriction)
20000
Maximum upload rate (0 for no restriction)
20000


用户创建完毕之后,即可启动ftp服务器了,但建议同样再用如下模式,将以下内容记录到一个bat脚本中并另放在bin目录中,如我的bat文件叫:run-ftpd.bat,双击即可启动.
ftpd.bat res/conf/my-ftpd-typical.xml


OK,到目前为之apache服务器可以正常运行了,你可以用ftp客户端进行连接了,也可以在IE浏览器中访问,如:ftp://127.0.0.1:2121/,之后提示输入用户名和密码(为你新增加的用户)即可看到服务器上的目录。


接下来进入到将apache ftp server集成到java开发环境中,在ftp解压后的common/lib目录中包含了我们开发所需的jar包。
将以下JAR包加入到工程中:
ftplet-api-1.0.6.jar
ftpserver-core-1.0.6.jar
mina-core-2.0.4.jar
slf4j-api-1.5.2.jar
slf4j-log4j12-1.5.2.jar
log4j-1.2.14.jar
jcl-over-slf4j-1.5.2.jar

将ftp解压目录下的res/config/users.properties文件复制到你的java项目中(该文件中包含你所创建的用户信息)

我们创建管理Ftp服务器的类,以下为FtpServerTest.java的代码:
import java.io.File;
import org.apache.ftpserver.FtpServer;
import org.apache.ftpserver.FtpServerFactory;
import org.apache.ftpserver.ftplet.FtpException;
import org.apache.ftpserver.listener.ListenerFactory;
import org.apache.ftpserver.ssl.SslConfigurationFactory;
import org.apache.ftpserver.usermanager.PropertiesUserManagerFactory;

/**
 * 启动/关闭 Apache FTP Server服务器管理
 */
public class FtpServerTest {	
	public static void main(String [] args){	
		FtpServerTest ftp=new FtpServerTest();
		
		//简单模式启动FTP服务器
		//FtpServerFactory serverFactory = new FtpServerFactory();
		//FtpServer server = serverFactory.createServer();
		
		FtpServer server=ftp.createFtpServer();
		ftp.start(server);				
		try{
			//启动10分钟做测试
			Thread.sleep(600000);
		}catch(Exception e){
			e.printStackTrace();
		}		
		ftp.stop(server);
		
	}
	
	public FtpServer createFtpServer(){				
		//相对复杂一点儿的配置方式:
		FtpServerFactory serverFactory = new FtpServerFactory();		        
		ListenerFactory factory = new ListenerFactory();		        
		//设置监听端口
		factory.setPort(2121);
						
		String porject=System.getProperty("user.dir") + File.separator+"bin";
		System.out.println("文件存放目录:"+porject);
		//定义SSL 配置
		//SslConfigurationFactory ssl = new SslConfigurationFactory();
		//ssl.setKeystoreFile(new File(porject+"/config/ftpserver.jks"));
		//ssl.setKeystorePassword("password");
		
		//加载SSL配置
		//factory.setSslConfiguration(ssl.createSslConfiguration());
		//factory.setImplicitSsl(true);
		
		//默认存在一个default的监听端口,这里采用这种方式替换默认的监听端口
		serverFactory.addListener("default", factory.createListener());
		PropertiesUserManagerFactory userManagerFactory = new PropertiesUserManagerFactory();
		//加载用户属性文件,专门用来管理FTP链接用户(如:用户名、密码、最多链接IP、上传下载传输速度)
		userManagerFactory.setFile(new File(porject+"/config/myusers.properties"));
		serverFactory.setUserManager(userManagerFactory.createUserManager());		
		
		System.out.println(userManagerFactory.getUrl());

		// 创建服务
		FtpServer server = serverFactory.createServer(); 								
		return server;
	}		
	
	/**
	 * 启动 server
	 * @param server
	 */
	public void start(FtpServer server){
		try{
			server.start();
			System.out.println("已启动");
		}catch(FtpException ftpe){
			ftpe.printStackTrace();
		}
	}
	
	/**
	 * 关闭server
	 * @param server
	 */
	public void stop(FtpServer server){
		server.stop();
		System.out.println("已关闭");
	}
}


客户端我们同样采用apache的开源项目commons-net-3.3.jar,该工程是一个专用来提供解析处理网络链接等服务与工具,将该jar包加入到java项目中。
我们再创建链接Ftp服务器的客户端类,以下为FtpTest.java的代码:
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.net.URLEncoder;
import org.apache.commons.io.IOUtils;
import org.apache.commons.net.ftp.FTPClient;
import org.apache.commons.net.ftp.FTPClientConfig;

/** 
* Apache commons-net FPT上传与下载
*/ 
public class FtpTest { 
    public static void main(String[] args) { 
        testUpload(); 
        //testDownload(); 
    } 

    /** 
     * FTP上传单个文件测试 
     */ 
    public static void testUpload() { 
        FTPClient ftpClient = new FTPClient(); 
        FileInputStream fis = null; 

        try { 
            ftpClient.connect("127.0.0.1",2121);                              
            ftpClient.login("myuser", "12345678"); 

            File srcFile = new File("D:\\test\\test.jpg"); 
            fis = new FileInputStream(srcFile); 
            //设置上传目录 
            ftpClient.changeWorkingDirectory(""); 
            ftpClient.setBufferSize(1024); 
            //ftpClient.setControlEncoding("UTF-8"); 
            //设置文件类型(二进制) 
            ftpClient.setFileType(FTPClient.BINARY_FILE_TYPE); 
            
            String fileName="测试2.jpg";            
            fileName=new String(fileName.getBytes("UTF-8"),"ISO-8859-1");
            ftpClient.storeFile(fileName, fis); 
            System.out.println("上传完毕");
        } catch (IOException e) { 
            e.printStackTrace(); 
            throw new RuntimeException("FTP客户端出错!", e); 
        } finally { 
            IOUtils.closeQuietly(fis); 
            try { 
                ftpClient.disconnect(); 
            } catch (IOException e) { 
                e.printStackTrace(); 
                throw new RuntimeException("关闭FTP连接发生异常!", e); 
            } 
        } 
    } 

    /** 
     * FTP下载单个文件测试 
     */ 
    public static void testDownload() { 
        FTPClient ftpClient = new FTPClient(); 
        FileOutputStream fos = null; 

        try { 
            ftpClient.connect("127.0.0.1",2121); //IP,端口
            ftpClient.login("myuser", "12345678"); //用户名,密码

            String remoteFileName = "测试.jpg"; //要下载的文件名称
            remoteFileName=new String(remoteFileName.getBytes("UTF-8"),"ISO-8859-1");
            fos = new FileOutputStream(new File("D:\\test.jpg")); 

            ftpClient.setBufferSize(1024);             
            //设置文件类型(二进制) 
            ftpClient.setFileType(FTPClient.BINARY_FILE_TYPE); 
            ftpClient.retrieveFile(remoteFileName, fos);
            
            System.out.println("下载完毕");
        } catch (IOException e) { 
            e.printStackTrace(); 
            throw new RuntimeException("FTP客户端出错!", e); 
        } finally { 
            IOUtils.closeQuietly(fos); 
            try { 
                ftpClient.disconnect(); 
            } catch (IOException e) { 
                e.printStackTrace(); 
                throw new RuntimeException("关闭FTP连接发生异常!", e); 
            } 
        } 
    } 
} 


先启动服务器,执行FtpServerTest类,该服务设置启动为10分钟,10分钟后服务就会停止;
再启动客户端,执行FtpTest类,该类中包括上传文件、下载文件两个方法。
到此为止,基本上ftp服务端的管理与客户端的上传下载的例子已成功执行。

注意事项:
1.刚开始测试的时候,发现在上传中文名称的文件时,上传文件失败,网络上也很多这个问题,但是没有给出解决方案,只是说了一下ftp服务器的字符格式与系统的字符格式不统一、或与客户端的字符格式不统一。
其实只需要将要上传到服务器的文件名称,或要下载的文件名称通过String转码一下就行。如我们上面代码中的:
String fileName=new String(fileName.getBytes("UTF-8"),"ISO-8859-1");
很简单,就这样解决了ftp上传下载中文文件名称失败的问题。


你可能感兴趣的:(ApacheFtpServer 集成java项目开发)