Простейший сервер и клиент


Этот пример покажет простейшее использование серверного и клиентского сокета. Все, что делает сервер, это ожидает соединения, затем использует сокет, полученный при соединении, для создания InputStream'а и OutputStream'а. Они конвертируются в Reader и Writer, которые оборачиваются в BufferedReader и PrintWriter. После этого все, что будет прочитано из BufferedReader'а будет переправлено в PrintWriter, пока не будет получена строка "END", означающая, что пришло время закрыть соединение.

Клиент создает соединение с сервером, затем создает OutputStream и создает некоторую обертку, как и в сервере. Строки текста посылаются через полученный PrintWriter. Клиент также создает InputStream (опять таки, с соответствующей конвертацией и оберткой), чтобы слушать, что говорит сервер (который, в данном случае, просто отсылает слова назад).

И сервер, и клиент используют одинаковый номер порта, а клиент использует адрес локальной заглушки для соединения с сервером на этой же самой машине, так что вы не можете провести тест по сети. (Для некоторых конфигураций вам может понадобиться сетевое соединения для работы программы даже, если вы не используете сетевую коммуникацию.)

Вот сервер:

//: c15:JabberServer.java
// Очень простой сервер, который просто отсылает
// назад все, что посылает клиент.
// {RunByHand}
import java.io.*;

import java.net.*;

public class JabberServer {
  
// Выбираем порт вне пределов 1-1024:
  
public static final int PORT = 8080;
  
  
public static void main(String[] args) throws IOException {
     
ServerSocket s = new ServerSocket(PORT);
      System.out.println
("Started: " + s);
     
try {
        
// Блокирует до тех пор, пока не возникнет соединение:
        
Socket socket = s.accept();
        
try {
           
System.out.println("Connection accepted: " + socket);
            BufferedReader in =
new BufferedReader(new InputStreamReader(
                 
socket.getInputStream()));
           
// Вывод автоматически выталкивается из буфера PrintWriter'ом
           
PrintWriter out = new PrintWriter(new BufferedWriter(
                 
new OutputStreamWriter(socket.getOutputStream())), true);
           
while (true) {
              
String str = in.readLine();
              
if (str.equals("END"))
                 
break;
               System.out.println
("Echoing: " + str);
               out.println
(str);
           
}
           
// Всегда закрываем два сокета...
        
}
        
finally {
           
System.out.println("closing...");
            socket.close
();
        
}
      }
     
finally {
        
s.close();
     
}
   }
}
// /:~

Вы можете видеть, что для ServerSocket'а необходим только номер порта, а не IP адрес (так как он запускается на локальной машине!). Когда вы вызываете accept( ), метод блокирует выполнение до тех пор, пока клиент не попробует подсоединится к серверу. То есть, сервер ожидает соединения, но другой процесс может выполнятся (смотрите Главу 14). Когда соединение установлено, метод accept( ) возвращает объект Socket, представляющий это соединение.

Здесь тщательно обработана отвественность за очистку сокета. Если конструктор ServerSocket завершится неудачей, программа просто звершится (обратите внимание, что мы должны предположить, что конструктор ServerSocket не оставляет никаких открытых сокетов, если он зваершается неудачей). По этой причине main( ) выбрасывает IOException, так что в блоке try нет необходимости. Если конструктор ServerSocket завершится успешно, то все вызовы методов должны быть помещены в блок try-finally, чтобы убедиться, что блок не будет покинут ни при каких условиях и ServerSocket будет правильно закрыт.

Аналогичная логика используется для сокета, возвращаемого из метода accept( ). Если метод accept( ) завершится неудачей, то мы должны предположить, что сокет не существует и не удерживает никаких ресурсов, так что он не нуждается в очистке. Однако если он закончится успешно, то следующие выражения должны быть помещены в блок try-finally, чтобы при каких-либо ошибках все равно произошла очистка. Позаботится об этом необходимо, потому что сокеты используют важные ресурсы, не относящиеся к памяти, так что вы должны быть прилежны и очищать их (так как в Java нет деструкторов, чтобы сделать это за вас).

