实现方案

ftpserver支持配置文件和db两种方式来保存账号信息和其它相关配置，如果我们的业务系统需要将用户信息和ftp的账号信息打通，并且还有相关的业务统计，比如统计系统中每个人上传文件的时间、个数等等，那么使用数据库来保存ftp账号信息还是比较方便灵活的。我这里就选择使用mysql了。

springboot开始整合

添加项目依赖

  1.     <dependency>
  2.       <groupId>org.apache.ftpserver</groupId>
  3.       <artifactId>ftpserver-core</artifactId>
  4.       <version>1.1.1</version>
  5.     </dependency>
  6.     <dependency>
  7.       <groupId>org.apache.ftpserver</groupId>
  8.       <artifactId>ftplet-api</artifactId>
  9.       <version>1.1.1</version>
  10.     </dependency>
  12.     <dependency>
  13.       <groupId>org.apache.mina</groupId>
  14.       <artifactId>mina-core</artifactId>
  15.       <version>2.0.16</version>
  16.     </dependency>

创建FTP_USER 数据库

  1. CREATE TABLE FTP_USER (      
  2.   userid VARCHAR(64) NOT NULL PRIMARY KEY,       
  3.   userpassword VARCHAR(64),      
  4.   homedirectory VARCHAR(128) NOT NULL,             
  5.   enableflag BOOLEAN DEFAULT TRUE,    
  6.   writepermission BOOLEAN DEFAULT FALSE,       
  7.   idletime INT DEFAULT 0,             
  8.   uploadrate INT DEFAULT 0,             
  9.   downloadrate INT DEFAULT 0,
  10.   maxloginnumber INT DEFAULT 0,
  11.   maxloginperip INT DEFAULT 0
  12. );

字段说明：

  • userid：登录账号
  • userpassword：登录密码
  • homedirectory：主目录，用户授权主目录
  • enableflag：当前用户可用
  • writepermission：具有上传权限
  • idletime：空闲时间（为300秒）
  • uploadrate：上传速率限制为480000字节每秒 0为不限制
  • downloadrate：下载速率限制为480000字节每秒 0为不限制
  • maxloginnumber：最大登陆用户数
  • maxloginperip：同IP登陆用户数

创建Ftpserver

