Java Socket: Entendendo a classe Socket e a ServerSocket em detalhes

Com a constante necessidade de trabalhar em ambientes distribu�dos surgiram alternativas, em Java, para que isso fosse poss�vel. Uma dela e que estudaremos neste artigo � a Socket. H� diversos artigos e tutoriais na internet explicando como funciona o Socket e como realizar a conex�o Cliente-Servidor, mas nosso objetivo vai mais al�m, pois queremos mostrar o funcionamento de cada m�todo nessa poderosa classe e como utiliz�-lo.

De acordo com a pr�pria Oracle: �Socket � um ponto de comunica��o entre duas m�quinas�, ou seja, podemos enviar mensagens entre a m�quina A e a m�quina B atrav�s de uma conex�o estabelecida com o Socket.

Para que essa comunica��o seja poss�vel n�s precisamos criar a classe Servidora que � respons�vel por esperar a conex�o do cliente e a classe Cliente que ir� conectar-se no Servidor. Antes de iniciarmos a pr�tica e come�ar a criar nosso ambiente de comunica��o, vamos entender as classes que usaremos e seus m�todos.

Quer ser um programador Java de sucesso? Confira nosso checklist e saiba como!

ServerSocket class

A primeira classe importante � a ServerSocket e ela � respons�vel por esperar a conex�o do cliente. Esta classe possui um construtor onde passamos a porta que desejamos usar para escutar as conex�es.

Listagem 1. Construtor

ServerSocket server = new ServerSocket(3322);

Veja na Listagem 1 que estamos criando um objeto ServerSocket passando como par�metro o argumento 3322 que corresponde ao n�mero da porta que ser� aguardada uma conex�o do cliente. Existem outros construtores mas este � o mais utilizado.

accept(): O m�todo accept() escuta uma conex�o e aceita se alguma for encontrada. O accept() bloqueia todo o restante at� que uma conex�o seja feita, ele fica em espera aguardando que algu�m conecte. Quando alguma conex�o � aceita ele retorna um objeto Socket, que veremos mais � frente.
Listagem 2. accept()
```
ServerSocket server = new ServerSocket(3322);
System.out.println("Servidor iniciado na porta 3322");
 
Socket cliente = server.accept();
 
//OUTRAS L�GICAS AQUI
```
Perceba na Listagem 2 que o trecho comentado �OUTRAS L�GICAS AQUI� s� ser� executado quando alguma conex�o for aceita e o �accept()� for liberado, at� ent�o ele n�o passar� desta linha.
bind(): Vincula um endere�o ao socket. Vejamos um exemplo na Listagem 3.
Listagem 3. Usando bind()
```
ServerSocket server = new ServerSocket(3322);
server.bind(new InetSocketAddress("192.168.0.1", 0));
```
Por�m se voc� executar o c�digo acima provavelmente ter� o seguinte erro:
```
�java.net.SocketException: Already bound
at java.net.ServerSocket.bind(ServerSocket.java:314)
at java.net.ServerSocket.bind(ServerSocket.java:286)
at br.com.loginremoto.util.Server.main(Server.java:17)�
```
Isso ocorre porque ao criar o ServerSocket ele automaticamente j� � vinculado (bind) ao IP atual, e por isso voc� n�o pode refazer o bind. Ent�o fique atento para realizar o bind() apenas quando for necess�rio.
close(): Um m�todo de extrema import�ncia que fecha a conex�o atual. Qualquer cliente que esteja conectado ser� automaticamente desconectado.
getChannel(): retorna um objeto ServerSocketChannel que corresponde a um canal criado atrav�s do m�todo open() da classe ServerSocketChannel. N�o entraremos em detalhes do seu uso neste artigo.
getInetAddress(): Retorna o endere�o de IP local do servidor. Vejamos seu uso na Listagem 4.
Listagem 4. Recuperando informa��o do IP
```
ServerSocket server = new ServerSocket(3322);                      
InetAddress inet = server.getInetAddress();
System.out.println("HostAddress="+inet.getHostAddress());
System.out.println("HostName="+inet.getHostName());
```
Recuperamos o objeto do tipo InetAddress e acessamos seus diversos m�todos, um deles s�o: getHostAddress() e getHostName().
getLocalPort(): como o pr�prio nome j� sugere ele retorna o n�mero da porta no qual o servidor est� escutando uma conex�o.
Listagem 5. Recuperando a porta
```
ServerSocket server = new ServerSocket(3322);                       
System.out.println("Porta = "+server.getLocalPort());
```
Bem simples, veja que na Listagem 5 apenas usamos o getLocalPort() e retornamos no console atrav�s do System.out.println o valor da porta.
isClosed(): Verifica se o ServerSocket est� fechado, assim podemos evitar erros chamando m�todos que n�o poder�amos se ele estivesse fechado.
isBound(): Lembre que anteriormente n�s tentamos realizar um bind, mas obtivemos um erro porque o ServerSocket j� tinha uma endere�o vinculado, com o isBound() n�s evitamos este erro. Vejamos na Listagem 6.
Listagem 6. isBound()
```
ServerSocket server = new ServerSocket(3322);                      
if (!server.isBound()){
server.bind(new InetSocketAddress("192.168.0.1", 0));
}
```
toString(): Este m�todo nos retorna um valor formatado representando as informa��es de endere�o IP e porta do ServerSocket.