И ServerSocket и Socket, производимый методом accept( ), печатаются в System.out. Это означает, что автоматически вызывается их метод toString( ). Вот что он выдаст:

ServerSocket[addr=0.0.0.0,PORT=0,localport=8080]
Socket[addr=127.0.0.1,PORT=1077,localport=8080]

Короче говоря, вы увидите как это соответствует тому, что делает клиент.

Следующая часть программы выглядит, как открытие файла для чтения и записи за исключением того, что InputStream и OutputStream создаются из объекта Socket. И объект InputStream'а и OutputStream'а конвертируются в объекты Reader'а и Writer'а с помощью "классов-конвертеров" InputStreamReader и OutputStreamreader, соответственно. Вы можете также использовать классы из Java 1.0 InputStream и OutoutStream напрямую, но, с точки зрения вывода, есть явное преимущество в использовании этого подхода. Оно проявляется в PrintWriter'е, который имеет перегруженный конструктор, принимающий в качестве второго аргумента флаг типа boolean, указывающий, нужно ли автоматическое выталкивание буфера вывода в конце каждого выражения println( ) (но не print( )). Каждый раз, когда вы записываете в вывод, буфер вывода должен выталкиваться, чтобы информация проходила по сети. Выталкивание важно для этого конкретного примера, поскольку клиент и сервер ожидают строку от другой стороны, прежде, чем приступят к ее обработке. Если выталкивание буфера не произойдет, информация не будет помещена в сеть до тех пор, пока буфер не заполнится, что может привести к многочисленным проблемам в этом примере.

Когда пишите сетевую программу, вам необходимо быть осторожным при использовании автоматического выталкивания буфера. При каждом выталкивании буфера пакеты должны создаваться и отправляться. В данном случае это именно то, что нам надо, так как если пакет, содержащий строку, не будет отослан, то общение между сервером и клиентом остановится. Другими словами, конец строки является концом сообщения. Но во многих случаях, сообщения не ограничиваются строками, так что будет более эффективным использовать автоматическое выталкивание буфера, поэтому позвольте встроенному механизму буфферизации построить и отослать пакет. В таком случае могут быть посланы пакеты большего размера и процесс обработки пойдет быстрее.

Обратите внимание, что фактически все открытые вами потоки, буфферезированы. В конце этой главы есть упражнение, которое покажет вам, что происходит, если вы не буфферезируете потоки (вещи становятся медленнее).

В бесконечном цикле while происходит чтение строк из входного BufferedReader'а и запись информации в System.out и в выходной PrintWriter. Обратите внимание, что вход и выход могут быть любыми потоками, так случилось, что они связаны с сетью.

Когда клиент посылает строку, содержащую "END", программа прекращает цикл и закрывает сокет.

Вот клиент:

//: c15:JabberClient.java
// Очень простой клиент, который просто посылает
// строки на сервер и читает строки,
// посылаемые сервером.
// {RunByHand}
import java.net.*;

import java.io.*;

public class JabberClient {
  
public static void main(String[] args) throws IOException {
     
// Передаем null в getByName(), получая
      // специальный IP адрес "локальной заглушки"
      // для тестирования на машине без сети:
     
InetAddress addr = InetAddress.getByName(null);
     
// Альтернативно, вы можете использовать
      // адрес или имя:
      // InetAddress addr =
      // InetAddress.getByName("127.0.0.1");
      // InetAddress addr =
      // InetAddress.getByName("localhost");
     
System.out.println("addr = " + addr);
      Socket socket =
new Socket(addr, JabberServer.PORT);
     
// Помещаем все в блок try-finally, чтобы
      // быть уверенным, что сокет закроется:
     
try {
        
System.out.println("socket = " + socket);
         BufferedReader in =
new BufferedReader(new InputStreamReader(socket
               .getInputStream
()));
        
// Вывод автоматически Output быталкивается PrintWriter'ом.
        
PrintWriter out = new PrintWriter(new BufferedWriter(
              
new OutputStreamWriter(socket.getOutputStream())), true);
        
for (int i = 0; i < 10; i++) {
           
out.println("howdy " + i);
            String str = in.readLine
();
            System.out.println
(str);
        
}
        
out.println("END");
     
}
     
finally {
        
System.out.println("closing...");
         socket.close
();
     
}
   }
}
// /:~

