C#中使用XML——編寫XML

2024-09-05 20:55:46

字體：大中小

來源：轉載

供稿：網友

商業源碼熱門下載www.html.org.cn

在我的上一篇文章《c#中使用xml——讀取xml》中和大家討論了如何使用.net framework中提供的類在c#中讀取xml以及讀取的一些相關概念，那么今天就說一說如何在c#中編寫xml文檔，起初我覺得用編程的方式去編寫xml簡直就是自討苦吃，后來想想還是覺得挺有用的，我想microsoft那班家伙能編出這些類來應該不是僅僅為了向比爾i蓋茨交差吧！至于它的用處嘛……比如說做安裝程序啊！我們可以根據在安裝過程中用戶所選的選項以及一些設置來生成相應的xml文檔再根據xml文檔來初始化我們的應用程序。空洞的話不說那么多了，下面我們來了解一下具體的實現細節。
要編寫xml同樣是采用流的概念，在.net中編寫xml的細節是作為xmlwriter類來實現的，但該類是抽象類不能夠實例化，為此，我們要想在程序中訪問它的方法以實現編寫xml的愿望，必需使用它的派生類xmltextwriter，該類提供了一系列的屬性和方法為我們編寫xml做準備，下面將詳細的介紹這個類：

構造函數：

public xmltextwriter(textwriter);

public xmltextwriter(stream, encoding);

public xmltextwriter(string, encoding);

第一個構造函數是把現有的textwriter實例傳遞過去，system.io.textwriter類是一個有序的字符流

第二個構造函數是把要寫入的流作為第一個參數，第二個參數是指定xml文檔的編碼方式，默認是utf8，可取encoding的枚舉值，流可以是filestream，memorystream，networkstream等等

第三個構造函數是把希望寫入的文件名當作一個字符串（如果存在，就重寫該文件）傳遞給第一個參數，第二個參數指定編碼方式

常用的方法：

writerstartdocument()和writerenddocument()方法：

第一個方法用來編寫xml聲明部分，如：<?xml version=”1.0” encoding=”utf-8” ?>

第二個方法用來關閉任何打開的元素或屬性并將編寫器重新設置為 start 狀態。

writerstartelement()和writeendelement()方法：

第一個方法用來寫出指定的開始標記，該方法有以下幾個重載：

writerstartelement(string localname)

使用傳遞的字符串作為元素的本地名稱

writerstartelement(string localname,string namespace)

第一個參數指定元素的本地名稱，第二個參數指定元素所在的命名空間

writerstartelement(string prefix,string localname,string namespace)

第一個參數指定元素的前綴，第二個參數指定元素的本地名稱，第三個參數指定元素所在的命名空間

第二個方法用來寫出與開始元素對應的關閉元素，如果開始元素不包含任何內容，將用一個”/>”做為關閉元素

writerstartattribute()和writerendattribute()方法：

第一個方法用于編寫一個屬性的開頭，該方法有兩個重載：

writerstartattribute(string localname,string namespace)

第一個參數指定屬性的本地名稱，第二個參數指定屬性所在的命名空間

writerstartattribute(string prefix,string localname,string namespace)

第一個參數指定屬性的前綴，第二個參數指定屬性的本地名稱，第三個參數指定屬性所在的命名空間

第二個方法用于關閉writerstartattribute創建的屬性

writerelementstring()方法：

該方法可以創建一個包含字符串值的元素，它有以下重載：

writerelementstring(string localname,string value)

如果編寫這樣的代碼：writerelementstring(“para”,”some text”) 將輸出：<para>some text</para>

writerelementstring(string localname,string namespace,string value)