Agora j� sabemos como funcionam os principais e mais utilizados m�todos da classe ServerSocket, por�m ainda precisamos entender o uso da classe Socket.

Socket class

Ao contr�rio da classe ServerSocket que funciona como um Servidor escutando o cliente, a classeSocket � o cliente propriamente dito. Muito dos m�todos estudados na classe ServerSocket est�o presentes na Socket e n�o repetiremos os mesmos conceitos, tais como: bind, close, getChannel e etc, mas vamos ver alguns um pouco diferente que n�o abordamos anteriormente.

getInputStream(): � atrav�s deste m�todo que o Servidor (ServerSocket) consegue capturar o que o cliente est� enviado. Vejamos na Listagem 7.
Listagem 7. Lendo o que o cliente enviou
```
Scanner entrada = new Scanner(cliente.getInputStream());
```
Perceba que capturamos a mensagem do cliente e passamos para um objeto Scanner, depois disso podemos manipular da forma que acharmos necess�rio as mensagens enviadas.
getOutputStream(): Ao contr�rio do getInputStream() o getOutputStream() envia dados para o outro lado da comunica��o, neste caso o ServerSocket.
Listagem 8. Enviando dados ao servidor
```
PrintStream saida = new PrintStream(cliente.getOutputStream());
Scanner teclado = new Scanner(System.in);
while (teclado.hasNextLine()) {
  saida.println(teclado.nextLine());
}
```
Na Listagem 8 colocamos o que o usu�rio est� digitando no console na vari�vel �saida� que � do tipo PrintStream, que consequentemente ser� o que o nosso servidor receber� do outro lado, ou seja, nosso ServerSocket.

Constru��o da Aplica��o

Dado os conceitos que foram apresentados, com o detalhamento e uso dos m�todos mais importantes e utilizados com maior frequ�ncia, podemos agora come�ar a desenvolver nossa aplica��o para comunica��o atrav�s do Socket.

Primeiramente vamos construir nossa classe Server com base no que foi ensinado Observe a Listagem 9.

Listagem 9. Server.class


  package br.com.loginremoto.util;
   
  import java.io.IOException;
  import java.net.ServerSocket;
  import java.net.Socket;
  import java.util.Scanner;
  import java.util.logging.Level;
  import java.util.logging.Logger;
   
  public class Server {
      
      public static void main(String args[]){
          try {
              ServerSocket server = new ServerSocket(3322);                       
              System.out.println("Servidor iniciado na porta 3322");
              
              Socket cliente = server.accept();
              System.out.println("Cliente conectado do IP "+cliente.getInetAddress().
                      getHostAddress());
              Scanner entrada = new Scanner(cliente.getInputStream());
              while(entrada.hasNextLine()){
                  System.out.println(entrada.nextLine());
              }
              
              entrada.close();
              server.close();
              
          } catch (IOException ex) {
              Logger.getLogger(Server.class.getName()).log(Level.SEVERE, null, ex);
          }
          
      }
      
  }

Vamos entender o c�digo acima:

Primeiramente criar um objeto do tipo SocketServer na porta 3322, assim podemos escutar conex�es do cliente nesta porta. � muito importante que voc� escolha uma porta que j� n�o esteja em uso por algum servi�o do seu sistema operacional. Por exemplo: Se voc� usar o tomcat na porta 8080, n�o poder� utilizar esta porta para testar a sua conex�o Socket.
Depois n�s chamamos o m�todo �server.accept()� que ir� �bloquear� a execu��o do restante da l�gica at� que uma conex�o seja estabelecida. Se voc� quiser que v�rios clientes possam se conectar simultaneamente voc� poderia envolver o �server.accept()� em um la�o �while� para que ele possa aceitar diversas conex�es at� que determinada condi��o seja atingida.
Ao usarmos o getInputStream() estamos capturando o que o cliente digitou, e neste ponto uma conex�o j� foi estabelecida, s� precisamos trafegar os dados neste �canal de comunica��o�. Nosso objetivo aqui � apenas usar o �while� e mostrar no console do servidor o que est� sendo digitado no cliente, mas voc� poderia fazer v�rios tipos de tratamentos no lado do servidor com os dados recebidos.
Por fim n�s fechamos a conex�o do servidor e o Scanner, assim o fluxo de transmiss�o � interrompido.

Repare que nossa classe acima possui um m�todo �main()� e devemos execut�-la para que o Servidor comece a escutar uma conex�o do cliente, ou seja, executamos a classe acima e depois executamos o cliente que far� a conex�o autom�tica neste servidor.

Nosso cliente ser� composto por um formul�rio simples com uma caixa de texto (JtextArea) e um Jbutton, assim poderemos enviar tudo que for digitado na caixa de texto para o console do servidor.

Formul�rio do Cliente

Figura 1. Formul�rio do Cliente

Na Figura 1 temos a demonstra��o de como criamos a interface do nosso usu�rio. Veja que ela � bem simples e leve, ao digitar qualquer texto basta clicar em Enviar Mensagem que esta chegar� no Servidor. Vejamos agora na Listagem 10 como foi feita a constru��o do nosso formul�rio e a explica��o dos m�todos.

Listagem 10. Formul�rio Fclient


  package br.com.loginremoto.gui;
   
  import java.io.IOException;
  import java.io.PrintStream;
  import java.net.Socket;
  import java.util.logging.Level;
  import java.util.logging.Logger;
   
  /**
   *
   * @author ronaldo
   */
  public class FClient extends javax.swing.JFrame {
   
      private Socket cliente;
      
      /**
       * Creates new form FClient
       */
      public FClient() {
          initComponents();
          initCliente();
      }
      
      private void initCliente(){
          try {
              cliente = new Socket("127.0.0.1",3322);
          } catch (IOException ex) {
              Logger.getLogger(FCliente.class.getName()).log(Level.SEVERE, null, ex);
          }
      }
   
      /**
       * This method is called from within the constructor to initialize the form.
       * WARNING: Do NOT modify this code. The content of this method is always
       * regenerated by the Form Editor.
       */
      @SuppressWarnings("unchecked")
      // <editor-fold defaultstate="collapsed" desc="Generated Code">                          
      private void initComponents() {
   
          jScrollPane1 = new javax.swing.JScrollPane();
          jTextArea1 = new javax.swing.JTextArea();
          jButton1 = new javax.swing.JButton();
   
          setDefaultCloseOperation(javax.swing.WindowConstants.EXIT_ON_CLOSE);
   
          jTextArea1.setColumns(20);
          jTextArea1.setRows(5);
          jScrollPane1.setViewportView(jTextArea1);
   
          jButton1.setText("Enviar Mensagem");
          jButton1.addActionListener(new java.awt.event.ActionListener() {
              public void actionPerformed(java.awt.event.ActionEvent evt) {
                  jButton1ActionPerformed(evt);
              }
          });
   
          javax.swing.GroupLayout layout = new javax.swing.GroupLayout(getContentPane());
          getContentPane().setLayout(layout);
          layout.setHorizontalGroup(
              layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
              .addGroup(layout.createSequentialGroup()
                  .addContainerGap()
                  .addGroup(layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
                      .addComponent(jScrollPane1, javax.swing.GroupLayout.DEFAULT_SIZE, 376, Short.MAX_VALUE)
                      .addGroup(layout.createSequentialGroup()
                          .addComponent(jButton1)
                          .addGap(0, 0, Short.MAX_VALUE)))
                  .addContainerGap())
          );
          layout.setVerticalGroup(
              layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
              .addGroup(layout.createSequentialGroup()
                  .addContainerGap()
                  .addComponent(jScrollPane1, javax.swing.GroupLayout.PREFERRED_SIZE, 228, javax.swing.GroupLayout.PREFERRED_SIZE)
                  .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.RELATED)
                  .addComponent(jButton1)
                  .addContainerGap(25, Short.MAX_VALUE))
          );
   
          pack();
      }// </editor-fold>                        
   
      private void jButton1ActionPerformed(java.awt.event.ActionEvent evt) {                                         
          try {
              PrintStream saida = new PrintStream(cliente.getOutputStream());
              saida.println(jTextArea1.getText());
              jTextArea1.setText("");
          } catch (IOException ex) {
              Logger.getLogger(FCliente.class.getName()).log(Level.SEVERE, null, ex);
          }
      }                                        
   
      /**
       * @param args the command line arguments
       */
      public static void main(String args[]) {
          /* Set the Nimbus look and feel */
          //<editor-fold defaultstate="collapsed" desc=" Look and feel setting code (optional) ">
          /* If Nimbus (introduced in Java SE 6) is not available, stay with the default look and feel.
           * For details see http://download.oracle.com/javase/tutorial/uiswing/lookandfeel/plaf.html
           */
          try {
              for (javax.swing.UIManager.LookAndFeelInfo info : javax.swing.UIManager.getInstalledLookAndFeels()) {
                  if ("Nimbus".equals(info.getName())) {
                      javax.swing.UIManager.setLookAndFeel(info.getClassName());
                      break;
                  }
              }
          } catch (ClassNotFoundException ex) {
              java.util.logging.Logger.getLogger(FClient.class.getName()).log(java.util.logging.Level.SEVERE, null, ex);
          } catch (InstantiationException ex) {
              java.util.logging.Logger.getLogger(FClient.class.getName()).log(java.util.logging.Level.SEVERE, null, ex);
          } catch (IllegalAccessException ex) {
              java.util.logging.Logger.getLogger(FClient.class.getName()).log(java.util.logging.Level.SEVERE, null, ex);
          } catch (javax.swing.UnsupportedLookAndFeelException ex) {
              java.util.logging.Logger.getLogger(FClient.class.getName()).log(java.util.logging.Level.SEVERE, null, ex);
          }
          //</editor-fold>
   
          /* Create and display the form */
          java.awt.EventQueue.invokeLater(new Runnable() {
              public void run() {
                  new FClient().setVisible(true);
              }
          });
      }
   
      // Variables declaration - do not modify                     
      private javax.swing.JButton jButton1;
      private javax.swing.JScrollPane jScrollPane1;
      private javax.swing.JTextArea jTextArea1;
      // End of variables declaration                   
  }

Perceba que temos logo no in�cio um atributo �private Socket cliente� que usaremos para conex�o cliente-servidor. Este atributo ser� �til para armazenamos a inst�ncia de conex�o que foi estabelecida com o servidor e n�o precisar ficar reconectando a todo instante.
No m�todo construtor Fcliente() fazemos chamada a outro m�todo: initCliente().
O initCliente() � respons�vel por inicializar a conex�o cliente com o servidor 3322 que criamos anteriormente, o IP 127.0.0.1 indica que o servidor est� na mesma m�quina que o cliente, ou seja, local. Nada impede que voc� fa�a o teste usando um outro computador como servidor ou at� mesmo em uma rede externa.
O m�todo initComponents() � respons�vel por inicializar e dispor os componentes no nosso formul�rio, que � um Jframe.
Temos a a��o de clique do bot�o disparando o m�todo jButton1ActionPerformed(), ou seja, quando o usu�rio digitar seu texto e clicar no bot�o Enviar Mensagem, esse m�todo ser� chamado. Neste m�todo temos o uso do getOutputStream() que � respons�vel por enviar os dados ao servidor, para isso n�s capturamos o que o usu�rio escreveu atrav�s do getText() do componente JtextArea e colocando dentro do m�todo println() do objeto PrintStream, assim cada vez que for clicado no bot�o Enviar Mensagem a mesma aparecer� no console do servidor.
Por fim temos o m�todo main() que nos possibilita executar o Formul�rio em quest�o e realizar as opera��es necess�rias.

