在本篇文章中，我們來盡可能詳細地深入探討 catkin config 的使用方法。這是掌握 catkin_tools 工作流的關鍵，能極大地提升你的開發效率和項目的規范性。

catkin config 的核心思想

首先，要理解它的核心思想：為你的 Catkin 工作空間創建一個持久化的、可被版本控制的配置。

在沒有 catkin_tools 的年代（使用 catkin_make），如果你想給編譯過程傳遞一個參數，比如開啟優化，你必須每次都這樣寫：

# 每次編譯都要寫，很麻煩
catkin_make -DCMAKE_BUILD_TYPE=Release

如果你忘了寫，那這次編譯就不是 Release 模式了。這非常繁瑣且容易出錯。

catkin config 就是為了解決這個問題。你用 catkin config 設置一次，這個配置就會被保存下來，之后每一次運行 catkin build 都會自動使用這個配置，直到你再次修改它。

---

配置是如何存儲的？

當你第一次在工作空間運行 catkin init 或 catkin config 時，它會在你的工作空間根目錄下創建一個隱藏文件夾 .catkin_tools。所有的配置信息都以 YAML 文件的形式存儲在這里面，通常是：

<your_ws>/.catkin_tools/profiles/default/config.yaml

default 是默認的配置文件名。你可以把它理解為“當前激活的配置”。

你通常不應該手動編輯這個 YAML 文件，而是通過 catkin config 命令來安全地修改它。

---

catkin config 的常用操作

1. 查看當前配置

這是最基本的操作。想知道當前工作空間都設置了些什么？

# 顯示當前激活配置的詳細信息
catkin config# 或者使用更簡潔的別名
catkin config -l

示例輸出：

這個輸出告訴你：

• 當前用的是 default 配置。
• 工作空間繼承自 ROS 的主環境 /opt/ros/noetic。
• 各個目錄（build, devel 等）的位置。
• 最重要的：
  • CMake 參數 (CMAKE_ARGS): 編譯時會傳遞 -DCMAKE_BUILD_TYPE=RelWithDebInfo 給 CMake。
  • Make 參數 (MAKE_ARGS): 編譯時會使用 make -j32，即 32 線程并行編譯。

2. 設置/修改配置項

這是最核心的用法。

A. 設置 CMake 參數 (--cmake-args)

這是最常用的功能，用來向 CMake 傳遞 -D 開頭的變量。

• 設置編譯類型為 Release (開啟優化，去除調試信息)

  catkin config --cmake-args -DCMAKE_BUILD_TYPE=Release
  

  運行后，再 catkin config -l 看看，CMAKE_ARGS 就變了。現在每次 catkin build 都會是優化過的版本。

• 設置編譯類型為 Debug (包含調試信息，方便 GDB 調試)

  catkin config --cmake-args -DCMAKE_BUILD_TYPE=Debug
  

• 添加多個 CMake 參數

  catkin config --cmake-args -DCMAKE_BUILD_TYPE=Debug -DOTHER_VAR=True
  

• 在現有參數基礎上追加 (Append)
  假設你已經設置了 Debug 模式，現在想再加一個參數，但不想覆蓋掉原來的。

  catkin config --append-args -DNEW_FLAG=ON
  

  注意： 如果不加 --append-args，新的設置會覆蓋掉所有舊的 CMAKE_ARGS。

B. 設置 Make 參數 (--make-args)

用來控制 make 命令本身的行為。

• 設置并行編譯的線程數

  # 使用 8 個線程編譯
  catkin config --make-args -j8
  # 使用與 CPU 核心數相同的線程數，并保留 2 個核心空閑
  catkin config --make-args -j$(nproc) -l$(nproc)
  

C. 設置安裝目錄 (--install)

默認情況下，catkin build 只會生成 devel 空間。如果你想生成一個可以被部署到其他機器上的 install 空間（類似于 /opt/ros/noetic 的結構），你需要開啟安裝選項。

# 開啟安裝功能，產物會出現在 <ws>/install 目錄
catkin config --install

D. 拉黑/白名單包 (--blacklist / --whitelist)

如果你的 src 目錄里有些包你暫時不想編譯它，可以拉黑。

# 編譯時忽略 my_buggy_pkg 和 another_pkg
catkin config --blacklist my_buggy_pkg another_pkg

反之，也可以只編譯白名單里的包。

3. 清除配置

• 清除所有 CMake 參數

  catkin config --cmake-args ""
  

• 清除所有配置，恢復到初始狀態

  catkin config --clear-all
  

---

殺手級功能：配置文件 (Profiles)

這是 catkin_tools 最強大的功能之一。你可以為不同的場景創建不同的配置集，并隨時切換。

最常見的場景：調試 (Debug) vs. 發布 (Release)。

工作流示例：

1. 查看當前有的 Profiles

   catkin profile list
   # 輸出可能只有：
   # default (active)
   

2. 創建新的 Profiles

   # 創建一個叫 'debug' 的 profile
   catkin profile add debug# 創建一個叫 'release' 的 profile
   catkin profile add release
   

3. 分別為不同的 Profile 設置配置

   • 配置 release Profile:

     # 注意 --profile release 參數
     catkin config --profile release --cmake-args -DCMAKE_BUILD_TYPE=Release
     

   • 配置 debug Profile:

     catkin config --profile debug --cmake-args -DCMAKE_BUILD_TYPE=Debug -DCMAKE_CXX_FLAGS="-O0 -g"
     

     這里我們還額外加了 C++ 編譯器的標志，-O0 關閉優化，-g 生成調試符號。

4. 在 Profiles 之間切換

   • 激活 release Profile:

     catkin profile set release
     

     現在，你再運行 catkin config -l，看到的就是 release 的配置了。此時運行 catkin build 就會編譯出優化版本。

   • 激活 debug Profile:

     catkin profile set debug
     

     現在運行 catkin build 就會編譯出帶調試符號的版本，可以用 GDB 來調試。

5. 臨時使用某個 Profile 進行構建
   你也可以不切換全局激活的 Profile，只在本次構建時臨時使用。

   catkin build --profile debug
   

最佳實踐和注意事項

1. 先 clean 再 build：當你切換了影響編譯結果的核心配置（尤其是 CMAKE_BUILD_TYPE）后，最好先運行 catkin clean 或 catkin clean <package_name> 來清除舊的編譯產物，然后再運行 catkin build，以確保新的配置被完全應用。

2. 充分利用 Profiles：為不同的任務（調試、發布、測試）建立不同的 Profile，這是一個非常好的習慣，能讓你的工作流非常清晰和高效。

3. 定期檢查：時不時用 catkin config -l 檢查一下當前的配置，確保它符合你的預期。

4. 將配置納入版本控制：.catkin_tools 目錄可以被 Git 等版本控制工具管理起來。這樣，團隊里的每個成員 clone 倉庫后，就可以使用完全相同的構建配置，保證了環境的一致性。

通過熟練使用 catkin config 和 catkin profile，你可以像專業開發者一樣，精確、高效地管理你的 ROS 項目構建過程。