298 lines
12 KiB
C#
298 lines
12 KiB
C#
#nullable enable
|
|
|
|
using Cysharp.Threading.Tasks;
|
|
using Newtonsoft.Json.Linq;
|
|
using SampleProject.Config;
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using UnityEngine;
|
|
using UVC.Log;
|
|
using UVC.network;
|
|
using UVC.Tests;
|
|
|
|
namespace UVC.Data
|
|
{
|
|
/// <summary>
|
|
/// MQTT 통신을 통해 데이터를 수신하고 처리하는 파이프라인을 관리하는 클래스입니다.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// 이 클래스는 MQTT 브로커에 연결하여 등록된 토픽으로 들어오는 메시지를 수신하고,
|
|
/// 해당 메시지를 지정된 데이터 매퍼를 통해 변환한 후 핸들러에게 전달합니다.
|
|
/// 여러 MQTT 토픽을 동시에 관리하고 각각에 대한 처리 방식을 개별적으로 설정할 수 있습니다.
|
|
/// </remarks>
|
|
/// <example>
|
|
/// <code>
|
|
/// // 1. 데이터 구조를 정의하는 DataMask 생성
|
|
/// var dataMask = new DataMask();
|
|
/// dataMask["deviceId"] = "";
|
|
/// dataMask["temperature"] = 0.0;
|
|
/// dataMask["humidity"] = 0.0;
|
|
/// dataMask["timestamp"] = DateTime.Now;
|
|
///
|
|
/// // 2. DataMapper 생성
|
|
/// var dataMapper = new DataMapper(dataMask);
|
|
///
|
|
/// // 3. 데이터 처리 핸들러 정의
|
|
/// Action<IDataObject?> dataHandler = (data) =>
|
|
/// {
|
|
/// if (data != null)
|
|
/// {
|
|
/// // 데이터 처리 로직
|
|
/// Console.WriteLine($"Received data: {data.ToJson()}");
|
|
/// }
|
|
/// };
|
|
///
|
|
/// // 4. MQTTPipeLineInfo 생성 및 설정
|
|
/// var pipelineInfo = new MQTTPipeLineInfo("sensor/+/data")
|
|
/// .setDataMapper(dataMapper)
|
|
/// .setHandler(dataHandler);
|
|
///
|
|
/// // 5. MQTTPipeLine 인스턴스 생성
|
|
/// var mqttPipeline = new MQTTPipeLine("mqtt.eclipseprojects.io", 1883);
|
|
///
|
|
/// // 6. 파이프라인 정보 추가
|
|
/// mqttPipeline.Add(pipelineInfo);
|
|
///
|
|
/// // 7. 파이프라인 실행
|
|
/// mqttPipeline.Execute();
|
|
///
|
|
/// // ... 애플리케이션 로직 수행 ...
|
|
///
|
|
/// // 8. 파이프라인 중지 및 리소스 해제
|
|
/// mqttPipeline.Stop();
|
|
/// mqttPipeline.Dispose();
|
|
/// </code>
|
|
/// </example>
|
|
public class MQTTPipeLine
|
|
{
|
|
|
|
/// <summary>
|
|
/// 테스트를 위한 목업 모드 활성화 여부를 설정하거나 가져옵니다.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// true로 설정하면 실제 MQTT 요청 대신 MQTTPipeLine를 사용합니다.
|
|
/// 테스트 환경에서 외부 의존성 없이 MQTT 통신을 시뮬레이션할 때 유용합니다.
|
|
/// </remarks>
|
|
public bool UseMockup { get; internal set; } = false;
|
|
|
|
/// <summary>
|
|
/// MQTT 브로커의 도메인 주소
|
|
/// </summary>
|
|
private string domain;
|
|
|
|
/// <summary>
|
|
/// MQTT 브로커의 포트 번호
|
|
/// </summary>
|
|
public int port;
|
|
|
|
private List<string> topics = new List<string>();
|
|
|
|
/// <summary>
|
|
/// 토픽별 파이프라인 정보를 저장하는 딕셔너리
|
|
/// </summary>
|
|
private Dictionary<string, MQTTPipeLineInfo> infoList;
|
|
|
|
/// <summary>
|
|
/// MQTT 통신을 처리하는 서비스 객체
|
|
/// </summary>
|
|
private MQTTService mqtt;
|
|
|
|
private MockMQTTService? mockupMQTT;
|
|
|
|
/// <summary>
|
|
/// MQTTPipeLine 인스턴스를 생성합니다.
|
|
/// </summary>
|
|
/// <param name="domain">MQTT 브로커의 도메인 주소, 기본값은 "localhost"입니다.</param>
|
|
/// <param name="port">MQTT 브로커의 포트 번호, 기본값은 1883입니다.</param>
|
|
public MQTTPipeLine(string domain = "localhost", int port = 1883)
|
|
{
|
|
this.domain = string.IsNullOrEmpty(domain) ? Constants.MQTT_DOMAIN : domain;
|
|
this.port = port;
|
|
mqtt = new MQTTService(this.domain, this.port);
|
|
infoList = new Dictionary<string, MQTTPipeLineInfo>();
|
|
}
|
|
|
|
/// <summary>
|
|
/// 컬렉션에 주제가 없으면 추가합니다.
|
|
/// </summary>
|
|
/// <remarks>이 메서드는 컬렉션에 중복된 주제가 추가되지 않도록 합니다. 지정된 주제가 이미 있으면
|
|
/// 컬렉션은 변경되지 않습니다.</remarks>
|
|
/// <param name="topic">컬렉션에 추가할 주제입니다. null이거나 비어 있을 수 없습니다.</param>
|
|
public void AddTopic(string topic)
|
|
{
|
|
if (!topics.Contains(topic))
|
|
{
|
|
topics.Add(topic);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// 토픽에 대한 파이프라인 정보를 추가합니다.
|
|
/// </summary>
|
|
/// <param name="info">추가할 MQTTPipeLineInfo 객체</param>
|
|
/// <remarks>
|
|
/// 동일한 토픽에 대한 정보가 이미 존재하는 경우 덮어씁니다.
|
|
/// </remarks>
|
|
public void Add(MQTTPipeLineInfo info)
|
|
{
|
|
if (!infoList.ContainsKey(info.Topic))
|
|
{
|
|
infoList.Add(info.Topic, info);
|
|
}
|
|
else
|
|
{
|
|
infoList[info.Topic] = info;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// 지정된 토픽에 대한 파이프라인 정보를 제거합니다.
|
|
/// </summary>
|
|
/// <param name="topic">제거할 토픽 이름</param>
|
|
public void Remove(string topic)
|
|
{
|
|
if (infoList.ContainsKey(topic))
|
|
{
|
|
infoList.Remove(topic);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// 파이프라인을 실행하여 MQTT 브로커에 연결하고 등록된 모든 토픽을 구독합니다.
|
|
/// </summary>
|
|
public void Execute()
|
|
{
|
|
if (!UseMockup)
|
|
{
|
|
foreach (var topic in topics)
|
|
{
|
|
mqtt.AddTopicHandler(topic, OnTopicMessage);
|
|
}
|
|
mqtt.Connect();
|
|
}
|
|
else
|
|
{
|
|
// Mockup 모드인 경우 MockMQTTService를 사용하여 테스트 환경을 설정합니다.
|
|
mockupMQTT = new MockMQTTService();
|
|
foreach (var topic in infoList.Keys)
|
|
{
|
|
mockupMQTT.AddTopicHandler(topic, OnTopicMessage);
|
|
}
|
|
mockupMQTT.Connect();
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// MQTT 토픽으로 메시지가 수신되었을 때 호출되는 콜백 메서드입니다.
|
|
/// </summary>
|
|
/// <param name="topic">수신된 메시지의 토픽</param>
|
|
/// <param name="message">수신된 메시지 내용</param>
|
|
/// <remarks>
|
|
/// 이 메서드는 수신된 메시지의 형식(JSON 객체 또는 배열)에 따라 적절한 파싱을 수행하고,
|
|
/// 등록된 데이터 매퍼를 통해 메시지를 변환한 후, 해당 토픽에 등록된 핸들러에게 전달합니다.
|
|
/// 'UpdatedDataOnly' 설정에 따라 데이터가 변경된 경우에만 핸들러를 호출할 수도 있습니다.
|
|
/// 메시지 처리는 백그라운드 스레드에서 수행되며, 핸들러는 메인 스레드에서 호출됩니다.
|
|
/// </remarks>
|
|
private void OnTopicMessage(string topic, string message)
|
|
{
|
|
// 메시지 처리를 백그라운드 스레드에서 실행하여 메인 스레드 부하를 줄입니다.
|
|
UniTask.RunOnThreadPool(() =>
|
|
{
|
|
if (infoList.ContainsKey(topic))
|
|
{
|
|
MQTTPipeLineInfo info = infoList[topic];
|
|
IDataObject? dataObject = null;
|
|
|
|
message = message.Trim();
|
|
if (!string.IsNullOrEmpty(message))
|
|
{
|
|
try
|
|
{
|
|
if (message.StartsWith("{"))
|
|
{
|
|
JObject source = JObject.Parse(message);
|
|
if (info.Validator != null && !info.Validator.IsValid(source))
|
|
{
|
|
return; // 유효성 검사 실패 시 핸들러 호출을 중단
|
|
}
|
|
if (info.DataMapper != null) dataObject = info.DataMapper.Map(source);
|
|
}
|
|
else if (message.StartsWith("["))
|
|
{
|
|
JArray source = JArray.Parse(message);
|
|
if (info.Validator != null)
|
|
{
|
|
JArray? validSource = info.Validator.GetValidData(source);
|
|
if (validSource != null && validSource.Count > 0)
|
|
{
|
|
// 유효한 데이터가 있는 경우에만 매핑
|
|
if (info.DataMapper != null) dataObject = info.DataMapper.Map(validSource);
|
|
}
|
|
else
|
|
{
|
|
return; // 유효성 검사 실패 시 핸들러 호출을 중단
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if (info.DataMapper != null) dataObject = info.DataMapper.Map(source);
|
|
}
|
|
}
|
|
|
|
if (dataObject != null) dataObject = DataRepository.Instance.AddData(topic, dataObject, info.UpdatedDataOnly);
|
|
|
|
// 핸들러 호출이 필요한지 확인
|
|
bool shouldInvoke = !info.UpdatedDataOnly || (dataObject != null && dataObject.UpdatedCount > 0);
|
|
|
|
if (shouldInvoke)
|
|
{
|
|
// 핸들러를 메인 스레드에서 안전하게 호출
|
|
UniTask.Post(() => info.Handler?.Invoke(dataObject));
|
|
}
|
|
}
|
|
catch (Exception ex)
|
|
{
|
|
// 예외 발생 시 로깅 또는 처리
|
|
// 예외 로깅도 메인 스레드에서 처리하여 Unity API 호출에 대한 스레드 안정성 확보
|
|
UniTask.Post(() => ULog.Error($"Error processing message for topic '{topic}': {ex.Message}", ex));
|
|
}
|
|
}
|
|
}
|
|
}).Forget();
|
|
}
|
|
|
|
/// <summary>
|
|
/// 파이프라인을 중지하고 모든 토픽 구독을 해제한 후 MQTT 브로커와의 연결을 종료합니다.
|
|
/// </summary>
|
|
public void Stop()
|
|
{
|
|
if (!UseMockup)
|
|
{
|
|
foreach (var topic in infoList.Keys)
|
|
{
|
|
mqtt.RemoveTopicHandler(topic, OnTopicMessage);
|
|
}
|
|
mqtt.Disconnect();
|
|
}
|
|
else
|
|
{
|
|
// Mockup 모드인 경우 MockMQTTService를 사용하여 연결을 종료합니다.
|
|
mockupMQTT?.Disconnect();
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// 현재 인스턴스에서 사용되는 모든 리소스를 해제하고 진행 중인 모든 작업을 중지합니다.
|
|
/// </summary>
|
|
/// <remarks>이 메서드는 모든 반복 작업을 중단하고, 내부 상태를 지우고, 관련 리소스를 삭제합니다.
|
|
/// <see cref="Dispose"/>를 호출한 후에는 해당 인스턴스를 더 이상 사용할 수 없습니다.</remarks>
|
|
public void Dispose()
|
|
{
|
|
if (!UseMockup) mqtt.Disconnect();
|
|
else mockupMQTT?.Disconnect();
|
|
infoList.Clear();
|
|
}
|
|
|
|
}
|
|
}
|