A nossa limita��o � que apenas um cliente por vez pode se conectar ao servidor, isso ocorre porque quando um cliente se conecta ele ocupa a �nica Thread que o Servidor possui e se outro tentar consequentemente ele n�o conseguir�. A solu��o para isso � trabalhar com Multi-threading para aceitar v�rias conex�es simult�neas, mas voc� deve ficar atento a quantidade m�xima de conex�es que o servidor pode suportar por isso � importante parametrizar tal recurso. Deixaremos como desafio para que voc� implemente a solu��o com v�rios clientes conectados, a dica � voc� usar o m�todo accept() dentro de um la�o para que v�rias conex�es possam ser aceitas, assim o servidor estar� �sempre� esperando uma nova conex�o.

Neste artigo vimos o uso da classe Socket e a ServerSocket para constru��o de uma aplica��o b�sica que faz comunica��o entre cliente e servidor. A aplica��o de tais conceitos � muito �til em diversas situa��es, por exemplo:

Criar um mecanismo de envio de comandos do cliente para o servidor, onde o servidor ir� executar este comando localmente. Ex: Envio um shutdown para o servidor, e este desliga a m�quina servidora.
Sistema de chat entre Cliente-Cliente e Cliente-Servidor.
Sincronismo de informa��es para sistemas distribu�dos, ou seja, sistema que possuem diversos banco de dados podem ser centralizados atrav�s de uma comunica��o Socket.

E ainda h� muitas outras aplica��es no qual o Socket � utilizado.

Alguns leitores mais cr�ticos podem se perguntar porque n�o usar outro mecanismo de comunica��o como, por exemplo o muito conhecido RMI (Remote Method Invocation) em vez do Socket. N�o entraremos em detalhes sobre o RMI neste artigo, mas o RMI possui uma estrutura de comunica��o mais robusta j� com multithreading, garbage collection distribu�do e muitos outros recursos que o Socket n�o possui nativamente. Por�m para aplica��es que necessitam de uma comunica��o mais simples, o Socket supri as necessidades, usar o RMI para tais aplica��es � como �matar uma formiga com uma bomba�, ou seja, desnecess�rio. Vale lembrar que nem sempre o mais completo e mais robusto pode ser melhor para o seu cen�rio, ainda mais quando este � simples e n�o exige toda essa robustez.

Confira outros conte�dos:

Introdu��o ao JDBC

Novidades do Java

Teste unit�rio com JUnit

Por Ronaldo Em 2015

Coment�rios nesta publica��o Escrever um coment�rio sobre conte�do

Paulo Lima

N�vel 2

Boa tarde, quando eu chamo o m�todo close() do socket ele volta a seu estado de accept() esperando uma nova conex�o ? e os m�todos da minha regra de neg�cio voltam a seus estados originais ?

há +1 ano

Ver coment�rios anteriores (13)

Rodolfo Gomes

DevMedia

No que precisar Paulo, pode contar conosco

forte abra�o!

há +1 ano

Cl�ber Barros

N�vel 1

Poderia deixar dispon�vel os arquivos do exemplo

há +1 ano

Ver coment�rios anteriores (2)

Marcio Souza

DevMedia

Ol� Cl�ber, recriei o projeto para disponibilizar os fontes, como a Daniella j� informou, est� agora dispon�vel no link c�digo fonte no topo do artigo.

há +1 ano

Black November

