能快速構建和定製網絡拓撲圖的WPF開源項目-NodeNetwork

大家好，我是沙漠盡頭的狼，今天介紹一個WPF開源項目-NodeNetwork，它可以幫助我們快速構建和定製網絡拓撲圖。

一、前言

在現代軟件開發中，數據可視化和可交互性越來越受到關注。爲了實現這一點，通常需要使用各種圖表、表格、網絡拓撲圖等控件。然而，對於某些特殊的場景，這些控件可能無法滿足需求，此時我們需要一種自定義的方式來展示和處理數據。NodeNetwork就是一種這樣的自定義方式，它是一個基於C# WPF的開源項目，可以幫助我們快速構建和定製網絡拓撲圖。

NodeNetwork的代碼託管在GitHub上，是由荷蘭的一位開發者Wouterdek所創建和維護的。在本文中，我們將對NodeNetwork進行介紹和分析，希望讀者能夠通過本文了解到NodeNetwork的核心概念、應用場景和使用方法，同時也能夠掌握一些開發NodeNetwork的技巧和經驗。

倉庫地址：https://github.com/Wouterdek/NodeNetwork

倉庫截圖：

倉庫源碼結構：

二、示例

1. 計算器示例

此示例允許用戶使用節點編輯器創建數學表達式。修改節點時，將自動計算和更新結果值。此應用程序包含節點驗證，自定義節點子類，值輸入/輸出，自定義輸入編輯器，節點列表，...

下面是計算器示例應用程序的演示：

2. 代碼生成器示例

在此示例中，用戶可以創建 LUA 代碼。與虛幻引擎中的藍圖類似，編輯器具有執行流程和數據流。自定義輸入/輸出端口、節點編輯器提供了更直觀的體驗。

下面是代碼生成器應用程序的截圖：

3. 着色器編輯器示例

此庫更實用的示例可能是着色器編輯器。

下面是使用 NodeNetwork 製作的着色器編輯器示例的演示：

這些示例應用程序可在此處下載，其源代碼包含在存儲庫中，庫的二進制版本在 NuGet 上可用。

三、特徵

專爲 .NET Framework 4.7.2 和 .NET Core 3.1 或更高版本構建。
開放、寬鬆的許可證-Apache-2.0 license。
使用現代反應式 MVVM 代碼構建的交互式、可靠的控件。
順滑的平移、縮放控件。
自動佈局系統。
高度可定製，但默認情況下易於使用。
強大的節點和連接驗證支持。
大量的單元測試提供支持。
...

四、NodeNetwork的核心概念

以下內容可參考倉庫組件說明頁。

1. 節點（Node）

節點是NodeNetwork中的最基本元素，可以表示任何一個數據源或處理單元。每個節點可以包含一個或多個輸入端口和輸出端口，分別表示節點接收和輸出的數據。NodeNetwork中內置了幾種常用的節點類型，如常量節點、計算節點、輸入輸出節點等，同時也支持自定義節點類型。

2. 連接（Connection）

連接是NodeNetwork中的一個核心概念，用於表示節點之間的數據傳輸關係。每個連接都有一個源端口和目標端口，源端口表示數據的來源，目標端口表示數據的目標。連接還可以攜帶一些元數據（metadata），用於描述連接的一些附加信息，如顏色、線寬等。

3. 端口（Port）

端口是節點的輸入或輸出端點，用於與其他節點進行連接。每個端口都有一個類型，表示該端口所能接收或輸出的數據類型。端口還可以有一些其他屬性，如標籤、描述等，用於描述端口的功能和作用。

4. 圖形界面（GUI）

NodeNetwork是基於WPF框架實現的，因此它具有一套強大的圖形界面（GUI）系統。在NodeNetwork中，每個節點和連接都可以顯示爲一個圖形化的元素，用戶可以通過拖拽、縮放等方式對這些元素進行操作。

5. 佈局（Layout）

佈局是NodeNetwork的另一個重要概念，用於控制節點和連接的位置和大小。NodeNetwork中提供了多種不同的佈局方式，如自由佈局、柵格佈局、力導向佈局等。用戶可以根據具體的需求選擇不同的佈局方式，並且可以通過代碼或圖形界面進行佈局的定製和調整。

6. 序列化和反序列化（Serialization and Deserialization）

