SpringBoot项目集成FTP的方法步骤

目录 写在前面 FTP相关软件安装 开始集成 引入相关jar包 引入FTPUtils.java和FTPHelper.java 如何使用 写在前面 FTP是一个文件传输协议，被开发人员广泛用于在互联网中文件传输的一套标准协议。 而我们通常在开发过程中也 0 Comments

目录
  • 写在前面
  • FTP相关软件安装
  • 开始集成
    • 引入相关jar包
    • 引入FTPUtils.java和FTPHelper.java
  • 如何使用

写在前面

FTP是一个文件传输协议，被开发人员广泛用于在互联网中文件传输的一套标准协议。
而我们通常在开发过程中也要通过FTP来搭建文件系统，用于存储系统文件等。
目前正值SpringBoot热潮，所以我们接下来会一起学习一下SpringBoot如何集成FTP，以及相关的FTP组件包，还有其主要提供的几个方法。

当然在这系列文章结尾，我们还会给出确切的FTP操作工具类，算是一些小成果，希望和大家共勉。

FTP相关软件安装

我在此就不介绍如何安装FTP了，但是我可以推荐给大家一些软件作为选择。
Linux版本，推荐使用vsftpd进行搭建FTP，只需要改指定的几个配置，添加上用户即可。
Windows版本，推荐使用Serv-U进行搭建FTP，图形化界面，有中文版，操作起来很简单。

开始集成

引入相关jar包

这里我们对FTP相关的组件包使用的是edtFTPj，其实之前很多人都选择的是Java自带的包来实现FTP功能的。
在我们的SpringBoot项目中pom.xml下添加以下依赖。

?

1

2

3

4

5

<dependency>

<groupId>com.enterprisedt</groupId>

<artifactId>edtFTPj</artifactId>

<version>1.5.3</version>

</dependency>

更新maven进行引入，然后我们进行下一步。

引入FTPUtils.java和FTPHelper.java

引入两个工具类。

我这里先贡献一下代码，请大家酌情作为参考。

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

/**

* Ftp 工具类

*/

