Blog | Holger Stehle

Byte-Angaben mit C# formatieren 👍 👎

Mit gewisser Regelmäßigkeit kommt man als Softwareentwickler in die Verlegenheit, Dateigrößen statt in der Form 10110 Byte in der "üblichen" Schreibweise mit größeren Einheiten (in diesem Fall 9.87 KiB) darzustellen.

Zwar gäbe es hier wieder einmal die Möglichkeit per DllImport und beispielsweise StrFormatByteSizeW zu arbeiten, jedoch möchten wir in diesem Fall die Implementierung selbst vornehmen, um die Basis (Stichwort: Binärpräfixe) konsistent bestimmen zu können. Ich stelle dazu zwei mögliche Implementierungen vor:

Hilfsklasse mit Methode zur Formatierung

0102030405060708091011121314151617

public static class Helper {    private static readonly IReadOnlyList<string> unitList = new string[] {        "Byte", "KiB", "MiB", "GiB", "TiB", "PiB", "EiB"    };

    public static string FormatBytes(double bytes) {        int index = 0;
        while(bytes >= 1024 && index < Helper.unitList.Count) {            bytes /= 1024;            index++;        }
        return $"{Math.Round(bytes, 2).ToString("N2")} {Helper.unitList[index]}";    }}

Alternativ lässt sich das Problem jedoch auch ohne Schleife – und daher mathematisch etwas eleganter – durch ein ähnliches Vorgehen wie bei der Ermittlung der Anzahl der Ziffern einer Zahl mittels Logarithmen lösen:

Alternativer Lösungsansatz

010203040506

public static string FormatBytes(double bytes) {    int index = Convert.ToInt32(Math.Floor(Math.Log(bytes, 1024)));    bytes /= Math.Pow(1024, index);
    return $"{Math.Round(bytes, 2).ToString("N2")} {Helper.unitList[index]}";}

Die Verwendung gestaltet sich nun in jedem Fall recht einfach:

Formatierung verwenden

string formattedBytes = Helper.FormatBytes(1024);         // 1,00 KiBformattedBytes = Helper.FormatBytes(1024 * 1024);         // 1,00 MiBformattedBytes = Helper.FormatBytes(1024 * 1024 * 1024);  // 1,00 GiB

Abschließend möchte ich auch noch kurz eine beispielhafte Implementierung zur Verwendung im Rahmen einer benutzerdefinierten Formatierung per String.Format skizzieren:

Implementierung der benutzerdefinierten Formatierung

010203040506070809

public class FileSizeFormatProvider : ICustomFormatter, IFormatProvider {    public string Format(string format, object arg, IFormatProvider formatProvider) {        return Helper.FormatBytes(Convert.ToDouble(arg));    }
    public object GetFormat(Type formatType) {        return this;    }}

Bitte beachtet jedoch, dass diese Implementierung noch nicht vollständig ist. Weiterführende Informationen zur korrekten Implementierung finden sich im MSDN per ICustomFormatter und IFormatProvider. Verwendung:

Verwendung der benutzerdefinierten Formatierung verwenden

formattedBytes = String.Format(new FileSizeFormatProvider(), "{0}", (1024 * 1024));  // 1,00 MiB

Ich werde eine vollständige Implementierung vermutlich in einem späteren Beitrag nachreichen.

HTTP-Statuscode einer Webseite mit C# ermitteln 👍 👎

Hin und wieder kann es – beispielsweise im Rahmen eines Monitorings - erforderlich sein, den HTTP-Statuscode einer Webseite zu ermitteln. Das lässt sich mit C# grundsätzlich bereits mit wenigen Zeilen lösen:

Hilfsmethode

01020304050607

public static HttpStatusCode GetHttpStatusCode(Uri uri) {    HttpWebRequest httpWebRequest = WebRequest.CreateHttp(uri);
    using(HttpWebResponse webResponse = (HttpWebResponse) httpWebRequest.GetResponse()) {        return webResponse.StatusCode;    }}

In der Praxis möchte man vermutlich zumindest noch das Weiterleitungs- und Zwischenspeicherverhalten konfigurieren, daher bietet es sich an, unsere Methode entsprechend zu erweitern:

Hilfsmethode (erweitert)

010203040506070809101112131415

public static HttpStatusCode GetHttpStatusCode(    Uri uri,    bool allowAutoRedirect = false,    RequestCacheLevel requestCacheLevel = RequestCacheLevel.NoCacheNoStore) {    HttpWebRequest httpWebRequest = WebRequest.CreateHttp(uri);    {        httpWebRequest.AllowAutoRedirect = allowAutoRedirect;        httpWebRequest.CachePolicy = new RequestCachePolicy(requestCacheLevel);    }
    using(HttpWebResponse webResponse = (HttpWebResponse) httpWebRequest.GetResponse()) {        return webResponse.StatusCode;    }}

