背景描述

有時(shí)候Python應(yīng)用的代碼在本地開發(fā)環(huán)境運(yùn)行十分正常，但是放到線上以后卻出現(xiàn)了莫名其妙的異常，經(jīng)過再三排查以后還是找不到問題原因，于是就在想，要是可以在服務(wù)器環(huán)境中進(jìn)行單步跟蹤調(diào)試就好了。

然而，在服務(wù)器系統(tǒng)上安裝一個(gè)IDE肯定是不現(xiàn)實(shí)的；通過SSH遠(yuǎn)程到服務(wù)器端，采用pdb進(jìn)行調(diào)試雖然可行，但是操作還是較為繁瑣，而且也不夠直觀。

那么，是否可以將開發(fā)環(huán)境中的IDE與服務(wù)器環(huán)境相連，實(shí)現(xiàn)利用開發(fā)環(huán)境的IDE調(diào)試服務(wù)器環(huán)境中運(yùn)行的程序呢？ 答案是肯定的，這就是遠(yuǎn)程調(diào)試（Remote Debug）。

遠(yuǎn)程調(diào)試的工作原理

遠(yuǎn)程調(diào)試的功能在Eclipse、IntelliJ IDEA等大型IDE中均有支持，實(shí)現(xiàn)原理都基本相同，這里采用PyCharm進(jìn)行說明。

在遠(yuǎn)程調(diào)試的模式下，PyCharm（IDE）扮演服務(wù)端（Server）的角色，而運(yùn)行在遠(yuǎn)程計(jì)算機(jī)上的應(yīng)用程序扮演客戶端（Client）的角色。正因如此，進(jìn)行遠(yuǎn)程調(diào)試時(shí)，需要先在本地開發(fā)環(huán)境中設(shè)定端口并啟動(dòng)IDE，IDE會(huì)對設(shè)定的端口開始監(jiān)聽，等待客戶端的連接請求；那遠(yuǎn)程計(jì)算機(jī)中的應(yīng)用程序又是怎樣與IDE建立通訊連接的呢？

針對遠(yuǎn)程調(diào)試功能，PyCharm提供了pydevd模塊，該模塊以pycharm-debug.egg的形式存在于PyCharm的安裝路徑中。遠(yuǎn)程計(jì)算機(jī)安裝該庫文件后，然后就可以調(diào)用pydevd.settrace方法，該方法會(huì)指定IDE所在機(jī)器的IP地址和監(jiān)聽的端口號，用于與IDE建立連接；建立連接后，便可在IDE中對遠(yuǎn)程在遠(yuǎn)程計(jì)算機(jī)中的程序進(jìn)行單步調(diào)試。

使用PyCharm進(jìn)行遠(yuǎn)程開發(fā)和調(diào)試

你是否經(jīng)常要在Windows 7或MAC OS X上面開發(fā)Python或Web應(yīng)用程序，但是它們最后需要在linux上面來運(yùn)行呢？ 我們經(jīng)常會(huì)碰到開發(fā)時(shí)沒有問題但是到了正式的Linux環(huán)境下面卻出現(xiàn)問題。那么怎樣保證開發(fā)環(huán)境跟運(yùn)行環(huán)境的一致呢？

通常有兩種方法解決。一種是使用PyCharm內(nèi)置支持的Vagrant，這個(gè)教程可以參考Vagrant開發(fā)環(huán)境配置。 不過很遺憾的是我自己在試驗(yàn)過程中啟動(dòng)VirtualBox虛擬機(jī)時(shí)候老是報(bào)錯(cuò)，暫時(shí)還沒解決，讀者可以自己試著測試看行不行。 第二種方式就是通過PyCharm的遠(yuǎn)程解釋器加上文件同步功能，實(shí)現(xiàn)本地編輯代碼->同步到服務(wù)器->通過遠(yuǎn)程debug來調(diào)試測試程序。目前我選擇的是第二種，雖然比第一種更笨拙點(diǎn)。

遠(yuǎn)程調(diào)試的功能在Eclipse、IntelliJ IDEA等大型IDE中均有支持，實(shí)現(xiàn)原理都基本相同，這里采用PyCharm進(jìn)行說明。

遠(yuǎn)程服務(wù)器的同步配置

遠(yuǎn)程服務(wù)器IP地址192.168.203.95，開啟ssh服務(wù)，安裝python版本2.7。我用一個(gè)在PyCharm里面的core-python項(xiàng)目來做演示。

