root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 8 Packages Projects Releases Wiki Activity

TextMessage.toString() does not throw StringIndexOutOfBoundsException for payload with multibyte characters 

Issue: SPR-12307
This commit is contained in:
Juergen Hoeller 2014-10-07 13:35:38 +02:00
parent aaf69eb1f1
commit da14aeea7a
6 changed files with 65 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
spring-websocket/src/main/java/org/springframework/web/socket/AbstractWebSocketMessage.java
View File

@ -69,10 +69,6 @@ public abstract class AbstractWebSocketMessage<T> implements WebSocketMessage<T>
return this.last;
}
@Override
public int hashCode() {
return AbstractWebSocketMessage.class.hashCode() * 13 + ObjectUtils.nullSafeHashCode(this.payload);
}
@Override
public boolean equals(Object other) {
@ -86,10 +82,15 @@ public abstract class AbstractWebSocketMessage<T> implements WebSocketMessage<T>
return ObjectUtils.nullSafeEquals(this.payload, otherMessage.payload);
}
@Override
public int hashCode() {
return ObjectUtils.nullSafeHashCode(this.payload);
}
@Override
public String toString() {
return getClass().getSimpleName() + " payload= " + toStringPayload()
+ ", byteCount=" + getPayloadLength() + ", last=" + isLast() + "]";
return getClass().getSimpleName() + " payload=[" + toStringPayload() +
"], byteCount=" + getPayloadLength() + ", last=" + isLast() + "]";
}
protected abstract String toStringPayload();

3
spring-websocket/src/main/java/org/springframework/web/socket/BinaryMessage.java
View File

@ -26,7 +26,6 @@ import java.nio.ByteBuffer;
*/
public final class BinaryMessage extends AbstractWebSocketMessage<ByteBuffer> {
/**
* Create a new binary WebSocket message with the given ByteBuffer payload.
* @param payload the non-null payload
@ -78,7 +77,7 @@ public final class BinaryMessage extends AbstractWebSocketMessage<ByteBuffer> {
* @param isLast if the message is the last of a series of partial messages
*/
public BinaryMessage(byte[] payload, int offset, int length, boolean isLast) {
super((payload != null) ? ByteBuffer.wrap(payload, offset, length) : null, isLast);
super(payload != null ? ByteBuffer.wrap(payload, offset, length) : null, isLast);
}

5
spring-websocket/src/main/java/org/springframework/web/socket/PingMessage.java
View File

@ -26,7 +26,6 @@ import java.nio.ByteBuffer;
*/
public final class PingMessage extends AbstractWebSocketMessage<ByteBuffer> {
/**
* Create a new ping message with an empty payload.
*/
@ -45,12 +44,12 @@ public final class PingMessage extends AbstractWebSocketMessage<ByteBuffer> {
@Override
public int getPayloadLength() {
return (getPayload() != null) ? getPayload().remaining() : 0;
return (getPayload() != null ? getPayload().remaining() : 0);
}
@Override
protected String toStringPayload() {
return (getPayload() != null) ? getPayload().toString() : null;
return (getPayload() != null ? getPayload().toString() : null);
}
}

5
spring-websocket/src/main/java/org/springframework/web/socket/PongMessage.java
View File

@ -26,7 +26,6 @@ import java.nio.ByteBuffer;
*/
public final class PongMessage extends AbstractWebSocketMessage<ByteBuffer> {
/**
* Create a new pong message with an empty payload.
*/
@ -45,12 +44,12 @@ public final class PongMessage extends AbstractWebSocketMessage<ByteBuffer> {
@Override
public int getPayloadLength() {
return (getPayload() != null) ? getPayload().remaining() : 0;
return (getPayload() != null ? getPayload().remaining() : 0);
}
@Override
protected String toStringPayload() {
return (getPayload() != null) ? getPayload().toString() : null;
return (getPayload() != null ? getPayload().toString() : null);
}
}

10
spring-websocket/src/main/java/org/springframework/web/socket/TextMessage.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2002-2013 the original author or authors.
* Copyright 2002-2014 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -41,9 +41,8 @@ public final class TextMessage extends AbstractWebSocketMessage<String> {
}
/**
* Create a new text WebSocket message from the given byte[]. It is assumed the
* byte array can be encoded into an UTF-8 String.
*
* Create a new text WebSocket message from the given byte[]. It is assumed
* the byte array can be encoded into an UTF-8 String.
* @param payload the non-null payload
*/
public TextMessage(byte[] payload) {
@ -76,7 +75,8 @@ public final class TextMessage extends AbstractWebSocketMessage<String> {
@Override
protected String toStringPayload() {
return (getPayloadLength() > 10) ? getPayload().substring(0, 10) + ".." : getPayload();
String payload = getPayload();
return (payload.length() > 10 ? payload.substring(0, 10) + ".." : payload);
}
}

48
spring-websocket/src/test/java/org/springframework/web/socket/TextMessageTests.java Normal file
View File

@ -0,0 +1,48 @@
/*
* Copyright 2002-2014 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.web.socket;
import org.hamcrest.Matchers;
import org.junit.Test;
import static org.junit.Assert.*;
/**
* Test fixture for {@link TextMessage}.
*
* @author Shinobu Aoki
* @author Juergen Hoeller
*/
public class TextMessageTests {
@Test
public void toStringWithAscii() {
String expected = "foo,bar";
TextMessage actual = new TextMessage(expected);
assertThat(actual.getPayload(), Matchers.is(expected));
assertThat(actual.toString(), Matchers.containsString(expected));
}
@Test
public void toStringWithMultibyteString() {
String expected = "\u3042\u3044\u3046\u3048\u304a";
TextMessage actual = new TextMessage(expected);
assertThat(actual.getPayload(), Matchers.is(expected));
assertThat(actual.toString(), Matchers.containsString(expected));
}
}