如果編寫這樣的代碼：writerelementstring(“para”,”http://www.w3.org/ns”,”some text”) 將輸出：<para xmlns=”http://www.w3.org/ns”>some text</para>

如果編寫嵌套幾級的元素可使用writerstartelement()和writerendelement()方法，如果編寫直接包含內容的元素可以使用該方法

writerattributestring()方法：

類似與writerelementstring()方法，在使用上如果屬性的值當中不包含實體可直接使用該方法來寫出屬性，如果屬性值包含實體可使用writerstartattribute()和writerendattribute()方法，例如要寫出這樣的xml——<para author=”do&0241;a&l.perez”/>,可編寫以下代碼：

writerstartelement(“para”);

writerstartattribute(“author”,null);

writerstring(“do”);

writercharentiry(“~n”);

writerstring(“a”);

writercharentiry(“&”);

writerstring(“l.perez”);

writerendattribute();

writerendelement();

該方法有以下重載：

writerattributestring(string localname,string value);

writerattributestring(string localname,string namespace,string value);

writerattributestring(string prefx, string localname,string namespace,string value);

writernode(xmlreader reader,bool defattr)方法：

該方法可以從xmlreader讀取器中復制節點并把它們寫入xmlwriter流中，第一個參數是xmlreader的實例，第二個參數接受一個布爾值，決定是否復制元素中的屬性，考慮下面xml片段：

<para>

<sent>

the<b>xmlwriter</b>class writes xml content to a stream.

</sent>

</para>

以下代碼復制其中的片段，reader代表xmlreader的實例writer代表xmlwriter類的實例：

while(reader.read())

{

if (reader.name == ”sent” && reader.nodetype == xmlnodetype.element)

{

writer.writernode(reader,true);

}

}

得到以下輸出：

<sent>

the<b>xmlwriter</b>class writes xml content to a stream.

</sent>

writercomment(string text)方法：用于寫出注釋

writerstring(string text)方法：用于寫出文本

writercdata(string text)方法：寫出cdata數據塊

writerbase64(byte[] buffer,int index,int count)方法：將指定的二進制字節編碼為 base64 并寫出結果文本

flush()：將緩沖區中的所有內容刷新到基礎流，并同時刷新基礎流

close()：關閉此流和基礎流

以上對xmltextwriter類的一些重要方法做了簡單介紹，下面我們就來看一個例程，看看在程序中如何使用這些方法，照樣還是先來看下運行效果圖：

example1按紐將向一個文件寫出xml聲明和一個元素節點以及節點內的文本，example2按紐將在example1的基礎上添加屬性節點，嵌套元素以及文本，writenode按紐使用writernode()方法在現有讀取器中復制該讀取器中的所有元素及屬性并寫到一個新的xml文檔中，example3按紐將寫一份完整的xml文檔，example4按紐在example3按紐的基礎上另外生成一份文檔并向該文檔中追加cdata部分，example5按紐將使用writerbase64()方法對一幅圖片進行編碼并將編碼后的數據寫到xml文檔中，example6按紐將使用example5按紐中生成的xml讀取其中數據并對其中編碼數據進行解碼最后生成一張圖片。

以下是功能實現代碼：

namespace xmlwriting

{

using system;

using system.io;

using system.text;

using system.xml;

using system.drawing;

using system.collections;

using system.componentmodel;

using system.windows.forms;

using system.data;

/// <summary>

/// form1 的摘要說明。

/// </summary>

public class form1 : system.windows.forms.form

{

private system.windows.forms.textbox textbox1;

private system.windows.forms.button button1;

private system.windows.forms.button button2;

private system.windows.forms.button button3;

private system.windows.forms.button button4;

private system.windows.forms.button button5;

private system.windows.forms.button button6;

private system.windows.forms.button button7;

/// <summary>

/// 必需的設計器變量。

/// </summary>

private system.componentmodel.container components = null;

public form1()

{

//

// windows 窗體設計器支持所必需的

//

initializecomponent();

//

// todo: 在 initializecomponent 調用后添加任何構造函數代碼

//

}

/// <summary>

/// 清理所有正在使用的資源。

/// </summary>

protected override void dispose( bool disposing )

{

if( disposing )

{

if (components != null)

{

components.dispose();

}

}

base.dispose( disposing );

}

#region windows 窗體設計器生成的代碼

/// <summary>

/// 設計器支持所需的方法 - 不要使用代碼編輯器修改

/// 此方法的內容。

/// </summary>

private void initializecomponent()

{

this.textbox1 = new system.windows.forms.textbox();

this.button1 = new system.windows.forms.button();

this.button2 = new system.windows.forms.button();

this.button3 = new system.windows.forms.button();

this.button4 = new system.windows.forms.button();

this.button5 = new system.windows.forms.button();

this.button6 = new system.windows.forms.button();

this.button7 = new system.windows.forms.button();

this.suspendlayout();

//

// textbox1

//

this.textbox1.anchor = ((system.windows.forms.anchorstyles)((((system.windows.forms.anchorstyles.top | system.windows.forms.anchorstyles.bottom)

| system.windows.forms.anchorstyles.left)

| system.windows.forms.anchorstyles.right)));

this.textbox1.location = new system.drawing.point(0, 8);

this.textbox1.multiline = true;

this.textbox1.name = "textbox1";

this.textbox1.scrollbars = system.windows.forms.scrollbars.both;

this.textbox1.size = new system.drawing.size(784, 332);

this.textbox1.tabindex = 0;

this.textbox1.text = "";

//

// button1

//

this.button1.anchor = ((system.windows.forms.anchorstyles)((system.windows.forms.anchorstyles.bottom | system.windows.forms.anchorstyles.left)));

this.button1.location = new system.drawing.point(0, 344);

this.button1.name = "button1";

this.button1.tabindex = 1;

this.button1.text = "example1";

this.button1.click += new system.eventhandler(this.button1_click);

//

// button2

//

this.button2.anchor = ((system.windows.forms.anchorstyles)((system.windows.forms.anchorstyles.bottom | system.windows.forms.anchorstyles.left)));

this.button2.location = new system.drawing.point(88, 344);

this.button2.name = "button2";

this.button2.tabindex = 2;

this.button2.text = "example2";

this.button2.click += new system.eventhandler(this.button2_click);

//

// button3

//

this.button3.anchor = ((system.windows.forms.anchorstyles)((system.windows.forms.anchorstyles.bottom | system.windows.forms.anchorstyles.left)));

this.button3.location = new system.drawing.point(176, 344);

this.button3.name = "button3";

this.button3.tabindex = 3;

this.button3.text = "writenode";

this.button3.click += new system.eventhandler(this.button3_click);

//

// button4

//

this.button4.anchor = ((system.windows.forms.anchorstyles)((system.windows.forms.anchorstyles.bottom | system.windows.forms.anchorstyles.left)));

this.button4.location = new system.drawing.point(264, 344);

this.button4.name = "button4";

this.button4.tabindex = 4;

this.button4.text = "example3";

this.button4.click += new system.eventhandler(this.button4_click);

//

// button5

//

this.button5.location = new system.drawing.point(352, 344);

this.button5.name = "button5";

this.button5.tabindex = 5;

this.button5.text = "example4";

this.button5.click += new system.eventhandler(this.button5_click);

//

// button6

//

this.button6.location = new system.drawing.point(440, 344);

this.button6.name = "button6";

this.button6.tabindex = 6;

this.button6.text = "example5";

this.button6.click += new system.eventhandler(this.button6_click);

//

// button7

//

this.button7.location = new system.drawing.point(528, 344);

this.button7.name = "button7";

this.button7.tabindex = 7;

this.button7.text = "example6";

this.button7.click += new system.eventhandler(this.button7_click);

//

// form1

//

this.autoscalebasesize = new system.drawing.size(6, 14);

this.clientsize = new system.drawing.size(784, 373);

this.controls.add(this.button7);

this.controls.add(this.button6);

this.controls.add(this.button5);

this.controls.add(this.button4);

this.controls.add(this.button3);

this.controls.add(this.button2);

this.controls.add(this.button1);

this.controls.add(this.textbox1);

this.name = "form1";

this.text = "xmlwriting";

this.resumelayout(false);

}

#endregion

/// <summary>

/// 應用程序的主入口點。

/// </summary>

[stathread]

static void main()

{

application.run(new form1());

}

private void button1_click(object sender, system.eventargs e)

{

this.textbox1.text = string.empty;

const string filename = "writexml.xml";

xmltextwriter xmltxtwt = new xmltextwriter(filename,encoding.utf8);

// 寫xml文檔聲明

xmltxtwt.writestartdocument();

// 寫xml起始元素

xmltxtwt.writestartelement("ct","contactdetails","http://www.deltabis.com/contact");

// 寫文本

xmltxtwt.writestring("this is a xml file");

// 寫xml結束元素

xmltxtwt.writeendelement();

// 寫關閉文檔元素

xmltxtwt.writeenddocument();

xmltxtwt.flush(); //刷新

xmltxtwt.close();

this.textbox1.text = readxml(filename);

}

/// <summary>

/// 讀取經過編寫的xml文件的所有內容

/// </summary>

/// <param name="xmlpath">文件路徑</param>

/// <returns>表示內容的字符串</returns>

private string readxml(string xmlpath)

{

string xmlstr = string.empty;

xmltextreader xmltxtrd = new xmltextreader(xmlpath);

xmltxtrd.movetocontent();

xmlstr = xmltxtrd.readouterxml();

xmltxtrd.close();

return xmlstr;

}

private void button2_click(object sender, system.eventargs e)

{

this.textbox1.text = string.empty;

const string filename = "writexml1.xml";

xmltextwriter xmltxtwt = new xmltextwriter(filename,encoding.utf8);

// 設置xml的輸出格式，這里使用縮進

xmltxtwt.formatting = formatting.indented;

// 設置縮進的數量，這里是4個空格，indentchar屬性默認是空格

xmltxtwt.indentation = 4;

xmltxtwt.writestartdocument();

xmltxtwt.writestartelement("ct","contactdetails","http://www.deltabis.com/contact");

xmltxtwt.writeattributestring("date","20050121 14:00");

xmltxtwt.writeelementstring("contact","abcd");

xmltxtwt.writeelementstring("contact","efgh");

xmltxtwt.writeelementstring("contact","ijkl");

xmltxtwt.writeelementstring("contact","mnop");

xmltxtwt.writeendelement();

xmltxtwt.writeenddocument();

xmltxtwt.flush();

xmltxtwt.close();

this.textbox1.text = readxml(filename);

}

// 從讀取器中復制節點及其內容

private void button3_click(object sender, system.eventargs e)

{

xmltextreader xmltxtrd = new xmltextreader("唐詩.xml");

xmltextwriter xmltxtwt = new xmltextwriter("writexml2.xml",encoding.utf8);

xmltxtwt.formatting = formatting.indented;

xmltxtwt.indentation = 4;

xmltxtwt.writestartdocument();

xmltxtwt.writecomment("以下是從讀取器中拷貝的節點");

try

{

while(xmltxtrd.read())

{

if (xmltxtrd.nodetype == xmlnodetype.element)

xmltxtwt.writenode(xmltxtrd,true);

}

}

catch(exception exp)

{

messagebox.show(exp.tostring());

}

finally

{

xmltxtwt.flush();

xmltxtwt.close();

xmltxtrd.close();

}

this.textbox1.text = readxml("writexml2.xml");

}

// 編寫一份完整的xml

private void button4_click(object sender, system.eventargs e)

{

this.textbox1.text = string.empty;

string filename = "writexml3.xml";

xmltextwriter xmltxtwt = new xmltextwriter(filename,encoding.utf8);

xmltxtwt.formatting = formatting.indented;

xmltxtwt.indentation = 4;

xmltxtwt.writestartdocument();

xmltxtwt.writestartelement("ct","contactdetails","http://www.deltabis.com/contact");

xmltxtwt.writeattributestring("date","20050121 16:00");

xmltxtwt.writecomment("this document contains contact information.");

xmltxtwt.writestartelement("contact");

xmltxtwt.writeattributestring("title",string.empty);

xmltxtwt.writestartelement("name");

xmltxtwt.writeelementstring("firstname","steven");

xmltxtwt.writeelementstring("middle",string.empty);

xmltxtwt.writeelementstring("lastname","livingstone-perez");

xmltxtwt.writefullendelement();

xmltxtwt.writefullendelement();

xmltxtwt.writefullendelement();

xmltxtwt.writeenddocument();

xmltxtwt.flush();

xmltxtwt.close();

this.textbox1.text = readxml(filename);

}

// 添加cdata數據塊

private void button5_click(object sender, system.eventargs e)

{

this.textbox1.text = string.empty;

string filename = "writexml4.xml";

xmltextwriter xmltxtwt = new xmltextwriter(filename,encoding.utf8);

xmltxtwt.formatting = formatting.indented;

xmltxtwt.indentation = 4;

xmltxtwt.writestartdocument();

xmltxtwt.writestartelement("ct","contactdetails","http://www.deltabis.com/contact");

xmltxtwt.writeattributestring("date","20050121 16:00");

xmltxtwt.writecomment("this document contains contact information.");

xmltxtwt.writestartelement("contact");

xmltxtwt.writeattributestring("title",string.empty);

xmltxtwt.writestartelement("name");

xmltxtwt.writeelementstring("firstname","steven");

xmltxtwt.writeelementstring("middle",string.empty);

xmltxtwt.writeelementstring("lastname","livingstone-perez");

xmltxtwt.writefullendelement();

xmltxtwt.writestartelement("notes","http://www.deltabis.com/contact"); // 該節點的命名空間與上面一樣，該節點將使用上面的前綴

xmltxtwt.writecdata("<securityalogrithm>88hshshhhdd8*^&@^*^#*&!%~~~(ghj*(**&%^){}^(*&7*(9$%###$@!");

xmltxtwt.writeendelement();

xmltxtwt.writefullendelement();

xmltxtwt.writefullendelement();

xmltxtwt.writeenddocument();

xmltxtwt.flush();

xmltxtwt.close();

this.textbox1.text = readxml(filename);

}

// 對圖片進行編碼，并寫出

private void button6_click(object sender, system.eventargs e)

{

int readbyte = 0;

int bytestoread = 100;

string filename = "writexml5.xml";

this.textbox1.text = string.empty;

// 打開圖片文件，利用該圖片構造一個文件流

filestream fs = new filestream(@"d:/03.jpg",filemode.open);

// 使用文件流構造一個二進制讀取器將基元數據讀作二進制值

binaryreader br = new binaryreader(fs);

xmltextwriter xmltxtwt = new xmltextwriter(filename,encoding.utf8);

xmltxtwt.formatting = formatting.indented;

xmltxtwt.indentation = 4;

xmltxtwt.writestartdocument();

xmltxtwt.writestartelement("ct","contactdetails","http://www.deltabis.com/contact");

xmltxtwt.writestartelement("image");

xmltxtwt.writeattributestring("imagename","03.jpg");

byte[] base64buffer = new byte[bytestoread];

do

{

readbyte = br.read(base64buffer,0,bytestoread); //將數據讀入字節數組

xmltxtwt.writebase64(base64buffer,0,readbyte); //將數組中二進制值編碼為base64并寫出到xml文件

}while(bytestoread <= readbyte);

xmltxtwt.writeendelement();

xmltxtwt.writeendelement();

xmltxtwt.writeenddocument();

xmltxtwt.flush();

xmltxtwt.close();

this.textbox1.text = readxml(filename);

}

// 解碼并生成圖片

private void button7_click(object sender, system.eventargs e)

{

int readbyte = 0;

int bytestoread = 100;

xmltextreader xmltxtrd = new xmltextreader("writexml5.xml");

filestream fs = new filestream("newimage.jpg",filemode.create);

binarywriter bw = new binarywriter(fs);

byte[] base64buffer = new byte[bytestoread];

while(xmltxtrd.read())

{

if (xmltxtrd.nodetype == xmlnodetype.element && xmltxtrd.name == "image")

{

do

{

readbyte = xmltxtrd.readbase64(base64buffer,0,bytestoread);

bw.write(base64buffer,0,readbyte);

}while(readbyte <= bytestoread);

}

}

bw.flush();

bw.close();

fs.close();

xmltxtrd.close();

}

}

}

以下是在writenode按紐中要使用到的xml文件：

唐詩.xml

<?xml version="1.0" encoding="gb2312"?>

<唐詩>

<五言絕句>

<作者字號="太白">李白</作者>

<標題>靜夜思</標題>

<內容>床前明月光，疑是地上霜。舉頭望明月，低頭思故鄉。</內容>

</五言絕句>

<五言絕句>

<作者字號="太白">李太白</作者>

<標題>春曉</標題>

<內容>春眠不覺曉，處處聞啼鳥。夜來風雨聲，花落知多少。</內容>

</五言絕句>

<五言絕句>

<作者字號="季凌">王之渙</作者>

<標題>登鶴雀樓</標題>

<內容>白日依山盡，黃河入海流。欲窮千里目，更上一層樓</內容>

</五言絕句>

<五言絕句>

<作者>李清照</作者>

<標題>如夢令</標題>

<內容>昨夜風疏雨驟，濃睡不消殘酒，試問卷簾人，卻道海棠依舊，知否，知否，應是綠肥紅瘦。</內容>

</五言絕句>

</唐詩>

上一篇：在C#中使用XML指南之讀取XML

下一篇：C#中使用XML——基于DOM的案例分析