Milo庫
今天跟大家來介紹一下一個OPC UA協議的開源庫，我們使用的現場設備為西門子的S7-1500 CPU，西門子的S7-1500在V2.1版本后就直接可以作為OPC UA的服務器來供其他客戶端訪問。所以用OPC協議來進行數據采集就是最好的方式。
計算機語言采用java，所以也花了很大的力氣來找OPC UA通信協議的java實現庫，盡管OPC Foundation在Github上也有協議的java實現，但是各種學習的資源很有限，學習曲線比較陡峭。然后碰巧在Github上找到了一個OPC UA的開源庫，就是今天要介紹的 Milo，據了解該項目的Eclipse旗下的一個物聯網的項目，是一個高性能的OPC UA棧，提供了一組客戶端和服務端的API，支持對實時數據的訪問，監控，報警，訂閱數據，支持事件，歷史數據訪問，和數據建模。
Milo Github鏈接
Milo 初探
在Milo中大量的采用了java 8的新特性CompletableFuture來進行異步操作，Milo中有大量的操作都是直接返回CompletableFuture對象，還有大量使用函數接口和接口默認方法等新特性，所以JDK的版本要8.0，對CompletableFuture不太熟悉的可以先去了解CompletableFuture的相關概念在來看Milo的官方例子會輕松很多。
添加依賴
好了，下面就添加相關依賴，Milo的依賴有三個Stack，Client SDK，Server SDK。
Client SDK依賴
<dependency>
<groupId>org.eclipse.milo</groupId>
<artifactId>sdk-client</artifactId>
<version>0.2.4</version>
</dependency>
1
2
3
4
5
Server SDK依賴
<dependency>
<groupId>org.eclipse.milo</groupId>
<artifactId>sdk-server</artifactId>
<version>0.2.4</version>
</dependency>
1
2
3
4
5
Stack依賴
<dependency>
<groupId>org.eclipse.milo</groupId>
<artifactId>stack-client</artifactId>
<version>0.2.4</version>
</dependency>
<dependency>
<groupId>org.eclipse.milo</groupId>
<artifactId>stack-server</artifactId>
<version>0.2.4</version>
</dependency>
1
2
3
4
5
6
7
8
9
10
11
目前最新的版本是0.2.4
開發客戶端就添加客戶端的依賴，開發服務端就添加服務端的依賴。一般來說Stack依賴並不需要手動添加，在我們添加Client SDK或者Server SDK的時候會包含了Stack依賴。
添加bouncycastle依賴
為什么需要添加bouncycastle依賴？因為創建OPC UA客戶端必須要有相關的數字證書，而bouncycastle就作為解析相關的數字證書的庫所以要添加相關的bouncycastle依賴。
<dependency>
<groupId>org.bouncycastle</groupId>
<artifactId>bcpkix-jdk15on</artifactId>
<version>1.57</version>
</dependency>
1
2
3
4
5
所以如果我們開發OPC UA客戶端，總的依賴項也很簡單，如下：
<dependency>
<groupId>org.eclipse.milo</groupId>
<artifactId>sdk-client</artifactId>
<version>0.2.4</version>
</dependency>
<dependency>
<groupId>org.bouncycastle</groupId>
<artifactId>bcpkix-jdk15on</artifactId>
<version>1.57</version>
</dependency>
1
2
3
4
5
6
7
8
9
10
11
搜索服務節點
首先要創建OPC客戶端第一件事當然是指定一個URL。以S7-1500的CPU為例，可以在博圖軟件的組態界面雙擊CPU然后再屬性窗口里面找到OPC選項卡然后里面就會有這個CPU的OPC UA的URL。拿到這個URL后就可以在java中定義這個地址。
//在西門子S7-1500中OPC UA服務器的端口默認為4840
String EndPointUrl = "opc.tcp://localhost:4840";
1
2
獲取服務節點列表
對應的OPC UA服務地址（也就是上面定義的字符串）的節點並不止一個，因為在一個對應的OPC UA服務地址里面可能也有不一樣的服務器安全策略，每種不同安全策略對應一個節點。以S7-1500為例就有下面幾種安全策略。
無安全設置
Basic128Rsa15 - 簽名
Basic128Rsa15 - 簽名和加密
Basic256 - 簽名
Basic256 - 簽名和加密
Basic256Sha256 - 簽名
Basic256Sha256 - 簽名和加密
以上策略可以在S7-1500 CPU的組態中選擇啟用哪一個。然后在java中就會搜索到相應的節點。
EndpointDescription[] endpointDescription = UaTcpStackClient.getEndpoints(EndPointUrl).get();
//過濾掉不需要的安全策略，選擇一個自己需要的安全策略
EndpointDescription endpoint = Arrays.stream(endpoints)
.filter(e -> e.getSecurityPolicyUri().equals(securityPolicy.getSecurityPolicyUri()))
.findFirst().orElseThrow(() -> new Exception("no desired endpoints returned"));
1
2
3
4
5
6
接下來創建配置類，然后再用這個配置類來生成OPC客戶端對象。
OpcUaClientConfig config = OpcUaClientConfig.builder()
.setApplicationName(LocalizedText.english("OPCAPP"))
.setApplicationUri("urn:LAPTOP-AQ90KJVR:OPCAPP")
.setCertificate(certificate)
.setKeyPair(keyPair)
.setEndpoint(endpoint)
.setIdentityProvider(new UsernameProvider("username","password"))
.setRequestTimeout(uint(5000))
.build();
OpcUaClient opcClient = new OpcUaClient(config);
1
2
3
4
5
6
7
8
9
10
11
下面就來對上面這些代碼左一個解釋。
在我們調用了builder后就要進行一些基本的客戶端設置，setCertificate()有一個X509Certificate對象的形參，表示設置的數字證書（OPCUA應用都需要有數字證書和密匙對來創建，而數字證書和密匙對我們可以自己創建，具體的生成數字證書的方法這里就不討論了，具體的可以到我博客的另一篇文章中看到或者到我的Github上有相關例程）。
OPCUA標准java實現 Milo庫 證書的生成和使用
GitHub關於Milo庫使用證書例程
setKeyPair()接受一個KeyPair對象表示密匙對。
setEndpoint()接受一個EndpointDescription對象，就是設置剛剛我們選擇的節點就可以了。
setIdentityProvider()該方法表示指定客戶端使用的訪問驗證方式，接受一個IdentityProvider接口，而Milo庫為我們提供了4個IdentityProvider接口的實現。
AnonymousProvider
CompositeProvider
UsernameProvider
X509IdentityProvider
我自己比較常用第一個匿名驗證和第三個用戶名驗證方式，因為這兩種驗證方式也方便簡單。
上面的例子中使用的是用戶名和密碼驗證方式，對於該驗證方式只需要實例化一個UsernameProvider類，在構造函數中設置用戶名和密碼。
這樣在創建和OPC UA服務器連接的時候會與服務器中設置的授權的用戶名和密碼比對，符合的話就允許連接。
對於AnonymousProvider匿名驗證方式就更簡單了，只需要實例化一個AnonymousProvider對象不需要輸入任何的實參。匿名連接到OPC UA服務器。
setRequestTimeout()設置請求超時時間，單位為毫秒。
最后通過該config對象最終創建OPCUA的客戶端對象OpcUaClient opcClient = new OpcUaClient(config);
在有了這個OpcUaClient對象后我們就能夠開始訪問OPC UA服務器來進行現場的信息采集了。
瀏覽節點，讀，寫
瀏覽節點
在OPC UA中的讀和寫是對OPC地址空間中的節點進行訪問，地址空間中的節點都實現了Node接口，由於其實現類太多了
這里就不一一羅列出來了。
下面我們就來瀏覽一個節點:
public void browseNode(OpcUaClient client){
//開啟連接
client.connect().get();
List<Node> nodes = client.getAddressSpace.browse(Identifiers.RootFolder).get();
for(Node node:nodes){
System.out.println("Node= " + node.getBrowseName().get().getName());
}
}
1
2
3
4
5
6
7
8
9
10
正如上面所見我們只需要不到幾行的代碼就完成了節點的瀏覽訪問，從上面的方法可以看到形參是一個OpcUaClient對象
而該對象我們在上一節已經創建了，我們對傳入的OpcUaClient對象調用getAddressSpace()來獲取地址空間對象，AddressSpace對象
有很多用於訪問節點的方法，這里我們調用browse()方法，該方法接受一個NodeId對象來表示開始瀏覽的根節點，隨后方法會
瀏覽根節點下的所有節點，並返回一個CompletableFuture<List<Node>>對象（此處用到了java8.0的新特性）。
在browse()后調用get()以阻塞的方式等待返回。
在上面例子中的Identifiers.RootFolder是Milo庫預定義的根目錄，Identifiers中還有很多其他的預定於NodeId，當然我們也可以
自己new一個NodeId出來，這都是可以的。
隨后對我們獲取到的節點列表進行歷遍並且打印每一個節點的名稱到標准輸出。
以上就是對OPC UA地址空間中的節點進行訪問的過程，相當的簡單。
獲取節點值
獲取節點的值也是一樣的簡單，廢話不多說直接上代碼。
public void readValue(OpcUaClient client){
//創建連接
client.connect().get();
NodeId nodeId = new NodeId(3,"\"test_value\"");
DataValue value = client.readValue(0.0, TimestampsToReturn.Both, nodeId).get();
System.out.println((Integer)value.getValue().getValue());
}
1
2
3
4
5
6
7
8
9
10
以上的代碼從PLC中讀取了名為"test_value"的變量，並且把值打印在了標准輸出中。
下面我們來看下上面的代碼是怎么回事，首先我們創建了連接，由於Milo庫大量采用了CompletableFuture，所以大家會在很多地方看到
調用get()方法來阻塞等待方法返回。然后是創建了一個NodeId對象，該對象的構造函數共有10個重載，我個人比較經常用到的是：
/**
* @param namespaceIndex the index for a namespace URI. An index of 0 is used for OPC UA defined NodeIds.
* @param identifier the identifier for a node in the address space of an OPC UA Server.
*/
public NodeId(int namespaceIndex, String identifier) {
//...
}
1
2
3
4
5
6
7
以S7-1500 PLC為例，所有的變量的地址空間的索引都是整數3，標識就是PLC中的變量名（注意要帶雙引號）。
創建好NodeId后就可以讀取變量的值了。
調用OpcUaClient對象的readValue()方法讀取變量值，該方法接受三個參數
default CompletableFuture<DataValue> readValue(double maxAge,
TimestampsToReturn timestampsToReturn,
NodeId nodeId) {
//...
}
1
2
3
4
5
第一個參數如果設置為0的話會獲取最新的值，如果maxAge設置到Int32的最大值，則嘗試從緩存中讀取值。
第二個參數為請求返回的時間戳,第三個參數為要讀取的NodeId對象。
該對象也是返回的CompletableFuture<DataValue>，這里可以發現它返回的是一個DataValue對象，在該對象中有一個Variant
對象來存放真正的值，為了獲取PLC變量的值，我們需要從readValue()中返回的DataValue中調用.getValue()來獲取
其中的Variant對象，然后再次調用getValue()方法來獲得真正的值。Variant中的值的類型是Object,所以獲取到值后需要強制轉換到我們所需要的值然后再使用。
以上就是讀取PLC中的變量值的代碼了，也是很簡單的對吧。
寫變量
下面來展示對變量寫入值，代碼如下：
public void writeValue(OpcUaClient client, int value){
//創建連接
client.connect().get();
//創建變量節點
NodeId nodeId = new NodeId(3,"\"test_value\"");
//創建Variant對象和DataValue對象
Variant v = new Variant(value);
DataValue dataValue = new DataValue(v,null,null);
StatusCode statusCode = client.writeValue(nodeId,dataValue).get();
System.out.println(statusCode.isGood());
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
向PLC變量寫入值的代碼跟讀取的代碼差不多，不同的是需要創建一個Variant然后再用這個Variant對象創建DataValue對象。
OpcUaClient對象的writeValue()的方法接受一個需要寫入的變量節點，和一個值對象DataValue，該方法返回的是一個StatusCode對象
，上面的代碼把返回來的StutusCode判斷是否為Good，並且輸出到標准輸出中來。
以上就是向PLC變量寫入值的代碼，Milo庫為我們封裝了大量的操作，使得在對變量的讀寫甚至之后介紹到的操作中都更便利了。
訂閱變量
對於讀取PLC里面的變量，有時候我們更需要的是當變量變化的時候客戶端能夠收到並且做出相應的反應，而不是對變量作輪詢讀取。OPC UA提供了創建變量監控和訂閱的方式來監控對應變量的變化。
public void createSubscription(OpcUaClient client){
//創建連接
client.connect().get();
//創建發布間隔1000ms的訂閱對象
UaSubscription subscription = client.getSubscriptionManager().createSubscription(1000.0).get();
//創建訂閱的變量
NodeId nodeId = new NodeId(3,"\"test_value\"");
ReadValueId readValueId = new ReadValueId(nodeId,AttributeId.Value.uid(),null,null);
//創建監控的參數
MonitoringParameters parameters = new MonitoringParameters(
uint(1),
1000.0, // sampling interval
null, // filter, null means use default
uint(10), // queue size
true // discard oldest
);
//創建監控項請求
//該請求最后用於創建訂閱。
MonitoredItemCreateRequest request = new MonitoredItemCreateRequest(readValueId, MonitoringMode.Reporting, parameters);
List<MonitoredItemCreateRequest> requests = new ArrayList<>();
requests.add(request);
//創建監控項，並且注冊變量值改變時候的回調函數。
List<UaMonitoredItem> items = subscription.createMonitoredItems(
TimestampsToReturn.Both,
requests,
(item,id)->{
item.setValueConsumer((item, value)->{
System.out.println("nodeid :"+item.getReadValueId().getNodeId());
System.out.println("value :"+value.getValue().getValue());
})
}
).get();
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
上面的代碼與之前的例子相比代碼量多了很多，下面我們就來解釋上面的代碼都發生了什么。
首先還是需要創建OPC連接，然后用OpcUaClient對象創建UaSubscription訂閱對象，方法.createSubscription()接受一個double類型的參數，表示訂閱發布間隔，單位為毫秒。
接下來就是創建需要訂閱的變量。
NodeId nodeId = new NodeId(3,"\"test_value\"");
ReadValueId readValueId = new ReadValueId(nodeId,AttributeId.Value.uid(),null,null);
1
2
然后創建監控參數對象，監控參數對象用於之后的創建監控請求對象，創建訂閱需要用到監控請求對象，MonitoringParameters的構造函數如下：
public MonitoringParameters(UInteger clientHandle, Double samplingInterval, ExtensionObject filter, UInteger queueSize, Boolean discardOldest) {
this.clientHandle = clientHandle;
this.samplingInterval = samplingInterval;
this.filter = filter;
this.queueSize = queueSize;
this.discardOldest = discardOldest;
}
1
2
3
4
5
6
7
這里就接受最重要的兩個參數。
第一個參數clientHandle對象很重要，用來標識每個創建的監控項，所以對於不同的監控變量這個值必須不同，並且唯一。可以采用遞增的方式來設置這個值，或者在多線程環境下使用具有原子性的數據類型來設置該值。
第二個參數samplingInterval是變量的采樣周期，單位為毫秒。以S7-1500為例的話在PLC的組態設置里面也是可以設置采樣周期，所以暫不清楚這兩種設置方式是否會沖突。
好了，在創建了監控變量ReadValueId對象和監控參數對象MonitoringParameters后就可以用這兩個對象來創建監控項請求對象MonitoredItemCreateRequest了，該對象構造函數如下：
public MonitoredItemCreateRequest(ReadValueId itemToMonitor, MonitoringMode monitoringMode, MonitoringParameters requestedParameters) {
this.itemToMonitor = itemToMonitor;
this.monitoringMode = monitoringMode;
this.requestedParameters = requestedParameters;
}
1
2
3
4
5
可以看到構造函數以剛剛我們創建的ReadValueId和MonitoringParameters對象作為形參。所以我們創建該對象也很簡單
MonitoredItemCreateRequest request = new MonitoredItemCreateRequest(readValueId, MonitoringMode.Reporting, parameters);
1
這樣就創建了一個監控項創建請求對象。
因為MonitoredItemCreateRequest對象包含了監控的變量節點和監控的參數，所以接下來我們就可以用MonitoredItemCreateRequest來創建變量訂閱了，我們調用一開始獲得的UaSubscription對象的createMonitoredItems()方法，該方法的簽名如下：
public interface UaSubscription {
//...
default CompletableFuture<List<UaMonitoredItem>> createMonitoredItems(
TimestampsToReturn timestampsToReturn,
List<MonitoredItemCreateRequest> itemsToCreate,
BiConsumer<UaMonitoredItem, Integer> itemCreationCallback) {
//...
}
//...
}
1
2
3
4
5
6
7
8
9
10
11
12
13
可以看到，該方法接受一個MonitoredItemCreateRequest列表，如果有多個需要訂閱的變量就可以把所有需要監控的對象都加入到該列表然后調用該方法來創建訂閱。如果只有一個訂閱的變量，那么把該變量的MonitoredItemCreateRequest對象加入一個List然后把這個List作為實參傳遞進createMonitoredItems方法即可。
我們再來看第三個參數，第三個參數是一個BiConsumer函數接口，該函數接口會在List<MonitoredItemCreateRequest>里每個監控項創建成功后調用的函數接口。該函數提供了一個UaMonitoredItem參數，我們用該參數可以訪問到創建成功的監控項的NodeId信息等等。
所以我們利用函數接口在創建監控成功后，隨便為監控項注冊變量值改變的回調函數。如下：
List<UaMonitoredItem> items = subscription.createMonitoredItems(
TimestampsToReturn.Both,
requests,
(item,id)->{
item.setValueConsumer((item, value)->{
System.out.println("nodeid :"+item.getReadValueId().getNodeId());
System.out.println("value :"+value.getValue().getValue());
})
}
).get();
1
2
3
4
5
6
7
8
9
10
上面例子中在創建成功的回調函數中對item調用setValueConsumer方法來設置變量值改變的回調函數，這個回調函數就是該變量每次發生改變后所調用的方法，這里的例子是變量改變時打印節點id和變量值到標准輸出中。
最后
到這里這篇結束OPC UA的java實現的Milo庫的文章就到此結束了，文章中提供了創建OPC客戶端對象以及變量瀏覽，讀，寫，和訂閱的具體例子。雖然這些都是很基本也很簡單的操作，但是網上對於Milo庫的學習資源真的是少之又少，所以也希望能讓大家有一個概念，如果需要了解更高級的功能或更多關於Milo庫的架構建議你去到Milo庫的Github倉庫中的閱讀源代碼來了解更多更詳細的信息。
————————————————
版權聲明：本文為CSDN博主「Chiva Chen」的原創文章，遵循 CC 4.0 BY-SA 版權協議，轉載請附上原文出處鏈接及本聲明。
原文鏈接：https://blog.csdn.net/q932104843/article/details/86664236