基于spring boot sftp文件上传

基于spring boot sftp文件上传

2018年06月21日 11:30:17 奇点_ 阅读数 3101

对sftp文件上传将行封装，实现连接的单例模式，完成线程安全的改进，sftp文件上传下载失败的重试。

application.yml配置文件

 

1. sftp:

2.    ip: 192.168.43.102

3.    port: 22

4.    username: admin

5.    password: admin

6.    downloadSleep: 100 #文件下载失败下次超时重试时间

7.    downloadRetry: 10 #文件下载失败重试次数

8.    uploadSleep: 100 #文件上传失败下次超时重试时间

9.    uploadRettry: 10 #文件上传失败重试次数

SFTPClientUtils.java

包含sftp文件上传的一些基本方法，单个上传，批量下载，单个文件下载

1. @Component

2. @ConfigurationProperties(prefix = "sftp")

3. public class SFTPClientUtils {

4. private static int downloadSleep;

5. private static int downloadRetry;

6. private static int uploadSleep;

7. private static int uploadRettry;

8. private static Logger LOGGER = LoggerFactory.getLogger(SFTPClientUtils.class);

9. /** 

10. * 文件上传  

11.      * 将文件对象上传到sftp作为文件。文件完整路径=basePath+directory

12.      * 目录不存在则会上传文件夹 

13.      * @param basePath  服务器的基础路径  

14.      * @param directory  上传到该目录   

15.      * @param sftpFileName  sftp端文件名   

16.      * @param file   文件对象   

17.      */    

18.     public synchronized static boolean upload(String basePath,String directory, String filePath){    

19.     boolean result = false;

20.     Integer i = 0;

21.         while(!result){

22.         ChannelSftp sftp = SFTPConnectionFactory.getInstance().makeConnection();

23.         try {     

24.                 sftp.cd(basePath);  

25.                 sftp.cd(directory);    

26.             } catch (SftpException e) {   

27.             LOGGER.info("sftp文件上传，目录不存在开始创建");

28.                 String [] dirs=directory.split("/");  

29.                 String tempPath=basePath;  

30.                 for(String dir:dirs){  

31.                     if(null== dir || "".equals(dir)) continue;  

32.                     tempPath+="/"+dir;  

33.                     try{   

34.                         sftp.cd(tempPath);  

35.                     }catch(SftpException ex){  

36.                         try {

37.     sftp.mkdir(tempPath);

38.     sftp.cd(tempPath);  

39.     } catch (SftpException e1) {

40.     LOGGER.error("sftp文件上传，目录创建失败，错误信息:"+e1.getMessage()+ex.getMessage());

41.     }  

42.                     }  

43.                 }  

44.             }    

45.             try {

46.             File file = new File(filePath);

47.     sftp.put(new FileInputStream(file) , file.getName());

48.     if(i>0){

49. LOGGER.info("sftp重试文件上传成功，ftp路径:"+basePath+directory+",文件名称:"+file.getName());

50. }else{

51. LOGGER.info("sftp文件上传成功，ftp路径为"+basePath+directory+",文件名称:"+file.getName());

52. }

53.     result = true;

54.     } catch (Exception e) {

55.     i++;

56.     LOGGER.error("sftp文件上传失败，重试中。。。第"+i+"次，错误信息"+e.getMessage());

57. if(i>uploadRettry){

58. LOGGER.error("sftp文件上传失败，超过重试次数结束重试，错误信息"+e.getMessage());

59. return result;

60. }

61.     try {

62. TimeUnit.MILLISECONDS.sleep(uploadSleep);

63. } catch (InterruptedException e1) {

64. e1.printStackTrace();

65. }

66.     }  

67.             

68.         }

69.    

70.         return result;

71.     }   

72.     /**  

73.      * 下载文件。 

74.      * @param directory 下载目录   

75.      * @param downloadFile 下载的文件  

76.      * @param saveFile 存在本地的路径  

77.      */      

78.     public synchronized static boolean download(String directory, String downloadFile, String saveFile){    

79.     boolean result = false;

80.     Integer i = 0;

81.     while(!result){

82.     ChannelSftp sftp = SFTPConnectionFactory.getInstance().makeConnection();

83.     if (directory != null && !"".equals(directory)) {    

84.     try {

85.     sftp.cd(directory);

86.     } catch (SftpException e) {

87.     LOGGER.error("sftp文件下载，目录不存在，错误信息"+e.getMessage());

88.     }    

89.     }    

90.     File file = new File(saveFile+downloadFile); 

91.     FileOutputStream fileOutputStream = null;

92.     try {

93.     fileOutputStream = new FileOutputStream(file);

94.     } catch (FileNotFoundException e1) {

95.     LOGGER.error("sftp文件下载失败，本地目录不存在"+e1.getMessage());

96.     }

97.     try {

98.     sftp.get(downloadFile, fileOutputStream);

99. if(i>0){

100.     LOGGER.info("sftp文件重试下载成功,sftp地址:"+directory+",本地文件地址:"+saveFile);

101.     }else{

102.     LOGGER.info("sftp文件下载成功,sftp地址:"+directory+",本地文件地址:"+saveFile);

103.     }

104.     result = true;

105.     } catch (SftpException e1) {

106.     i++;

107. LOGGER.error("sftp文件下载失败，重试中。。。第"+i+"次，错误信息"+e1.getMessage());

108. if(i>downloadRetry){

109. LOGGER.error("ftp文件下载失败，超过重试次数结束重试，错误信息"+e1.getMessage());

110. return result;

111. }

112. try {

113. TimeUnit.MILLISECONDS.sleep(downloadSleep);

114. } catch (Exception e2) {

115. e2.printStackTrace();

116. }

117.     }finally {

118.     try {

119.     fileOutputStream.close();

120.     } catch (IOException e) {

121.    

122.     e.printStackTrace();

123.     }

124.     }

125.     }

126.         return result;

127.     }    

128.     

129.       

130.       

131.     /**  

132.      * 删除文件  

133.      * @param directory 要删除文件所在目录  

134.      * @param deleteFile 要删除的文件  

135.      */    

136.     public synchronized static boolean delete(String directory, String deleteFile){    

137.     boolean result = false;

138.     ChannelSftp sftp = SFTPConnectionFactory.getInstance().makeConnection();

139.     try {

140. sftp.cd(directory);

141. sftp.rm(deleteFile);

142. } catch (SftpException e) {

143. // TODO Auto-generated catch block

144. e.printStackTrace();

145. }    

146.         result = true;

147.         return result;

148.     }

149. public static int getDownloadSleep() {

150. return downloadSleep;

151. }

152. public static void setDownloadSleep(int downloadSleep) {

153. SFTPClientUtils.downloadSleep = downloadSleep;

154. }

155. public static int getDownloadRetry() {

156. return downloadRetry;

157. }

158. public static void setDownloadRetry(int downloadRetry) {

159. SFTPClientUtils.downloadRetry = downloadRetry;

160. }

161. public static int getUploadSleep() {

162. return uploadSleep;

163. }

164. public static void setUploadSleep(int uploadSleep) {

165. SFTPClientUtils.uploadSleep = uploadSleep;

166. }

167. public static int getUploadRettry() {

168. return uploadRettry;

169. }

170. public static void setUploadRettry(int uploadRettry) {

171. SFTPClientUtils.uploadRettry = uploadRettry;

172. }    

173.       

174.       

175.    

176.         

177.    

178. }