В main( ) вы можете видеть все три способа получение InetAddress IP адреса локальной заглушки: с помощью null, localhost или путем явного указания зарезервированного адреса 127.0.0.1, если вы хотите соединится с машиной по сети, вы замените это IP адресом машины. Когда печатается InetAddress (с помощью автоматического вызова метода toString( )), то получается результат:

При передачи в getByName( ) значения null, он по умолчанию ищет localhos и затем производит специальныйы адрес 127.0.0.1.

Обратите внимание, что Socket создается при указании и InetAddress'а, и номера порта. Чтобы понять, что это значит, когда будете печатать один из объектов Socket помните, что Интернет соединение уникально определяется четырьмя параметрами: клиентским хостом, клиентским номером порта, серверным хостом и серверным номером порта. Когда запускается сервер, он получает назначаемый порт (8080) на localhost (127.0.0.1). Когда запускается клиент, он располагается на следующем доступном порту на своей машине, 1077 - в данном случае, который так же оказался на той же самой машине (127.0.0.1), что и сервер. Теперь, чтобы передать данные между клиентом и сервером, каждая сторона знает, куда посылать их. Поэтому, в процессе соединения с "известным" сервером клиент посылает "обратный адрес", чтобы сервер знал, куда посылать данные. Вот что вы видите среди выводимого стороной сервера:

Socket[addr=127.0.0.1,port=1077,localport=8080]

Это означает, что сервер просто принимает соединение с адреса 127.0.0.1 и порта 1077 во время прослушивания локального порта (8080). На клиентской стороне:

Socket[addr=localhost/127.0.0.1,PORT=8080,localport=1077]

Это значит, что клиент установил соединение с адресом 127.0.0.1 по порту 8080, используя локальный порт 1077.

Вы заметите, что при каждом повторном запуске клиента номер локального порта увеличивается. Он начинается с 1025 (первый после зарезервированного блока портов) и будет увеличиваться до тех пор, пока вы не перезапустите машину, в таком случае он снова начнется с 1025. (На машинах под управлением UNIX, как только будет достигнут верхний предел диапазона сокетов, номер будет возвращен снова к наименьшему доступному номеру.)

Как только объект Socket будет создан, процесс перейдет к BufferedReader и PrintWriter, как мы это уже видели в сервере (опять таки, в обоих случаях вы начинаете с Socket'а). В данном случае, клиент инициирует обмен путем посылки строки "howdy", за которой следует число. Обратите внимание, что буфер должен опять выталкиваться (что происходит автоматически из-за второго аргумента в конструкторе PrintWriter'а). Если буфер не будет выталкиваться, процесс обмена повиснет, поскольку начальное "howdy" никогда не будет послана (буфер недостаточно заполнен, чтобы отсылка произошла автоматически). Каждая строка, посылаемая назад сервером, записывается в System.out, чтобы проверить, что все работает корректно. Для завершения обмена посылается ранее оговоренный "END". Если клиент просто разорвет соединение, то сервер выбросит исключение.

Вы можете видеть, что аналогичные меры приняты, чтобы быть уверенным в том, что сетевые ресурсы, представляемые сокетом, будут правильно очищены. Для этого используется блок try-finally.

Сокет производит "посвященную" связь, которая остается постоянной до тех пор, пока не будет явного рассоединения. (Посвященная связь может быть рассоединена неявно, если одна из сторон, или посредническая связь соединения рушатся.) Это означает, что два партнера замкнуты в коммуникации и соединение постоянно открыто. Это выглядит, как логический подход к сети, но это вносит дополнительную нагрузку на сеть. Позднее в этой главе вы увидите отличный подход к сетевому взаимодействию, при котором соединение является временным.

Обслуживание множества клиентов

