proguard.optimize.gson._GsonUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proguard-base Show documentation
ProGuard is a free shrinker, optimizer, obfuscator, and preverifier for Java bytecode
There is a newer version: 7.6.0
/*
 * ProGuard -- shrinking, optimization, obfuscation, and preverification
 *             of Java bytecode.
 *
 * Copyright (c) 2002-2020 Guardsquare NV
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2 of the License, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */
package proguard.optimize.gson;

import com.google.gson.*;
import com.google.gson.internal.bind.ReflectiveTypeAdapterFactory;
import com.google.gson.reflect.TypeToken;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

import java.lang.reflect.*;
import java.util.Map;

/**
 * This utility class is injected into the program class pool when the GSON
 * optimizations are applied. It contains the logic for picking the right
 * type adapter for a given type and value that needs to be serialized.
 *
 * The injected toJson() methods in the domain classes will use these utility
 * methods for serializing the fields of the domain class with the appropriate
 * type adapter.
 *
 * @author Lars Vandenbergh
 */
public final class _GsonUtil
{
    private static final Logger logger = LogManager.getLogger(_GsonUtil.class);

    /**
     * Returns the appropriate type adapter for handling the given value with
     * the given declared type.
     *
     * @param gson         the Gson context that manages all registered type
     *                     adapters.
     * @param declaredType the type of the value to (de)serialize.
     * @param value        the value to (de)serialize.
     * @return             the type adapter for handling the given value and
     *                     declared type.
     */
    public static TypeAdapter getTypeAdapter(Gson gson, Class declaredType, Object value)
    {
        // If the runtime type is a sub type and there is a custom type adapter registered for
        // the declared type, that one should get precedence over the runtime type adapter if
        // the runtime type adapter is not custom.
        Type runtimeType = getRuntimeTypeIfMoreSpecific(declaredType, value);
        TypeAdapter runtimeTypeAdapter = gson.getAdapter(TypeToken.get(runtimeType));
        if (declaredType != runtimeType && !isCustomTypeAdapter(runtimeTypeAdapter))
        {
            TypeAdapter declaredTypeAdapter = gson.getAdapter(declaredType);
            if (isCustomTypeAdapter(declaredTypeAdapter))
            {
                return declaredTypeAdapter;
            }
        }

        // In all other cases the type adapter for the runtime type is used.
        return runtimeTypeAdapter;
    }


    /**
     * Returns the appropriate type adapter for handling the given value with
     * the given declared type token.
     *
     * @param gson              the Gson context that manages all registered type
     *                          adapters.
     * @param declaredTypeToken the declared type token of the value to (de)serialize.
     * @param value             the value to (de)serialize.
     * @return                  the type adapter for handling the given value and
     *                          declared type.
     */
    public static TypeAdapter getTypeAdapter(Gson gson, TypeToken declaredTypeToken, Object value)
    {
        // If the runtime type is a sub type and there is a custom type adapter registered for
        // the declared type, that one should get precedence over the runtime type adapter if
        // the runtime type adapter is not custom.
        Type declaredType = declaredTypeToken.getType();
        Type runtimeType = getRuntimeTypeIfMoreSpecific(declaredType, value);
        TypeAdapter runtimeTypeAdapter = gson.getAdapter(TypeToken.get(runtimeType));
        if (declaredType != runtimeType && !isCustomTypeAdapter(runtimeTypeAdapter))
        {
            TypeAdapter declaredTypeAdapter = gson.getAdapter(declaredTypeToken);
            if (isCustomTypeAdapter(declaredTypeAdapter))
            {
                return declaredTypeAdapter;
            }
        }

        // In all other cases the type adapter for the runtime type is used.
        return runtimeTypeAdapter;
    }


    /**
     * Finds a compatible runtime type if it is more specific
     */
    private static Type getRuntimeTypeIfMoreSpecific(Type type, Object value) {
        if (value != null
            && (type == Object.class || type instanceof TypeVariable || type instanceof Class)) {
            type = value.getClass();
        }
        return type;
    }

    /**
     * Determines whether a given type adapter is a custom type adapter, i.e.
     * a type adapter that is registered by the user of the Gson API and not
     * the GSON reflection based type adapter or the optimized type adapter
     * injected by DexGuard.
     */
    private static boolean isCustomTypeAdapter(TypeAdapter declaredTypeAdapter)
    {
        return !(declaredTypeAdapter instanceof _OptimizedTypeAdapter) &&
               !(declaredTypeAdapter instanceof ReflectiveTypeAdapterFactory.Adapter);
    }


    /**
     * Dumps the cached type adapter for each type for debugging purpose.
     */
    public static void dumpTypeTokenCache(String message, Map, TypeAdapter> typeTokenCache)
    {
        logger.info(message);
        for (Map.Entry, TypeAdapter> typeTokenCacheEntry : typeTokenCache.entrySet())
        {
            logger.info("    {} -> {}", typeTokenCacheEntry.getKey(), typeTokenCacheEntry.getValue());
        }
    }
}