Golang SFTP 客户端实现指南

SFTP (SSH File Transfer Protocol) 是基于 SSH 的安全文件传输协议。在 Go 中，我们可以使用 github.com/pkg/sftp 库来实现 SFTP 客户端功能。

安装依赖

首先安装必要的依赖包：

go get github.com/pkg/sftp
go get golang.org/x/crypto/ssh

基本使用示例

1. 建立 SFTP 连接

package main

import (
	"fmt"
	"log"
	"os"
	
	"github.com/pkg/sftp"
	"golang.org/x/crypto/ssh"
)

func main() {
	// SSH 连接配置
	config := &ssh.ClientConfig{
		User: "username",
		Auth: []ssh.AuthMethod{
			ssh.Password("password"),
		},
		HostKeyCallback: ssh.InsecureIgnoreHostKey(), // 生产环境应使用更安全的方式
	}

	// 建立 SSH 连接
	conn, err := ssh.Dial("tcp", "hostname:22", config)
	if err != nil {
		log.Fatalf("failed to dial: %v", err)
	}
	defer conn.Close()

	// 创建 SFTP 客户端
	client, err := sftp.NewClient(conn)
	if err != nil {
		log.Fatalf("failed to create sftp client: %v", err)
	}
	defer client.Close()

	// 现在可以使用 client 进行文件操作...
}

2. 文件上传

func uploadFile(client *sftp.Client, localPath, remotePath string) error {
	// 打开本地文件
	srcFile, err := os.Open(localPath)
	if err != nil {
		return fmt.Errorf("failed to open local file: %v", err)
	}
	defer srcFile.Close()

	// 创建远程文件
	dstFile, err := client.Create(remotePath)
	if err != nil {
		return fmt.Errorf("failed to create remote file: %v", err)
	}
	defer dstFile.Close()

	// 复制文件内容
	if _, err := io.Copy(dstFile, srcFile); err != nil {
		return fmt.Errorf("failed to copy file content: %v", err)
	}

	return nil
}

3. 文件下载

func downloadFile(client *sftp.Client, remotePath, localPath string) error {
	// 打开远程文件
	srcFile, err := client.Open(remotePath)
	if err != nil {
		return fmt.Errorf("failed to open remote file: %v", err)
	}
	defer srcFile.Close()

	// 创建本地文件
	dstFile, err := os.Create(localPath)
	if err != nil {
		return fmt.Errorf("failed to create local file: %v", err)
	}
	defer dstFile.Close()

	// 复制文件内容
	if _, err := io.Copy(dstFile, srcFile); err != nil {
		return fmt.Errorf("failed to copy file content: %v", err)
	}

	return nil
}

4. 列出目录内容

func listDirectory(client *sftp.Client, path string) ([]os.FileInfo, error) {
	files, err := client.ReadDir(path)
	if err != nil {
		return nil, fmt.Errorf("failed to read directory: %v", err)
	}

	for _, file := range files {
		fmt.Printf("%-20s %8d %s\n", 
			file.Name(), 
			file.Size(), 
			file.Mode().String())
	}

	return files, nil
}

5. 创建和删除目录

// 创建目录
func createDirectory(client *sftp.Client, path string) error {
	if err := client.Mkdir(path); err != nil {
		return fmt.Errorf("failed to create directory: %v", err)
	}
	return nil
}

// 删除目录
func removeDirectory(client *sftp.Client, path string) error {
	if err := client.RemoveDirectory(path); err != nil {
		return fmt.Errorf("failed to remove directory: %v", err)
	}
	return nil
}

高级功能

1. 使用公钥认证

func publicKeyAuth(privateKeyPath string) (ssh.AuthMethod, error) {
	key, err := os.ReadFile(privateKeyPath)
	if err != nil {
		return nil, fmt.Errorf("failed to read private key: %v", err)
	}

	signer, err := ssh.ParsePrivateKey(key)
	if err != nil {
		return nil, fmt.Errorf("failed to parse private key: %v", err)
	}

	return ssh.PublicKeys(signer), nil
}

// 使用方式
auth, err := publicKeyAuth("/path/to/private/key")
if err != nil {
	log.Fatal(err)
}

config := &ssh.ClientConfig{
	User: "username",
	Auth: []ssh.AuthMethod{auth},
	// ...
}

2. 断点续传

func resumeUpload(client *sftp.Client, localPath, remotePath string) error {
	// 获取本地文件信息
	localFile, err := os.Open(localPath)
	if err != nil {
		return err
	}
	defer localFile.Close()

	localStat, err := localFile.Stat()
	if err != nil {
		return err
	}

	// 检查远程文件是否存在及其大小
	remoteStat, err := client.Stat(remotePath)
	var remoteSize int64
	if err == nil {
		remoteSize = remoteStat.Size()
		if remoteSize >= localStat.Size() {
			return fmt.Errorf("remote file is same size or larger than local file")
		}
	}

	// 以追加模式打开远程文件
	remoteFile, err := client.OpenFile(remotePath, os.O_WRONLY|os.O_CREATE|os.O_APPEND)
	if err != nil {
		return err
	}
	defer remoteFile.Close()

	// 定位到本地文件的相应位置
	if _, err := localFile.Seek(remoteSize, 0); err != nil {
		return err
	}

	// 继续上传剩余部分
	if _, err := io.Copy(remoteFile, localFile); err != nil {
		return err
	}

	return nil
}

最佳实践

1. 连接管理：重用 SSH 和 SFTP 连接，避免频繁建立和断开连接
2. 错误处理：妥善处理所有可能的错误，特别是网络相关的错误
3. 并发控制：如果需要并发传输多个文件，使用适当的并发控制机制
4. 进度显示：对于大文件传输，可以实现进度显示功能
5. 超时设置：为 SSH 连接设置合理的超时时间

完整示例

package main

import (
	"fmt"
	"io"
	"log"
	"os"
	"path/filepath"
	"time"

	"github.com/pkg/sftp"
	"golang.org/x/crypto/ssh"
)

func main() {
	// 配置 SSH 客户端
	config := &ssh.ClientConfig{
		User: "username",
		Auth: []ssh.AuthMethod{
			ssh.Password("password"),
		},
		HostKeyCallback: ssh.InsecureIgnoreHostKey(),
		Timeout:         30 * time.Second,
	}

	// 建立 SSH 连接
	conn, err := ssh.Dial("tcp", "sftp.example.com:22", config)
	if err != nil {
		log.Fatalf("failed to dial: %v", err)
	}
	defer conn.Close()

	// 创建 SFTP 客户端
	client, err := sftp.NewClient(conn)
	if err != nil {
		log.Fatalf("failed to create sftp client: %v", err)
	}
	defer client.Close()

	// 列出远程目录
	fmt.Println("Remote directory listing:")
	if _, err := listDirectory(client, "."); err != nil {
		log.Fatal(err)
	}

	// 上传文件
	localFile := "localfile.txt"
	remoteFile := "remotefile.txt"
	if err := uploadFile(client, localFile, remoteFile); err != nil {
		log.Fatal(err)
	}
	fmt.Printf("Successfully uploaded %s to %s\n", localFile, remoteFile)

	// 下载文件
	downloadedFile := "downloaded.txt"
	if err := downloadFile(client, remoteFile, downloadedFile); err != nil {
		log.Fatal(err)
	}
	fmt.Printf("Successfully downloaded %s to %s\n", remoteFile, downloadedFile)
}

通过以上代码示例，您可以在 Go 中实现基本的 SFTP 文件传输功能。根据实际需求，您可以进一步扩展这些基础功能。