JabberServer работает, но он может обработать только одного клиента одновременно. В обычных серверах вы захотите, чтобы была возможность иметь дело со многими клиентами одновременно. Ответом является многопоточность, и в языках, которые не поддерживают многопоточность напрямую, это означает что вы встретите все возможные трудности. В Главе 14 вы видели, что многопоточность в Java проста насколько это возможно, учитывая это, можно сказать, что многопоточность весьма сложная тема. Поскольку нити (потоки) в Java достаточно прамолинейны, то создание сервера, который обрабатывает несколько клиентов, относительно простое заняте.

Основная схема состоит в создании единственного ServerSocket'а на сервере и вызове метода accept( ) для ожидания новых соединений. Когда accept( ) возвращается, вы получаете результирующий сокет и используете его для создания новой нити (потока), работа которой будет состоять в ослуживании определенного клиента. Затем вы вызовите метод accept( ) снова, чтобы подождать нового клиента.

В следующем коде сервера вы можете видеть, что он очень похож на пример JabberServer.java, за исключением того, что все операции по обслуживанию определенного клиента былы помещены внутрь отдельного thread-класса:

//: c15:MultiJabberServer.java
// Сервер, который использует многопоточность
// для обработки любого числа клиентов.
// {RunByHand}
import java.io.*;

import java.net.*;

class ServeOneJabber extends Thread {
  
private Socket socket;
  
private BufferedReader in;
  
private PrintWriter out;
  
  
public ServeOneJabber(Socket s) throws IOException {
     
socket = s;
      in =
new BufferedReader(new InputStreamReader(socket.getInputStream()));
     
// Включаем автоматическое выталкивание:
     
out = new PrintWriter(new BufferedWriter(new OutputStreamWriter(socket
            .getOutputStream
())), true);
     
// Если любой из вышеприведенных вызовов приведет к
      // возникновению исключения, то вызывающий отвечает за
      // закрытие сокета. В противном случае, нить
      // закроет его.
     
start(); // вызываем run()
  
}
  
  
public void run() {
     
try {
        
while (true) {
           
String str = in.readLine();
           
if (str.equals("END"))
              
break;
            System.out.println
("Echoing: " + str);
            out.println
(str);
        
}
        
System.out.println("closing...");
     
}
     
catch (IOException e) {
        
System.err.println("IO Exception");
     
}
     
finally {
        
try {
           
socket.close();
        
}
        
catch (IOException e) {
           
System.err.println("Socket not closed");
        
}
      }
   }
}

public class MultiJabberServer {
  
static final int PORT = 8080;
  
  
public static void main(String[] args) throws IOException {
     
ServerSocket s = new ServerSocket(PORT);
      System.out.println
("Server Started");
     
try {
        
while (true) {
           
// Блокируется до возникновения нового соединения:
           
Socket socket = s.accept();
           
try {
              
new ServeOneJabber(socket);
           
}
           
catch (IOException e) {
              
// Если завершится неудачей, закрывается сокет,
               // в противном случае, нить закроет его:
              
socket.close();
           
}
         }
      }
     
finally {
        
s.close();
     
}
   }
}
// /:~

Нить ServeOneJabber принимает объект Socket'а, который производится методом accept( ) в main( ) при каждом новом соединении с клиентом. Затем, как и прежде, с помощью Socket, создается BufferedReader и PrintWriter с возможностью автоматического выталкивания буфера. И наконец, вызывается специальный метод нити start( ). Здесь выполняются те же действия, что и в предыдущем примере: читается что-то из сокета и затем отсылается обратно до тех пор, пока не будет прочитан специальный сигнал "END".

Ответственность за очистку сокета должна быть, опять таки, внимательно спланирована. В этом случае, сокет создается вне ServeOneJabber, так что ответственность может быть совместная. Если конструктор ServeOneJabber завершится неудачей, он просто выбросит исключение тому, кто его вызвал, и кто должен очистить нить. Но если конструктор завершился успешно, то объект ServeOneJabber принимает ответственность за очистку нити на себя, в своем методе run( ).

