NoDL
每個 ROS 2 節點一份可審查的介面檔案,可產生程式碼、文件與偏差檢查
授權條款
Apache-2.0
概述
NoDL(Node Definition Language,節點定義語言)讓 ROS 2 節點能在單一文件中宣告其介面——發布者、訂閱、服務、動作、QoS 與參數——這份文件可以像任何其他合約一樣接受審查。它會根據這份文件,以 C++ 抽象基底類別或 rclpy 基底類別的形式產生節點的接線程式碼,行為部分則仍由人手撰寫;透過 rosdoc2 Sphinx 擴充功能產生精確的介面參考文件;並檢查運作中的系統是否偏離該文件。反方向同樣可行:ros2 nodl describe 會觀察一個運作中的節點並草擬其 NoDL,因此既有的程式碼庫無需重寫即可採用。它由 ros-tooling 旗下的 ROS 2 ROSGraph Working Group 開發,並針對每個現行的 ROS 2 發行版釋出。
ROS 2 節點的介面並沒有固定的存放位置。主題與服務在建構函式程式碼中建立,參數在任何有人記得的地方宣告,QoS 則是某個呼叫點的細節,而唯一完整描述節點對外提供什麼的,就是運作中的節點圖。NoDL 將這個介面放進一個檔案,並讓該檔案成為權威依據。作者們對範圍拿捏謹慎:它檢查的是節點圖合約——端點、型別、QoS、參數——並明白表示它無法證明行為、TF 座標框架語意、排程或即時性保證。
同一份文件可用於三種用途,且可分別採用。產生功能負責撰寫管線程式碼:C++ 產生器會輸出一個已接好所有端點的抽象基底類別,並將參數交由 generate_parameter_library 處理,Python 產生器則為 rclpy 做同樣的事,包括生命週期節點。文件功能根據檔案產生介面參考文件,而非仰賴會逐漸與實作脫節的註解。一致性檢查會將宣告的合約與運作中節點實際提供的內容進行比對,而 ros2 nodl diff 則可離線比較兩份文件。ament_nodl 會將文件註冊到 ament 索引,並在 colcon test 中執行運作中節點的檢查。
此專案始於 2020 年,在一陣密集開發後,第 2 版於 2026 年 9 月推出:巢狀參數、Python 服務、動作與生命週期程式碼產生,以及一個可執行的 dummy-robot 教學,全都在發布前兩週內合併。它的進展會在 ROS PMC 自己的會議紀錄中報告,而 2.1 版預計隨 2027 年 4 月的下一個 ROS 2 發行版推出。
為何重要
介面接線是 ROS 2 開發中耗費大量時間的地方,也是許多整合錯誤的藏身之處:某個主題名稱在一個節點中改了,卻沒在其消費端改、一個沒人記錄的參數、一個只在執行時才出現的 QoS 不符。NoDL 是 ROS 專案自己的嘗試,由負責 ROS 節點圖工具的工作小組提出,目的是讓節點介面成為明確的合約,而非程式碼中自然浮現的特性。正是這樣的出身,讓它即使在這麼早期也值得關注:如果它能普及,就會是那種最終出現在每個範本裡的東西。
解決的問題
ROS 2 節點的介面分散在建構函式程式碼中,只有在運作中的節點圖裡才能完整看到,因此往往沒有文件記錄,並在節點之間逐漸出現偏差。NoDL 將它化為單一經過審查的檔案,由此產生接線程式碼、產生文件,並能抓出已不再符合該檔案的運作中系統。
重點
- 一份 NoDL 文件即可宣告節點的發布者、訂閱、服務、動作、QoS 與參數
- 以 C++ 抽象基底類別或 rclpy 基底類別的形式產生介面接線程式碼,行為部分仍由人手撰寫
- 透過 rosdoc2 Sphinx 擴充功能,將精確的介面參考文件產生到 ROS 文件中
- 根據宣告的合約檢查運作中的節點,並可用 ros2 nodl diff 離線比較文件
- ros2 nodl describe 可從運作中的節點草擬 NoDL,因此既有程式碼無需重寫即可採用
- 由 ROS 2 ROSGraph Working Group 開發,並針對 Humble、Jazzy、Kilted、Lyrical 與 Rolling 釋出
- 第 2 版於 2026 年 9 月推出;2.1 版預計隨 2027 年 4 月的 ROS 2 發行版推出
適用對象
- 整合錯誤源於節點之間對主題、型別、QoS 或參數認知不一致的 ROS 2 團隊
- 希望介面文件能自動產生、而非手動維護的套件維護者
- 開發新節點時,寧可一次宣告介面、也不想手寫管線程式碼的任何人
- 希望在運作中節點偏離其合約時,讓 colcon test 失敗的 CI 負責人
限制
- 依其自身說法仍處於早期採用階段——v2 已推出,結構描述被形容為相當穩定,但尚未定案
- 僅檢查節點圖合約;無法證明行為、TF 座標框架語意、排程或即時性
- 程式碼產生涵蓋 C++ 與 Python;沒有其他用戶端函式庫的產生器
- 部分完整測試的相依套件只能透過 pip 取得,因此 buildfarm 建置執行的是縮減版的測試套件
- 採用程式碼產生功能意味著你的節點要繼承自產生的基底類別,對既有程式碼而言是結構性的變更
- 維護者群體不大——近期的工作大多來自少數幾位貢獻者