Suche: ATA

C#-Member als obsolet kennzeichnen 👍 👎

Hin und wieder kann es sinnvoll sein, Programmelemente (z. B. Eigenschaften oder Methoden) als obsolet zu kennzeichnen. Dies ist insbesondere bei der Umsetzung allgemeiner Programmbibliotheken hilfreich, beispielsweise um den Anwender auf eine entfallende bzw. verbesserte Funktionalität hinzuweisen.

.NET stellt hierfür das Obsolete-Attribut zur Dekoration entsprechender Teile bereit. Die Verwendung ist intuitiv:
Programmelemente als obsolet kennzeichnen
01020304050607080910111213
[Obsolete("Bitte verwenden Sie .NET-Standardfunktionalität.")]public static class Sorting {    [Obsolete("Bitte verwenden Sie zumindest " + nameof(Mergesort) + ".", true)]    public static string[] Bogosort(string[] data) {        /* ohne Implementierung */        return data;    }
public static string[] Mergesort(string[] data) { /* ohne Implementierung */ return data; }}
Bei Verwendung dieser Klasse erscheint nun folgende Warnung in Visual Studio:
"Sorting" ist veraltet: "Bitte verwenden Sie .NET-Standardfunktionalität."
Bei Verwendung der Methode Bogosort erscheint zusätzlich folgender Fehler:
"Sorting.Bogosort(string[])" ist veraltet: "Bitte verwenden Sie zumindest Mergesort."

Arbeitgeber- und Wohnortwechsel 👍 👎

Nach nun etwa 10 Jahren professioneller Tätigkeit für meinen bisherigen Arbeitgeber in Berlin nutze ich eine in vielerlei Hinsicht passende Gelegenheit für eine sowohl berufliche als auch private Veränderung.

Arbeitgeberwechsel

Ich arbeite ab dem 1. Februar 2018 als Softwareentwickler im öffentlichen Dienst für Dataport. Technologisch bewege ich mich dabei weiterhin hauptsächlich im Bereich der .NET-Technologie.

Wohnortwechsel

Ich werde im Zuge meiner neuen Herausforderungen auch einen örtlichen Wechsel vollziehen und meinen Lebensmittelpunkt daher mit Aufnahme meiner neuen Tätigkeit nach Hamburg verlegen.


Für euch als Leser ändert sich jedoch nichts, da ich weiterhin gerne Beiträge zum Thema C#/.NET schreiben werde.

Syslog-Nachrichten mit C# versenden 👍 👎

Syslog beschreibt einen Protokollierungsstandard. Dieser Beitrag soll die beispielhafte Implementierung eines C#-Clients aufzeigen. Dazu werden UDP-basierte Nachrichten im (älteren) BSD-Format nach RFC 3164 erzeugt.