Обратите внимание на упрощенность MultiJabberServer. Как и прежде создается ServerSocket и вызывается метод accept( ), чтобы позволить новое соединение. Но в это время возвращаемое значение метода accept( ) (сокет) передается в конструктор для ServeOneJabber, который создает новую нить для обработки этого соединения. Когда соединение завершиется, нить просто умирает.

Если создание ServerSocket'а проваливается, то из метода main( ), как и прежде, выбрасывается исключение. Но если создание завершается успешно, внешний блок try-finally гарантирует очистку. Внутренний try-catch гарантирует только от сбоев в конструкторе ServeOneJabber. Если конструктор завершится успешно, то нить ServeOneJabber закроет соответствующий сокет.

Для проверки этого сервера, который реально обрабатывает несколько клиентов, приведенная ниже программа создает несколько клиентов (используя нити), которые соединяются с одним и тем же сервером. Максимальное допустимое число нитей определяется переменной final int MAX_THREADS.

//: c15:MultiJabberClient.java
// Клиент, который проверяет MultiJabberServer,
// запуская несколько клиентов.
// {RunByHand}
import java.net.*;

import java.io.*;

class JabberClientThread extends Thread {
  
private Socket socket;
  
private BufferedReader in;
  
private PrintWriter out;
  
private static int counter = 0;
  
private int id = counter++;
  
private static int threadcount = 0;
  
  
public static int threadCount() {
     
return threadcount;
  
}
  
  
public JabberClientThread(InetAddress addr) {
     
System.out.println("Making client " + id);
      threadcount++;
     
try {
        
socket = new Socket(addr, MultiJabberServer.PORT);
     
}
     
catch (IOException e) {
        
System.err.println("Socket failed");
        
// Если создание сокета провалилось,
         // ничего ненужно чистить.
     
}
     
try {
        
in = new BufferedReader(new InputStreamReader(socket
               .getInputStream
()));
        
// Включаем автоматическое выталкивание:
        
out = new PrintWriter(new BufferedWriter(new OutputStreamWriter(
              
socket.getOutputStream())), true);
         start
();
     
}
     
catch (IOException e) {
        
// Сокет должен быть закрыт при любой
         // ошибке, кроме ошибки конструктора сокета:
        
try {
           
socket.close();
        
}
        
catch (IOException e2) {
           
System.err.println("Socket not closed");
        
}
      }
     
// В противном случае сокет будет закрыт
      // в методе run() нити.
  
}
  
  
public void run() {
     
try {
        
for (int i = 0; i < 25; i++) {
           
out.println("Client " + id + ": " + i);
            String str = in.readLine
();
            System.out.println
(str);
        
}
        
out.println("END");
     
}
     
catch (IOException e) {
        
System.err.println("IO Exception");
     
}
     
finally {
        
// Всегда закрывает:
        
try {
           
socket.close();
        
}
        
catch (IOException e) {
           
System.err.println("Socket not closed");
        
}
        
threadcount--; // Завершаем эту нить
     
}
   }
}

public class MultiJabberClient {
  
static final int MAX_THREADS = 40;
  
  
public static void main(String[] args) throws IOException,
         InterruptedException
{
     
InetAddress addr = InetAddress.getByName(null);
     
while (true) {
        
if (JabberClientThread.threadCount() < MAX_THREADS)
           
new JabberClientThread(addr);
         Thread.currentThread
().sleep(100);
     
}
   }
}
// /:~

Конструктор JabberClientThread принимает InetAddress и использует его для открытия сокета. Вероятно, вы заметили шаблон: сокет всегда используется для создания определенного рода объектов Reader'а и Writer'а (или InputStream и/или OutputStream), которые являются тем единственным путем, которым может быть использован сокет. (Вы можете, конечно, написать класс или два для автоматизации этого процесса вместо набора этого текста, если вас это беспокоит.) Далее, start( ) выполняет инициализацию нити и запуск run( ). Здесь сообщение посылается на сервер, а информация с сервера отображается на экране. Однако, нить имеет ограниченноен время жизни и, в конечном счете, завершается. Обратите внимание, что сокет очищается, если конструктор завершился неудачей после создания сокета, но перед тем, как конструктор завершится. В противном случае, ответственность за вызов close( ) для сокета ложиться на метод run( ).

