Класс WebClient

C# и .NET --- Сетевое программирование --- Класс WebClient

Если необходимо только запросить файл с определенного URI (Uniform Resource Identifier — унифицированный идентификатор ресурса), то простейшим в использовании классом .NET, который подходит для этого, будет System.Net.WebClient. Этот исключительно высокоуровневый класс предназначен для выполнения базовых операций с помощью всего одной или двух команд. В настоящее время в .NET Framework поддерживаются URI, начинающиеся с идентификаторов http:, https: и file:.

Важно отметить, что термин URL (Uniform Resource Locator — универсальный локатор ресурсов) больше не используется в новых технических спецификациях, а вместо него отдается предпочтение URI. URI имеет приблизительно тот же смысл, что и URL, но немного более общий, потому что в URL не подразумевается обязательное применение одного из знакомых протоколов, таких как HTTP или FTP.

Загрузка файлов

Для загрузки файлов с использованием WebClient доступны два метода. Выбор метода зависит от того, как должно обрабатываться содержимое файла. Если необходимо просто сохранить файл на диске, следует применять метод DownloadFile(). Этот метод принимает два параметра: URI файла и местоположение (путь и имя файла) для сохранения запрошенных данных:

WebClient Client = new WebClient();
Client.DownloadFile("http://www.professorweb.ru/", "index.php");

Часто приложение должно обрабатывать данные, извлеченные с веб-сайта. Это обеспечивает метод OpenRead(), возвращающий ссылку на Stream, которую можно использовать для извлечения данных в память:

WebClient Client = new WebClient();
Stream str = Client.OpenRead("http://www.professorweb.ru/");

В следующем примере демонстрируется применение метода WebClient.OpenRead(). Содержимое загруженной страницы будет отображено в элементе управления TextBox. Для начала создайте новый проект как стандартное приложение WPF и добавьте элемент управления TextBox по имени txb. В начало файла к списку директив using потребуется добавить ссылки на пространства имен System.Net и System.IO. Затем добавьте обработчик клика по кнопке:

private void Button_Click(object sender, RoutedEventArgs e)
{
   WebClient client = new WebClient();
   Stream stream = client.OpenRead("http://www.professorweb.ru");
   StreamReader sr = new StreamReader(stream);
   string newLine;
   while ((newLine = sr.ReadLine()) != null)
         txb.Text += newLine;

   stream.Close();
}

В этом примере класс StreamReader из пространства имен System.IO подключается к сетевому потоку. Это позволяет получить данные из потока в виде текста, используя высокоуровневые методы вроде ReadLine(). На рис. показаны результаты запуска этого кода:

Класс WebClient также включает в себя метод OpenWrite(). Этот метод возвращает записываемый поток для отправки данных по определенному URI. При этом можно указать метод, который должен использоваться для отправки данных на хост, по умолчанию это POST.

Выгрузка файлов

В классе WebClient также имеются методы UploadFile() и UploadData(). Они используются, когда нужно отправить HTML-форму или выгрузить на сервер целый файл. UploadFile() выгружает файл в указанное местоположение по указанному имени локального файла, в то время как UploadData() выгружает двоичные данные, представленные в виде массива байт, по указанному URI (есть также метод DownloadData(), предназначенный для извлечения массива байтов из URI).

WebClient client = new WebClient();
client.UploadFile("http://professorweb.ru/NewFile.html", "samplefile.txt");
byte[] image;
client.UploadData("http://professorweb.ru/NewFile.jpg", image);

Хотя класс WebClient очень прост в использовании, он обладает весьма ограниченными возможностями. В частности, невозможно передавать регистрационные данные для аутентификации — одна из проблем, связанных с загрузкой данных, состоит в том, что лишь относительно немного сайтов принимают файлы без аутентификации.

В запросы можно добавлять информацию заголовка и проверять заголовки в ответе, но лишь в очень общем смысле — специфическая поддержка какого-то одного протокола отсутствует. Причина в том, что WebClient — класс общего назначения, предназначенный для работы с любым протоколом, позволяющем отправлять запросы и получать ответы (вроде HTTP и FTP). Он не может обработать никаких средств, специфичных для какого-то одного протокола, например, сокеты, которые специфичны для HTTP. Чтобы воспользоваться преимуществами этих средств, нужно работать с семейством классов, основанным на двух других классах из пространства имен System.Net, а именно — WebRequest и WebResponse.