Lift restriction on naming when using the "@SerializedNamed" annotation.
Fix for Issue 290.
This commit is contained in:
parent
7f9762db63
commit
4917fc7f76
@ -66,7 +66,7 @@ final class Escaper {
|
||||
}
|
||||
|
||||
public String escapeJsonString(CharSequence plainText) {
|
||||
StringBuffer escapedString = new StringBuffer(plainText.length() + 20);
|
||||
StringBuilder escapedString = new StringBuilder(plainText.length() + 20);
|
||||
try {
|
||||
escapeJsonString(plainText, escapedString);
|
||||
} catch (IOException e) {
|
||||
@ -75,7 +75,7 @@ final class Escaper {
|
||||
return escapedString.toString();
|
||||
}
|
||||
|
||||
private void escapeJsonString(CharSequence plainText, StringBuffer out) throws IOException {
|
||||
private void escapeJsonString(CharSequence plainText, StringBuilder out) throws IOException {
|
||||
int pos = 0; // Index just past the last char in plainText written to out.
|
||||
int len = plainText.length();
|
||||
|
||||
|
@ -1,58 +0,0 @@
|
||||
/*
|
||||
* Copyright (C) 2008 Google Inc.
|
||||
*
|
||||
* 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 com.google.gson;
|
||||
|
||||
import com.google.gson.internal.$Gson$Preconditions;
|
||||
|
||||
import java.util.regex.Matcher;
|
||||
import java.util.regex.Pattern;
|
||||
|
||||
/**
|
||||
* This class can be used to check the validity of a JSON field name.
|
||||
*
|
||||
* <p>The primary use of this object is to ensure that any Java fields that use the
|
||||
* {@link com.google.gson.annotations.SerializedName} annotation is providing valid JSON
|
||||
* field names. This will make the code fail-fast rather than letting the invalid
|
||||
* field name propagate to the client and it fails to parse.</p>
|
||||
*
|
||||
* @author Joel Leitch
|
||||
*/
|
||||
class JsonFieldNameValidator {
|
||||
private static final String COMMON_PATTERN = "[a-zA-Z][a-zA-Z0-9\\ \\$_\\-]*$";
|
||||
|
||||
private static final Pattern JSON_FIELD_NAME_PATTERN =
|
||||
Pattern.compile("(^" + COMMON_PATTERN + ")|(^[\\$_]" + COMMON_PATTERN + ")");
|
||||
|
||||
|
||||
/**
|
||||
* Performs validation on the JSON field name to ensure it is a valid field name.
|
||||
*
|
||||
* @param fieldName the name of the field to validate
|
||||
* @return {@code fieldName} if it is a valid JSON field name
|
||||
* @throws IllegalArgumentException if the field name is an invalid JSON field name
|
||||
*/
|
||||
public String validate(String fieldName) {
|
||||
$Gson$Preconditions.checkNotNull(fieldName);
|
||||
$Gson$Preconditions.checkArgument(!"".equals(fieldName.trim()));
|
||||
|
||||
Matcher matcher = JSON_FIELD_NAME_PATTERN.matcher(fieldName);
|
||||
if (!matcher.matches()) {
|
||||
throw new IllegalArgumentException(fieldName + " is not a valid JSON field name.");
|
||||
}
|
||||
return fieldName;
|
||||
}
|
||||
}
|
@ -19,20 +19,22 @@ package com.google.gson;
|
||||
import com.google.gson.annotations.SerializedName;
|
||||
|
||||
/**
|
||||
* A {@link FieldNamingStrategy2} that acts as a chain of responsibility. If the
|
||||
* {@link com.google.gson.annotations.SerializedName} annotation is applied to a field then this
|
||||
* strategy will translate the name to the {@code serializedName.value()}; otherwise it delegates
|
||||
* to the wrapped {@link FieldNamingStrategy2}.
|
||||
* A {@link FieldNamingStrategy2} that acts as a chain of responsibility. If the
|
||||
* {@link com.google.gson.annotations.SerializedName} annotation is applied to a
|
||||
* field then this strategy will translate the name to the {@code
|
||||
* serializedName.value()}; otherwise it delegates to the wrapped
|
||||
* {@link FieldNamingStrategy2}.
|
||||
*
|
||||
* <p>NOTE: this class performs JSON field name validation for any of the fields marked with
|
||||
* an {@code @SerializedName} annotation.</p>
|
||||
* <p>
|
||||
* NOTE: this class performs JSON field name validation for any of the fields
|
||||
* marked with an {@code @SerializedName} annotation.
|
||||
* </p>
|
||||
*
|
||||
* @see SerializedName
|
||||
*
|
||||
* @author Joel Leitch
|
||||
*/
|
||||
final class SerializedNameAnnotationInterceptingNamingPolicy implements FieldNamingStrategy2 {
|
||||
private static final JsonFieldNameValidator fieldNameValidator = new JsonFieldNameValidator();
|
||||
private final FieldNamingStrategy2 delegate;
|
||||
|
||||
SerializedNameAnnotationInterceptingNamingPolicy(FieldNamingStrategy2 delegate) {
|
||||
@ -41,7 +43,6 @@ final class SerializedNameAnnotationInterceptingNamingPolicy implements FieldNam
|
||||
|
||||
public String translateName(FieldAttributes f) {
|
||||
SerializedName serializedName = f.getAnnotation(SerializedName.class);
|
||||
return serializedName == null ? delegate.translateName(f)
|
||||
: fieldNameValidator.validate(serializedName.value());
|
||||
return serializedName == null ? delegate.translateName(f) : serializedName.value();
|
||||
}
|
||||
}
|
||||
|
@ -1,112 +0,0 @@
|
||||
/*
|
||||
* Copyright (C) 2008 Google Inc.
|
||||
*
|
||||
* 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 com.google.gson;
|
||||
|
||||
import junit.framework.TestCase;
|
||||
|
||||
/**
|
||||
* Unit tests for the {@link JsonFieldNameValidator} class.
|
||||
*
|
||||
* @author Joel Leitch
|
||||
*/
|
||||
public class JsonFieldNameValidatorTest extends TestCase {
|
||||
|
||||
private JsonFieldNameValidator validator;
|
||||
|
||||
@Override
|
||||
protected void setUp() throws Exception {
|
||||
super.setUp();
|
||||
validator = new JsonFieldNameValidator();
|
||||
}
|
||||
|
||||
public void testValidFieldBeginsWithDollarSign() throws Exception {
|
||||
String fieldName = "$abc";
|
||||
assertEquals(fieldName, validator.validate(fieldName));
|
||||
}
|
||||
|
||||
public void testValidFieldBeginsWithUnderscore() throws Exception {
|
||||
String fieldName = "_abc";
|
||||
assertEquals(fieldName, validator.validate(fieldName));
|
||||
}
|
||||
|
||||
public void testValidFieldBeginsWithLetter() throws Exception {
|
||||
String fieldName = "abc";
|
||||
assertEquals(fieldName, validator.validate(fieldName));
|
||||
}
|
||||
|
||||
public void testValidFieldMixingLetter() throws Exception {
|
||||
String fieldName = "$abc_12v$34";
|
||||
assertEquals(fieldName, validator.validate(fieldName));
|
||||
}
|
||||
|
||||
public void testInvalidFieldStartingWithNumbers() throws Exception {
|
||||
try {
|
||||
validator.validate("1abc");
|
||||
fail("Json field name can not start with a number");
|
||||
} catch (IllegalArgumentException expected) { }
|
||||
}
|
||||
|
||||
public void testInvalidFieldStartingTwoDollarSigns() throws Exception {
|
||||
try {
|
||||
validator.validate("$$abc");
|
||||
fail("Json field name can not start with a double dollar sign");
|
||||
} catch (IllegalArgumentException expected) { }
|
||||
}
|
||||
|
||||
public void testInvalidFieldStartingTwoUnderscores() throws Exception {
|
||||
try {
|
||||
validator.validate("__abc");
|
||||
fail("Json field name can not start with a double underscore");
|
||||
} catch (IllegalArgumentException expected) { }
|
||||
}
|
||||
|
||||
public void testInvalidFieldStartingDollarUnderscore() throws Exception {
|
||||
try {
|
||||
validator.validate("$_abc");
|
||||
fail("Json field name can not start with two non-alphabet characters");
|
||||
} catch (IllegalArgumentException expected) { }
|
||||
}
|
||||
|
||||
public void testJavaAndJsKeywordAsFieldName() throws Exception {
|
||||
String fieldName = "break";
|
||||
assertEquals(fieldName, validator.validate(fieldName));
|
||||
}
|
||||
|
||||
public void testInvalidCharacters() throws Exception {
|
||||
try {
|
||||
validator.validate("abc.123");
|
||||
fail("Json field name can not contain a period character");
|
||||
} catch (IllegalArgumentException expected) { }
|
||||
}
|
||||
|
||||
public void testDashesInFieldName() throws Exception {
|
||||
String fieldName = "test-field-name";
|
||||
assertEquals(fieldName, validator.validate(fieldName));
|
||||
}
|
||||
|
||||
public void testSpacesInFieldName() throws Exception {
|
||||
String fieldName = "test field name";
|
||||
assertEquals(fieldName, validator.validate(fieldName));
|
||||
}
|
||||
|
||||
public void testSpacesInBeginningOfName() throws Exception {
|
||||
try {
|
||||
validator.validate(" testFieldName");
|
||||
fail("Json field name can not contain a period character");
|
||||
} catch (IllegalArgumentException expected) { }
|
||||
}
|
||||
}
|
@ -15,8 +15,6 @@
|
||||
*/
|
||||
package com.google.gson.functional;
|
||||
|
||||
import java.lang.reflect.Field;
|
||||
|
||||
import com.google.gson.FieldNamingPolicy;
|
||||
import com.google.gson.FieldNamingStrategy;
|
||||
import com.google.gson.Gson;
|
||||
@ -27,6 +25,8 @@ import com.google.gson.common.TestTypes.StringWrapper;
|
||||
|
||||
import junit.framework.TestCase;
|
||||
|
||||
import java.lang.reflect.Field;
|
||||
|
||||
/**
|
||||
* Functional tests for naming policies.
|
||||
*
|
||||
@ -34,7 +34,6 @@ import junit.framework.TestCase;
|
||||
* @author Joel Leitch
|
||||
*/
|
||||
public class NamingPolicyTest extends TestCase {
|
||||
|
||||
private GsonBuilder builder;
|
||||
|
||||
@Override
|
||||
@ -136,6 +135,16 @@ public class NamingPolicyTest extends TestCase {
|
||||
assertEquals("{\"A\":10}", actual);
|
||||
}
|
||||
|
||||
public void testComplexFieldNameStrategy() throws Exception {
|
||||
Gson gson = new Gson();
|
||||
String json = gson.toJson(new ClassWithComplexFieldName(10));
|
||||
String escapedFieldName = "@value\\\"_s$\\\\";
|
||||
assertEquals("{\"" + escapedFieldName + "\":10}", json);
|
||||
|
||||
ClassWithComplexFieldName obj = gson.fromJson(json, ClassWithComplexFieldName.class);
|
||||
assertEquals(10, obj.value);
|
||||
}
|
||||
|
||||
private static class UpperCaseNamingStrategy implements FieldNamingStrategy {
|
||||
public String translateName(Field f) {
|
||||
return f.getName().toUpperCase();
|
||||
@ -160,4 +169,12 @@ public class NamingPolicyTest extends TestCase {
|
||||
this.b = b;
|
||||
}
|
||||
}
|
||||
|
||||
private static class ClassWithComplexFieldName {
|
||||
@SerializedName("@value\"_s$\\") public final long value;
|
||||
|
||||
ClassWithComplexFieldName(long value) {
|
||||
this.value = value;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
Loading…
Reference in New Issue
Block a user