Каков пример простейшего возможного примера Socket.io?

113

Итак, в последнее время я пытался понять Socket.io, но я не супер-великий программист, и почти каждый пример, который я могу найти в Интернете (поверьте, я искал часами), содержит дополнительные вещи, которые усложняют ситуацию. Многие примеры делают кучу вещей, которые меня сбивают с толку, или подключаются к какой-то странной базе данных, или используют coffeescript или тонны JS-библиотек, которые загромождают вещи.

Мне бы хотелось увидеть базовый работающий пример, где сервер просто отправляет сообщение клиенту каждые 10 секунд, говоря, сколько сейчас времени, а клиент записывает эти данные на страницу или выдает предупреждение, что-то очень простое. Затем я могу разобраться во всем, что мне нужно, например, соединения с базами данных и т. Д. И да, я проверил примеры на сайте socket.io, и они не работают для меня, и я не понимаю, что они делают. .

Cocorico
источник
4
Что не так с первым примером на ( socket.io/#how-to-use )? Мне кажется достаточно простым ...
maerics
1
Привет, уже немного поздно, но кто-нибудь в будущем сможет найти здесь хороший учебник по использованию socketio с nodejs. programmerblog.net/using-socketio-with-nodejs
Джейсон В.

Ответы:

154

Изменить: я считаю, что для всех лучше проконсультироваться с отличным примером чата на странице начала работы Socket.IO. С тех пор, как я дал этот ответ, API был значительно упрощен. При этом вот исходный ответ, обновленный small-small для нового API.

Просто потому, что мне сегодня хорошо:

index.html

<!doctype html>
<html>
    <head>
        <script src='/socket.io/socket.io.js'></script>
        <script>
            var socket = io();

            socket.on('welcome', function(data) {
                addMessage(data.message);

                // Respond with a message including this clients' id sent from the server
                socket.emit('i am client', {data: 'foo!', id: data.id});
            });
            socket.on('time', function(data) {
                addMessage(data.time);
            });
            socket.on('error', console.error.bind(console));
            socket.on('message', console.log.bind(console));

            function addMessage(message) {
                var text = document.createTextNode(message),
                    el = document.createElement('li'),
                    messages = document.getElementById('messages');

                el.appendChild(text);
                messages.appendChild(el);
            }
        </script>
    </head>
    <body>
        <ul id='messages'></ul>
    </body>
</html>

app.js

var http = require('http'),
    fs = require('fs'),
    // NEVER use a Sync function except at start-up!
    index = fs.readFileSync(__dirname + '/index.html');

// Send index.html to all requests
var app = http.createServer(function(req, res) {
    res.writeHead(200, {'Content-Type': 'text/html'});
    res.end(index);
});

// Socket.io server listens to our app
var io = require('socket.io').listen(app);

// Send current time to all connected clients
function sendTime() {
    io.emit('time', { time: new Date().toJSON() });
}

// Send current time every 10 secs
setInterval(sendTime, 10000);

// Emit welcome message on connection
io.on('connection', function(socket) {
    // Use socket to communicate with this particular client only, sending it it's own id
    socket.emit('welcome', { message: 'Welcome!', id: socket.id });

    socket.on('i am client', console.log);
});

app.listen(3000);
Линус Тиль
источник
Спасибо большое, это, конечно, работает, и, что более важно, я начинаю понимать, как это работает. Очень любезно с вашей стороны написать это, я, честно говоря, потратил как минимум 3 или 4 часа, пытаясь заставить все это работать, как бы грустно это ни было, ха-ха. Большое спасибо, Линус!
Cocorico,
У меня это не работает. В браузере появляется пустая страница. На стороне сервера нет никаких выходов, кроме «авторизовано клиентом» и «авторизовано рукопожатие».
Борис
1
@Boris, у вас может возникнуть эта проблема, если вы откроете файл index.html локально. Если вы это сделали, замените теги сценария на src = "http: //. Если вы размещаете на веб-сервере, откройте консоль javascript и попытайтесь определить, что не работает.
CodeMonkeyKing
4
сначала я получаю "io not defined" - я использовал это вместо <script src = " cdn.socket.io/socket.io-1.2.1.js" > </ script >, и теперь он работает
Александр Миллс
Вы должны запустить «npm init», а затем установить socket io через npm «npm install socket.io --save»
Фарид Мовсумов
31

Вот мое представление!

если вы поместите этот код в файл с именем hello.js и запустите его с помощью узла hello.js, он должен распечатать сообщение hello, оно было отправлено через 2 сокета.

В коде показано, как обрабатывать переменные для приветственного сообщения, отправленного от клиента на сервер через раздел кода, помеченный // Зеркало.

Имена переменных объявляются локально, а не все вверху, потому что они используются только в каждом из разделов между комментариями. Каждый из них может находиться в отдельном файле и запускаться как отдельный узел.

// Server
var io1 = require('socket.io').listen(8321);

io1.on('connection', function(socket1) {
  socket1.on('bar', function(msg1) {
    console.log(msg1);
  });
});

// Mirror
var ioIn = require('socket.io').listen(8123);
var ioOut = require('socket.io-client');
var socketOut = ioOut.connect('http://localhost:8321');


ioIn.on('connection', function(socketIn) {
  socketIn.on('foo', function(msg) {
    socketOut.emit('bar', msg);
  });
});

// Client
var io2 = require('socket.io-client');
var socket2 = io2.connect('http://localhost:8123');

var msg2 = "hello";
socket2.emit('foo', msg2);

ошибка
источник
Я думаю, это должно быть приемлемым решением. По крайней мере, мне помогли.
Daft Fox
21

Может быть, это тоже может вам помочь. У меня возникли некоторые проблемы с тем, чтобы понять, как работает socket.io, поэтому я попытался максимально упростить пример.

Я адаптировал этот пример из примера, размещенного здесь: http://socket.io/get-started/chat/

Сначала начните с пустого каталога и создайте очень простой файл с именем package.json. Поместите в него следующее.

{
"dependencies": {}
}

Затем в командной строке используйте npm для установки зависимостей, которые нам нужны для этого примера.

$ npm install --save express socket.io

Это может занять несколько минут, в зависимости от скорости вашего сетевого подключения / ЦП / т. Д. Чтобы убедиться, что все прошло по плану, вы можете еще раз просмотреть файл package.json .

$ cat package.json
{
  "dependencies": {
    "express": "~4.9.8",
    "socket.io": "~1.1.0"
  }
}

Создайте файл с именем server.js. Очевидно, это будет наш сервер, управляемый узлом. Поместите в него следующий код:

var app = require('express')();
var http = require('http').Server(app);
var io = require('socket.io')(http);

app.get('/', function(req, res){

  //send the index.html file for all requests
  res.sendFile(__dirname + '/index.html');

});

http.listen(3001, function(){

  console.log('listening on *:3001');

});

//for testing, we're just going to send data to the client every second
setInterval( function() {

  /*
    our message we want to send to the client: in this case it's just a random
    number that we generate on the server
  */
  var msg = Math.random();
  io.emit('message', msg);
  console.log (msg);

}, 1000);

Создайте последний файл с именем index.html и поместите в него следующий код.

<html>
<head></head>

<body>
  <div id="message"></div>

  <script src="/socket.io/socket.io.js"></script>
  <script>
    var socket = io();

    socket.on('message', function(msg){
      console.log(msg);
      document.getElementById("message").innerHTML = msg;
    });
  </script>
</body>
</html>

Теперь вы можете протестировать этот очень простой пример и увидеть результат, подобный следующему:

$ node server.js
listening on *:3001
0.9575486415997148
0.7801907607354224
0.665313188219443
0.8101786421611905
0.890920243691653

Если вы откроете веб-браузер и укажете ему имя хоста, на котором запущен процесс узла, вы увидите, что в вашем браузере появятся те же числа, что и в любом другом подключенном браузере, просматривающем ту же страницу.

ray_voelker
источник
10

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

в каждом простом примере socket.io я мог найти задействованный http.createServer (). но что, если вы хотите добавить немного магии socket.io в существующую веб-страницу? вот самый простой и самый маленький пример, который я мог придумать.

это просто возвращает строку, переданную с консоли ЗАПИСАННЫМ ЗАПИСИ.

app.js

var http = require('http');

var app = http.createServer(function(req, res) {
        console.log('createServer');
});
app.listen(3000);

var io = require('socket.io').listen(app);


io.on('connection', function(socket) {
    io.emit('Server 2 Client Message', 'Welcome!' );

    socket.on('Client 2 Server Message', function(message)      {
        console.log(message);
        io.emit('Server 2 Client Message', message.toUpperCase() );     //upcase it
    });

});

index.html:

<!doctype html>
<html>
    <head>
        <script type='text/javascript' src='http://localhost:3000/socket.io/socket.io.js'></script>
        <script type='text/javascript'>
                var socket = io.connect(':3000');
                 // optionally use io('http://localhost:3000');
                 // but make *SURE* it matches the jScript src
                socket.on ('Server 2 Client Message',
                     function(messageFromServer)       {
                        console.log ('server said: ' + messageFromServer);
                     });

        </script>
    </head>
    <body>
        <h5>Worlds smallest Socket.io example to uppercase strings</h5>
        <p>
        <a href='#' onClick="javascript:socket.emit('Client 2 Server Message', 'return UPPERCASED in the console');">return UPPERCASED in the console</a>
                <br />
                socket.emit('Client 2 Server Message', 'try cut/paste this command in your console!');
        </p>
    </body>
</html>

бежать:

npm init;  // accept defaults
npm  install  socket.io  http  --save ;
node app.js  &

используйте что-то вроде этого теста порта, чтобы убедиться, что ваш порт открыт.

теперь перейдите по адресу http: //localhost/index.html и используйте консоль браузера для отправки сообщений обратно на сервер.

Лучше всего догадаться, что при использовании http.createServer он меняет за вас следующие две строки:

<script type='text/javascript' src='/socket.io/socket.io.js'></script>
var socket = io();

Я надеюсь, что этот очень простой пример избавит моих друзей-новичков от некоторых проблем. и обратите внимание, что я не стал использовать "зарезервированное слово" в именах определяемых пользователем переменных для моих определений сокетов.

Edwardsmarkf
источник
3
every simple socket.io example i could find involved http.createServer(). but what if you want to include a bit of socket.io magic in an existing webpageммм да ... var app = http.createServer(- wut
Дон Чидл
1
Очень-очень полезно, вы спасли мне день. Большое спасибо. Это простейший ответ, не загружающий слишком много в node.js, этот пример лучше для всех новичков, чтобы начать и познакомиться с node. Еще раз спасибо
Картик Элумалай
0

index.html

<!doctype html>
<html>
  <head>
    <title>Socket.IO chat</title>
    <style>
      * { margin: 0; padding: 0; box-sizing: border-box; }
      body { font: 13px Helvetica, Arial; }
      form { background: #000; padding: 3px; position: fixed; bottom: 0; width: 100%; }
      form input { border: 0; padding: 10px; width: 90%; margin-right: .5%; }
      form button { width: 9%; background: rgb(130, 224, 255); border: none; padding: 10px; }
      #messages { list-style-type: none; margin: 0; padding: 0; }
      #messages li { padding: 5px 10px; }
      #messages li:nth-child(odd) { background: #eee; }
      #messages { margin-bottom: 40px }
    </style>
  </head>
  <body>
    <ul id="messages"></ul>
    <form action="">
      <input id="m" autocomplete="off" /><button>Send</button>
    </form>
    <script src="https://cdn.socket.io/socket.io-1.2.0.js"></script>
    <script src="https://code.jquery.com/jquery-1.11.1.js"></script>
    <script>
      $(function () {
        var socket = io();
        $('form').submit(function(){
          socket.emit('chat message', $('#m').val());
          $('#m').val('');
          return false;
        });
        socket.on('chat message', function(msg){
          $('#messages').append($('<li>').text(msg));
          window.scrollTo(0, document.body.scrollHeight);
        });
      });
    </script>
  </body>
</html>

index.js

var app = require('express')();
var http = require('http').Server(app);
var io = require('socket.io')(http);
var port = process.env.PORT || 3000;

app.get('/', function(req, res){
  res.sendFile(__dirname + '/index.html');
});

io.on('connection', function(socket){
  socket.on('chat message', function(msg){
    io.emit('chat message', msg);
  });
});

http.listen(port, function(){
  console.log('listening on *:' + port);
});

И запустите эти команды для запуска приложения.

npm init;  // accept defaults
npm  install  socket.io  http  --save ;
node start

и открываем URL: - http://127.0.0.1:3000/Порт может быть другим. и вы увидите этот ВЫХОД

введите описание изображения здесь

Вишал Тхакур
источник