Golang 遠程傳輸文件

概述

之前有一篇介紹如何使用 golang 通過SSH協議來執行遠程命令：Golang 執行遠程命令 同樣，通過SSH協議也可以使用 golang 來遠程傳輸文件。

除了 SSH 的庫，為了傳輸文件，還需要用到 github.com/pkg/sftp 這個庫。

實現方式

廢話不多說，直接看代碼。 由於是基於 SSH 協議實現的遠程文件傳輸，所以先創建 SSH 的連接，再創建傳輸文件的 sftp 客戶端。

func connect(user, password, host string, port int) (*sftp.Client, error) {  
  var (
    auth         []ssh.AuthMethod
    addr         string
    clientConfig *ssh.ClientConfig
    sshClient    *ssh.Client
    sftpClient   *sftp.Client
    err          error
  )
  // get auth method
  auth = make([]ssh.AuthMethod, 0)
  auth = append(auth, ssh.Password(password))

  clientConfig = &ssh.ClientConfig{
    User:    user,
    Auth:    auth,
    Timeout: 30 * time.Second,
  }

  // connet to ssh
  addr = fmt.Sprintf("%s:%d", host, port)

  if sshClient, err = ssh.Dial("tcp", addr, clientConfig); err != nil {
    return nil, err
  }

  // create sftp client
  if sftpClient, err = sftp.NewClient(sshClient); err != nil {
    return nil, err
  }

  return sftpClient, nil
}

發送文件

使用上面的 connect 方法創建 sftpClient 後，發送文件很簡單。

package main

import (  
  "fmt"
  "log"
  "os"
  "path"
  "time"

  "github.com/pkg/sftp"

  "golang.org/x/crypto/ssh"
)

func main() {  
  var (
    err        error
    sftpClient *sftp.Client
  )

  // 這裡換成實際的 SSH 連接的 用戶名，密碼，主機名或IP，SSH端口
  sftpClient, err = connect("root", "rootpass", "127.0.0.1", 22)
  if err != nil {
    log.Fatal(err)
  }
  defer sftpClient.Close()

  // 用來測試的本地文件路徑 和 遠程機器上的文件夾
  var localFilePath = "/path/to/local/file/test.txt"
  var remoteDir = "/remote/dir/"
  srcFile, err := os.Open(localFilePath)
  if err != nil {
    log.Fatal(err)
  }
  defer srcFile.Close()

  var remoteFileName = path.Base(localFilePath)
  dstFile, err := sftpClient.Create(path.Join(remoteDir, remoteFileName))
  if err != nil {
    log.Fatal(err)
  }
  defer dstFile.Close()

  buf := make([]byte, 1024)
  for {
    n, _ := srcFile.Read(buf)
    if n == 0 {
      break
    }
    dstFile.Write(buf)
  }

  fmt.Println("copy file to remote server finished!")
}

獲取文件

從遠程機器上獲取文件的方式略有不同，但也很簡單。

package main

import (  
  "fmt"
  "log"
  "os"
  "path"
  "time"

  "github.com/pkg/sftp"

  "golang.org/x/crypto/ssh"
)

func main() {

  var (
    err        error
    sftpClient *sftp.Client
  )

  // 這裡換成實際的 SSH 連接的 用戶名，密碼，主機名或IP，SSH端口
  sftpClient, err = connect("root", "rootpass", "127.0.0.1", 22)
  if err != nil {
    log.Fatal(err)
  }
  defer sftpClient.Close()

  // 用來測試的遠程文件路徑 和 本地文件夾
  var remoteFilePath = "/path/to/remote/path/test.txt"
  var localDir = "/local/dir"

  srcFile, err := sftpClient.Open(remoteFilePath)
  if err != nil {
    log.Fatal(err)
  }
  defer srcFile.Close()

  var localFileName = path.Base(remoteFilePath)
  dstFile, err := os.Create(path.Join(localDir, localFileName))
  if err != nil {
    log.Fatal(err)
  }
  defer dstFile.Close()

  if _, err = srcFile.WriteTo(dstFile); err != nil {
    log.Fatal(err)
  }

  fmt.Println("copy file from remote server finished!")
}

總結

上面的例子只是演示了文件傳輸，傳輸文件夾也很簡單，只是多了遍歷文件夾和創建文件夾的步驟，具體的函數可以自行查看 sftp 庫中doc。