配置ftpserver,提供ftpserver的init()、start()、stop()方法

  1. package com.qingfeng.ftpserver.mysqldatasource;
  3. import com.qingfeng.ftpserver.config.YmlProperties;
  4. import com.qingfeng.ftpserver.ftplet.MyFtpPlet;
  5. import org.apache.ftpserver.ConnectionConfigFactory;
  6. import org.apache.ftpserver.DataConnectionConfigurationFactory;
  7. import org.apache.ftpserver.FtpServer;
  8. import org.apache.ftpserver.FtpServerFactory;
  9. import org.apache.ftpserver.ftplet.FtpException;
  10. import org.apache.ftpserver.ftplet.Ftplet;
  11. import org.apache.ftpserver.listener.ListenerFactory;
  12. import org.apache.ftpserver.usermanager.ClearTextPasswordEncryptor;
  13. import org.apache.ftpserver.usermanager.DbUserManagerFactory;
  14. import org.slf4j.Logger;
  15. import org.slf4j.LoggerFactory;
  16. import org.springframework.context.annotation.Configuration;
  17. import org.springframework.stereotype.Service;
  19. import javax.sql.DataSource;
  20. import java.io.IOException;
  21. import java.util.HashMap;
  22. import java.util.Map;
  24. /**
  25.  * @ProjectName MyFtpServer
  26.  * @author Administrator
  27.  * @version 1.0.0
  28.  * @Description
  29.  * 注意：被@Configuration标记的类会被加入ioc容器中，而且类中所有带 @Bean注解的方法都会被动态代理，因此调用该方法返回的都是同一个实例。
  30.  * ftp服务访问地址：
  31.  * ftp://localhost:2121/
  32.  * @createTime 2022/4/21 0021 23:21
  33.  */
  34. @Configuration("MyFtp")
  35. @Service
  36. public class MyFtpServer {
  38.     private static final Logger logger = LoggerFactory.getLogger(MyFtpServer.class);
  40.     // springboot配置好数据源直接注入即可
  41.     private DataSource dataSource;
  43.     private YmlProperties yml;
  45.     protected FtpServer server;
  47.     // 我们这里利用spring加载@Configuration的特性来完成ftp server的初始化
  48.     public MyFtpServer(DataSource dataSource, YmlProperties yml) {
  49.         this.dataSource = dataSource;
  50.         this.yml = yml;
  51.         initFtp();
  52.         logger.info("Apache ftp server is already instantiation complete!");
  53.         System.out.println("Apache ftp server is already instantiation complete!");
  54.     }
  56.     /**
  57.      * ftp server init
  58.      * @throws IOException
  59.      */
  60.     public void initFtp() {
  61.         FtpServerFactory serverFactory = new FtpServerFactory();
  62.         ListenerFactory listenerFactory = new ListenerFactory();
  63.         // 1、设置服务端口
  64.         listenerFactory.setPort(new Integer(this.yml.getFtpport()));
  66.         // 2、设置被动模式数据上传的接口范围,云服务器需要开放对应区间的端口给客户端
  67.         DataConnectionConfigurationFactory dataConnectionConfFactory = new DataConnectionConfigurationFactory();
  68.         dataConnectionConfFactory.setPassivePorts(this.yml.getPassiveports());
  69.         listenerFactory.setDataConnectionConfiguration(dataConnectionConfFactory.createDataConnectionConfiguration());
  71.         // 3、增加SSL安全配置
  72.         /*
  73.         SslConfigurationFactory ssl = new SslConfigurationFactory();
  74.         ssl.setKeystoreFile(new File("src/main/resources/ftpserver.jks"));
  75.         ssl.setKeystorePassword("password");
  76.         ssl.setSslProtocol("SSL");
  77.         //set the SSL configuration for the listener
  78.         listenerFactory.setSslConfiguration(ssl.createSslConfiguration());
  79.         listenerFactory.setImplicitSsl(true);
  80.         */
  82.         //替换默认的监听器
  83.         serverFactory.addListener("default", listenerFactory.createListener());
  85.         // 4、设置最大连接数
  86.         ConnectionConfigFactory connectionConfigFactory = new ConnectionConfigFactory();
  87.         connectionConfigFactory.setMaxLogins(new Integer(this.yml.getMaxlogins()));
  88.         serverFactory.setConnectionConfig(connectionConfigFactory.createConnectionConfig());
  90.         // 5、配置自定义用户事件
  91.         Map<String, Ftplet> ftpLets = new HashMap<String, Ftplet>();
  92.         ftpLets.put("ftpService", new MyFtpPlet());
  93.         serverFactory.setFtplets(ftpLets);
  95.         // 6、读取用户的配置信息
  96.         // 注意：配置文件位于resources目录下，如果项目使用内置容器打成jar包发布，FTPServer无法直接直接读取Jar包中的配置文件。
  97.         // 解决办法：将文件复制到指定目录(本文指定到根目录)下然后FTPServer才能读取到。
  98.         /*
  99.         PropertiesUserManagerFactory userManagerFactory = new PropertiesUserManagerFactory();
  100.         String tempPath = System.getProperty("java.io.tmpdir") + System.currentTimeMillis() + ".properties";
  101.         File tempConfig = new File(tempPath);
  102.         ClassPathResource resource = new ClassPathResource("users.properties");
  103.         IOUtils.copy(resource.getInputStream(), new FileOutputStream(tempConfig));
  104.         userManagerFactory.setFile(tempConfig);
  105.         userManagerFactory.setPasswordEncryptor(new ClearTextPasswordEncryptor());  //密码以明文的方式
  106.         serverFactory.setUserManager(userManagerFactory.createUserManager());
  107.         */
  109.         // 6.2、基于数据库来存储用户实例
  110.         DbUserManagerFactory dbUserManagerFactory = new DbUserManagerFactory();
  111.         // todo....
  112.         System.out.println("======================================");
  113.         System.out.println(this.yml.getAdminname());
  114.         dbUserManagerFactory.setDataSource(dataSource);
  115.         dbUserManagerFactory.setAdminName(this.yml.getAdminname());
  116.         dbUserManagerFactory.setSqlUserAdmin(this.yml.getSqluseradmin());
  117.         dbUserManagerFactory.setSqlUserInsert(this.yml.getSqluserinsert());
  118.         dbUserManagerFactory.setSqlUserDelete(this.yml.getSqluserdelete());
  119.         dbUserManagerFactory.setSqlUserUpdate(this.yml.getSqluserupdate());
  120.         dbUserManagerFactory.setSqlUserSelect(this.yml.getSqluserselect());
  121.         dbUserManagerFactory.setSqlUserSelectAll(this.yml.getSqluserselectall());
  122.         dbUserManagerFactory.setSqlUserAuthenticate(this.yml.getSqluserauthenticate());
  123.         dbUserManagerFactory.setPasswordEncryptor(new ClearTextPasswordEncryptor());  //密码以明文的方式
  124.         serverFactory.setUserManager(dbUserManagerFactory.createUserManager());
  126.         // 7、实例化FTP Server
  127.         server = serverFactory.createServer();
  128.     }
  130.     /**
  131.      * ftp server start
  132.      */
  133.     public void start() {
  134.         try {
  135.             server.start();
  136.             logger.info("Apache Ftp server is starting!");
  137.         } catch (FtpException e) {
  138.             e.printStackTrace();
  139.         }
  140.     }
  142.     /**
  143.      * ftp server stop
  144.      */
  145.     public void stop() {
  146.         server.stop();
  147.         logger.info("Apache Ftp server is stoping!");
  148.     }
  150. }