In einem früheren Beitrag hatte ich bereits mein NAS von Synology erwähnt. Sofern ihr ebenfalls ein solches besitzt, könnt ihr dieses sehr einfach als Server einrichten und somit direkt für die Beispiele (und mehr) nutzen.
Syslog-Klasse implementieren
010203040506070809101112131415161718192021222324252627282930313233343536
public class Syslog : IDisposable {    private const int Facility = 1;  // user-level messages    private const int FacilityFactor = 8;
private readonly UdpClient udpClient;

public Syslog(string hostname = "localhost", int port = 514) { this.udpClient = new UdpClient(hostname, port); }
public void Send(Severity severity, string message, [CallerMemberName] string caller = null) { byte[] data = Encoding.UTF8.GetBytes(String.Format("<{0}>{1} {2} {3}", ((Syslog.Facility * Syslog.FacilityFactor) + (int) severity), DateTime.Now.ToString("MMM dd HH:mm:ss"), Dns.GetHostName(), ((!String.IsNullOrWhiteSpace(caller)) ? (caller + " ") : (String.Empty)) + message ));
this.udpClient.Send(data, data.Length); }
public void Dispose() => this.udpClient?.Dispose();

public enum Severity { Emergency, // [0] system is unusable Alert, // [1] action must be taken immediately Critical, // [2] critical conditions Error, // [3] error conditions Warning, // [4] warning conditions Notice, // [5] normal but significant condition Informational, // [6] informational messages Debug, // [7] debug-level messages } // https://tools.ietf.org/html/rfc3164}
Es handelt sich hierbei – wie üblich – um eine minimale Implementierung ohne Fehlerbehandlung, welche außerdem keine Konfiguration des Facility-Wertes ermöglicht. Die Verwendung gestaltet sich nun jedoch sehr einfach:
Syslog-Klasse verwenden
01020304
using(Syslog syslog = new Syslog("syslog.example.net")) {    syslog.Send(Severity.Notice, "Dies ist eine weniger interessante Meldung.");    syslog.Send(Severity.Warning, "Dies ist eine sehr interessante Meldung.", "MyApp");}

CSV- zu XML-Dateien konvertieren 👍 👎

Ein bestehendes Projekt von mir beinhaltet eine erweiterbare Dateiverwaltung. Die Anforderung war es nun, CSV-Dateien zu XML-Dateien zu konvertieren. Die Ausgangsdateien haben folgenden einheitlichen Aufbau:
CSV-Dateiformat (→ test.csv)
010203
spalte1,spalte2,spalte3inhaltA,inhaltB,inhaltCinhaltD,inhaltE,inhaltF
Zwar ist dieser konkrete Kontext sicherlich etwas speziell, jedoch möchte ich die allgemein verwendbare Kernfunktionalität kurz vorstellen. Ihr könnt euch im Folgenden also auf die Methode ConvertFiles konzentrieren:
Konvertierung implementieren
010203040506070809101112131415161718192021222324252627282930313233
public static class CsvToXml {    public static void ConvertDirectory(string path, SearchOption searchOption) {        CsvToXml.ConvertFiles(Directory.EnumerateFiles(path, "*.csv", searchOption));    }
public static void ConvertFiles(params string[] pathList) { foreach(string path in pathList) { using(StreamReader fileStream = File.OpenText(path)) { string currentLine = fileStream.ReadLine(); string[] fieldList = currentLine.Split(',');
XElement root = new XElement("entries"); XDocument document = new XDocument(root);
while((currentLine = fileStream.ReadLine()) != null) { string[] dataList = currentLine.Split(',');
XElement entry = new XElement("entry"); root.Add(entry);
for(int i = 0; i < dataList.Length; i++) { entry.Add(new XElement(fieldList[i], dataList[i])); } }
document.Save(Path.Combine( Path.GetDirectoryName(path), String.Concat(Path.GetFileNameWithoutExtension(path), ".xml") )); } } }}
Ich habe die beispielhafte Implementierung bereits etwas vereinfacht und wie üblich um Fehlerbehandlungen etc. reduziert, um den Fokus auf die eigentliche Funktionalität zu legen. Die Verwendung gestaltet sich nun sehr einfach:
Konvertierung anwenden
01
CsvToXml.ConvertDirectory(@"X:\data", SearchOption.TopDirectoryOnly);
Die zu Beginn beschriebene Beispiel-Datei würde nun zu folgender Datei konvertiert:
XML-Dateiformat (→ test.xml)
01020304050607080910111213
<?xml version="1.0" encoding="utf-8"?><entries>  <entry>    <spalte1>inhaltA</spalte1>    <spalte2>inhaltB</spalte2>    <spalte3>inhaltC</spalte3>  </entry>  <entry>    <spalte1>inhaltD</spalte1>    <spalte2>inhaltE</spalte2>    <spalte3>inhaltF</spalte3>  </entry></entries>
Natürlich kann diese grundlegende Funktionalität beliebig erweitert werden, beispielsweise für weitere Dateiendungen oder um die Bezeichner der äußeren Elemente (entries und entry) individuell angeben zu können. Je nach gewünschtem Einsatzzweck kann insbesondere auch die SearchOption-Aufzählung interessant sein.

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);}

Projektverweise

Kategorien / Archiv  |  Übersicht RSS-Feed

Schlagworte

Suche