HBuilderX: ftp插件/sftp插件使用教程 ( 适用HBuilderX 2.7.11版本及以下)

本文档仅适用于2.6.7 至 2.7.11之间的HBuilderX版本。2.7.12起的FTP插件文档另见https://ask.dcloud.net.cn/article/37430

1. ftp插件简介

1.1 插件安装

插件名称：Ftp Sync, 点击菜单【工具】【插件安装】，安装Ftp Sync插件

1.2 插件介绍

此插件是vscode中流行的ftp插件，因HBuilderX兼容vscode的部分插件生态，也可以在HBuilderX中使用。

• 使用此插件，可将本地工作区文件，与FTP服务器或linux服务器文件同步。
• 支持ftp/sftp协议
• 支持远程文件上传、下载、删除
• 支持自动保存上传

2. ftp使用介绍

使用步骤：

1. 如下图，在项目管理器，新建一个空目录或空项目，然后选中
2. 右键菜单，点击【Ftp-sync: 创建连接配置】
3. 系统自动创建.ftp/ftp-sync.json配置文件
4. 编辑ftp-sync.json, 填写host（ip）、username（用户名）、password（密码）、port（端口）、protocol（协议）
5. 填写完配置文件，右键菜单，点击【Ftp-sync: 浏览远程文件】
6. 选择指定文件，进行上传、下载、删除操作s

3. ftp配置文件参数说明

{  
    "remotePath": "/",                  // 远程服务器文件路径，默认为根目录，可以指定目录，比如/srv  
    "host": "host",                     // 主机IP，即目标电脑IP地址  
    "username": "username",             // ftp用户名，或目标电脑用户名  
    "password": "password",             // ftp密码，或目标电脑密码  
    "port": 21,                         // 端口，ftp默认为21; ssh/sftp默认为22。  
    "secure": false,  
    "protocol": "ftp",                  // 协议：支持ftp、sftp  
    "uploadOnSave": false,              // 是否修改后立即保存上传  
    "passive": false,  
    "debug": false,  
    "privateKeyPath": null,  
    "passphrase": null,  
    "agent": null,  
    "allow": [],  
    "ignore": [  
        "\\.ftp",  
        "\\.git",  
        "\\.DS_Store"  
    ],  
    "generatedFiles": {  
        "extensionsToInclude": [],  
        "path": ""  
    }  
}

注意：配置文件是放在项目下的普通json文件，存放着ftp账号。若你的项目使用三方node库，请注意其可靠性，避免ftp账户失窃

3.1 ftp协议

如果远程服务器，搭建了ftp服务，username和password需要填写ftp的用户密码

3.2 sftp协议

sftp不需要任何配置，开启SSH默认就开启了SFTP。

也就是说，如果您的远程服务器为linux系统，即使没有搭建ftp服务，也可以通过sftp连接，使用文件同步的服务。

• SSH/SFTP，默认端口为：22
• 使用sftp服务，username和password，需要填写目标电脑的用户、密码

4. 使用sftp，连接同步Mac/linux服务器文件

sftp不需要任何配置，开启SSH默认就开启了SFTP。

只要支持ssh协议的电脑，都可以使用本插件同步修改文件

另外，也可以通过外部命令方式搭配三方软件使用ftp，详见：https://ask.dcloud.net.cn/article/35459

5. ftp操作配置快捷键

菜单【工具】【自定义快捷键】

备注： 2.6.12+版本开始支持

[  
  // 项目管理器 右键菜单 FTP: 上传选中文件  
  {  
    "key": "ctrl+shift+u",  
    "command": "extension.ftpsyncuploadselected"  
  },  
  // 项目管理器 右键菜单  FTP: 下载选中文件  
  {  
    "key": "ctrl+shift+d",  
    "command": "extension.ftpsyncdownloadselected"  
  },  
  // 项目管理器 右键菜单  FTP: 浏览远程文件  
  {  
    "key": "ctrl+alt+b",  
    "command": "extension.ftpsynclistselected"  
  },  
  // 编辑器 右键菜单 FTP: 上传当前文件   
  {  
    "key": "ctrl+shift+c",  
    "command": "extension.ftpsyncsingle"  
  },  
  // 项目管理器 右键菜单  FTP: 创建连接配置  
  {  
    "key": "ctrl+shift+i",  
    "command": "extension.ftpsyncinit"  
  }  
]