创建配置监听器Listener

  1. package com.qingfeng.ftpserver.listener;
  3. import com.qingfeng.ftpserver.mysqldatasource.MyFtpServer;
  4. import org.slf4j.Logger;
  5. import org.slf4j.LoggerFactory;
  6. import org.springframework.beans.factory.annotation.Autowired;
  7. import org.springframework.web.context.support.WebApplicationContextUtils;
  9. import javax.servlet.ServletContextEvent;
  10. import javax.servlet.ServletContextListener;
  11. import javax.servlet.annotation.WebListener;
  13. @WebListener
  14. public class FtpServerListener implements ServletContextListener {
  16.     private static final Logger logger = LoggerFactory.getLogger(MyFtpServer.class);
  17.     private static final String SERVER_NAME="FTP-SERVER";
  19.     @Autowired
  20.     private MyFtpServer server;
  23.     //容器初始化调用方法start ftpServer
  24.     public void contextInitialized(ServletContextEvent sce) {
  25.         WebApplicationContextUtils.getRequiredWebApplicationContext(sce.getServletContext())
  26.                 .getAutowireCapableBeanFactory().autowireBean(this);//必须添加的代码
  28.         sce.getServletContext().setAttribute(SERVER_NAME,server);
  29.         try {
  30.             System.out.println("===================111===================");
  31.             System.out.println(server);
  32.             //项目启动时已经加载好了
  33.             server.start();
  34.             System.out.println("Apache Ftp server is started!");
  35.             logger.info("Apache Ftp server is started!");
  36.         } catch (Exception e){
  37.             e.printStackTrace();
  38.             throw new RuntimeException("Apache Ftp server start failed!", e);
  39.         }
  40.     }
  42.     //容器关闭时调用方法stop ftpServer
  43.     public void contextDestroyed(ServletContextEvent sce) {
  44.         server.stop();
  45.         sce.getServletContext().removeAttribute(SERVER_NAME);
  46.         logger.info("Apache Ftp server is stoped!");
  47.         System.out.println("Apache Ftp server is stoped!");
  48.     }
  50. }

