XmlSerializer 、String メンバーを Base64 エンコードする
-
05-07-2019 - |
質問
簡単なケースを考えてみましょう
public class Test {
public String myString;
}
myString をシリアル化するときに XmlSerializer に Base64 エンコードするように指示する方法はありますか?
解決
単に byte []
プロパティに設定すると、Base64で自動的にエンコードされます:
public class Test {
public byte[] MyProperty {get;set;}
public void SetMyProperty(string text)
{
MyProperty = System.Text.Encoding.Unicode.GetBytes(text);
}
}
Test test = new Test();
test. SetMyProperty("123456789123456789");
出力:
<MyProperty>MQAyADMANAA1ADYANwA4ADkAMQAyADMANAA1ADYANwA4ADkA</MyProperty>
(ここをデコードしてみてください)
残念ながら、MyPropertyをプライベートにし、 System.Xml.Serialization
でシリアル化する方法(私が知っていること)はありません。
他のヒント
Base64 変換者 バイナリ データを文字列に変換します。文字列内のデータを Base64 エンコードしたい場合は、まずバイト配列にエンコードする必要があります。を使用して Encoding.UTF.GetBytes(myString)
.
これにより、そもそもなぜこれを行う必要があるのかという疑問が生じます。Base 64 を使用する必要がある場合、最初からテキスト データを本当に持っていると確信していますか?
Jon Grantの有用な提案に従って、必要なBase64エンコーディングをカプセル化するBase64String型を実装しました。
public class Base64String: IXmlSerializable
{
private string value;
public Base64String() { }
public Base64String(string value)
{
this.value = value;
}
public string Value
{
get { return value; }
set { this.value = value; }
}
public static implicit operator string(Base64String x)
{
return x.ToString();
}
public static implicit operator Base64String(string x)
{
return new Base64String(x);
}
public override string ToString()
{
return value;
}
#region IXmlSerializable Members
public System.Xml.Schema.XmlSchema GetSchema()
{
return null;
}
public void ReadXml(System.Xml.XmlReader reader)
{
MemoryStream ms = null;
byte[] buffer = new byte[256];
int bytesRead;
while ((bytesRead = reader.ReadElementContentAsBase64(buffer, 0, buffer.Length)) > 0)
{
if (ms == null)
ms = new MemoryStream(bytesRead);
ms.Write(buffer, 0, bytesRead);
}
if (ms != null)
value = System.Text.UnicodeEncoding.Unicode.GetString(ms.ToArray());
}
public void WriteXml(System.Xml.XmlWriter writer)
{
if (!string.IsNullOrEmpty(value))
{
byte[] rawData = Encoding.Unicode.GetBytes(value);
writer.WriteBase64(rawData, 0, rawData.Length);
}
}
static public string EncodeTo64(string toEncode)
{
byte[] toEncodeAsBytes
= System.Text.UnicodeEncoding.Unicode.GetBytes(toEncode);
string returnValue
= System.Convert.ToBase64String(toEncodeAsBytes);
return returnValue;
}
static public string DecodeFrom64(string encodedData)
{
byte[] encodedDataAsBytes
= System.Convert.FromBase64String(encodedData);
string returnValue =
System.Text.UnicodeEncoding.Unicode.GetString(encodedDataAsBytes);
return returnValue;
}
#endregion
}
そして、次のようなタイプを使用できます:
static void Main(string[] args)
{
Foo foo = new Foo();
foo.Field1 = "Pluto";
foo.Field2 = "Pippo";
foo.Field3 = "Topolino";
foo.Field4 = "Paperino";
XmlSerializer ser = new XmlSerializer(typeof(Foo));
ser.Serialize(Console.Out, foo);
Console.ReadLine();
}
[XmlRoot("Sample")]
public class Foo
{
public Foo() { }
[XmlElement("Alfa_64")]
public Base64String Field1;
[XmlElement("Beta")]
public string Field2;
[XmlElement("Gamma_64")]
public Base64String Field3;
[XmlElement("Delta_64")]
public Base64String Field4;
}
文字列をBase64値として保存し、get句でそれをデコードするプロパティを設定します。
XmlSerializer
クラスからの出力を変更する唯一のサポートされている方法は、特別な隠しプロパティなどのようないハックなしで IXmlSerializable
インターフェースを実装することです。
IXmlSerializable
を実装し、エンコードされた文字列を書き出す Base64String
クラスを定義することで、クラス全体のシリアル化コードを記述する必要がなくなります。演算子を定義して、暗黙的にキャスト可能にする文字列であり、通常の文字列とほとんど同じように機能します。