Die Verwendung gestaltet sich nun sehr intuitiv:

Hilfsmethode verwenden

01020304

Uri uri = new Uri("https://ccc.coders-online.net/");
HttpStatusCode statusCode = GetHttpStatusCode(uri);  // Found (302)statusCode = GetHttpStatusCode(uri, true);           // OK    (200)

Wenn ihr den Wert der HttpStatusCode-Aufzählung zu int konvertiert erhaltet ihr im Übrigen den entsprechenden numerischen Wert nach Definition des HTTP-Protokolls.

RandomNumberGenerator-Implementierung in C# für random.org 👍 👎

In einem früheren Beitrag zum Thema (Pseudo-)Zufallszahlen in C# hatte ich bereits die Klassen Random und RNGCryptoServiceProvider vorgestellt. Letztere leitet dabei von der abstrakten Klasse RandomNumberGenerator ab, welche wir im Folgenden ebenfalls als Basis für eine Klasse verwenden werden.

Unsere Klasse soll die Werte jedoch nicht selbst erzeugen, sondern vom Anbieter random.org über dessen Schnittstelle auf Basis von JSON-RPC beziehen. Der Dienst ist – zumindest derzeit und in gewissen Grenzen – kostenlos, wobei ein API-Schlüssel benötigt wird, den ihr dem Konstruktor der Klasse übergeben müsst.

Hinweis: Ich möchte vor der eigentlichen Implementierung noch darauf hinweisen, dass dieser Beitrag weder die Güte der darüber ermittelten (Pseudo-)Zufallszahlen noch die Vertrauenswürdigkeit des Anbieters bewerten soll. Dieser Beitrag soll lediglich eine sehr einfache und beispielhafte Implementierung für den Fall aufzeigen, dass ihr euch eben für diese Nutzung (beispielsweise für weniger kritische Daten oder aus reinem Interesse) entschieden habt.

Klasse implementieren

010203040506070809101112131415161718192021222324252627282930313233343536373839404142434445

public class RandomOrg : RandomNumberGenerator {    private const string ApiMethod = "generateIntegers";    private const string ApiUrl = "https://api.random.org/json-rpc/1/invoke";    private const string ApiVersion = "2.0";
    private readonly string apiKey;

    public RandomOrg(string apiKey) {        this.apiKey = apiKey;    }
    public override void GetBytes(byte[] data) {        Array.Copy(this.SendRequest(data.Length), data, data.Length);    }
    public override void GetNonZeroBytes(byte[] data) {        Array.Copy(this.SendRequest(data.Length, 1), data, data.Length);    }

    private byte[] SendRequest(int n, byte min = 0) {        using(WebClient webClient = new WebClient()) {            JavaScriptSerializer js = new JavaScriptSerializer();
            dynamic data = js.Deserialize<dynamic>(webClient.UploadString(ApiUrl, js.Serialize(new {                jsonrpc = ApiVersion,                method = ApiMethod,                @params = new {                    apiKey = this.apiKey,                    n = n,                    min = min,                    max = 255                },                id = DateTime.Now.Ticks            })));
            if(data.ContainsKey("error")) {                throw new Exception(data["error"]["message"]);            }
            return Array.ConvertAll((object[]) data["result"]["random"]["data"], Convert.ToByte);        }    }}

Die eigentliche Verwendung gestaltet sich nun kompatibel zur Basisklasse RandomNumberGenerator und entsprechend einfach. Um beispielsweise ein byte-Feld mit fünf Zahlen zu befüllen, kann folgender Aufruf dienen:

Klasse verwenden

01020304

