// Stream MS HelpManual: https://learn.microsoft.com/zh-cn/dotnet/api/system.io.stream?view=net-8.0 // FileStream 官方手冊: https://learn.microsoft.com/zh ...
// Stream MS HelpManual: https://learn.microsoft.com/zh-cn/dotnet/api/system.io.stream?view=net-8.0
// FileStream 官方手冊: https://learn.microsoft.com/zh-cn/dotnet/api/system.io.filestream?view=net-8.0
// StreamWriter: https://learn.microsoft.com/zh-cn/dotnet/api/system.io.streamwriter?view=net-8.0
// StreamRead: https://learn.microsoft.com/zh-cn/dotnet/api/system.io.streamreader?view=net-8.0
/* 關於FileStream的概念
* FileSrteam 為文件提供 Stream，既支持同步讀寫操作，也支持非同步讀寫操作。
* 而Stream 是所有流的抽象基類也是FileStream的父類。 流是位元組序列的抽象，例如文件、輸入/輸出設備、進程中通信管道或 TCP/IP 套接字。 類 Stream 及其派生類提供這些不同類型的輸入和輸出的通用視圖，並將程式員與操作系統和基礎設備的特定詳細信息隔離開來。
* 流涉及三個基本操作：
* 1. 可以從流中讀取數據。 讀取是將數據從流傳輸到數據結構中，例如位元組數組。
* 2. 可以寫入流。 寫入是將數據從數據結構傳輸到流中。
* 3. 流可以支持查找。 查找是指查詢和修改流中的當前位置。 搜尋功能取決於流具有的後備存儲類型。 例如，網路流沒有當前位置的統一概念，因此通常不支持查找。
*
* 要理解一點, FileStream 類處理的是流, 什麼是流? 它是一種對設備抽象出來的對象, 能夠讀取和寫入這個對象的類型僅能是byte(位元組)類型.
* 電腦的所有信息(對象)都是二進位, 而二進位是位元組類型, 所以只要電腦能夠訪問就能夠用Stream來表達;
* FileStream 是一種線性的狀態,必需要開始和結束, 就像一跟線有頭和尾中間不能斷. 主要就是它有一套 打開>操作>關閉 的流程,
* 需要使用using關鍵字來調用和結束資源. 因為FileStream操作完之後必需關閉流, 以防止操作系統句柄到處亂放導致記憶體泄漏風險的發生;
*/
/* using 資源釋放
* using 除了導入名稱空間和別名空間名, 還有的作用就是定義資源調用.
*
* using可以算是.NET中新的語法元素，它清楚地說明一個通常比較占用資源的對象何時開始使用和何時被手動釋放。
* 當using可以被使用時，建議儘量使用using語句。至今為止，使用using語句發現它帶給程式員的只有優點，而沒有任何弊端。
* 在.NET的環境中，托管的資源都將由.NET的垃圾回收機制來釋放，而一些非托管的資源則需要程式員手動地將它們釋放。
* .NET提供了主動和被動兩種釋放非托管資源的方式，即IDisposable介面的Dispose方法和類型自己的Finalize方法。
* 任何帶有非托管資源的類型，都有必要實現IDisposable的Dispose方法，並且在使用完這些類型後需要手動地調用對象的Dispose方法來釋放對象中的非托管資源。
*
* using語句的作用就是提供了一個高效的調用對象Dispose方法的方式。
* 對於任何IDisposable介面的類型，都可以使用using語句，而對於那些沒有實現IDisposable介面的類型，使用using語句會導致一個編譯錯誤。
*
* using語句為實現了IDisposable的類型對象調用Dispose方法，using語句能夠保證使用的對象的Dispose方法在using語句塊結束時被調用，無論是否有異常被拋出。
* C#編譯器在編譯時自動為using語句加上try/finally塊，所以using的本質和異常捕獲語句一樣，但是語法更為簡潔。所有using使用的對象都應該在using語句開始後再初始化，以保證所有的對象都能夠被Dispose。
*
*經常會和 Stream 類使用在一塊
* 參考鏈接: https://www.cnblogs.com/dotnet261010/p/12329706.html
*/
using System.Text;
using System.Diagnostics;
using System.Xml.Linq;
namespace ConsoleApp_Stream
{
internal class Program
{
static void Main(string[] args)
{
// FileStream_read(); // FileStream 讀取文件
// FileStream_write(); // FileStream 寫入文件
// StreamWrite_Example(); // StreamWriter 快速寫入文件
// StreamRead_Example(); // StreamReader 快速寫入文件
}
static void FileStream_read() // FileStream 讀取文件
{
string path = "d:/1.txt"; // 指定一個文件
FileInfo fileInfo = new FileInfo(path);
Console.WriteLine(fileInfo.Length);
// 為打開文件設定合適的數據空間, 才能夠完整讀入
byte[] byte_write = new byte[fileInfo.Length];
char[] char_write = new char[fileInfo.Length];
// 由於打開文件經常引發錯誤, 必要使用try來嵌套.
try
{
using (FileStream fileStream = new FileStream(path, FileMode.Open)) // 需要使用兩個關鍵參數, 一個是指定文件, 第二個是調用文件的方式, 文件的存在或不存在會影響調用結果. 查看具體說明: https://learn.microsoft.com/zh-cn/dotnet/api/system.io.filemode?view=net-8.0
{
fileStream.Seek(0, SeekOrigin.Begin); // 流有一個指針, 指定文件的位置(記憶體的位置). 所以需要讀取或寫入之前指定指針的位置, 使用Seek方法來修改指針位置,
// 有兩個參數, 一: byte(位元組)類型, 從0起始, 如果使用-5則是從尾部倒數; 二: SeekOrigin指定開始計算的起始位置, 有三個枚舉參數:Begin(開始) Current(最近) End(結束)
// 若沒有指定Seek方法, 預設會從0開始,使用Begin;
/* Seek 方法說明:
// 將該流的當前位置設置為給定值。
//
// 參數:
// offset:
// 相對於 origin 的點，從此處開始查找。
//
// origin:
// 使用 System.IO.SeekOrigin 類型的值，將開始位置、結束位置或當前位置指定為 offset 的參考點。
//
// 返回結果:
// 流中的新位置。*/
fileStream.Read(byte_write,0,Convert.ToInt32(fileInfo.Length)); // 以byte格式讀取文件數據存入byte_write[]中; 該方法最後一個參數 最大隻能返回一個Int32位的範圍的數(該數表示文件的大小, 單位b), 所以對於大文件會導致數據丟失(丟失頭部分).
/* Read 方法說明:
// 從流中讀取位元組塊並將該數據寫入給定緩衝區中。
//
// 參數:
// array:
// 當此方法返回時，包含指定的位元組數組，此數組中 offset 和 (offset + count - 1) 之間的值被從當前源中讀取的位元組所替換。
//
// offset:
// array 中的位元組偏移量，將在此處放置讀取的位元組。
//
// count:
// 最多讀取的位元組數, int類型 32位。
//
// 返回結果:
// 讀入緩衝區中的總位元組數。 如果位元組數當前不可用，則總位元組數可能小於所請求的位元組數；如果已到達流結尾，則為零。*/
}
}
catch
{
Console.WriteLine("Error!");
return;
}
Decoder read = Encoding.UTF8.GetDecoder(); // Decoder是System.Text命名空間的類; 很明顯需要轉換將byte轉換為char數組, 並指定其編碼方式.
read.GetChars(byte_write, 0, byte_write.Length, char_write, 0); // 轉換數據; 共五個參數, 前三個為轉換前的 byte[]類型, 後兩個為轉換後的char[]類型
/* GetChars 方法說明:
// 在派生類中重寫時，將指定位元組數組的位元組序列和內部緩衝區中的任何位元組解碼到指定的字元數組。
//
// 參數:
// bytes:
// 包含要解碼的位元組序列的位元組數組。
//
// byteIndex:
// 第一個要解碼的位元組的索引。
//
// byteCount:
// 要解碼的位元組數。
//
// chars:
// 要用於包含所產生的字元集的字元數組。
//
// charIndex:
// 開始寫入所產生的字元集的索引位置。
//
// 返回結果:
// 寫入 chars 的實際字元數。*/
Console.WriteLine(char_write); // 列印輸出
Console.ReadKey();
/* 總結
* 1. [新建儲存變數]
* 該方法需要定義兩個數組, byte數組類型讀取數據, char數組類型存放數據;
* 2. [創建FileStream(流)讀取對象]
* 使用FileStream創建流對象, 在該對象內指定Seek(可選), 使用Read方法讀取文件並以byte[]格式存入.
* 3. [轉換數據]
* 有了byte[]數據後需要轉換該數據為char格式, 使用System.Text空間的Decoder類來轉換數據, 註意,生成該對象是直接指定轉換的文件格式;
* 然後使用decoder對象GetChars方法來轉換, 共五個參數, 前三個為轉換前的 byte[]類型, 後兩個為轉換後的char[]類型;
*
* 總結下來就是FileStream對流的處理過程確實比較麻煩, 但其核心就是讀取文件的byte(位元組)到byte[], 以便下一步的操作.
*/
}
static void FileStream_write() // FileStream 寫入文件
{
string path = "d:/2.txt"; // 指定一個文件
// 這裡可以自定義char, 或可以讀取其他文件.
string str = "紫怡偏殿，一般都是失寵的王妃居住的地方，十分偏僻，滿地落葉，似乎已經很久沒有人居住。";
char[] char_write = str.ToCharArray(); // 將string 轉換為 char
Encoder encoder = Encoding.UTF8.GetEncoder();
// byte[] 大小空間因該由轉換char[]來分配大小;
byte[] byte_write = new byte[encoder.GetByteCount(char_write,true)]; // 因為byte_write沒有設定固定範圍, 所以在這裡需要設定一個以char_write來指定的範圍值. 在這裡最後一個參數flush相當於對象緩存, 如未必要true可釋放記憶體並清除, 相當於GC
/* GetByteCount 方法說明:
// 在派生類中重寫時，計算對“字元”範圍中的一組字元進行編碼所產生的位元組數。 一個參數指示計算後是否要清除編碼器的內部狀態。
//
// 參數:
// chars:
// 要編碼的字元範圍。
//
// flush:
// 若要在計算後模擬清除解碼器的內部狀態，則為 true；否則為 false。
//
// 返回結果:
// 通過對指定字元和內部緩衝區中的所有字元進行編碼而產生的位元組數。*/
encoder.GetBytes(char_write, 0, char_write.Length, byte_write, 0, true); // 可以理解為將char[]轉為byte[]類型. 在這裡最後一個參數flush相當於對象緩存, 如未必要true可釋放記憶體並清除, 相當於GC
/* GetBytes 方法說明:
// 在派生類中重寫時，將指定字元數組中的一組字元和內部緩衝區中的任何字元編碼到指定的位元組數組中。 一個參數指示轉換後是否清除編碼器的內部狀態。
//
// 參數:
// chars:
// 包含要編碼的字元集的字元數組。
//
// charIndex:
// 第一個要編碼的字元的索引。
//
// charCount:
// 要編碼的字元的數目。
//
// bytes:
// 要包含所產生的位元組序列的位元組數組。
//
// byteIndex:
// 要開始寫入所產生的位元組序列的索引位置。
//
// flush:
// 如果要在轉換後清除編碼器的內部狀態，則為 true；否則為 false。
//
// 返回結果:
// 寫入 bytes 的實際位元組數。*/
// 由於打開文件經常引發錯誤, 必要使用try來嵌套.
try
{
using (FileStream fileStream = new FileStream(path, FileMode.Create)) // 需要使用兩個關鍵參數, 一個是指定文件, 第二個是調用文件的方式, 文件的存在或不存在會影響調用結果. 查看具體說明: https://learn.microsoft.com/zh-cn/dotnet/api/system.io.filemode?view=net-8.0
{
fileStream.Seek(0, SeekOrigin.Begin); // 流有一個指針, 指定文件的位置(記憶體的位置). 所以需要讀取或寫入之前指定指針的位置, 使用Seek方法來修改指針位置,
// 有兩個參數, 一: byte(位元組)類型, 從0起始, 如果使用-5則是從尾部倒數; 二: SeekOrigin指定開始計算的起始位置, 有三個枚舉參數:Begin(開始) Current(最近) End(結束)
// 若沒有指定Seek方法, 預設會從0開始,使用Begin;
/* Seek 方法說明:
// 將該流的當前位置設置為給定值。
//
// 參數:
// offset:
// 相對於 origin 的點，從此處開始查找。
//
// origin:
// 使用 System.IO.SeekOrigin 類型的值，將開始位置、結束位置或當前位置指定為 offset 的參考點。
//
// 返回結果:
// 流中的新位置。*/
fileStream.Write(byte_write, 0, byte_write.Length); // 寫入到流, 和Read類似, 但是最後一個參數就因該為byte[]類型的大小.
/* Write 方法說明:
// 將位元組塊寫入文件流。
//
// 參數:
// array:
// 包含要寫入該流的數據的緩衝區。
//
// offset:
// array 中的從零開始的位元組偏移量，從此處開始將位元組複製到該流。
//
// count:
// 最多寫入的位元組數。*/
}
}
catch
{
Console.WriteLine("Error!");
return;
}
Process.Start("c:\\Windows\\System32\\notepad.exe",$" {path}"); // 打開寫入的文件
/* 總結
* 1. [獲取或新建儲存字元組]
* 如string轉char, 或者獲取外部文件並讀取.
* 2. [轉換數據]
* Encoder需要留意, 因為對於不確定空間大小的byte[]類型, 所以增加一個GetByteCount方法來獲取char的大小空間,
* 其中有轉換的編碼器緩存會保留在系統內, 需要填入true釋放記憶體, GetBytes也是如此;
* GetBytes方法和GetChars方法使用方式一樣, 共6個參數, 前三個為char[]對象, 後兩個為byte[]對象, 最後是一個緩存清除參數.
* 3. [寫到Stream(流) ]
* FileStream 寫入文件方法和讀取方法沒有多大區別.
*
* 總結: 一如既往的步驟繁瑣, 尤其是轉換byte數據, 其方法更為繁瑣, 沒有一個方法直接轉換的來的方便. 但也知道了處理方法的過程是怎麼一回事.
*/
}
// 還有一些更為簡單的方法
static void StreamWrite_Example()
{
// FileStream fileStream = new FileStream("d:/1.txt", FileMode.Create);
// StreamWriter streamwriter = new StreamWriter(fileStream);
// 相當於 ↓
// StreamWriter writer = new StreamWriter("d:/1.txt", true); // StreamWrite 其對象讀/寫是預設的; 參數2: true 在文件後繼續添加字元/字元串,若無文件則創建新文件. false 刪除之前的文件創建一個新文件並寫入數據.
/* StreamWrite構造函數:
// 用預設編碼和緩衝區大小，為指定的文件初始化 System.IO.StreamWriter 類的一個新實例。 如果該文件存在，則可以將其覆蓋或向其追加。 如果該文件不存在，此構造函數將創建一個新文件。
// 參數:
// path:
// 要寫入的完整文件路徑。
// append:
// 若要追加數據到該文件中，則為 true；若要覆蓋該文件，則為 false。 如果為true指定的文件不存在，該參數無效，且構造函數將創建一個新文件。*/
try
{
using (StreamWriter writer = new StreamWriter("d:/1.txt", false)) // StreamWrite 其對象讀/寫是預設的; 參數2: true 在文件後繼續添加字元/字元串,若無文件則創建新文件. false 刪除之前的文件創建一個新文件並寫入數據.
{
writer.WriteLine("Hello World");
writer.WriteLine("我的C#入門第11天");
writer.Flush(); // 清除緩存區
writer.Close(); // 關閉StreamWriter對象流
}
} catch { }
}
static void StreamRead_Example()
{
try
{
using (StreamReader streamReader = new StreamReader("D:/1.txt", true))
{
/* // RradToEnd()快速讀取文件, 但僅僅支持小文件. 對於大文件會增加讀取時間而且會影響記憶體.
var T = streamReader.ReadToEnd(); // 對於小文件 RradToEnd() 這個方法是比較不錯的方法.
Console.WriteLine(T);
streamReader.Close();
*/
/* // ReadLine輸出
var T = streamReader.ReadLine();
// 第一次使用while來輸出我是有點疑惑的, 但是看了StreamRead.ReadLine方法後才知道, ReadLine()到達流的終點則返回一個null, 這樣while迴圈則結束;
while (T != null)
{
Console.WriteLine($"{T}");
T = streamReader.ReadLine(); // ReadLine()到達流的終點則返回一個null, 這樣while迴圈則結束; 因此該方法寫在while最後.
}
*/
// Read輸出
var A = streamReader.Read(); // Read() 只能以char的方式讀取.
while(A != -1)
{
Console.Write(Convert.ToChar(A)); // 因為char是單字元輸出, 所以需要使用write方法 連續列印, 這樣不會換行列印;
A = streamReader.Read(); // 和readLine() 一樣, 到達流的終點有一個返回值為 -1, 這樣while迴圈則結束; 因此該方法寫在while最後.
}
}
} catch { Console.WriteLine("Error!"); return; }
}
// 其他方法
static void Else()
{
// 還有另一種方式, 使用File類的ReadLine,或者ReadAllLine, REadAllText 方法, 該方法可以讀取內容多的文件
foreach (var R in File.ReadAllText("D:/1.txt"))
{
Console.Write(R); // 由於ReadAllText是以char字元輸出, 所以使用write不換行列印
}
// 創建一個新文件(文件存在則覆蓋)，在其中寫入指定的位元組數組，然後關閉該文件。
string[] strings = { "123", "456", "7890" };
File.WriteAllLines("d:/2.txt", strings);
// 快速將字元串轉換為byte
string strsum="";
foreach (var R in File.ReadAllLines("D:/1.txt")) { strsum += R; } // 將遍歷的string 賦值給strsum變數
byte[] bytes = new UTF8Encoding(true).GetBytes(strsum); // 初始化 System.Text.UTF8Encoding 類的新實例。 Bool參數指定是否提供一個 Unicode 位元組順序標記。
// 之後就可以對使用Stream類方法來對bytes操作了
}
}
}文章編寫or整理的內容由作者完成，引用or參考會給出原文鏈接。
