VScode实现本地与远端同步开发的两种方式

2023-05-16

alt

远程服务端开发IDE分析

这里仅对Pycharm 和 Visual Studio Code (简称VS或VScode)做简单的对比分析,Pycharm是面向专业开发者的Python IDE,分为Professional(专业)和Community(社区)版本,仅专业版本提供remote server功能,破解专业版本经常需要更换激活码,购买专业版本1743元/第一年,如果既不破解又不想购买,那就换用完全免费开源的VScode,VScode通过支持相关插件的安装(例如SSH、Python、Pylance等)的形式能很好的实现本地和远程服务器同步开发。 alt

本地远程服务器开发必要性

实际开发中,有些开发场景需要采用本地Remote服务端开发模式,例如

  1. 本地cpu、windows,需要用到服务端linux、gpu计算能力
  2. 本地开发,服务端测试或部署,期望本地代码增删改查能自动或便捷同步到远端服务器
  3. 边端或远端有特殊接口,本地无法开发,需要同步边/远端环境才能运行开发,这种情况以边缘盒子开发较为常见。
  4. 使用本地IDE直接进行服务端代码开发,包括具备debug、代码补全、函数跳转、错误检测等功能。

本文以下两个角度,借助VScode实现本地和远端同步开发

  1. 代码在本地——"从本地到远端"
  2. 代码在远端——"从远端到本地"

对以上两个角度,本文所展示均只是基于VScode实现的一种方式,并非仅此一种,按照个人开发习惯进行取舍整合。

从本地到远程服务器

实际开发中,以本地开发环境为windows,远程服务器为linux情况最常见,对于初级开发者,一般将项目代码在本地开发好,然后手动或者借助FTP/SFTP桌面工具同步代码到远程服务器进行测试或者部署,再借助xshell、MobaXterm等工具登录服务器,通过bash命令手动启动服务,这条流水线存在以下问题:

  • 当对代码做增删改查时,需要本地通过各种IDE编辑好,再手动同步到服务器
  • 每次对服务进行启停操作,需要通过xshell等工具登录,然后手动启停
  • 本地无法共享服务器计算资源和环境配置,例如服务器有gpu、cpu,而本地仅有cpu,对CV计算测试显然需要服务器资源。

下面介绍如何借助VScode,无需各种工具切换,让本地项目享用远端(云端)服务器环境和计算资源,且便捷同步本地和远程代码。

  1. 下载安装VScode,打开本地项目文件
  2. 安装VScode python插件、SFTP插件
    Ctrl+Shift+X 分别输入 python、SFTP alt alt 此时左侧导航栏会多出SFTP图标 alt
  3. 配置本地Python解释器
    使用快捷键:Ctrl+Shift+P 打开命令面板,在命令面板中输入>Python: select Interpret,选择本地python解释器(这里假设本地已有可用的python环境,如果没有请自行安装) alt
  4. 打开sftp.json文件
    Ctrl+Shift+P 打开命令面板,在命令面板中输入>SFTP:Config 命令后打开sftp.json文件,项目中自动新增.vscode目录,里面包含sftp.json模板文件 alt 修改name、host、port、username等信息,新的sftp.json如下 alt
  5. 连接远端linux服务器
    配置完成并保存后在命令面板中输入>SFTP:Open SSH in Terminal以连接远端的服务器 alt 随后命令面板会提示您需要选择要连接的SFTP服务器(可能需要等30秒才出现,具体视网络情况,因为本地和远程建立连接需要时间),选择sftp.json中的SFTP服务器并回车即可 alt 根据提示在终端输入密码即可(第一次需要手动输入密码) alt 或者选择左侧SFTP图标,右键远程服务名 alt 终端进入bash命令模式 alt 切换服务端python环境,再运行脚本即可。
  6. 本地项目文件远端同步和脚本增删改查自动同步
    SFTP连接成功后,在左侧空白处右键选择“Sync Local->Remote”将代码同步到远程服务器,同步成功后本地修改或者删除代码时都会 自动和远端服务器同步(因为在sftp.json中设置"uploadOnSave": true)。(建议先在远端新建项目路径,在sftp.json中设置该路径为remotePath,即指定了本地代码同步到远端的路径) alt
  7. 手动同步脚本增删改查 如果设置"uploadOnSave": false,当在本地修改某个脚本时,右击该脚本,通过"Upload File"或者"Download File"上传或者下拉更新,项目文件手动同步到远端也可以采用该方式 alt
  8. 退出远程连接模式
    选择右下角kill按钮即可关闭远程连接 alt

