vs2019+cmake實現Linux遠程開發

在上一篇文章中我們介紹了使用vs2019作為遠程Linux系統的開發環境，但我們是創建的傳統的sln項目，而對於Linux開發者來說以autotools或是cmake進行項目結構的組織更為簡單直觀，也符合在Linux環境上的習慣。

autotools是較為古老的也是使用最為廣泛的構建系統，你在Linux上總是避免不了類似./configure && make這樣的命令，背後就是autotools為你完成了檢測系統環境到生成makefile的一系列工作。

cmake是較新的一種工具，autotools雖然功能強大使用廣泛，但是它的學習成本和維護成本也十分驚人，所以人們創造了cmake來簡化工作。cmake十分簡單易學，在表現力上絲毫不亞於autotools，同時還提供了豐富的官方模塊和第三方模塊以便於定製各種各樣的功能。已經有許多項目開始使用cmake了，例如google test框架，qbittorrent，KDE，_MySQL_等，未來Qt也會從qmake遷移至cmake，目前已經提供了初步支持。

遺憾的是vs2019並不支持autotools工具鏈，但是vs2019支持cmake，而且相比vs2017，vs2019提供了遠程開發的cmake支持，並且支持了更多的設置選項，所以我們今天將會介紹如何使用vs2019+cmake實現Linux遠程開發。不過需要註意的是，本文是介紹如何搭建開發環境的，並不會介紹cmake的語法，並且我也假設各位讀者已經基本瞭解了簡單的CMkaeLists.txt該如何編寫，如果不瞭解那麼你可能需要先進行簡單的cmake學習，這超出了本文的討論範圍你可以尋找其他的博客園文章學習相關知識。當然，即使理解不了後文所羅列的CMakeLists.txt的內容也沒關係，我會儘量給出簡單易懂的註釋。

好了，現在該讓我們進入主題了。

創建遠程cmake項目

創建很簡單，在vs的啟動視窗中選擇“創建新項目”，然後找到“CMkae項目”，選擇後點擊下一步即可，和創建傳統項目的過程完全一樣，如圖：

創建完成後你的項目里會是如下的場景（假如項目名稱叫CMakeProject1）：

也許你會奇怪，為什麼cmake項目不像sln項目那樣區分出Linux和Windows平臺呢？答案是我們可以通過對項目進行設置來切換本地環境和遠程環境！

整個項目由CMakeLists.txt進行組織，而vs則負責在什麼環境上運行cmake，這樣就實現了同一套項目可以幾乎不經過修改在不同平臺上編譯運行（只要你的目標平臺裝有cmake，且版本最低為3.8；本地環境vs自帶了cmake）。

預設情況下的cmake project是在本地環境的，所以接下來我們創建一個叫“LinuxQt”的遠程項目，接著設置對應的遠程Linux環境。

設置遠程環境

設置遠程環境之前，你需要先在頂部的工具菜單的選項對話框中將遠程連接設置好，並同步遠程環境的頭文件，具體過程可以參考這篇，過程一樣就不贅述了。

在初始的項目中啟動項要麼是某個文件要麼是空的，沒有我們的遠程環境，所以我們需要右鍵資源管理器中顯示的CMakeLists.txt文件：

找到“project-name的CMake設置”，project-name是你的項目名稱，點擊。這時會生成一個“CMakeSettings.json”的文件，這是整個項目的配置文件，雙擊打開會顯示圖形化的配置界面：

首先我們看到了配置名稱，這是給你的自定義配置起名字的地方，右邊的綠色加號表示添加新的配置，因為我們只想使用Linux遠程環境，所以我們直接修改了預設的配置項。

接下來是配置類型，這和cmake中的選項對應，在此處設置後就無需再寫進CMakeLists.txt了，有Debug，Release等模式，我們選擇Release，因為遠程環境上的Qt我沒有安裝調試符合，選Debug除了增大編譯目標的體積外也沒什麼用。

下麵則是重點，遠程電腦名稱選項。點擊下拉框即可出現我們在連接管理器中添加的遠程環境，如果你沒有添加遠程環境，在右側的按鈕可以直接打開連接管理器進行添加。該選項預設是空的，也就是本機編譯不啟用遠程環境。

接下來是工具集，也就是最終調用的編譯器工具鏈，vs支持gcc和clang，linux_x64對應gcc，linux_clang_x64對應clang，此外還有arm平臺的支持，選用什麼工具鏈看對應平臺和個人喜好，我這裡選擇了gcc。