using(RandomOrg numberGenerator = new RandomOrg("@ToDo")) {  // API-Schlüssel eintragen    byte[] randomNumbers = new byte[5];    numberGenerator.GetBytes(randomNumbers);}

Zeitserver mit C# abfragen 👍 👎

Im Folgenden möchte ich drei Möglichkeiten vorstellen, wie man mit C# über ein Netzwerk eine Zeitangabe abrufen kann. Es gilt zu beachten, dass es sich um sehr reduzierte Beispiele handelt und beispielsweise keine umfassende Fehlerbehandlung berücksichtigt wird. Wir verwenden standardmäßig jeweils einen Server des NIST.

Time Protocol

Beim Time Protocol handelt es sich um ein sehr einfaches (und etwas betagtes) Protokoll. Der Dienst steht für gewöhnlich unter Port 37 zur Verfügung. Details zum Protokoll können in RFC 868 nachgelesen werden.

Methode zur Zeitabfrage per Time Protocol

010203040506070809101112131415161718

public static DateTime GetTime(string host = "time.nist.gov", int port = 37) {    using(TcpClient client = new TcpClient(host, port)) {        using(NetworkStream networkStream = client.GetStream()) {            // Antwort lesen            byte[] timeBuffer = new byte[4];            networkStream.Read(timeBuffer, 0, timeBuffer.Length);
            // Byte-Reihenfolge ggf. umkehren            if(BitConverter.IsLittleEndian) {                Array.Reverse(timeBuffer);            }
            return (new DateTime(1900, 1, 1, 0, 0, 0, DateTimeKind.Utc))                .AddSeconds(BitConverter.ToUInt32(timeBuffer, 0))                .ToLocalTime();        }    }}

Daytime Protocol

Beim Daytime Protocol verhält es sich ähnlich, ist jedoch textbasiert. Der Dienst steht für gewöhnlich unter Port 13 zur Verfügung. Details zum Rückgabeformat können in RFC 867 und der Dienstbeschreibung des NIST nachgelesen werden – wir werden uns auf den minimalen Part (Datum und Uhrzeit) beschränken.

Methode zur Zeitabfrage per Daytime Protocol

010203040506070809101112131415161718

public static DateTime GetDaytime(string host = "time.nist.gov", int port = 13) {    using(TcpClient client = new TcpClient(host, port)) {        using(StreamReader streamReader = new StreamReader(client.GetStream())) {            // Antwort lesen und auftrennen            string[] response = streamReader.ReadToEnd().Split(' ');
            // Datum und Uhrzeit ermitteln            int[] date = Array.ConvertAll(response[1].Split('-'), Int32.Parse);            int[] time = Array.ConvertAll(response[2].Split(':'), Int32.Parse);
            return new DateTime(                CultureInfo.CurrentCulture.Calendar.ToFourDigitYear(date[0]),                date[1], date[2], time[0], time[1], time[2],                DateTimeKind.Utc            ).ToLocalTime();        }    }}

Network Time Protocol (NTP)

Beim Network Time Protocol handelt es sich um einen weit verbreiteten Standard zur Zeitsynchronisierung in Computernetzwerken über Port 123. Details zum Protokoll können in RFC 5905 nachgelesen werden – wir werden uns wieder auf einen minimalen Teil beschränken. Als Server bietet sich hier natürlich auch die PTB an.

Methode zur Zeitabfrage per NTP

010203040506070809101112131415161718192021222324252627282930313233343536

public static DateTime GetNetworkTime(string host = "time.nist.gov", int port = 123) {    using(UdpClient client = new UdpClient()) {        client.Connect(host, port);
        // Anfrage senden        const byte header = (              (0 << 6)  // LI   = 0 (keine Warnung; zur Verdeutlichung ausformuliert)            | (4 << 3)  // VN   = 4 (Version)            | (3 << 0)  // Mode = 3 (Client)        );  // 00_100_011
        byte[] request = new byte[48];        request[0] = header;
        client.Send(request, request.Length);
        // Antwort lesen        IPEndPoint endPoint = new IPEndPoint(IPAddress.Any, 0);        byte[] response = client.Receive(ref endPoint);
        // Daten ab Offset aus ggf. umgekehrter Byte-Reihenfolge ermitteln        const int offset = 40;
        if(BitConverter.IsLittleEndian) {            Array.Reverse(response, offset, 4);            Array.Reverse(response, (offset + 4), 4);        }
        ulong integerPart = BitConverter.ToUInt32(response, offset);        ulong fractionalPart = BitConverter.ToUInt32(response, (offset + 4));
        return (new DateTime(1900, 1, 1, 0, 0, 0, DateTimeKind.Utc))            .AddMilliseconds((integerPart * 1000) + ((fractionalPart * 1000) / UInt32.MaxValue))            .ToLocalTime();    }}

Insbesondere bei diesem letzten Beispiel möchte ich noch einmal explizit darauf hinweisen, dass es sich um eine sehr reduzierte Implementierung handelt. Die Rückgabe erfolgt bei allen Beispielen jeweils bereits in lokaler Zeit.

Neujahr 👍 👎

Ich bedanke mich für das bisherige Interesse und wünsche ein glückliches und erfolgreiches neues Jahr 2017.

Ich würde mich natürlich sehr darüber freuen, dich auch im nächsten Jahr wieder hier begrüßen zu dürfen.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
16 17 18 19 20 21 22 23 24 25 26 27 28 29

Projektverweise

BitStadt – Stadtportal
Berlin · Hamburg · Amsterdam

Kategorien / Archiv | Übersicht

PHP-Funktionen in C# (136)
Wörterbuch (257)