首先我們需要配置PyCharm通服務(wù)器的代碼同步，打開Tools | Deployment | Configuration

點(diǎn)擊左邊的“+”添加一個(gè)部署配置，輸入名字，類型選SFTP

確定之后，再配置遠(yuǎn)程服務(wù)器的ip、端口、用戶名和密碼。root path是文件上傳的根目錄，注意這個(gè)目錄必須用戶名有權(quán)限創(chuàng)建文件。

然后配置映射，local path是你的工程目錄，就是需要將本地這個(gè)目錄同步到服務(wù)器上面，我填的是項(xiàng)目根目錄。 Deploy path on server 這里填寫相對于root path的目錄，下面那個(gè)web path不用管先

如果你還有一些文件或文件夾不想同步，那么在配置對話框的第三個(gè)tab頁“Excluded path”里面添加即可，可同時(shí)指定本地和遠(yuǎn)程。

還有一個(gè)設(shè)置，打開Tools | Deployment | Options，將”Create Empty directories”打上勾，要是指定的文件夾不存在，會(huì)自動(dòng)創(chuàng)建。

上傳和下載文件

有幾種方法可以實(shí)現(xiàn)本地和遠(yuǎn)程文件的同步，手動(dòng)和當(dāng)文件保存后自動(dòng)觸發(fā)。這里我選擇了手動(dòng)，因?yàn)樽詣?dòng)觸發(fā)比如影響性能，PyCharm會(huì)卡，感覺不爽。

手動(dòng)上傳方式很簡單，選擇需要同步的文件或文件夾，然后選擇 Tools | Deployment | Upload to sftp(這個(gè)是剛剛配置的部署名稱)

下載文件也是一樣，選擇 Tools | Deployment | Download from sftp

比較遠(yuǎn)程和本地文件

有時(shí)候你并不確定遠(yuǎn)程和本地版本的完全一致，需要去比較看看。PyCharm提供了對比視圖來為你解決這個(gè)問題。

選擇Tools | Deployment | Browse Remote Host，打開遠(yuǎn)程文件視圖，在右側(cè)窗口就能看到遠(yuǎn)程主機(jī)中的文件

選擇一個(gè)你想要對比的文件夾，點(diǎn)擊右鍵->Sync with Local，打開同步對比窗口，使用左右箭頭來同步內(nèi)容。

上面是服務(wù)器與本地對比，那么本地文件通服務(wù)器對比，就先在PyCharm里面選擇文件或文件夾，然后右鍵->Deployment->Sync with deployed to即可

PyCharm遠(yuǎn)程調(diào)試

在PyCharm中進(jìn)行遠(yuǎn)程調(diào)試有兩種選擇：

1. 使用遠(yuǎn)程的解釋器
2. 使用Python調(diào)試服務(wù)器

這里簡單起見我只演示第一種，使用遠(yuǎn)程解釋器，也就是使用服務(wù)器上面安裝的python解釋器。

配置遠(yuǎn)程Python解釋器

選擇File | Settings，選擇Project | Project Interpreter，然后在右邊，點(diǎn)擊那個(gè)小齒輪設(shè)置，如下

然后點(diǎn)擊”Add Remote”，填寫主機(jī)的ssh配置

如果之前配置過SFTP的話就直接選“Deployment configuration”，然后選擇剛剛的模板名稱就可以了，由于我上面配置過就直接選模板， 這里請仔細(xì)看我的Python解釋器是虛擬環(huán)境virtualenv，這個(gè)要在服務(wù)器上面先創(chuàng)建好虛擬環(huán)境。

開始調(diào)試

完成之后選擇這個(gè)遠(yuǎn)程的解釋器作為工程的解釋器即可,然后配置一個(gè)運(yùn)行實(shí)例，打斷點(diǎn)調(diào)試。 這里我以另外一個(gè)django工程為例來說明，名字為zspace，因?yàn)橛靡粋€(gè)web工程來說明更具代表性。

選擇“Run/Debug Configuration”，添加一個(gè)“Django server”，然后配置像下面這樣寫

請注意圖中標(biāo)出的幾個(gè)點(diǎn)，具體什么意思就不用多解釋了吧，^_^

然后你就可以像本地調(diào)試一樣打斷點(diǎn)做調(diào)試了。這個(gè)步驟太簡單就不截圖了，記得修改源碼后同步到服務(wù)器繼續(xù)下一次的調(diào)試。

以上就是本文的全部內(nèi)容，希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

最新評論