注意,通过以上方式,让开发者仅在VScode下就可进行本地开发、本地代码自动同步到远端、远端命令执行,无需切换工具(例如使用pycharm开发代码,使用fileZilla同步文件,通过xshell连接远端并执行命令),但该方式需要本地和远端分别配置相同可运行的环境,且本地项目代码需要同步到远端服务器,这属于一种半手动远端服务器开发方式,下面介绍进阶式的本地远端同步开发方式。


进阶篇:从远程服务器到本地

以linux服务器为例,代码(或者项目)位于远程服务器上,通过VScode同步远程服务器环境并能在本地调试服务器代码(注意:无需将远程服务器代码同步到本地)。

连接linux远程服务器

点击左侧的扩展按钮(或用Ctrl+Shift+X),搜索插件"Remote Development"进行安装
alt 安装完后会在左侧生成了远程连接的图标,点击此图标,然后选择设置图标 alt 点击弹出的config文件,在文件中填写服务器的配置,Host为在VS Code内显示的名称,可以随意填写,Hostname是远程服务器的公网IP地址,User是用于登录的用户名称,这里选择.ssh/config alt 按照如下格式填写服务器相关配置信息

# Read more about SSH config files: https://linux.die.net/man/5/ssh_config
Host 服务器名称
    HostName 服务器IP
    User 登录账号
# eg:
Host testName
    HostName 127.0.0.1
    User root
# 填写好之后,保存关闭文件。

Ctrl+Shift+P 打开命令框,输入"Show Login Terminal";或者也可以依次选择"文件"->"首选项"->"设置",搜索Show Login Terminal,勾选"Always reveal the SSH login terminal" alt 再点击远程连接的图标,选择"Connect to Host in New Window" or "Connect to Host in Current Window" alt 输入登录密码即可连接远程服务器 alt 点击右下角"+"号,选择bash即可使用服务器sh命令 alt

出现的问题

以上通过ssh仅实现了本地和远端服务器的连接,但并没有在ssh中安装python解释器,在本地编辑运行代码时,会出现以下情况

  1. 无自动补全功能 alt
  2. 出现自动补全,但非python期望的补全方式 alt
  3. 需要在终端手动运行代码 需要在终端先手动切换虚拟环境,对应上合适的python解释器,再输入准确的脚本路径,方可运行 alt
  4. 所有py脚本没出现因警告或错误导致的高亮 alt
  5. 不支持"ctrl + 鼠标左击"函数跳转、debug、错误检测等功能 函数跳转功能对于程序理解和调试非常重要,这个功能的缺失极大影像项目开发进度和相关软件使用流畅度。
问题分析

出现以上问题根本原因是本地项目没有关联远程服务器的python解释器,即当使用快捷命令 Ctrl+Shift+P 打开命令框,输入"python: select interpreter"无服务端python解释器可选择 alt

解决方案

使用 Ctrl+Shift+X 打开扩展(插件)管理窗口(Extentions),输入"python"在应用商店中搜索扩展Pylance并install in SSH alt 安装成功后,提示"This extension is enabled in the Remote Extension Host because it prefers to run" alt 再次打开命令框,输入"python: select interpreter",此时便出现Linux服务器上可选的各种环境下的python解释器 alt 此时某些py脚本出现黄色高亮(脚本内部警告和错误导致),说明服务器上的python解释器已经起作用了。 alt 代码也能自动补全 alt 其它功能,例如debug、函数跳转等功能和使用本地解释器开发完全一致。