public class FtpHelper {

private FTPClient ftp;

public FtpHelper() {

}

/**

* 初始化Ftp信息

*

* @param ftpServer ftp服务器地址

* @param ftpPort Ftp端口号

* @param ftpUsername ftp 用户名

* @param ftpPassword ftp 密码

*/

public FtpHelper(String ftpServer, int ftpPort, String ftpUsername,

String ftpPassword) {

connect(ftpServer, ftpPort, ftpUsername, ftpPassword);

}

/**

* 连接到ftp

*

* @param ftpServer ftp服务器地址

* @param ftpPort Ftp端口号

* @param ftpUsername ftp 用户名

* @param ftpPassword ftp 密码

*/

public void connect(String ftpServer, int ftpPort, String ftpUsername, String ftpPassword) {

ftp = new FTPClient();

try {

ftp.setControlEncoding("UTF-8");

ftp.setRemoteHost(ftpServer);

ftp.setRemotePort(ftpPort);

ftp.setTimeout(6000);

ftp.setConnectMode(FTPConnectMode.ACTIVE);

ftp.connect();

ftp.login(ftpUsername, ftpPassword);

ftp.setType(FTPTransferType.BINARY);

} catch (Exception e) {

e.printStackTrace();

ftp = null;

}

}

/**

* 更改ftp路径

*

* @param ftp

* @param dirName

* @return

*/

public boolean checkDirectory(FTPClient ftp, String dirName) {

boolean flag;

try {

ftp.chdir(dirName);

flag = true;

} catch (Exception e) {

e.printStackTrace();

flag = false;

}

return flag;

}

/**

* 断开ftp链接

*/

public void disconnect() {

try {

if (ftp.connected()) {

ftp.quit();

}

} catch (Exception e) {

e.printStackTrace();

}

}

/**

* 读取ftp文件流

*

* @param filePath ftp文件路径

* @return s

* @throws Exception

*/

public InputStream downloadFile(String filePath) throws Exception {

InputStream inputStream = null;

String fileName = "";

filePath = StringUtils.removeStart(filePath, "/");

int len = filePath.lastIndexOf("/");

if (len == -1) {

if (filePath.length() > 0) {

fileName = filePath;

} else {

throw new Exception("没有输入文件路径");

}

} else {

fileName = filePath.substring(len + 1);

String type = filePath.substring(0, len);

String[] typeArray = type.split("/");

for (String s : typeArray) {

ftp.chdir(s);

}

}

byte[] data;

try {

data = ftp.get(fileName);

inputStream = new ByteArrayInputStream(data);

} catch (Exception e) {

e.printStackTrace();

}

return inputStream;

}

/**

* 上传文件到ftp

*

* @param file 文件对象

* @param filePath 上传的路径

* @throws Exception

*/

public void uploadFile(File file, String filePath) throws Exception {

InputStream inStream = new FileInputStream(file);

uploadFile(inStream, filePath);

}

/**

* 上传文件到ftp

*

* @param inStream 上传的文件流

* @param filePath 上传路径

* @throws Exception

*/

public void uploadFile(InputStream inStream, String filePath)

throws Exception {

if (inStream == null) {

return;

}

String fileName = "";

filePath = StringUtils.removeStart(filePath, "/");

int len = filePath.lastIndexOf("/");

if (len == -1) {

if (filePath.length() > 0) {

fileName = filePath;

} else {

throw new Exception("没有输入文件路径");

}

} else {

fileName = filePath.substring(len + 1);

String type = filePath.substring(0, len);

String[] typeArray = type.split("/");

for (String s : typeArray) {

if (!checkDirectory(ftp, s)) {

ftp.mkdir(s);

}

}

}

ftp.put(inStream, fileName);

}

/**

* 删除ftp文件

*

* @param filePath 文件路径

* @throws Exception

*/

public void deleteFile(String filePath) throws Exception {

String fileName = "";

filePath = StringUtils.removeStart(filePath, "/");

int len = filePath.lastIndexOf("/");

if (len == -1) {

if (filePath.length() > 0) {

fileName = filePath;

} else {

throw new Exception("没有输入文件路径");

}

} else {

fileName = filePath.substring(len + 1);

String type = filePath.substring(0, len);

String[] typeArray = type.split("/");

for (String s : typeArray) {

if (checkDirectory(ftp, s)) {

ftp.chdir(s);

}

}

}

ftp.delete(fileName);

}

/**

* 切换目录

*

* @param path

* @throws Exception

*/

public void changeDirectory(String path) {

if (!ValidateUtils.isEmpty(path)) {

try {

ftp.chdir(path);

} catch (Exception e) {

e.printStackTrace();

}

}

}

}

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

/**

* Ftp 工具类

*/