然後是“遠程生成根”這個選項，截圖裡未給出，這是遠程編譯時vs存放整個項目的路徑，預設在你的家目錄下的.vs目錄里，你也可以根據自己的需要修改這一路徑，我們演示用的項目就直接使用預設值了。

生成根選項後是設置調用cmake程式時的參數的，只要把需要的參數原樣填入輸入框即可，這裡我們沒用到也就不截圖了。

vs2019中一個強大的功能就是可以把cmake中由系統或是模塊產生的變數的值顯示出來（需要在cache成功刷新之後，也就是cmakelists文件保存後或手動在項目菜單中單擊為項目生成緩存）：

接著我們點擊顯示高級選項，因為想要vs能提供代碼補全還需要一點設置：

在這裡你可以設置cmake生成什麼類型的makefile，cmake的運行目錄和編譯完成後程式的安裝目錄，以及cmake本身所在的路徑（如果你把cmake安裝到了不太常規的地方例如/opt）。

其中重點關註IntellSense選項，這是選擇代碼補全的引擎：

可以看到所有選項都是由平臺名稱-編譯器名稱-32位/64位這種格式組成的，預設值是空，我們想要代碼補全可用就要選擇和遠程環境完全對應的那種模式。

另外右上角一直有直接編輯json文件的按鈕，如果你討厭gui的話可以選擇它。

最後我們保存修改，vs會自動刷新cache，現在我們可以進行遠程開發了。

編寫CMakeLists.txt

前面說過cmake項目的組織需要依靠CMakeLists.txt，現在我們來編寫它。

我們的測試項目會使用Qt，隨機顯示一些不同引擎產生的隨機數，然後把它們顯示在圖表中。選擇這個示例是為了更好的展示cmake項目的能力，但是遠程開發gui程式在vs上目前還有些困難：

1. vs運行遠程環境的程式依靠ssh，然而Linux的gui程式運行需要連接xserver（通常連接信息在環境變數中），ssh啟動的shell環境里沒有這些環境變數，你可能還需要額外設置程式啟動時的命令行參數，否則運行會發生錯誤。
2. 這是Qt自身的原因，Qt依賴自己的moc系統，和原生c++有些出入，因此代碼補全時會經常找不到類型等（clion沒有此類問題）。
3. vs自身的問題，雖然Qt自己支持cmake，但是vs在遠程環境調用moc時不能正常工作，自定義widget會報類似找不到vtable等問題。
4. qt vs tool無法在遠程環境工作。

雖然有以上的缺陷，但是我們編寫單個文件的項目並且不自定義widget，同時只編譯生成程式而不運行的話還是沒有問題的。

下麵來看看CMakeLists.txt是如何編寫的：

project(LinuxQtExample)

# 設置c++語言標準，我使用c++17
set(CMAKE_CXX_STANDARD 17)

cmake_minimum_required (VERSION 3.10)

set(CMAKE_INCLUDE_CURRENT_DIR ON)

# 自動調用moc, uic, rcc
set(CMAKE_AUTOMOC ON)
set(CMAKE_AUTOUIC ON)
set(CMAKE_AUTORCC ON)

# 找到這些Qt組件
find_package(Qt5Widgets REQUIRED)
find_package(Qt5Core REQUIRED)
find_package(Qt5Gui REQUIRED)
find_package(Qt5Charts REQUIRED)

# 將源代碼添加到此項目的可執行文件。
add_executable (LinuxQt "main.cpp")

# 將Qt的庫鏈接至程式
target_link_libraries(LinuxQt Qt5::Core Qt5::Widgets Qt5::Gui Qt5::Charts)

更多如何用cmake構建Qt程式的內容請移步這裡。

編寫測試代碼

上述設置結束後就可以著手編寫代碼了，代碼提示和補全也能工作了（雖然對於Qt的部分補全不正常，但是c++標準庫的補全是可以正常工作的）：

#include <QApplication>
#include <QBarCategoryAxis>
#include <QBarSet>
#include <QBarSeries>
#include <QChart>
#include <QChartView>
#include <QPushButton>
#include <QString>
#include <QStringList>
#include <QValueAxis>
#include <QVBoxLayout>

#include <iostream>
#include <random>

