JavaでFTPクライアントを実装する

JavaでのFTPクライアントの実装

1. 概要

このチュートリアルでは、Apache Commons Netライブラリを利用して外部FTPサーバーと対話する方法を見ていきます。

2. セットアップ

外部システムとのやり取りに使用されるライブラリを使用する場合、ライブラリが正しく使用されていることを確認するために、追加の統合テストを作成することをお勧めします。

今日では、通常、Dockerを使用して、統合テストのためにこれらのシステムを起動します。ただし、特にパッシブモードで使用する場合、動的ポートマッピング（共有CIサーバーでテストを実行できるようにするために必要になることが多い）を利用する場合、FTPサーバーはコンテナー内で透過的に実行するのが最も簡単なアプリケーションではありません。）。

そのため、代わりにMockFtpServerを使用します。これはJavaで記述された偽の/スタブFTPサーバーであり、JUnitテストで簡単に使用できる広範なAPIを提供します。


    commons-net
    commons-net
    3.6


    org.mockftpserver
    MockFtpServer
    2.7.1
    test

常に最新バージョンを使用することをお勧めします。それらはhereとhereで見つけることができます。

3. JDKでのFTPサポート

驚いたことに、sun.net.www.protocol.ftp.FtpURLConnectionの形式で、一部のJDKフレーバーでFTPの基本的なサポートがすでに存在します。

ただし、このクラスを直接使用するべきではなく、代わりにJDKのjava.net.URLクラスを抽象化として使用することができます。

このFTPサポートは非常に基本的ですが、java.nio.file.Files,の便利なAPIを活用することで、単純なユースケースには十分である可能性があります。

@Test
public void givenRemoteFile_whenDownloading_thenItIsOnTheLocalFilesystem() throws IOException {
    String ftpUrl = String.format(
      "ftp://user:[email protected]:%d/foobar.txt", fakeFtpServer.getServerControlPort());

    URLConnection urlConnection = new URL(ftpUrl).openConnection();
    InputStream inputStream = urlConnection.getInputStream();
    Files.copy(inputStream, new File("downloaded_buz.txt").toPath());
    inputStream.close();

    assertThat(new File("downloaded_buz.txt")).exists();

    new File("downloaded_buz.txt").delete(); // cleanup
}

この基本的なFTPサポートには、ファイルリストなどの基本的な機能が既に欠けているため、次の例ではApache Net CommonsライブラリのFTPサポートを使用します。

4. 接続中

最初にFTPサーバーに接続する必要があります。クラスFtpClient.を作成することから始めましょう

これは、実際のApache Commons Net FTPクライアントに対する抽象化APIとして機能します。

class FtpClient {

    private String server;
    private int port;
    private String user;
    private String password;
    private FTPClient ftp;

    // constructor

    void open() throws IOException {
        ftp = new FTPClient();

        ftp.addProtocolCommandListener(new PrintCommandListener(new PrintWriter(System.out)));

        ftp.connect(server, port);
        int reply = ftp.getReplyCode();
        if (!FTPReply.isPositiveCompletion(reply)) {
            ftp.disconnect();
            throw new IOException("Exception in connecting to FTP Server");
        }

        ftp.login(user, password);
    }

    void close() throws IOException {
        ftp.disconnect();
    }
}

サーバーアドレスとポート、ユーザー名とパスワードが必要です。接続後、実際に返信コードをチェックして、接続が成功したことを確認する必要があります。また、PrintCommandListenerを追加して、コマンドラインツールを使用してFTPサーバーに接続したときに通常表示される応答を出力します。

統合テストには、MockFtpServerの起動/停止、クライアントの接続/切断などの定型コードが含まれているため、@Beforeメソッドと@Afterメソッドで次のことを実行できます。

public class FtpClientIntegrationTest {

    private FakeFtpServer fakeFtpServer;

    private FtpClient ftpClient;

    @Before
    public void setup() throws IOException {
        fakeFtpServer = new FakeFtpServer();
        fakeFtpServer.addUserAccount(new UserAccount("user", "password", "/data"));

        FileSystem fileSystem = new UnixFakeFileSystem();
        fileSystem.add(new DirectoryEntry("/data"));
        fileSystem.add(new FileEntry("/data/foobar.txt", "abcdef 1234567890"));
        fakeFtpServer.setFileSystem(fileSystem);
        fakeFtpServer.setServerControlPort(0);

        fakeFtpServer.start();

        ftpClient = new FtpClient("localhost", fakeFtpServer.getServerControlPort(), "user", "password");
        ftpClient.open();
    }

    @After
    public void teardown() throws IOException {
        ftpClient.close();
        fakeFtpServer.stop();
    }
}

モックサーバーの制御ポートを値0に設定することで、モックサーバーと無料のランダムポートを起動します。

そのため、サーバーの起動後にfakeFtpServer.getServerControlPort()を使用してFtpClientを作成するときに、実際のポートを取得する必要があります。

5. リストファイル

最初の実際の使用例は、ファイルのリストです。

まず、TDDスタイルのテストから始めましょう。

@Test
public void givenRemoteFile_whenListingRemoteFiles_thenItIsContainedInList() throws IOException {
    Collection files = ftpClient.listFiles("");
    assertThat(files).contains("foobar.txt");
}

実装自体も同様に簡単です。この例のために返されるデータ構造を少し単純にするために、返されるFTPFile配列をJava 8Streams:を使用してStringsのリストに変換します。

Collection listFiles(String path) throws IOException {
    FTPFile[] files = ftp.listFiles(path);
    return Arrays.stream(files)
      .map(FTPFile::getName)
      .collect(Collectors.toList());
}

6. ダウンロード中

FTPサーバーからファイルをダウンロードするために、APIを定義しています。

ここで、ローカルファイルシステムのソースファイルと宛先を定義します。

@Test
public void givenRemoteFile_whenDownloading_thenItIsOnTheLocalFilesystem() throws IOException {
    ftpClient.downloadFile("/buz.txt", "downloaded_buz.txt");
    assertThat(new File("downloaded_buz.txt")).exists();
    new File("downloaded_buz.txt").delete(); // cleanup
}

Apache Net Commons FTPクライアントには、定義されたOutputStream.に直接書き込む便利なAPIが含まれています。これは、これを直接使用できることを意味します。

void downloadFile(String source, String destination) throws IOException {
    FileOutputStream out = new FileOutputStream(destination);
    ftp.retrieveFile(source, out);
}

7. アップロード中

MockFtpServerは、ファイルシステムのコンテンツにアクセスするための便利なメソッドを提供します。この機能を使用して、アップロード機能の簡単な統合テストを作成できます。

@Test
public void givenLocalFile_whenUploadingIt_thenItExistsOnRemoteLocation()
  throws URISyntaxException, IOException {

    File file = new File(getClass().getClassLoader().getResource("baz.txt").toURI());
    ftpClient.putFileToPath(file, "/buz.txt");
    assertThat(fakeFtpServer.getFileSystem().exists("/buz.txt")).isTrue();
}

ファイルのアップロードは、APIに関してはダウンロードと非常によく似ていますが、OutputStreamを使用する代わりに、代わりにInputStreamを指定する必要があります。

void putFileToPath(File file, String path) throws IOException {
    ftp.storeFile(path, new FileInputStream(file));
}

8. 結論

JavaをApacheNet Commonsと一緒に使用すると、読み取りアクセスと書き込みアクセスのために、外部FTPサーバーと簡単に対話できることがわかりました。

いつものように、この記事の完全なコードは、GitHub repositoryで入手できます。

TOC