Threadcount хранит информацию о том, сколько в настоящее время существует объектов JabberClientThread. Эта переменная инкрементируется, как часть конструктора и декрементируется при выходе из метода run( ) (что означает, что нить умерла). В методе MultiJabberClient.main( ) вы можете видеть, что количество нитей проверяется, и если их много, то нить более не создается. Затем метод засыпает. Таким образом, некоторые нити, в конечном счете, умрут, и другие будут созданы. Вы можете поэкспериментировать с MAX_THREADS, чтобы увидеть, когда ваша конкретная система почувствует затруднения со множеством соединений.

Дейтаграммы

Пример, который вы недавно видели, использует Transmission Control Protocol (TCP, также известный, как сокет, основанный на потоках), который предназначен для наибольшей надежности и гарантии, что данные будут доставлены. Он позволяет передавать повторно потерянные данные, он обеспечивает множественные пути через различные маршрутизаторы в случае, если один из них отвалится, а байты будут доставлены в том порядке, в котором они посланы. Весь этот контроль и надежность добавляют накладные расходы: TCP сильно перегружен.

Существует второй потокол, называемый User Datagram Protocol (UDP), который не гарантирует, что пакет будет доставлен и не гарантирует, что пакеты достигнут точки назначения в том же порядке, в котором они были отправлены. Он называется "ненадежным протоколом" (TCP является "надежным протоколом"), что звучит плохо, но так как он намного быстрее, он может быть полезнее. Существуют приложения, такие как аудио сигнал, в которых не критично, если несколько пакетов потеряются здесь или там, а скорость жизненно необходима. Или например сервер времени, для которого реально не имеет значения, если одно из сообщений будет потеряно. Также, некоторые приложения могут быть способны отправлять UDP сообщения к серверу и затем считать, если нет ответа в разумный период времени, что сообщения были потеряны.

Обычно вы будете выполнять ваше прямое сетевое программирование с помощью TCP, и только иногда вы будете использовать UDP. Есть более общее толкование UDP, включая пример, в первой редакции этой книги (доступра на CR-ROM'е, сопровождающем это книгу или может быть свободно загружено с www.BruceEckel.com).

Использование URL'ов из апплета

Для апплета есть возможность стать причиной отображения любого URL с помощью Web броузера, в котором запущен апплет. Вы можете сделать это с помощью следующей строки:

getAppletContext().showDocument(u);

в которой u является объектом типа URL. Вот простой пример, который перенаправляет вас на другую страницу. Хотя вы просто перенаправляете на HTML страницу, вы можете также перенаправить на вывод, который дает CGI программа.

//: c15:ShowHTML.java
// <applet code=ShowHTML width=100 height=50>
// </applet>
import javax.swing.*;

import java.awt.*;

import java.awt.event.*;

import java.net.*;

import java.io.*;

import com.bruceeckel.swing.*;

public class ShowHTML extends JApplet {
  
JButton send = new JButton("Go");
   JLabel l =
new JLabel();
  
  
public void init() {
     
Container cp = getContentPane();
      cp.setLayout
(new FlowLayout());
      send.addActionListener
(new Al());
      cp.add
(send);
      cp.add
(l);
  
}
  
  
class Al implements ActionListener {
     
public void actionPerformed(ActionEvent ae) {
        
try {
           
// Это может быть CGI программа вместо
            // HTML страницы.
           
URL u = new URL(getDocumentBase(), "FetcherFrame.html");
           
// Отображается вывод URL с помощью
            // Web броузера, как обычная страница:
           
getAppletContext().showDocument(u);
        
}
        
catch (Exception e) {
           
l.setText(e.toString());
        
}
      }
   }
  
  
public static void main(String[] args) {
     
Console.run(new ShowHTML(), 100, 50);
  
}
}
// /:~

Красота класса URL состоит в том, что он отлично защищает вас. Вы можете соединится с Web серверами без знания многого из того, что происходит за занавесом.