// 這個函數里變數名起的很爛，因為是示例我偷懶了，請你不要在實際項目中寫出這種代碼
// 創建柱狀圖數據的函數
// std::random_device的某些實現在Windows上存在bug，每次運行會返回同樣的結果序列，linux沒問題
// QtCharts的所有類型/函數都在對應的命名空間中，和其他的QtWidgets不同
static QtCharts::QBarSeries* createSeries()
{
    auto dataSet1 = new QtCharts::QBarSet("mt19937");
    auto seed = std::random_device{}();
    std::uniform_int_distribution<int> u(0, 100);
    std::mt19937 rd1(seed);
    for (int i = 0; i < 10; ++i) {
        auto a = u(rd1);
        std::cout << a << std::endl;
        *dataSet1 << a;
    }

    auto dataSet2 = new QtCharts::QBarSet("minstd_rand");
    std::minstd_rand rd2(seed);
    for (int i = 0; i < 10; ++i) {
        auto a = u(rd2);
        std::cout << a << std::endl;
        *dataSet2 << a;
    }

    auto dataSet3 = new QtCharts::QBarSet("default");
    std::default_random_engine rd3(seed);
    for (int i = 0; i < 10; ++i) {
        auto a = u(rd3);
        std::cout << a << std::endl;
        *dataSet3 << a;
    }

    auto dataSet4 = new QtCharts::QBarSet("ranlux48");
    std::ranlux48 rd4(seed);
    for (int i = 0; i < 10; ++i) {
        auto a = u(rd4);
        std::cout << a << std::endl;
        *dataSet4 << a;
    }

    auto dataSet5 = new QtCharts::QBarSet("knuth_b");
    std::knuth_b rd5(seed);
    for (int i = 0; i < 10; ++i) {
        auto a = u(rd5);
        std::cout << a << std::endl;
        *dataSet5 << a;
    }

    auto barSeries = new QtCharts::QBarSeries;
    barSeries->append(dataSet1);
    barSeries->append(dataSet2);
    barSeries->append(dataSet3);
    barSeries->append(dataSet4);
    barSeries->append(dataSet5);
    return barSeries;
}

int main(int argc, char* argv[])
{
    QApplication app(argc, argv);
    auto chart = new QtCharts::QChart;

    // 創建Y軸顯示數據
    auto axisY = new QtCharts::QValueAxis;
    axisY->setRange(0, 100);
    axisY->setTickCount(10);
    axisY->setTitleText("Y軸");
    chart->addAxis(axisY, Qt::AlignLeft);

    // x軸顯示10次取隨機數的結果
    QStringList x;
    for (int i = 0; i < 10; ++i) {
        x << QString::number(i+1);
    }
    auto axisX = new QtCharts::QBarCategoryAxis;
    axisX->append(x);
    chart->addAxis(axisX, Qt::AlignBottom);

    auto barSeries = createSeries();
    chart->addSeries(barSeries);

    chart->setTitle("隨機數分佈圖");
    // 顯示圖例以及讓圖例擺放在圖表的底部
    chart->legend()->setVisible(true);
    chart->legend()->setAlignment(Qt::AlignBottom);
    // 顯示chart的容器
    auto view = new QtCharts::QChartView(chart);
    view->setRenderHint(QPainter::Antialiasing);

    auto layout = new QVBoxLayout;
    layout->addWidget(view);
    // 點擊按鈕刷新顯示的數據
    auto button = new QPushButton("點擊刷新");
    QObject::connect(button, &QPushButton::clicked, [chart]() {
        // removeAll會幫你刪除原來的series，所以不必擔心記憶體泄漏
        chart->removeAllSeries();
        auto barSeries = createSeries();
        chart->addSeries(barSeries);
    });
    layout->addWidget(button, Qt::AlignCenter);
    auto window = new QWidget;
    window->setLayout(layout);
    window->setWindowTitle("圖表");
    // 圖表預設會顯示成最小，為了不讓圖表縮成一團需要給一個固定的大小
    window->resize(700, 500);
    window->show();
    app.exec();
}

代碼中使用了utf8編碼的中文字元串，你需要設置源文件的編碼為utf8以免在Linux上運行時出現亂碼。具體見這裡。

運行測試

如之前所說，我們不能直接點擊運行按鈕，所以對於gui程式我們只能選擇頂部工具欄的生成->全部生成，這樣vs會自動調用cmake和make來完成程式的構建：

可以看到vs將整個項目用rsync同步到了遠程機上，接著運行了cmake和make。

生成成功後我們到之前設置的“遠程生成根”下out/build/...，省略號表示的是你的cmake項目配置的名字，編譯好的程式就在這裡，下麵在遠程環境中運行：

總結

cmake項目總體上比sln更簡單也更好控制，只是細節上還有欠缺。

cmake本省也簡單易學，有著強大的功能，如果你是從Linux上的開發環境遷移至Windows不妨試一試cmake。