Gson SerializedName在某些环境中发生了变化

时间:2016-04-26 08:21:31

标签: java spring-boot gson

我有一个带有GSon注释的DTO 我的问题是,如果我的应用程序在开发或分段或生产中运行,这些注释的价值必须改变......

目前,我必须使用不同的值打包我的应用程序,我希望这是自动的...它是在Spring Boot应用程序中,我想使用spring.profiles.active告诉我的应用程序采取正确的serializedName

以下是我使用的代码类型

  // Tests
  // @SerializedName("customfield_10123")
  // Prod
  @SerializedName("customfield_10114")
  private ActionDto action;

我希望有更好的方法吗?

1 个答案:

答案 0 :(得分:1)

这是一个非常粗略的例子,说明如何实现你想要的目标:

首先为每个可能的配置文件创建一个propery文件(名称可以是任何内容,但配置文件必须在名称上):

application-dev.properties
application-prod.properties
...

根据每个配置文件,使用每个键所需的值填充属性:

test=abc.test
...

注释您的POJO:

public class Foo {

    @SerializedName("${test}")
    private String name;

    ...

}

为您的类创建一个自定义序列化程序,它将解释自定义名称,如下所示:

public class FooSerializer implements JsonSerializer<Foo> {

    private static final Pattern PATTERN = Pattern.compile("\\$\\{(.*)\\}");
    private static Properties props;

    static {
        try {
            Resource resource = new ClassPathResource(String.format("/application-%s.properties", System.getProperty("spring.profiles.active")));
            props = PropertiesLoaderUtils.loadProperties(resource);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    @Override
    public JsonElement serialize(Foo foo, Type type, JsonSerializationContext jsonSerializationContext) {

        Field[] fields = foo.getClass().getDeclaredFields();

        JsonObject object = new JsonObject();

        for (Field field : fields) {
            field.setAccessible(true);
            String name = field.getName();
            if (field.isAnnotationPresent(SerializedName.class)) {
                String value = field.getAnnotation(SerializedName.class).value();
                Matcher matcher = PATTERN.matcher(value);
                if (matcher.find()) {
                    name = props.get(matcher.group(1)).toString();
                } else {
                    name = value;
                }
            }
            try {
                if (field.get(foo) != null) {
                    object.addProperty(name, field.get(foo).toString());
                }
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            }
        }
        return object;
    }
}

现在您只需要注册自定义序列化程序,就可以了:

Gson gson = new GsonBuilder().registerTypeAdapter(Foo.class, new FooSerializer()).setPrettyPrinting().create();

当然,根据活动配置文件可能有更好的方法来恢复属性文件,但是给定的代码段应该足以让您前进。此外,您需要考虑在任何给定时间可能有多个配置文件处于活动状态的事实,因此,如果这是您的方案,则需要在恢复属性之前将其考虑在内。

如果您总是想要使用属性中的值,那么您甚至不需要正则表达式部分。我使用正则表达式来允许这两种情况。

如果有什么事情不清楚,请告诉我,我会尽力改进。

修改

对于反序列化,我无法想出任何非常好的东西,所以这里有一个我认为远非正常的例子,但是完成了工作:

功能界面:

public interface Converter {

    Object convert(String s);
}

解串器:

public class FooDeserializer implements JsonDeserializer<Foo> {

    private static final Pattern PATTERN = Pattern.compile("\\$\\{(.*)\\}");
    private static Properties props;
    private static Map<Class, Converter> converterForClass = new HashMap<>();

    static {
        try {
            Resource resource = new ClassPathResource(String.format("/application-%s.properties", System.getProperty("spring.profiles.active")));
            props = PropertiesLoaderUtils.loadProperties(resource);

            converterForClass.put(Integer.TYPE, s -> Integer.parseInt(s.replace("\"", "")));
            converterForClass.put(Double.TYPE, s -> Double.parseDouble(s.replace("\"", "")));
            converterForClass.put(String.class, s -> s);
            converterForClass.put(Long.TYPE, s -> Long.parseLong(s.replace("\"", "")));
            converterForClass.put(Boolean.TYPE, s -> Boolean.parseBoolean(s.replace("\"", "")));
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    @Override
    public Foo deserialize(JsonElement jsonElement, Type type, JsonDeserializationContext jsonDeserializationContext) throws JsonParseException {


        Foo foo = new Foo();

        JsonObject jobject = (JsonObject) jsonElement;

        for (Entry entry : jobject.entrySet()) {
            Field field = searchField(entry.getKey().toString());
            if (field != null) {
                field.setAccessible(true);
                try {
                    Object r = converterForClass.get(field.getType()).convert(entry.getValue().toString());
                    field.set(foo, r);
                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                }
            }
        }
        return foo;

    }

    private Field searchField(String name) {
        Field[] fields = Foo.class.getDeclaredFields();

        for (Field field : fields) {
            field.setAccessible(true);
            if (field.isAnnotationPresent(SerializedName.class)) {
                String value = field.getAnnotation(SerializedName.class).value();

                Matcher matcher = PATTERN.matcher(value);
                if (value.equals(name)) {
                    return field;
                } else if (matcher.find()) {
                    if (props.get(matcher.group(1)).equals(name)) {
                        return field;
                    }
                }
            } else {
                if (field.getName().equals(name)) {
                    return field;
                }
            }
        }

        return null;
    }

注册反序列化器:

gsonBuilder.registerTypeAdapter(Foo.class, new FooDeserializer());

上述方法的问题是它不适用于嵌套对象。您将需要进一步的验证和实施。它也使用Java 8功能。