Каковы варианты использования списка кодировщиков или списка декодеров в аннотации WebSocket EndPoints?

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

@ServerEndpoint(value = "/subscribe", decoders = { TextStreamMessageDecoder.class }, encoders = { TextStreamMessageEncoder.class })
public class ChatServerEndPoint {
......
}

В списке декодеров и кодировщиков есть только один декодер и кодер. Поскольку это массив декодеров или кодировщиков, я могу одновременно использовать несколько типов кодировщиков или декодеров. Но в описании API тогда упоминалось,

Среда выполнения websocket будет использовать первый декодер в списке, способный декодировать сообщение, игнорируя остальные декодеры.

Если он всегда использует первые элементы списка, то каковы варианты использования нескольких кодировщиков или декодеров в API WebSockets?

После редактирования

public class TextStreamMessageDecoder implements Decoder.TextStream<JsonWrapper>{

    public JsonWrapper decode(Reader reader) throws DecodeException,
        IOException {
    JsonReader jsonReader = Json.createReader(reader);
    JsonObject jsonObject = jsonReader.readObject();

    return new JsonWrapper(jsonObject);
    }

}

public class TextStreamMessageEncoder implements Encoder.TextStream<JsonWrapper>{

public void encode(JsonWrapper object, Writer writer)
        throws EncodeException, IOException {
    JsonWriter jsonWriter = Json.createWriter(writer);
    JsonObject jsonObject = object.getJson();
    jsonWriter.write(jsonObject);

}

}

public class MessageDecoder implements Decoder.Text<JsonWrapper> {

    public JsonWrapper decode(String s) throws DecodeException {
    JsonObject json = Json.createReader(new StringReader(s)).readObject();
    return new JsonWrapper(json);
    }

    public boolean willDecode(String s) {
    // TODO Auto-generated method stub
    try {
        Json.createReader(new StringReader(s)).read();
        return true;
    } catch (JsonException ex) {
        ex.printStackTrace();
        return false;
    }
    }

}

public class MessageEncoder implements Encoder.Text<JsonWrapper> {

    public String encode(JsonWrapper jsonWrapper) throws EncodeException {

    return jsonWrapper.getJson().toString();
    }

}


@ClientEndpoint(decoders = { MessageDecoder.class}, encoders = { MessageEncoder.class })
public class ChatClientEndPoint {
@OnMessage
public void onMessage(String message, Session session) {
    logger.info("onMessage: " + session.getId());
    if (this.messageHandler != null)
        this.messageHandler.handleMessage(message);

}
}


@ServerEndpoint(value = "/subscribe", decoders = { TextStreamMessageDecoder.class, MessageDecoder.class}, encoders = { TextStreamMessageEncoder.class, MessageEncoder.class })
public class ChatServerEndPoint {
@OnMessage
public void onMessage(String message, Session session) {
    logger.info("onMessage: " + session.getId());
    // logger.info("onMessage: " + message.toString());
    Gson gson = new Gson();
    ClientMessage clientMessage = gson.fromJson(message,
            ClientMessage.class);
    System.out.println(clientMessage.toString());
}
}

Сервер отправляет Клиенту:

 try {
            Gson gson = new Gson();
            session.getBasicRemote().sendObject(
                    gson.toJson(new ServerMessage(1, "connection accepted")));
        } catch (EncodeException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
    }

Клиенты отправляют на сервер:

try {
        Gson gson = new Gson();
        session.getBasicRemote().sendObject(
                gson.toJson(new ClientMessage(1, "FirstName")));
    } catch (EncodeException e) {
        // TODO Auto-generated catch block
        e.printStackTrace();
}

Клиенты отправляют сообщение, используя класс MessageEncoder, в то время как сервер имеет два кодировщика и декодер, включая TextStreamMessageEncoder или декодер и MessageEncoder или декодер. Итак, какой декодер будет использоваться, когда клиент отправляет сообщение на сервер?


person Md. Mahedi Kaysar    schedule 14.07.2015    source источник


Ответы (2)


Декодеры имеют #willDecode, поэтому у вас может быть один декодирующий json, другой для декодирования hocon и т. д.

Кодировщик объявлений — они выбираются на основе общего типа — среда выполнения всегда должна отдавать предпочтение «ближайшему» кодировщику в зависимости от типа, который вы пытаетесь отправить (кодировать).

Кроме того, у вас может быть несколько onMessage. тип метода - текстовый/бинарный, поэтому вы можете захотеть зарегистрировать тестовый и бинарный декодеры.

person Pavel Bucek    schedule 15.07.2015
comment
если ClientEndPoint имеет только декодер сообщений TextStream, а ServerEndPoint имеет только декодер текстовых сообщений, должно ли сообщение правильно декодироваться с обеих сторон. Для меня это правильное декодирование. Но я не знаю причины. Они декодируют один и тот же класс JsonWrapper, но их тип кодирования отличается. Не могли бы вы объяснить это? - person Md. Mahedi Kaysar; 19.07.2015
comment
пожалуйста, поделитесь своей реализацией декодера и кодом, который отправляет сообщение - на стороне сервера и клиента. Я не знаю, почему ваш случай не должен работать, поскольку вы не поделились необходимыми подробностями. - person Pavel Bucek; 20.07.2015
comment
Я отредактировал свой вопрос, добавив все классы - person Md. Mahedi Kaysar; 20.07.2015
comment
вы вообще не используете кодировщики/декодеры - оба метода @OnMessage используют строковое сообщение, которое неявно обрабатывается Tyrus. Вы можете просто удалить его (значительно уменьшите сложность вашего кода), и вы получите то же поведение. - person Pavel Bucek; 20.07.2015
comment
Ваши ответы проясняют мне вопрос о кодировщиках и декодерах. Я написал полный ответ с примерами здесь. Спасибо. - person Md. Mahedi Kaysar; 22.07.2015

В соответствии с первым ответом я хотел бы резюмировать его следующим образом:

Давайте создадим два типа кодировщиков и декодеров, включая Text и BinaryStream.

public class JsonMessageEncoder implements Encoder.Text<JsonWrapper> {

    public String encode(JsonWrapper jsonWrapper) throws EncodeException {
        return jsonWrapper.getJson().toString();
    }

}

public class JsonMessageDecoder implements Decoder.Text<JsonWrapper> {

    public JsonWrapper decode(String s) throws DecodeException {
        JsonObject json = Json.createReader(new StringReader(s)).readObject();
        System.out.println("JsonWrapper decode: "+json);
        return new JsonWrapper(json);
    }

    public boolean willDecode(String s) {
        // TODO Auto-generated method stub
        try {
            Json.createReader(new StringReader(s)).read();
            return true;
        } catch (JsonException ex) {
            ex.printStackTrace();
            return false;
        }
    }

}

public class BinaryStreamMessageEncoder implements Encoder.BinaryStream<BinaryMessage>{

    public void encode(BinaryMessage object, OutputStream os)
            throws EncodeException, IOException {
        ObjectOutput objectOutput = new ObjectOutputStream(os);
        objectOutput.writeObject(object);

    }

}

public class BinaryStreamMessageDecoder implements Decoder.BinaryStream<BinaryMessage>{

    public BinaryMessage decode(InputStream is) throws DecodeException,
            IOException {
        ObjectInput objectInput = new ObjectInputStream(is);
        try {
            BinaryMessage binaryMessage= (BinaryMessage) objectInput.readObject();
            return binaryMessage;
        } catch (ClassNotFoundException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
        return null;

    }

}

Теперь добавьте эти кодировщики и декодеры в конечные точки клиента и сервера.

@ClientEndpoint(decoders = { JsonMessageDecoder.class, BinaryStreamMessageDecoder.class}, encoders = { JsonMessageEncoder.class, BinaryStreamMessageEncoder.class })
public class ChatClientEndPoint {
@OnMessage
    public void onMessage(JsonWrapper message, Session session) {
        logger.info("JsonWrapper onMessage: " + session.getId());
        if (this.messageHandler != null)
            this.messageHandler.handleMessage(message);

    }

    @OnMessage
    public void onMessage(BinaryMessage message, Session session) {
        logger.info("BinaryMessage onMessage: " + session.getId());
        if (this.messageHandler != null)
            this.messageHandler.handleMessage(message);

    }
}

@ServerEndpoint(value = "/subscribe", decoders = { JsonMessageDecoder.class, BinaryStreamMessageDecoder.class}, encoders = { JsonMessageEncoder.class,BinaryStreamMessageEncoder.class })
public class ChatServerEndPoint {
@OnMessage
    public void onMessage(JsonWrapper message, Session session) {
        logger.info("JsonWrapper onMessage: " + session.getId());
        // logger.info("onMessage: " + message.toString());
        Gson gson = new Gson();
        ClientMessage clientMessage = gson.fromJson(message.getJson().toString(),
                ClientMessage.class);
        System.out.println(clientMessage.toString());
    }
    @OnMessage
    public void onMessage(BinaryMessage message, Session session) {
        logger.info("BinaryMessage onMessage: " + session.getId());
        System.out.println(message.toString());
    }
}

Клиенты отправляют сообщение на сервер:

try {
            session.getBasicRemote().sendObject(new BinaryMessage("Binary Message"));
        } catch (EncodeException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }

Сервер отправляет сообщение клиенту:

try {
            session.getBasicRemote().sendObject(
                    gson.toJson(new ServerMessage(1, "connection accepted")));
        } catch (EncodeException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }

В примере: мы используем два метода @OnMessage для каждой конечной точки, где один для типа Text, а другой для декодера типа BinaryStream. Клиент и сервер отправляют друг другу сообщения разных типов, где клиент отправляет BinaryMessage, который имеет один атрибут String, а сервер отправляет объект Json. Таким образом, среда выполнения определит, какой тип декодера и кодировщика будет использоваться при обмене данными.

Выходной клиент:

JsonWrapper декодирует: {"id":1,"message":"подключение принято"}

ServerMessage [id=1, message=соединение принято]

Выходной сервер:

BinaryMessage [имя = двоичное сообщение]

person Md. Mahedi Kaysar    schedule 21.07.2015