Отправка данных из почтового запроса на выход веб-сокета в Play Framework (Scala)

Я только что извлек часть кода из MarkCLewis — Play-Videos . Также есть плейлист на YouTube Play Framework с использованием Scala, в котором вы узнаете, как создать чат с использованием веб-сокетов.

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

Не уверен, насколько хорошо вы знакомы с моделью актера и акка / пекко . Play Framework построен на основе play akka или play pekko в зависимости от версии Play.

Вы можете представить актера как очередь сообщений, которая будет последовательно обрабатывать каждое сообщение. Вы не можете создать актера как новый экземпляр объекта, вам нужен ActorSystem, который позволит вам создавать актеров. Каждый раз, когда вы создаете новый объект с помощью ActorSystem, вы получаете ссылку на него. Единственный способ отправлять сообщения актеру — использовать эту ссылку.

val dummyActor = system.actorOf(Props[DummyActor], "unique-name-of-actor")
dummyActor ! SomeMessage(param1, param2, param3)

WebSocket — это актер, который может получать сообщение от клиента и отправлять сообщение клиенту, открывшему соединение через веб-сокет. В примере называется ChatActor. Нам понадобится второй актер (с именем ChatManager), который позволит нам отправлять сообщения ChatActor, используя его ссылку.

маршруты

Нечего объяснять. Две конечные точки

• /: получить запрос GET и отправить сообщение на открытые веб-сокеты.
• /ws: конечная точка для открытия соединения через веб-сокет.

GET  /    HelloController.index
GET  /ws  HelloController.socket

Контроллер

Просто базовый контроллер с двумя методами и одним полем.

• manager: ChatManager, созданный с использованием ActorSystem, предоставленного игрой.

• index: как только получен HTTP-запрос, мы отправляем сообщение ChatManager, который отправит сообщение каждому ChatActor, имеющему открытое соединение через веб-сокет.

• socket: обработчик открытия соединения с веб-скокетом. Вы также можете видеть, что ChatActor получает параметр ActorManager by в своем конструкторе.

import org.apache.pekko.actor.{ActorSystem, Props}
import org.apache.pekko.stream.Materializer
import play.api.libs.streams.ActorFlow
import play.api.mvc._
import javax.inject.Inject

class HelloController @Inject() (cc: ControllerComponents)(implicit
    system: ActorSystem,
    mat: Materializer
) extends AbstractController(cc) {

  private val manager = system.actorOf(Props[ChatManager], "Manager")

  def index: Action[AnyContent] =
    Action { _ =>
      // this is the place where we sent a message to the manager.
      // Similar to what you need. You receive a POST (in this example
      // is a GET) and you send a message to the client connected to the
      // websocket
      manager ! ChatManager.Message("a hello message sent from index")
      Ok("hello")
    }

  def socket = WebSocket.accept[String, String] { _ =>
    ActorFlow.actorRef { out =>
      ChatActor.props(out, manager)
    }
  }
}

ЧатАктор

Как видите, как только актер создан, в первой строке мы отправили сообщение manager о том, что у нас есть новый чат. В методе receive мы рассматриваем два случая

• в случае String мы отправили сообщение менеджеру
• в случае получения SendMessage мы просто отправили сообщение через веб-сокет

import org.apache.pekko.actor.{Actor, ActorRef, Props}

class ChatActor(out: ActorRef, manager: ActorRef) extends Actor {
  manager ! ChatManager.NewChatter(self)

  import ChatActor._
  def receive = {
    case s: String        => manager ! ChatManager.Message(s)
    case SendMessage(msg) => out ! msg
  }
}

object ChatActor {
  def props(out: ActorRef, manager: ActorRef) = Props(
    new ChatActor(out, manager)
  )

  case class SendMessage(msg: String)
}

ЧатМенеджер

У нас есть изменяемый список с именем chatters, который будет содержать все открытые соединения webscoket. Тогда рассмотрим два случая

• когда получен NewChatter, мы просто добавляем новый элемент в список
• когда Message получен, мы перебираем список chatters и отправляем Message каждому из них

import org.apache.pekko.actor.{Actor, ActorRef}
import scala.collection.mutable.ListBuffer

class ChatManager extends Actor {
  private val chatters = ListBuffer.empty[ActorRef]

  import ChatManager._
  def receive = {
    case NewChatter(chatter) => chatters += chatter
    case Message(msg)        => for (c <- chatters) c ! ChatActor.SendMessage(msg)
  }
}

object ChatManager {
  case class NewChatter(chatter: ActorRef)
  case class Message(msg: String)
}