在實際的應用中，我們需要將節點和連接保存到文件或數據庫中，或者從文件或數據庫中讀取節點和連接。爲了實現這一點，NodeNetwork提供了序列化和反序列化功能。序列化是將節點和連接轉換成一個數據流的過程，反序列化則是將數據流轉換成節點和連接的過程。NodeNetwork支持多種不同的序列化格式，如XML、JSON、二進制等，用戶可以根據具體需求選擇不同的格式。

五、NodeNetwork的應用場景

NodeNetwork具有廣泛的應用場景，下面介紹其中的幾個：

1. 數據處理和分析

NodeNetwork可以幫助我們快速構建數據處理和分析的工具。例如，我們可以創建一個圖形化的工作流，將不同的數據處理節點連接起來，從而實現數據的預處理、轉換和分析。

2. 圖形化編輯器

NodeNetwork可以幫助我們快速構建圖形化的編輯器。例如，我們可以創建一個圖形化的界面，用於編輯和配置某些參數或選項，這些參數或選項可以通過節點和連接的方式進行交互和傳遞。

3. 可視化和交互式展示

NodeNetwork可以幫助我們快速構建可視化和交互式的展示工具。例如，我們可以創建一個圖形化的網絡拓撲圖，用於展示某些設備或系統的連接關係和狀態。用戶可以通過節點和連接的方式進行交互和控制，例如添加、刪除、修改節點和連接等。

六、NodeNetwork的使用方法

NodeNetwork的使用方法非常簡單，下面介紹其中的幾個步驟(參考不到30行代碼的Hello world)。

首先，使用 Dotnet 8創建WPF項目，項目命名爲NodeNetworkTest，您可以使用 .NET Framework 4.7.2 以上或 .NET CORE 3.x 以上，站長使用 .NET 8只是8預覽版2剛出來試試而已。

1. 安裝NodeNetwork

NodeNetwork可以通過NuGet包管理器進行安裝。在Visual Studio中，打開“包管理器控制檯”，輸入以下命令即可安裝NodeNetwork：

Install-Package NodeNetwork

2. 註冊NodeNetwork視圖

MVVM在整個NodeNetwork庫中都在貫徹使用。有關MVVM的介紹請點擊這裏查看。使用庫中的元素，您需要創建合適的視圖，併爲其提供相應的ViewModel實例。

在使用庫之前，請在App.xaml.cs文件的OnStartup方法內使用NNViewRegistrar.RegisterSplat()方法將NodeNetwork的視圖和相應的ViewModel進行註冊關聯。

using System.Windows;
using NodeNetwork;

namespace NodeNetworkTest;

public partial class App : Application
{
    protected override void OnStartup(StartupEventArgs e)
    {
        base.OnStartup(e);
        NNViewRegistrar.RegisterSplat();
    }
}

3. 創建視圖

打開MainWindow.xaml，添加NodeNetwork命名空間xmlns:nodenetwork="clr-namespace:NodeNetwork.Views;assembly=NodeNetwork"，並添加NetworkView視圖<nodenetwork:NetworkView x:Name="networkView" />，NetworkView表示整個網絡拓撲圖：

<Window x:Class="NodeNetworkTest.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        xmlns:nodenetwork="clr-namespace:NodeNetwork.Views;assembly=NodeNetwork"
        mc:Ignorable="d"
        Title="MainWindow" Height="450" Width="800">
    <Grid>
        <nodenetwork:NetworkView x:Name="networkView" />
    </Grid>
</Window>

4. 創建節點和連接

在NodeNetwork中，創建節點和連接非常簡單。首先，我們需要創建NetworkViewModel，它是NetworkView視圖的ViewModel，可以通過以下代碼創建：

var network = new NetworkViewModel();
networkView.ViewModel = network;

然後通過以下代碼創建第一個節點：

var node1 = new NodeViewModel();
node1.Name = "節點1";
network.Nodes.Add(node1);

並給第一個節點創建一個輸入端口：

var node1Input = new NodeInputViewModel();
node1Input.Name = "節點1輸入";
node1.Inputs.Add(node1Input);

創建第二個節點，並以同樣的方式給此節點創建一個輸出端口：

var node2 = new NodeViewModel();
node2.Name = "節點2";
network.Nodes.Add(node2);

var node2Output = new NodeOutputViewModel();
node2Output.Name = "節點2輸出";
node2.Outputs.Add(node2Output);

