All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.squareup.moshi.ClassJsonAdapter Maven / Gradle / Ivy

Go to download

The newest version!
/*
 * Copyright (C) 2015 Square, 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.squareup.moshi;

import com.jn.langx.annotation.Nullable;
import com.squareup.moshi.internal.Util;

import java.io.IOException;
import java.lang.annotation.Annotation;
import java.lang.reflect.*;
import java.util.Map;
import java.util.Set;
import java.util.TreeMap;

import static com.squareup.moshi.internal.Util.resolve;

/**
 * Emits a regular class as a JSON object by mapping Java fields to JSON object properties.
 *
 * 
Platform Types

 * Fields from platform classes are omitted from both serialization and deserialization unless
 * they are either public or protected. This includes the following packages and their subpackages:
 *
 * 
    
 *   
  • android.*
 *   
  • androidx.*
 *   
  • java.*
 *   
  • javax.*
 *   
  • kotlin.*
 *   
  • kotlinx.*
 *   
  • scala.*
 * 

 */
final class ClassJsonAdapter extends JsonAdapter {
    public static final JsonAdapter.Factory FACTORY = new JsonAdapter.Factory() {
        @Override
        public @Nullable
        JsonAdapter create(
                Type type, Set annotations, Moshi moshi) {
            if (!(type instanceof Class) && !(type instanceof ParameterizedType)) {
                return null;
            }
            Class rawType = Types.getRawType(type);
            if (rawType.isInterface() || rawType.isEnum()) {
                return null;
            }
            if (!annotations.isEmpty()) {
                return null;
            }
            if (Util.isPlatformType(rawType)) {
                String messagePrefix = "Platform " + rawType;
                if (type instanceof ParameterizedType) {
                    messagePrefix += " in " + type;
                }
                throw new IllegalArgumentException(
                        messagePrefix + " requires explicit JsonAdapter to be registered");
            }

            if (rawType.isAnonymousClass()) {
                throw new IllegalArgumentException("Cannot serialize anonymous class " + rawType.getName());
            }
            if (rawType.isLocalClass()) {
                throw new IllegalArgumentException("Cannot serialize local class " + rawType.getName());
            }
            if (rawType.getEnclosingClass() != null && !Modifier.isStatic(rawType.getModifiers())) {
                throw new IllegalArgumentException(
                        "Cannot serialize non-static nested class " + rawType.getName());
            }
            if (Modifier.isAbstract(rawType.getModifiers())) {
                throw new IllegalArgumentException("Cannot serialize abstract class " + rawType.getName());
            }
            if (Util.isKotlin(rawType)) {
                throw new IllegalArgumentException("Cannot serialize Kotlin type " + rawType.getName()
                        + ". Reflective serialization of Kotlin classes without using kotlin-reflect has "
                        + "undefined and unexpected behavior. Please use KotlinJsonAdapter from the "
                        + "moshi-kotlin artifact or use code gen from the moshi-kotlin-codegen artifact.");
            }

            ClassFactory classFactory = ClassFactory.get(rawType);
            Map> fields = new TreeMap>();
            for (Type t = type; t != Object.class; t = Types.getGenericSuperclass(t)) {
                createFieldBindings(moshi, t, fields);
            }
            return new ClassJsonAdapter(classFactory, fields).nullSafe();
        }

        /** Creates a field binding for each of declared field of {@code type}. */
        private void createFieldBindings(
                Moshi moshi, Type type, Map> fieldBindings) {
            Class rawType = Types.getRawType(type);
            boolean platformType = Util.isPlatformType(rawType);
            for (Field field : rawType.getDeclaredFields()) {
                if (!includeField(platformType, field.getModifiers())) {
                    continue;
                }

                // Look up a type adapter for this type.
                Type fieldType = resolve(type, rawType, field.getGenericType());
                Set annotations = Util.jsonAnnotations(field);
                String fieldName = field.getName();
                JsonAdapter adapter = moshi.adapter(fieldType, annotations, fieldName);

                // Create the binding between field and JSON.
                field.setAccessible(true);

                // Store it using the field's name. If there was already a field with this name, fail!
                Json jsonAnnotation = field.getAnnotation(Json.class);
                String name = jsonAnnotation != null ? jsonAnnotation.name() : fieldName;
                FieldBinding fieldBinding = new FieldBinding(name, field, adapter);
                FieldBinding replaced = fieldBindings.put(name, fieldBinding);
                if (replaced != null) {
                    throw new IllegalArgumentException("Conflicting fields:\n"
                            + "    " + replaced.field + "\n"
                            + "    " + fieldBinding.field);
                }
            }
        }

        /** Returns true if fields with {@code modifiers} are included in the emitted JSON. */
        private boolean includeField(boolean platformType, int modifiers) {
            if (Modifier.isStatic(modifiers) || Modifier.isTransient(modifiers)) {
                return false;
            }
            return Modifier.isPublic(modifiers) || Modifier.isProtected(modifiers) || !platformType;
        }
    };

    private final ClassFactory classFactory;
    private final FieldBinding[] fieldsArray;
    private final JsonReader.Options options;

    ClassJsonAdapter(ClassFactory classFactory, Map> fieldsMap) {
        this.classFactory = classFactory;
        this.fieldsArray = fieldsMap.values().toArray(new FieldBinding[fieldsMap.size()]);
        this.options = JsonReader.Options.of(
                fieldsMap.keySet().toArray(new String[fieldsMap.size()]));
    }

    @Override
    public T fromJson(JsonReader reader) throws IOException {
        T result;
        try {
            result = classFactory.newInstance();
        } catch (InstantiationException e) {
            throw new RuntimeException(e);
        } catch (InvocationTargetException e) {
            throw Util.rethrowCause(e);
        } catch (IllegalAccessException e) {
            throw new AssertionError();
        }

        try {
            reader.beginObject();
            while (reader.hasNext()) {
                int index = reader.selectName(options);
                if (index == -1) {
                    reader.skipName();
                    reader.skipValue();
                    continue;
                }
                fieldsArray[index].read(reader, result);
            }
            reader.endObject();
            return result;
        } catch (IllegalAccessException e) {
            throw new AssertionError();
        }
    }

    @Override
    public void toJson(JsonWriter writer, T value) throws IOException {
        try {
            writer.beginObject();
            for (FieldBinding fieldBinding : fieldsArray) {
                writer.name(fieldBinding.name);
                fieldBinding.write(writer, value);
            }
            writer.endObject();
        } catch (IllegalAccessException e) {
            throw new AssertionError();
        }
    }

    @Override
    public String toString() {
        return "JsonAdapter(" + classFactory + ")";
    }

    static class FieldBinding {
        final String name;
        final Field field;
        final JsonAdapter adapter;

        FieldBinding(String name, Field field, JsonAdapter adapter) {
            this.name = name;
            this.field = field;
            this.adapter = adapter;
        }

        void read(JsonReader reader, Object value) throws IOException, IllegalAccessException {
            T fieldValue = adapter.fromJson(reader);
            field.set(value, fieldValue);
        }

        @SuppressWarnings("unchecked")
            // We require that field's values are of type T.
        void write(JsonWriter writer, Object value) throws IllegalAccessException, IOException {
            T fieldValue = (T) field.get(value);
            adapter.toJson(writer, fieldValue);
        }
    }
}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy