【PyCharm中文教程 08】遠程代碼調試圖文教程

原創

2021-03-22 21:30

一般情況下，我們開發調試都是在個人PC上完成，遇到問題，開一下 Pycharm 的調試器，很快就能找到問題所在。

可有些時候，項目代碼的運行會對運行環境有依賴，必須在部署了相關依賴組件的服務器上纔可以運行，這就直接導致了我們不能在本地進行調試。

對於這種特殊的場景，就我所知，有如下兩種解決方案：

pdb
遠程調試

關於 pdb，之前也寫過專門的文章介紹使用方法，你可以點此查看：無圖形界面的代碼調試方法 - pdb

而遠程調試呢，是讓我們可以在我們在 PC 上用 PyCharm 的圖形化界面來進行調試遠方服務器上代碼，它和本地調試沒有太大的區別，原來怎麼調試的現在還是怎麼調試。

區別就在於，本地調試不需要事前配置，只要你的代碼準備好了，隨時可以開始 Debug ，而遠程調試呢，需要不少前置步驟，這也正是本篇文章的內容，教你如何配置遠程調試環境。

1. 新建一個項目

首先，要在Pycharm中新建一個空的項目，後面我們拉服務器上的項目代碼就會放置在這個項目目錄下。我這邊的名字是 NOVA，你可以自己定義。

2. 配置連接服務器

Tools -> Deployment -> configuration

添加一個Server

Name：填你的服務器的IP
Type：設定爲SFTP

點擊OK後，進入如下界面，你可以按我的備註，填寫信息：

SFTP host：公網ip
Port：服務器開放的ssh端口
Root path：你要調試的項目代碼目錄
Username：你登陸服務器所用的用戶
Auth type：登陸類型，若用密碼登陸的就是Password
Password：選密碼登陸後，這邊輸入你的登陸密碼，可以選擇保存密碼。

這裏請注意，要確保你的電腦可以ssh連接到你的服務器，不管是密鑰登陸還是密碼登陸，如果開啓了白名單限制要先解除。

填寫完成後，切換到Mappings選項卡，在箭頭位置，填寫\

以上服務器信息配置，全部正確填寫完成後，點擊OK

接下來，我們要連接遠程服務器了。 Tools -> Deployment -> Browse Remote Host

3. 下載項目代碼

如果之前填寫的服務器登陸信息準確無誤的話，現在就可以看到遠程的項目代碼。

選擇下載遠程代碼要本地。

下載完成提示。

現在的IDE界面應該是這樣子的。

4. 下載遠程解釋器

爲什麼需要這步呢？

遠程調試是在遠端的服務器上運行的，它除了依賴其他組件之外，還會有一些很多Python依賴包我們本地並沒有。

進入 File -> Settings 按圖示，添加遠程解釋器。

填寫遠程服務器信息，跟之前的一樣，不再贅述。

點擊OK後，會自動下載遠程解釋器。如果你的項目比較大，這個時間可能會比較久，請耐心等待。

5. 添加程序入口

因爲我們要在本地DEBUG，所以你一定要知道你的項目的入口程序。如果這個入口程序已經包含在你的項目代碼中，那麼請略過這一步。

如果沒有，就請自己生成入口程序。

比如，我這邊的項目，在服務器上是以一個服務運行的。而我們都知道服務的入口是Service文件。 cat /usr/lib/systemd/system/openstack-nova-compute.service

[Unit]
Description=OpenStack Nova Compute Server
After=syslog.target network.target libvirtd.service

[Service]
Environment=LIBGUESTFS_ATTACH_METHOD=appliance
Type=notify
NotifyAccess=all
TimeoutStartSec=0
Restart=always
User=nova
ExecStart=/usr/bin/nova-compute

[Install]
WantedBy=multi-user.target

看到那個ExecStart沒有？那個就是我們程序的入口。我們只要將其拷貝至我們的Pycharm中，並向遠程同步該文件。