カスタムシリアル化/逆シリアル化を使用したサービススタックサービスの単体テスト
-
12-12-2019 - |
質問
独自の逆シリアル化メカニズムが提供されている Web サービスのテストに問題があります。
私のサンプル Task
によって使用されているクラス TaskService
:
public class Task
{
public string TaskName { get; set; }
public string AuxData { get; set; }
public static void RegisterCustomSerialization(IAppHost appHost)
{
appHost.ContentTypeFilters.Register("application/xml", SerializeTaskToStream, DeserializeTaskFromStream);
}
public static void SerializeTaskToStream(IRequestContext requestContext, object response, Stream stream)
{
var tasks = response as List<Task>;
if (tasks != null)
{
using (var sw = new StreamWriter(stream))
{
if (tasks.Count == 0)
{
sw.WriteLine("<Tasks/>");
return;
}
sw.WriteLine("<Tasks>");
foreach (Task task in tasks)
{
if (task != null)
{
sw.WriteLine(" <Task type=\"new serializer\">");
sw.Write(" <TaskName>");
sw.Write(task.TaskName);
sw.WriteLine("</TaskName>");
sw.Write(" <AuxData>");
sw.Write(task.AuxData);
sw.WriteLine("</AuxData>");
sw.WriteLine(" </Task>");
}
}
sw.WriteLine("</Tasks>");
}
}
else
{
var task = response as Task;
using (var sw = new StreamWriter(stream))
{
if (task != null)
{
sw.WriteLine(" <Task type=\"new serializer\">");
sw.Write(" <TaskName>");
sw.Write(task.TaskName);
sw.WriteLine("</TaskName>");
sw.Write(" <AuxData>");
sw.Write(task.AuxData);
sw.WriteLine("</AuxData>");
sw.WriteLine(" </Task>");
}
}
}
}
public static object DeserializeTaskFromStream(Type type, Stream stream)
{
if (stream == null || stream.Length == 0)
return null; // should throw exception?
XDocument xdoc = XDocument.Load(stream);
XElement auxData = xdoc.Root.Element("AuxData");
return new Task() { AuxData = auxData.Value };
}
public override bool Equals(object obj)
{
Task task = obj as Task;
if (task == null)
return false;
return TaskName.Equals(task.TaskName);
}
public override int GetHashCode()
{
return TaskName.GetHashCode();
}
}
私のシリアル化/逆シリアル化コードは次のものに基づいています。 http://www.servicestack.net/ServiceStack.Northwind/vcard-format.htm そして https://github.com/ServiceStack/ServiceStack.Examples/blob/master/src/ServiceStack.Northwind/ServiceStack.Northwind.ServiceInterface/VCardFormat.cs
私の基本テストクラスは次のとおりです。
public class SimpleRestTestBase : AppHostBase
{
public SimpleRestTestBase() : base( "SimpleRestTestBase", typeof(TaskService).Assembly)
{
Instance = null;
Init();
}
public override void Configure(Funq.Container container)
{
SetConfig(new EndpointHostConfig
{
DefaultContentType = ContentType.Xml
}
);
Task.RegisterCustomSerialization(this);
Routes
.Add<Task>("/tasks/{TaskName}")
.Add<List<Task>>("/tasks");
container.Register(new List<Task>());
}
}
そして失敗した単体テスト:
[TestFixture]
public class SimpleTest : SimpleRestTestBase
{
[Test]
public void TestMetodRequiringServer()
{
var client = (IRestClient)new XmlServiceClient("http://localhost:53967");
var data = client.Get<List<Task>>("/api/tasks");
}
}
nUnit テスト ランナーを使用するときに発生する例外は次のとおりです。
Testing.SimpleTest.TestMetodRequiringServer:
System.Runtime.Serialization.SerializationException : Error in line 1 position 9. Expecting element 'ArrayOfTask' from namespace 'http://schemas.datacontract.org/2004/07/ServiceStackMVC'.. Encountered 'Element' with name 'Tasks', namespace ''.
カスタムのシリアル化/非シール化コードに関する情報を XmlServiceClient
?
解決
汎用の XML シリアル化形式 (application/xml) を、1 つの Web サービス出力のみを処理するように強力に結合されたカスタム バージョンでオーバーライドしています。Break) 他のすべてのサービスが XML を返さないようにします。カスタム XML を返したい場合は、代わりに XML 文字列を返すことで、それを必要とするサービスに限定します。
XmlServiceClient の実装は、ServiceStack が使用する XML シリアル化/逆シリアル化と強く結合されているため、変更できません。必要な正確な XML ペイロードを送信するには、生の HTTP クライアントを使用する必要があります。以下は、.NET の Web リクエストを使用して生の XML を送信する例です。https://stackoverflow.com/a/8046734/85785
カスタム XML を返したり送信したりしているため、Web サービスのカスタム リクエスト バインダーをオーバーライドして、リクエストを希望どおりに逆シリアル化できるようにすることもできます。
これを行う方法の例については、以下の Wiki ページを参照してください。
https://github.com/ServiceStack/ServiceStack/wiki/Serialization-deserialization
注記:カスタム XML を返すことは、ServiceStack の強力な型指定、インテリジェントで独自の意見を持つ性質の利点の多くを無視するため、理想的ではありません。