Commons net之FTP

矫情吗；* 2022-08-07 11:42 167阅读 0赞

官网API http://commons.apache.org/proper/commons-net/apidocs/index.html

最近用到FTP相关的操作，因为有伟大开源社区的存在，也不用自己再实现一把FTP协议了，看了下常用的FTP软件包，主要有Apache和Commons net中的Commons FTP和JDK中的自带的ftp操作类，看了下网友们写的例子，对比了一下。虽然我也不想每一个项目都依赖一堆外部JAR包，但还是选择采用Commons FTP，主要原因就是JDK中自带的是sun的内部包，并没有公开，并不能保证以后版本中能用。为方便使用，由于需要的功能也比较简单，也就做了下简单的封装。代码如下：

Java代码 ![收藏代码][icon_star.png]

1.  **package** org.migle.util; 
2.  
3.  **import** java.io.File; 
4.  **import** java.io.FileNotFoundException; 
5.  **import** java.io.FileOutputStream; 
6.  **import** java.io.IOException; 
7.  **import** java.io.InputStream; 
8.  **import** java.net.SocketException; 
9.  
10. **import** org.apache.commons.logging.Log; 
11. **import** org.apache.commons.logging.LogFactory; 
12. 
13. **import** org.apache.commons.net.ftp.FTP; 
14. **import** org.apache.commons.net.ftp.FTPClient; 
15. **import** org.apache.commons.net.ftp.FTPReply; 
16. 
17. /\*\*
18.  \* FTP Client工具类，封装了<a href="http://commons.apache.org/net/">Jakarta Commons Net
19.  \* FTPClient</a>对常用的功能如上传、下载 等功能提供简易操作，如果需要Jakarta Commons Net
20.  \* FTPClient的全部功能可以通过\{@link \#getFtpclient()\}
21.  \* 得到org.apache.commons.net.ftp.FTPClient
22.  \* 对象，对于org.apache.commons.net.ftp.FTPClient的全部功能有请查看 <a href =
23.  \* "http://commons.apache.org/net/api/org/apache/commons/net/ftp/FTPClient.html"
24.  \* > FTPClient API </a>
25.  \* 
26.  \* @since V2.0
27.  \* @version V1.0 2010-2-26
28.  \* @author 研发中心
29.  \*/
30. **public** **class** FTPClientUtil \{ 
31. 
32. **private** **static** Log logger = LogFactory.getLog(FTPClient.**class**); 
33. 
34. **private** FTPClient ftpclient; 
35. 
36. **public** FTPClientUtil(String host, **int** port) **throws** Exception \{ 
37. **this**(host, port, **null**, **null**); 
38.  \} 
39. 
40. **public** FTPClientUtil(String host, **int** port, String username, String password) 
41. **throws** Exception \{ 
42.  ftpclient = **new** FTPClient(); 
43. **try** \{ 
44.  ftpclient.connect(host, port); 
45. **int** reply = ftpclient.getReplyCode(); 
46. **if** (!FTPReply.isPositiveCompletion(reply)) \{ 
47.  ftpclient.disconnect(); 
48.  logger.fatal("FTP服务器拒绝连接"); 
49. **throw** **new** Exception("FTP服务器拒绝连接"); 
50.  \} 
51. **if** (username != **null**) \{ 
52. **if** (!ftpclient.login(username, password)) \{ 
53.  ftpclient.disconnect(); 
54.  logger.fatal("登陆验证失败，请检查账号和密码是否正确"); 
55. **throw** **new** Exception("登陆验证失败，请检查账号和密码是否正确"); 
56.  \} 
57.  \} 
58.  \} **catch** (SocketException e) \{ 
59.  logger.fatal("无法连接至指定FTP服务器", e); 
60. **throw** **new** Exception(e); 
61.  \} **catch** (IOException e) \{ 
62.  logger.fatal("无法用指定用户名和密码连接至指定FTP服务器", e); 
63. **throw** **new** Exception(e); 
64.  \} 
65.  \} 
66. 
67. /\*\*
68.  \* 
69.  \* @param path
70.  \* 文件在FTP上存储的绝路径
71.  \* @param input
72.  \* 上传文
73.  \* @throws IOException
74.  \*/
75. **public** **boolean** upload(String pathname, InputStream input) 
76. **throws** IOException \{ 
77. // 是否是在根目录 下
78.  ftpclient.setFileType(FTP.BINARY\_FILE\_TYPE); 
79. **if** (pathname.indexOf("/") != -1) \{ 
80.  String path = pathname.substring(0, pathname.lastIndexOf("/")); 
81.  mkdir(path); 
82.  \} 
83. **return** ftpclient.storeFile(**new** String(pathname.getBytes(), ftpclient.getControlEncoding()), input); 
84.  \} 
85. 
86. /\*\*
87.  \* 从FTP服务器上下载pathname指定的文件，命名为localName
88.  \* 
89.  \* @param pathname
90.  \* @param localName
91.  \* @return
92.  \* @throws Exception
93.  \*/
94. **public** **boolean** download(String pathname, String localName) **throws** Exception \{ 
95.  String filename = localName != **null** ? localName : pathname 
96.  .substring(pathname.lastIndexOf("/") + 1); 
97. 
98. **if** (filename == **null** || filename.isEmpty()) \{ 
99. **return** **false**; 
100.  \} 
101. 
102. // 设置被动模式
103.  ftpclient.enterLocalPassiveMode(); 
104. // 设置以二进制方式传输
105.  ftpclient.setFileType(FTP.BINARY\_FILE\_TYPE); 
106. 
107. **if** (ftpclient.listFiles(**new** String(pathname.getBytes(),ftpclient.getControlEncoding())).length == 0) \{ 
108.  logger.fatal("下载文件不存在"); 
109. **throw** **new** Exception("下载文件不存在"); 
110.  \} 
111. 
112.  File tmp = **new** File(filename + "\_tmp"); // 临时文件
113.  File file = **new** File(filename); 
114.  FileOutputStream output = **null**; 
115. **boolean** flag; 
116. **try** \{ 
117.  output = **new** FileOutputStream(tmp); 
118.  flag = ftpclient.retrieveFile(**new** String(pathname.getBytes(),ftpclient.getControlEncoding()), output); 
119.  output.close(); 
120. **if** (flag) \{ 
121. // 下载成功,重命名临时文件。
122.  tmp.renameTo(file); 
123.  System.out.println(file.getAbsolutePath()); 
124.  \} 
125.  \} **catch** (FileNotFoundException e) \{ 
126.  logger.fatal("下载文件失败", e); 
127. **throw** **new** Exception(e); 
128.  \} **finally** \{ 
129.  output.close(); 
130.  \} 
131. 
132. **return** flag; 
133.  \} 
134. 
135. /\*\*
136.  \* 只删除文件,如果删除空目录请用如下方法： <code>
137.  \* getFtpclient().removeDirectory(String pathname) 
138.  \* </code> 参考
139.  \* \{@link org.apache.commons.net.ftp.FTPClient FTPClient\}
140.  \* 
141.  \* @param pathname
142.  \* @return 成功删除返回true,否则返回false(如果文件不存在也返回false)
143.  \* @throws IOException
144.  \*/
145. **public** **boolean** delete(String pathname) **throws** IOException \{ 
146. **return** ftpclient.deleteFile(**new** String(pathname.getBytes(),ftpclient.getControlEncoding())); 
147.  \} 
148. 
149. /\*\*
150.  \* 改变当前目录至pathname,"/"代表根目录
151.  \* 
152.  \* @param pathname
153.  \* 路径名
154.  \* @return 如果改变成功返true否则返回false
155.  \* @throws IOException
156.  \*/
157. **public** **boolean** changeWorkingDirectory(String pathname) **throws** IOException \{ 
158. **return** ftpclient.changeWorkingDirectory(**new** String(pathname.getBytes(),ftpclient.getControlEncoding())); 
159.  \} 
160. 
161. /\*\*
162.  \* @return \{@link org.apache.commons.net.ftp.FTPClient FTPClient\}对象
163.  \*/
164. **public** FTPClient getFtpclient() \{ 
165. **return** **this**.ftpclient; 
166.  \} 
167. 
168. /\*\*
169.  \* @param ftpclient
170.  \* \{@link org.apache.commons.net.ftp.FTPClient FTPClient\}对象
171.  \*/
172. **public** **void** setFtpclient(FTPClient ftpclient) \{ 
173. **this**.ftpclient = ftpclient; 
174.  \} 
175. 
176. **public** **void** close() **throws** Exception \{ 
177.  ftpclient.disconnect(); 
178.  \} 
179. 
180. /\*\*
181.  \* 
182.  \* @param pathname
183.  \* 要创建的目录路径，可以是相对路径，也可以是绝路径("/"开始)
184.  \* @return 如果成功创建目录返回true，否则返回false(如果目录已存在也返回false)
185.  \* @throws IOException
186.  \*/
187. **public** **boolean** mkdir(String pathname) **throws** IOException \{ 
188. //ftpclient.setControlEncoding("ISO-8859-1");
189. //注意编码，如果不编码文件中文目录无法创建
190. **return** ftpclient.makeDirectory(**new** String(pathname.getBytes(),ftpclient.getControlEncoding())); 
191.  \} 
192. 
193. **public** **static** **void** main(String\[\] args) **throws** Exception \{ 
194. // URI uri = new URI(
195. // "ftp://100.180.185.205/oracle\_10201\_database\_win32/database/welcome.html");
196. // System.out.println(uri.toURL().getHost());
197. // System.out.println(uri.toURL().getPath());
198. // System.out.println(uri.toURL().getFile());
199. 
200.  FTPClientUtil ftputil = **new** FTPClientUtil("100.180.185.205", 21, "username", 
201. "password"); 
202.  System.out.println(ftputil.mkdir("测试")); 
203.  ftputil.close(); 
204. // ftputil.upload("drop.sql", new FileInputStream("c:/drop.sql"));
205. // ftputil.download("/drop.sql", "drop.sql");
206. // FTPClient ftp = ftputil.getFtpclient();
207. // FTPListParseEngine engine = ftp.initiateListParsing();
208. // System.out.println(ftp.listFiles().length);
209. // while (engine.hasNext()) \{ 
210. // FTPFile\[\] files = engine.getNext(25); // "page size" you want
211. // \}
212. 
213. // FTPClient ftpclient = ftputil.getFtpclient();
214. //
215. // FTPFile\[\] f = ftpclient.listFiles("/kk/aa/drop2.sql");
216. // System.out.println(f.length);
217. // System.out.println(ftpclient.makeDirectory("/tt/aa/bb"));
218. // System.out.println(ftpclient.getReplyString());
219. // ftpclient.changeWorkingDirectory("/tt/aa/bb");
220. // 
221. // //System.out.println(ftpclient.deleteFile("/tt/aa/cc/"));
222. // System.out.println(ftpclient.getReplyString());
223. // ftpclient.changeWorkingDirectory("/");
224. // System.out.println(ftpclient.listFiles().length);
225. 
226. // System.out.println("a".lastIndexOf("/"));
227.  \} 
228. \}

[icon_star.png]: /images/20220805/992bbd009b9d4e109c2584aedac7b20a.png