一般情况下,以上两种方式,更推荐方式二,在本地加载远端环境并开发,整个开发流程非常之流畅,与利用本地环境进行项目开发的方式几乎完全一致,毫无违和感。

附录

https://code.visualstudio.com/Download

关注公号【野马逐星】回复svm,lstm,mqtt,face即可等领取相关项目代码

本文由 mdnice 多平台发布

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

VScode实现本地与远端同步开发的两种方式 的相关文章

  • 揭秘被Arm编译器所隐藏的浮点运算~

    以下文章来源于Mculover666 xff0c 作者mculover666 引言 笔者接触嵌入式领域软件开发以来 xff0c 几乎用的都是 ARM Cortex M 内核系列的微控制器 感谢C语言编译器的存在 xff0c 让我不用接触汇编
  • main之前初始化流程

    本文分别介绍Keil调用的ARMCC以及ARM NONE EABI GCC两个编译器在main之前的操作 xff1a Keil MDK启动文件 总结一下MDK的启动流程 xff1a 1 系统初始化 xff0c 包括中断向量表的重新映射 2
  • 嵌入式单片机之STM32F103C8T6最小系统板电路设计参考

    STM32F103C8T6最小系统板电路设计 一 电源部分 设计了一个XH插座 xff0c 以便使用3 7V锂电池供电 xff0c 接入电压不允许超过6V 二 指示灯部分 电源指示灯可以通过一个短路帽控制亮灭 xff0c 以达到节电的目的
  • 国产射频前端,攀登新高峰

    2022年 xff0c 国产射频前端开启新篇章 射频前端包括功率放大器 xff08 PA xff09 滤波器 xff08 Filter xff09 开关 xff08 Switch xff09 低噪声放大器 xff08 LNA xff09 天
  • slam相关文章

    1 视觉SLAM漫谈 http www cnblogs com gaoxiang12 p 3695962 html 2 学习SLAM需要哪些预备知识 xff1f https www zhihu com question 35186064 3
  • 工业机器人主要核心

    主要核心为三部分 xff0c 控制器 xff08 就是用来控制机器人动作的那个手持设备 xff0c 可以用来编程 xff0c 一般用vxworks和linux xff0c wince来实现 xff09 伺服电机和减速器用来实现机器人的动作
  • 想搞工业机器人 这五大方面你必须了解

    origin http www robot china com news 201510 09 25754 html 1 工业机器人控制系统硬件结构 控制器是 机器人 系统的核心 xff0c 国外有关公司对我国实行严密封锁 近年来随着微电子技
  • 为什么我选择并且推崇用ROS开发机器人?

    origin http www leiphone com news 201701 zBHXGJcsRTioj4gH html 雷锋网 公众号 xff1a 雷锋网 按 xff1a 本文来自知乎 xff0c 作者贾子枫 xff0c 雷锋网已获授
  • 一飞智控CEO齐俊桐:一篇文章教你看透无人机飞控这十年

    origin http www leiphone com news 201702 YO2bskI7smE1U8TA html 无人机 又一个被国人玩坏了的单词 科幻电影里的无人机 10年前说自己是搞无人机的 xff0c 无不引来疑惑和赞叹的
  • 机器人框架

    ROS Rock Yarp Orocos
  • 列王的纷争-深度传感器已被巨头瓜分?

    origin http mt sohu com 20170325 n484729546 shtml 我们常常说苹果富可敌国 但是你这么说其实是在侮辱苹果 苹果可比美国政府有钱多了 根据最新消息 xff0c 美国政府账上的现金 xff0c 只
  • 不得不看!国内深度摄像头方案大起底

    origin http pieeco baijia baidu com article 517947 引言 xff1a 市场对深度视觉技术需求趋于井喷 xff0c 但可以提供产品和方案的公司寥寥无几 xff0c 本文分析了国内三家各具特点的
  • VR中的9轴传感器(重力加速度/陀螺仪/磁力计)

    origin http blog csdn net dabenxiong666 article details 53836503 前言 传感器的调试过程 xff0c 一般根据原厂提供demo代码 xff0c 调试数据接口 xff0c 将数据
  • STM32中AD采样的三种方法分析

    在进行STM32F中AD采样的学习中 xff0c 我们知道AD采样的方法有多种 xff0c 按照逻辑程序处理有三种方式 xff0c 一种是查询模式 xff0c 一种是中断处理模式 xff0c 一种是DMA模式 三种方法按照处理复杂方法DMA
  • 神经网络:比原来更容易学习了

    origin http geek csdn net news detail 195039 原文 xff1a NEURAL NETWORKS YOU VE GOT IT SO EASY 作者 xff1a Steven Dufresne 翻译
  • NuttX 编译系统

    origin http blog csdn net zhumaill article details 24400441 xff08 嵌入式 实时操作系统 rtos nuttx 7 1 makefile xff09 NuttX 编译系统 转载
  • NuttX 启动流程

    origin http blog csdn net zhumaill article details 23261543 xff08 嵌入式 实时操作系统 rtos nuttx 7 1 stm32 源代码分析 xff09 NuttX 启动流程
  • nuttx操作系统的移植以及下载

    origin http blog csdn net seawolfe article details 70244672 1 在ubuntu根目录下 xff1a root 64 ubuntu apt get update 更新包 2 root
  • 机器人峰会厂商

    origin http www chinarobtop com exhibition exhibition php 埃夫特 清能德创 芜湖瑞思 芜湖哈特 山东帅克机械 宁波慈兴轴承 A6 成都卡诺普 绿的谐波
  • 机器人公司

    1 螺趣科技 2 米兔机器人 3 360