public class FtpHelper {

private FTPClient ftp;

public FtpHelper() {

}

/**

* 初始化Ftp信息

*

* @param ftpServer ftp服务器地址

* @param ftpPort Ftp端口号

* @param ftpUsername ftp 用户名

* @param ftpPassword ftp 密码

*/

public FtpHelper(String ftpServer, int ftpPort, String ftpUsername,

String ftpPassword) {

connect(ftpServer, ftpPort, ftpUsername, ftpPassword);

}

/**

* 连接到ftp

*

* @param ftpServer ftp服务器地址

* @param ftpPort Ftp端口号

* @param ftpUsername ftp 用户名

* @param ftpPassword ftp 密码

*/

public void connect(String ftpServer, int ftpPort, String ftpUsername, String ftpPassword) {

ftp = new FTPClient();

try {

ftp.setControlEncoding("UTF-8");

ftp.setRemoteHost(ftpServer);

ftp.setRemotePort(ftpPort);

ftp.setTimeout(6000);

ftp.setConnectMode(FTPConnectMode.ACTIVE);

ftp.connect();

ftp.login(ftpUsername, ftpPassword);

ftp.setType(FTPTransferType.BINARY);

} catch (Exception e) {

e.printStackTrace();

ftp = null;

}

}

/**

* 更改ftp路径

*

* @param ftp

* @param dirName

* @return

*/

public boolean checkDirectory(FTPClient ftp, String dirName) {

boolean flag;

try {

ftp.chdir(dirName);

flag = true;

} catch (Exception e) {

e.printStackTrace();

flag = false;

}

return flag;

}

/**

* 断开ftp链接

*/

public void disconnect() {

try {

if (ftp.connected()) {

ftp.quit();

}

} catch (Exception e) {

e.printStackTrace();

}

}

/**

* 读取ftp文件流

*

* @param filePath ftp文件路径

* @return s

* @throws Exception

*/

public InputStream downloadFile(String filePath) throws Exception {

InputStream inputStream = null;

String fileName = "";

filePath = StringUtils.removeStart(filePath, "/");

int len = filePath.lastIndexOf("/");

if (len == -1) {

if (filePath.length() > 0) {

fileName = filePath;

} else {

throw new Exception("没有输入文件路径");

}

} else {

fileName = filePath.substring(len + 1);

String type = filePath.substring(0, len);

String[] typeArray = type.split("/");

for (String s : typeArray) {

ftp.chdir(s);

}

}

byte[] data;

try {

data = ftp.get(fileName);

inputStream = new ByteArrayInputStream(data);

} catch (Exception e) {

e.printStackTrace();

}

return inputStream;

}

/**

* 上传文件到ftp

*

* @param file 文件对象

* @param filePath 上传的路径

* @throws Exception

*/

public void uploadFile(File file, String filePath) throws Exception {

InputStream inStream = new FileInputStream(file);

uploadFile(inStream, filePath);

}

/**

* 上传文件到ftp

*

* @param inStream 上传的文件流

* @param filePath 上传路径

* @throws Exception

*/

public void uploadFile(InputStream inStream, String filePath)

throws Exception {

if (inStream == null) {

return;

}

String fileName = "";

filePath = StringUtils.removeStart(filePath, "/");

int len = filePath.lastIndexOf("/");

if (len == -1) {

if (filePath.length() > 0) {

fileName = filePath;

} else {

throw new Exception("没有输入文件路径");

}

} else {

fileName = filePath.substring(len + 1);

String type = filePath.substring(0, len);

String[] typeArray = type.split("/");

for (String s : typeArray) {

if (!checkDirectory(ftp, s)) {

ftp.mkdir(s);

}

}

}

ftp.put(inStream, fileName);

}

/**

* 删除ftp文件

*

* @param filePath 文件路径

* @throws Exception

*/

public void deleteFile(String filePath) throws Exception {

String fileName = "";

filePath = StringUtils.removeStart(filePath, "/");

int len = filePath.lastIndexOf("/");

if (len == -1) {

if (filePath.length() > 0) {

fileName = filePath;

} else {

throw new Exception("没有输入文件路径");

}

} else {

fileName = filePath.substring(len + 1);

String type = filePath.substring(0, len);

String[] typeArray = type.split("/");

for (String s : typeArray) {

if (checkDirectory(ftp, s)) {

ftp.chdir(s);

}

}

}

ftp.delete(fileName);

}

/**

* 切换目录

*

* @param path

* @throws Exception

*/

public void changeDirectory(String path) {

if (!ValidateUtils.isEmpty(path)) {

try {

ftp.chdir(path);

} catch (Exception e) {

e.printStackTrace();

}

}

}

}

如何使用

?

1

2

3

4

5

6

7

8

9

10

11

public static void main(String[] args) {

try {

// 从ftp下载文件

FtpHelper ftp = new FtpHelper("127.0.0.1", 21, "root", "123456");

File file = new File("D:\1.doc");

ftp.uploadFile(file, "test/weradsfad2.doc");

ftp.disconnect();

} catch (Exception e) {

e.printStackTrace();

}

}

到此这篇关于SpringBoot项目集成FTP的方法步骤的文章就介绍到这了,更多相关SpringBoot集成FTP内容请搜索服务器之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持服务器之家！

原文链接：https://juejin.cn/post/7022817255779991589

本文链接：https://my.lmcjl.com/post/20212.html

展开阅读全文

相关文章

4 评论

留下您的评论.