SFTPConnectionFactory.java

是生成sftp上传对象的工场类

1. /**

2.  * SFTP工厂类，用于获取SFTP的连接

3.  * @author 奇点_

4.  */

5. @Component

6. @ConfigurationProperties(prefix = "sftp")

7. public class SFTPConnectionFactory {

8. private static Logger LOGGER = LoggerFactory.getLogger(FTPClientUtils.class);

9.     /** SFTP 登录用户名*/      

10.     private static String username;   

11.     /** SFTP 登录密码*/      

12.     private static String password;    

13.     /** 私钥 */      

14.     private static String privateKey;    

15.     /** SFTP 服务器地址IP地址*/      

16.     private static String ip;    

17.     /** SFTP 端口*/    

18.     private static int port;

19.  

20. private static final SFTPConnectionFactory factory = new SFTPConnectionFactory();

21. private ChannelSftp client;

22. private Session session;

23. private SFTPConnectionFactory(){

24.  

25. }

26.  

27. public static SFTPConnectionFactory getInstance(){

28. return factory;

29. }

30. synchronized public ChannelSftp makeConnection(){

31.  

32. if(client==null||session==null||!client.isConnected()||!session.isConnected()){

33. try {    

34. JSch jsch = new JSch();    

35. if (privateKey != null) {    

36. jsch.addIdentity(privateKey);// 设置私钥    

37. }    

38. session = jsch.getSession(username, ip, port);    

39. if (password != null) {    

40. session.setPassword(password);      

41. }    

42. Properties config = new Properties();    

43. config.put("StrictHostKeyChecking", "no");    

44. session.setConfig(config);    

45. session.connect();    

46. Channel channel = session.openChannel("sftp");    

47. channel.connect();    

48. client = (ChannelSftp) channel;    

49. LOGGER.info("sftp服务器连接成功");

50. } catch (JSchException e) {    

51. LOGGER.error("sftp登录失败，检测登录ip，端口号，用户名密码是否正确，错误信息为"+e.getMessage());

52. } 

53. }

54.     

55.      return client;

56. }

57. /**  

58.      * 关闭连接 server   

59.      */    

60.     public  void logout(){    

61.         if (client != null) {    

62.             if (client.isConnected()) {    

63.             client.disconnect();    

64.             }    

65.         }    

66.         if (session != null) {    

67.             if (session.isConnected()) {    

68.                 session.disconnect();    

69.             }    

70.         }    

71.     }

72.  
73.  

74. public static String getUsername() {

75. return username;

76. }

77.  
78.  

79. public static void setUsername(String username) {

80. SFTPConnectionFactory.username = username;

81. }

82.  
83.  

84. public static String getPassword() {

85. return password;

86. }

87.  
88.  

89. public static void setPassword(String password) {

90. SFTPConnectionFactory.password = password;

91. }

92.  
93.  

94. public static String getPrivateKey() {

95. return privateKey;

96. }

97.  
98.  

99. public static void setPrivateKey(String privateKey) {

100. SFTPConnectionFactory.privateKey = privateKey;

101. }

102.  
103.  

104. public static String getIp() {

105. return ip;

106. }

107.  
108.  

109. public static void setIp(String ip) {

110. SFTPConnectionFactory.ip = ip;

111. }

112.  
113.  

114. public static int getPort() {

115. return port;

116. }

117.  
118.  

119. public static void setPort(int port) {

120. SFTPConnectionFactory.port = port;

121. }

122. }

pom.xml 依赖

3. org.springframework.boot

4. spring-boot-starter-web

7. fakepath

8. ftp4j

9. 1.7.2

12. com.jcraft

13. jsch

14. 0.1.54

17. org.springframework.boot

18. spring-boot-configuration-processor

19. true