创建MyFtpPlet实现监听事件

  1. package com.qingfeng.ftpserver.ftplet;
  3. import org.apache.ftpserver.ftplet.*;
  4. import org.slf4j.Logger;
  5. import org.slf4j.LoggerFactory;
  7. import java.io.File;
  8. import java.io.IOException;
  10. public class MyFtpPlet extends DefaultFtplet {
  12.     private static final Logger logger = LoggerFactory.getLogger(MyFtpPlet.class);
  14.     @Override
  15.     public FtpletResult onLogin(FtpSession session, FtpRequest request) throws FtpException, IOException {
  16.         // 获取上传文件的上传路径
  17.         String path = session.getUser().getHomeDirectory();
  18.         // 获取上传用户
  19.         String name = session.getUser().getName();
  20.         //校验文件夹路径是否存在
  21.         viladateDir(path);
  23.         logger.info("用户:'{}'登录成功, 目录地址: '{}'", name, path);
  24.         System.out.println("用户:'" + name + "'登录成功, 目录地址：'" + path + "'");
  26.         return super.onLogin(session, request);
  27.     }
  29.     @Override
  30.     public FtpletResult onUploadStart(FtpSession session, FtpRequest request) throws FtpException, IOException {
  31.         // 获取上传文件的上传路径
  32.         String path = session.getUser().getHomeDirectory();
  33.         //校验文件夹路径是否存在
  34.         viladateDir(path);
  36.         // 获取上传用户
  37.         String name = session.getUser().getName();
  38.         // 获取上传文件名
  39.         String filename = request.getArgument();
  40.         logger.info("用户:'{}'，上传文件到目录：'{}'，文件名称为：'{}，状态：开始上传~'", name, path, filename);
  41.         System.out.println("用户:'" + name + "'，上传文件到目录：'" + path + "'，文件名称为：'" + filename + "'，状态：开始上传~");
  42.         return super.onUploadStart(session, request);
  43.     }
  45.     @Override
  46.     public FtpletResult onUploadEnd(FtpSession session, FtpRequest request) throws FtpException, IOException {
  47.         // 获取上传文件的上传路径
  48.         String path = session.getUser().getHomeDirectory();
  49.         // 获取上传用户
  50.         String name = session.getUser().getName();
  51.         // 获取上传文件名
  52.         String filename = request.getArgument();
  53.         logger.info("用户:'{}'，上传文件到目录：'{}'，文件名称为：'{}，状态：成功！'", name, path, filename);
  54.         System.out.println("用户:'" + name + "'，上传文件到目录：'" + path + "'，文件名称为：'" + filename + "'，状态：成功！'");
  55.         return super.onUploadEnd(session, request);
  56.     }
  58.     @Override
  59.     public FtpletResult onDownloadStart(FtpSession session, FtpRequest request) throws FtpException, IOException {
  60.         // todo servies...
  61.         return super.onDownloadStart(session, request);
  62.     }
  64.     @Override
  65.     public FtpletResult onDownloadEnd(FtpSession session, FtpRequest request) throws FtpException, IOException {
  66.         // todo servies...
  67.         return super.onDownloadEnd(session, request);
  68.     }
  71.     //判断文件夹是否存在，不存在则创建文件夹
  72.     public void viladateDir(String path) {
  73.         File file = new File(path);
  75.         // 如果文件夹不存在则创建
  76.         if (!file.exists() && !file.isDirectory()){
  77.             System.out.println("文件夹不存在，创建新的文件夹");
  78.             file.mkdir();
  79.         }
  80.     }
  82. }

创建FtpConfig配置类

  1. package com.qingfeng.ftpserver.config;
  3. import org.springframework.context.annotation.Configuration;
  4. import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
  5. import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
  8. @Configuration
  9. public class FtpConfig implements WebMvcConfigurer {
  11.     @Override
  12.     public void addResourceHandlers(ResourceHandlerRegistry registry) {
  13.         //可以通过os来判断
  14.         String os = System.getProperty("os.name");
  15.         //linux设置
  16.         //registry.addResourceHandler("/ftp/**").addResourceLocations("file:/home/pic/");
  17.         //windows设置
  18.         //第一个方法设置访问路径前缀，第二个方法设置资源路径，既可以指定项目classpath路径，也可以指定其它非项目路径
  19.         registry.addResourceHandler("/ftp/**").addResourceLocations("file:D:\\FtpFileHome");
  20.         registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/");
  21.     }
  23. }

