Why Using isSuccess Can Break JSON Serialization in Java

In daily development we often define boolean fields in classes, e.g., a field indicating whether a request succeeded. Naming conventions vary: some use success, others isSuccess. According to the JavaBeans Specification, non‑boolean properties use get/set, while boolean properties use is for the getter.

For a boolean property isSuccess, the getter should be isSuccess() and the setter setSuccess(boolean). However, IDEs may generate isSuccess() and getSuccess(), leading to ambiguity.

public <PropertyType> get<PropertyName>();
public void set<PropertyName>(<PropertyType> a);

public boolean is<PropertyName>();
public void set<PropertyName>(boolean m);

When serializing objects, different JSON libraries apply different strategies. fastjson and Jackson inspect getters, treating isSuccess() as a property named success, producing JSON {"success":true}. Gson inspects fields directly, yielding {"isSuccess":true}. Consequently, deserializing fastjson’s output with Gson results in the boolean remaining false.

class Model implements Serializable {
    private static final long serialVersionUID = 1836697963736227954L;
    private boolean isSuccess;
    public boolean isSuccess() { return isSuccess; }
    public void setSuccess(boolean success) { isSuccess = success; }
    public String getHollis() { return "hollischuang"; }
}

public class BooleanMainTest {
    public static void main(String[] args) throws IOException {
        Model model = new Model();
        model.setSuccess(true);
        System.out.println("Serializable Result With fastjson :" + JSON.toJSONString(model));
        Gson gson = new Gson();
        System.out.println("Serializable Result With Gson :" + gson.toJson(model));
        ObjectMapper om = new ObjectMapper();
        System.out.println("Serializable Result With jackson :" + om.writeValueAsString(model));
    }
}

This discrepancy can cause serious bugs in production. The recommended practice is to name the field success and keep the getter isSuccess(), fully complying with JavaBeans rules and ensuring consistent behavior across serialization frameworks.