随机推荐

  • 解:高性能MEMS IMU解决方案-ADXRS290

    origin https ezchina analog com message 34890 对于复杂且高动态惯性配置的MEMS IMU应用 xff0c 评估功能时需要考虑许多属性 在设计周期早期评估这些属性优于追逐开放性成果 xff0c 从
  • 关于DIY电池均衡器--被动均衡---蓄电池--电瓶车电池组电压均衡的经历

    提示 xff1a 文章写完后 xff0c 目录可以自动生成 xff0c 如何生成可参考右边的帮助文档 前言 随着电动车长时间的反复使用 xff0c 电池参数难免会发生变化 xff0c 当电池组中各节电池参数不一时 xff0c 便会出现充电时
  • CMakeLists.txt与Makefile 的区别

    我平时一般是在windows使用VS编程 xff0c 但是偶尔在网上查资料的时候也会下载一些别人的代码 xff0c 其中就经常对CMakeLists txt和Makefile文件产生疑惑 xff0c 下面我来分析一下这两个经常使用的地方 C
  • 链接提示 extern "C"

    在 C 43 43 中调用 C 代码时 xff0c 需要给编译器指定 xff23 代码要按照 xff23 语言的编译器编译 xff0c 否则编译器会将 xff23 代码按照默认的C 43 43 编译器来编译 xff23 代码 xff0c 这
  • C/C++实现你的浪漫表白:浪漫流星雨表白程序,

    想要讨女朋友欢心也巩固自己所学的知识 xff0c 各位小伙伴有自己的想法了吗 xff1f 准备好想要怎样实施了吗 xff1f 有什么美好的计划了吗 xff1f 如果没有的话那么别慌 xff0c 我知道 xff0c 在座的各位肯定都是有自己的
  • DDR4原理及硬件设计

    DDR4 DRAM的工作原理 其引脚按照功能可以分为7类 xff1a 前3类为电源 地 配置 后4类为 xff1a 控制信号 时钟信号 地址信号 数据信号 电源 地 配置信号的功能很简单 xff0c 在此不赘述 控制信号主要是用来完成DDR
  • RK3568最小系统四层板设计总结

    很久没有关注DDR4和DDR5相关知识了 xff0c 利用找工作在家休息间隙从网上下载了RK3568的原理图和6层板的PCB参考设计 xff0c 将6层板改为4层板设计 进行总结之前 xff0c 先将设计时关于Allegro设计小技巧进行总
  • 部门管理经验小结

    很久没有针对管理做总结了 xff0c 回武汉后一直做工程师 xff0c 现对管理知识体系进行总结 xff1a 部门管理按照如下框图1所示 图1
  • STM32驱动开发(二)--USB Device RNDIS虚拟网卡(usb hound抓包完整数据流分析)

    一 简介 抓包工具 xff1a usb hound xff0c 本例使用安卓手机作为device 使用RNDIS功能连接电脑虚拟网卡 抓取完整数据流包按流程进行分析 数据流程熟悉之后 xff0c 查看stm32或者其他厂家的USB库开发RN
  • 瑞芯微RK3568控制板设计总结

    本周刚使用瑞芯微RK3568设计完成一款军用控制PCB板 xff0c 特进行总结便于后续设计提升效率 一 布局相关 器件布局效率及结果对于PCB设计至关重要 xff0c 特别在使用一个新处理器如何高效的展开器件的布局设计非常重要 xff0c
  • xilinx ise 下载地址

    10 1i ed2k file Xilinx ISE DS v10 1 iso 6345773056 5211e011944e70e0e682b3f90a613695 9 1i http download xilinx com direct
  • 输出比较模式时的TIM_OCMode_PWM1和TIM_OCMode_PWM2区别

    配合结构体成员TIM OCInitTypeDef TIM OCPolarity来一起使用 现在假定TIM OCInitTypeDef TIM OCPolarity 61 TIM OCPolarity High 则起始波形为高电位 若TIM
  • 运放稳定性连载4:运放网络,SPICE分析(1)

    作者 xff1a Tim Green xff0c 德州仪器公司 2 0 引言 本系列第2部分将着重分析运放电路 xff08 尤其是两种常见运放网络 xff09 的稳定性 重要的是必须在进行SPICE 仿真前先进行1 阶分析 xff08 主要
  • 运放稳定性连载18:电容负载稳定性:输出引脚补偿(2)

    我们的CMOS RRO输出引脚补偿实例如图9 20所示 这种实际电源应用采用OPA569功率运算放大器作为可编程电源 为了在负载上提供精确的电源电压 xff0c 可以采用一种差动放大器INA152对负载电压实施差动监控 闭环系统可以补偿任何
  • 音响开关机POP声/爆破声最新解决消除方法(D类音频功放IC应用实例)

    POP声是指音频器件在上电 断电瞬间以及上电稳定后 xff0c 各种操作带来的瞬态冲击所产生的爆破声 下文结合自身在推广小功率D类音频功放IC的过程中遇到的设计问题 xff0c 就音频系统开关机POP声的解决思路和大家分享一下 降低或去除P
  • 单片机stm32 USART串口实际应用解析

    stm32作为现在嵌入式物联网单片机行业中经常要用多的技术 xff0c 相信大家都有所接触 xff0c 今天这篇就给大家详细的分析下有关于stm32的出口 xff0c 还不是很清楚的朋友要注意看看了哦 xff0c 在最后还会为大家分享有些关
  • 串口数据传输当中的共用体和结构体转换

    https www cnblogs com codecamel p 4703174 html
  • extern "C" 引起的 error C2059

    extern 34 C 34 引起的 error C2059 转 在扩展名为 C的源文件中使用 extern 34 C 34 会引发错误 C2059 xff0c 错误提示为 xff1a error C2059 syntax error 39
  • 串口接收不定长数据

    这个通用的方法 xff0c 其实原理就是传输两个字节间是否超过了指定时间 xff0c 如果超过了一定的时间 xff0c 就认为是接收完一帧数据了 首先我们要知道 xff0c 串口是接收一个字节 xff0c 就会发生一次中断 xff0c 如果
  • VScode实现本地与远端同步开发的两种方式

    远程服务端开发IDE分析 这里仅对Pycharm 和 Visual Studio Code 简称VS或VScode 做简单的对比分析 xff0c Pycharm是面向专业开发者的Python IDE xff0c 分为Professional