如何讓Gson使用訪問者而不是字段？

Question

默認情況下，Gson使用字段作為序列化的基礎。 有沒有辦法讓它使用訪問器？

Answer 1

Gson的開發人員表示 ，他們從未對添加此功能的請求感到不滿，他們擔心會濫用api來增加對此功能的支持。

添加此功能的一種方法是使用TypeAdapter（我為粗糙的代碼道歉，但這證明了原理）：

import java.io.IOException;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

import com.google.common.base.CaseFormat;
import com.google.gson.Gson;
import com.google.gson.TypeAdapter;
import com.google.gson.reflect.TypeToken;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;

public class AccessorBasedTypeAdaptor<T> extends TypeAdapter<T> {

  private Gson gson;

  public AccessorBasedTypeAdaptor(Gson gson) {
    this.gson = gson;
  }

  @SuppressWarnings("unchecked")
  @Override
  public void write(JsonWriter out, T value) throws IOException {
    out.beginObject();
    for (Method method : value.getClass().getMethods()) {
      boolean nonBooleanAccessor = method.getName().startsWith("get");
      boolean booleanAccessor = method.getName().startsWith("is");
      if ((nonBooleanAccessor || booleanAccessor) && !method.getName().equals("getClass") && method.getParameterTypes().length == 0) {
        try {
          String name = method.getName().substring(nonBooleanAccessor ? 3 : 2);
          name = CaseFormat.UPPER_CAMEL.to(CaseFormat.LOWER_CAMEL, name);
          Object returnValue = method.invoke(value);
          if(returnValue != null) {
            TypeToken<?> token = TypeToken.get(returnValue.getClass());
            TypeAdapter adapter = gson.getAdapter(token);
            out.name(name);
            adapter.write(out, returnValue);
          }
        } catch (Exception e) {
          throw new ConfigurationException("problem writing json: ", e);
        }
      }
    }
    out.endObject();
  }

  @Override
  public T read(JsonReader in) throws IOException {
    throw new UnsupportedOperationException("Only supports writes.");
  }
}

您可以將此注冊為給定類型的普通類型適配器或通過TypeAdapterfactory注冊 - 可能檢查是否存在運行時注釋：

public class TypeFactory implements TypeAdapterFactory {

  @SuppressWarnings("unchecked")
  public <T> TypeAdapter<T> create(final Gson gson, final TypeToken<T> type) {
    Class<? super T> t = type.getRawType();
    if(t.isAnnotationPresent(UseAccessor.class)) {
     return (TypeAdapter<T>) new AccessorBasedTypeAdaptor(gson);
    }
    return null;
  }

在創建gson實例時，可以將其指定為正常：

new GsonBuilder().registerTypeAdapterFactory(new TypeFactory()).create();

Answer 2

注意：我是EclipseLink JAXB（MOXy）的負責人，也是JAXB（JSR-222）專家組的成員。

如果你不能讓Gson做你想做的事，下面就是你如何使用MOXy的原生JSON綁定來實現這一點。 像任何JAXB實現一樣MOXy默認使用屬性（公共）訪問。 您可以使用@XmlAccessorType(XmlAccessType.FIELD)配置字段訪問。 以下是一個例子：

顧客

package forum11385214;

public class Customer {

    private String foo;
    private Address bar;

    public String getName() {
        return foo;
    }

    public void setName(String name) {
        this.foo = name;
    }

    public Address getAddress() {
        return bar;
    }

    public void setAddress(Address address) {
        this.bar = address;
    }

}

地址

package forum11385214;

public class Address {

    private String foo;

    public String getStreet() {
        return foo;
    }

    public void setStreet(String street) {
        this.foo = street;
    }

}

jaxb.properties

要將MOXy配置為JAXB提供程序，您需要在與域模型相同的包中添加名為jaxb.properties的文件，並帶有以下條目（請參閱： http ： //blog.bdoughan.com/2011/05/specifying-eclipselink- moxy-as-your.html ）。

javax.xml.bind.context.factory=org.eclipse.persistence.jaxb.JAXBContextFactory

演示

package forum11385214;

import java.util.*;
import javax.xml.bind.*;
import javax.xml.transform.stream.StreamSource;
import org.eclipse.persistence.jaxb.JAXBContextProperties;

public class Demo {

    public static void main(String[] args) throws Exception {
        Map<String, Object> properties = new HashMap<String, Object>(2);
        properties.put(JAXBContextProperties.MEDIA_TYPE, "application/json");
        properties.put(JAXBContextProperties.JSON_INCLUDE_ROOT, false);
        JAXBContext jc = JAXBContext.newInstance(new Class[] {Customer.class}, properties);

        Unmarshaller unmarshaller = jc.createUnmarshaller();
        StreamSource json = new StreamSource("src/forum11385214/input.json");
        Customer customer = (Customer) unmarshaller.unmarshal(json, Customer.class).getValue();

        Marshaller marshaller = jc.createMarshaller();
        marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
        marshaller.marshal(customer, System.out);
    }

}

input.json /輸出

{
    "name" : "Jane Doe",
    "address" : {
        "street" : "1 Any Street"
    }
}

欲獲得更多信息

• http://blog.bdoughan.com/2011/08/json-binding-with-eclipselink-moxy.html
• http://blog.bdoughan.com/2011/06/using-jaxbs-xmlaccessortype-to.html
• http://blog.bdoughan.com/2012/04/jaxb-and-unmapped-properties.html