Desconto exclusivo para as primeiras 200 matrículas!

Pagamento integral

12x no cartão

De: R$ 69,00

Por: R$ 59,00

Total: R$ 708,00

Garanta o desconto

Formação FullStack Completa
Carreira Front-end I e II, Algoritmo e Javascript, Back-end e Mobile
+10.000 exercícios gamificados
+50 projetos reais
Comunidade com + 200 mil alunos
Estude pelo Aplicativo (Android e iOS)
Suporte online
12 meses de acesso

Pagamento facilitado

Cobrado mensalmente no cartão

De: R$ 79,00

Por: R$ 64,00 /mês

Tempo mínimo: 12 messes

Garanta o desconto

Formação FullStack Completa
Carreira Front-end I e II, Algoritmo e Javascript, Back-end e Mobile
+10.000 exercícios gamificados
+50 projetos reais
Comunidade com + 200 mil alunos
Estude pelo Aplicativo (Android e iOS)
Suporte online
Não compromete o limite do seu cartão

<Perguntas frequentes>

Carreira

Metodologia

Assinatura e Pagamentos

Cadastro

Nossos casos de sucesso

Leonardo Carlos

Eu sabia pouqu�ssimas coisas de programa��o antes de come�ar a estudar com voc�s, fui me especializando em v�rias �reas e ferramentas que tinham na plataforma, e com essa bagagem consegui um est�gio logo no in�cio do meu primeiro per�odo na faculdade.

Lucas Rodrigues

Estudo aqui na Dev desde o meio do ano passado! Nesse per�odo a Dev me ajudou a crescer muito aqui no trampo.
Fui o primeiro desenvolvedor contratado pela minha empresa. Hoje eu lidero um time de desenvolvimento!
Minha meta � continuar estudando e praticando para ser um Full-Stack Dev!

Her�clito J�nior

Economizei 3 meses para assinar a plataforma e sendo sincero valeu muito a pena, pois a plataforma � bem intuitiva e muuuuito did�tica a metodologia de ensino. Sinto que estou EVOLUINDO a cada dia. Muito obrigado!

Julio Cablen

Nossa! Plataforma maravilhosa. To amando o curso de desenvolvimento front-end, tinha coisas que eu ainda n�o tinha visto. A did�tica � do jeito que qualquer pessoa consegue aprender. S�rio, to apaixonado, adorando demais.

Joelberth Sena

Adquiri o curso de voc�s e logo percebi que s�o os melhores do Brasil. � um passo a passo incr�vel. S� n�o aprende quem n�o quer. Foi o melhor investimento da minha vida!

Felipe Nunes

Foi um dos melhores investimentos que j� fiz na vida e tenho aprendido bastante com a plataforma. Voc�s est�o fazendo parte da minha jornada nesse mundo da programa��o, irei assinar meu contrato como programador gra�as a plataforma.

Wanderson Oliveira

Comprei a assinatura tem uma semana, aprendi mais do que 4 meses estudando outros cursos. Exerc�cios pr�ticos que n�o tem como n�o aprender, est�o de parab�ns!

Jos� Lucas

Obrigado DevMedia, nunca presenciei uma plataforma de ensino t�o presente na vida acad�mica de seus alunos, parab�ns!

Eduardo Dorneles

Aprendi React na plataforma da DevMedia h� cerca de 1 ano e meio... Hoje estou h� 1 ano empregado trabalhando 100% com React!

Adauto Junior

J� fiz alguns cursos na �rea e nenhum � t�o bom quanto o de voc�s. Estou aprendendo muito, muito obrigado por existirem. Est�o de parab�ns... Espero um dia conseguir um emprego na �rea.

Ver todos os casos de sucesso

Java Socket: Entendendo a classe Socket e a ServerSocket em detalhes

Veja neste artigo como funcionam as classes Socket e ServerSocket para estabelecimento de conex�o cliente-servidor em Java.

ServerSocket class

Socket class

Constru��o da Aplica��o

Confira outros conte�dos:

Introdu��o ao JDBC

Novidades do Java

Teste unit�rio com JUnit

<Perguntas frequentes>

Nossos casos de sucesso