创建参数Properties类

  1. package com.qingfeng.ftpserver.config;
  3. import org.springframework.boot.context.properties.ConfigurationProperties;
  4. import org.springframework.stereotype.Component;
  6. @Component
  7. @ConfigurationProperties(prefix = "ftp")
  8. public class YmlProperties {
  9.     private String homedirectory;
  10.     private String ftpport;
  11.     private String passiveports;
  12.     private String maxlogins;
  13.     private String adminname;
  14.     private String sqluseradmin;
  15.     private String sqluserinsert;
  16.     private String sqluserdelete;
  17.     private String sqluserupdate;
  18.     private String sqluserselect;
  19.     private String sqluserselectall;
  20.     private String sqluserauthenticate;
  22.     public String getHomedirectory() {
  23.         return homedirectory;
  24.     }
  26.     public void setHomedirectory(String homedirectory) {
  27.         this.homedirectory = homedirectory;
  28.     }
  30.     public String getFtpport() {
  31.         return ftpport;
  32.     }
  34.     public void setFtpport(String ftpport) {
  35.         this.ftpport = ftpport;
  36.     }
  38.     public String getPassiveports() {
  39.         return passiveports;
  40.     }
  42.     public void setPassiveports(String passiveports) {
  43.         this.passiveports = passiveports;
  44.     }
  46.     public String getMaxlogins() {
  47.         return maxlogins;
  48.     }
  50.     public void setMaxlogins(String maxlogins) {
  51.         this.maxlogins = maxlogins;
  52.     }
  54.     public String getAdminname() {
  55.         return adminname;
  56.     }
  58.     public void setAdminname(String adminname) {
  59.         this.adminname = adminname;
  60.     }
  62.     public String getSqluseradmin() {
  63.         return sqluseradmin;
  64.     }
  66.     public void setSqluseradmin(String sqluseradmin) {
  67.         this.sqluseradmin = sqluseradmin;
  68.     }
  70.     public String getSqluserinsert() {
  71.         return sqluserinsert;
  72.     }
  74.     public void setSqluserinsert(String sqluserinsert) {
  75.         this.sqluserinsert = sqluserinsert;
  76.     }
  78.     public String getSqluserdelete() {
  79.         return sqluserdelete;
  80.     }
  82.     public void setSqluserdelete(String sqluserdelete) {
  83.         this.sqluserdelete = sqluserdelete;
  84.     }
  86.     public String getSqluserupdate() {
  87.         return sqluserupdate;
  88.     }
  90.     public void setSqluserupdate(String sqluserupdate) {
  91.         this.sqluserupdate = sqluserupdate;
  92.     }
  94.     public String getSqluserselect() {
  95.         return sqluserselect;
  96.     }
  98.     public void setSqluserselect(String sqluserselect) {
  99.         this.sqluserselect = sqluserselect;
  100.     }
  102.     public String getSqluserselectall() {
  103.         return sqluserselectall;
  104.     }
  106.     public void setSqluserselectall(String sqluserselectall) {
  107.         this.sqluserselectall = sqluserselectall;
  108.     }
  110.     public String getSqluserauthenticate() {
  111.         return sqluserauthenticate;
  112.     }
  114.     public void setSqluserauthenticate(String sqluserauthenticate) {
  115.         this.sqluserauthenticate = sqluserauthenticate;
  116.     }
  118. }

配置application.yml

  1. ftp:
  2.   homedirectory: D:/FtpFileHome
  3.   ftpport: 2121
  4.   passiveports: 10000-10500
  5.   maxlogins: 20
  6.   adminname: admin
  7.   sqluseradmin: SELECT userid FROM FTP_USER WHERE userid='{userid}' AND userid='admin'
  8.   sqluserinsert: INSERT INTO FTP_USER (userid, userpassword, homedirectory,enableflag, writepermission, idletime, uploadrate, downloadrate) VALUES ('{userid}', '{userpassword}', '{homedirectory}', {enableflag}, {writepermission}, {idletime}, uploadrate}, {downloadrate})
  9.   sqluserdelete: DELETE FROM FTP_USER WHERE userid = '{userid}'
  10.   sqluserupdate: UPDATE FTP_USER SET userpassword='{userpassword}',homedirectory='{homedirectory}',enableflag={enableflag},writepermission={writepermission},idletime={idletime},uploadrate={uploadrate},downloadrate={downloadrate},maxloginnumber={maxloginnumber}, maxloginperip={maxloginperip} WHERE userid='{userid}'
  11.   sqluserselect: SELECT userid,userpassword,CONCAT('${ftp.homedirectory}',homedirectory) as homedirectory,enableflag,writepermission,idletime,uploadrate,downloadrate,maxloginnumber,maxloginperip FROM ftp_user WHERE userid = '{userid}'
  12.   sqluserselectall: SELECT userid FROM FTP_USER ORDER BY userid
  13.   sqluserauthenticate: SELECT userid, userpassword FROM FTP_USER WHERE userid='{userid}'