最後，我們可以通過以下代碼將節點1的輸入端口和節點2的輸出端口連接到一起：

var connection = new ConnectionViewModel(network, node1Input, node2Output);
network.Connections.Add(connection);

完整代碼如下：

using DynamicData;
using NodeNetwork.ViewModels;
using System.Windows;

namespace NodeNetworkTest;

public partial class MainWindow : Window
{
    public MainWindow()
    {
        InitializeComponent();

        // 創建NetworkView視圖的ViewModel實例
        var network = new NetworkViewModel();

        // 給視圖(networkView)賦值viewmodel(network)
        networkView.ViewModel = network;

        // 創建第一個節點ViewModel，設置它的名稱並將此節點加入到network
        var node1 = new NodeViewModel();
        node1.Name = "節點1";
        network.Nodes.Add(node1);

        // 創建第一個節點的輸入端口ViewModel，設置它的名稱並加入第一個節點
        var node1Input = new NodeInputViewModel();
        node1Input.Name = "節點1輸入";
        node1.Inputs.Add(node1Input);

        // 創建第二個節點ViewModel，設置它的名稱並將此節點加入到network, 並以同樣的方式給此節點添加一個輸出Create the second node viewmodel, set its name, add it to the network and add an output in a similar fashion.
        var node2 = new NodeViewModel();
        node2.Name = "節點2";
        network.Nodes.Add(node2);

        var node2Output = new NodeOutputViewModel();
        node2Output.Name = "節點2輸出";
        node2.Outputs.Add(node2Output);

        // 將節點1的輸入端口和節點2的輸出端口連接到一起
        var connection = new ConnectionViewModel(network, node1Input, node2Output);
        network.Connections.Add(connection);
    }
}

運行程序看效果：

示例代碼已經全部給了，你也可以戳這克隆。

5. 佈局

在NodeNetwork中，佈局非常靈活和自由。我們可以通過代碼或圖形界面進行佈局。例如，我們可以通過以下代碼將節點放置在指定的位置：

node.Position = new Point(100, 100);

通過以下代碼調整整個網絡拓撲圖的佈局(參考佈局文檔)：

ForceDirectedLayouter layouter = new ForceDirectedLayouter();
var config = new Configuration
{
    Network = yourNetwork,
};
layouter.Layout(config, 10000);

6. 序列化和反序列化

在NodeNetwork中，序列化和反序列化非常簡單。我們可以通過以下代碼將節點和連接序列化爲XML格式：

var serializer = new XmlSerializer(typeof(NodeNetworkViewModel));
var writer = new StringWriter();
serializer.Serialize(writer, nodeNetwork);

然後，我們可以將XML字符串保存到文件或數據庫中。反序列化也非常簡單。我們可以通過以下代碼從XML字符串中反序列化節點和連接：

var serializer = new XmlSerializer(typeof(NodeNetworkViewModel));
var reader = new StringReader(xmlString);
var nodeNetwork = (NodeNetworkViewModel)serializer.Deserialize(reader);

七、總結

NodeNetwork是一個非常實用和靈活的C# WPF開源項目，它可以幫助我們快速構建圖形化的網絡拓撲圖，實現節點和連接的交互和傳遞。NodeNetwork提供了豐富的功能和特性，例如節點和連接的自定義、佈局和調整、序列化和反序列化等，可以滿足各種不同的應用需求。NodeNetwork的應用場景非常廣泛，例如數據處理和分析、圖形化編輯器、可視化和交互式展示等。NodeNetwork的使用方法非常簡單，我們只需要安裝NodeNetwork、創建節點和連接、佈局和調整、序列化和反序列化即可。

入門指南

有關使用此庫的簡單快速入門指南，請參閱此頁面上的說明書章節。該文檔包括設置信息、說明書章節、示例和 API 參考。

許可證

該庫在 Apache 許可證 2.0 下獲得許可。（見 choosealicense.com/licenses/apache-2.0 簡要介紹）此許可證的副本包含在 LICENSE 下的存儲庫中。

文檔

文檔可在此處獲得。如果要對文檔進行更改，可以通過向 gh-pages 分支發出拉取請求來實現。

貢獻

這些操作在 GitHub 頁面上非常受歡迎：錯誤報告、補丁、功能請求、拉取請求...