启动类配置@ServletComponentScan

image.png

拓展功能一（密码验证器）

用户密码验证

https://github.com/patrickfav/bcrypt
默认配置中，我们使用的用户密码是明文加密模式。

  1. # 明文
  2. dbUserManagerFactory.setPasswordEncryptor(new ClearTextPasswordEncryptor()); 
  3. # Md5
  4. dbUserManagerFactory.setPasswordEncryptor(new Md5PasswordEncryptor());
  5. # 自定义Hash
  6. dbUserManagerFactory.setPasswordEncryptor(new MyPasswordEncryptor());

image.png

自定义MyPasswordEncryptor加密器

增加bcrypt依赖

  1. <dependency>
  2.   <groupId>at.favre.lib</groupId>
  3.   <artifactId>bcrypt</artifactId>
  4.   <version>0.9.0</version>
  5. </dependency>

新建MyPasswordEncryptor

  1. package com.qingfeng.ftpserver.config;
  3. /**
  4. * @author Administrator
  5. * @version 1.0.0
  6. * @ProjectName finder-module-ftpserver
  7. * @Description TODO
  8. * @createTime 2022年04月21日 09:34:00
  9. */
  10. import at.favre.lib.crypto.bcrypt.BCrypt;
  11. import org.apache.ftpserver.usermanager.PasswordEncryptor;
  13. import java.security.NoSuchAlgorithmException;
  15. public class MyPasswordEncryptor implements PasswordEncryptor {
  16.     public MyPasswordEncryptor() {
  17.     }
  19.     public String encrypt(String password) {
  20.         String bcryptString = BCrypt.with(BCrypt.Version.VERSION_2Y).hashToString(10, password.toCharArray());
  21.         System.out.println(bcryptString);
  22.         return bcryptString;
  23.     }
  25.     public boolean matches(String passwordToCheck, String storedPassword) {
  26.         System.out.println("--------------matches-------------");
  27.         System.out.println(passwordToCheck);
  28.         System.out.println(storedPassword);
  29.         if (storedPassword == null) {
  30.             throw new NullPointerException("storedPassword can not be null");
  31.         } else if (passwordToCheck == null) {
  32.             throw new NullPointerException("passwordToCheck can not be null");
  33.         } else {
  34.             BCrypt.Result result = BCrypt.verifyer().verify(passwordToCheck.toCharArray(), storedPassword);
  35.             //            return this.encrypt(passwordToCheck).equalsIgnoreCase(storedPassword);
  36.             return result.verified;
  37.         }
  38.     }
  41.     public static void main(String[] args) throws NoSuchAlgorithmException {
  42.         String bcryptString = BCrypt.with(BCrypt.Version.VERSION_2Y).hashToString(10, "123456".toCharArray());
  43.         System.out.println(bcryptString);
  44.     }
  45. }

拓展功能二（文件类型验证）

  1.     @Override
  2.     public FtpletResult onUploadStart(FtpSession session, FtpRequest request) throws FtpException, IOException {
  3.         // 获取上传文件的上传路径
  4.         String path = session.getUser().getHomeDirectory();
  5.         //校验文件夹路径是否存在
  6.         viladateDir(path);
  8.         // 获取上传用户
  9.         String name = session.getUser().getName();
  10.         // 获取上传文件名
  11.         String filename = request.getArgument();
  12.         logger.info("用户:'{}'，上传文件到目录：'{}'，文件名称为：'{}，状态：开始上传~'", name, path, filename);
  13.         System.out.println("用户:'" + name + "'，上传文件到目录：'" + path + "'，文件名称为：'" + filename + "'，状态：开始上传~");
  14.         session.write(new DefaultFtpReply(550, "附件格式不正确!"));
  15.         return super.onUploadStart(session, request);
  16.     }

image.png

项目启动测试

image.png
image.png
image.png

可能遇到问题

1、@Autowired自动注入对象为Null的问题解决

image.png
解决方案：
增加如下配置

  1.  WebApplicationContextUtils.getRequiredWebApplicationContext(sce.getServletContext())
  2.                 .getAutowireCapableBeanFactory().autowireBean(this);//必须添加的代码

image.png