Avro
  1. Avro
  2. AVRO-839

Implement builder pattern in generated record classes that sets default values when omitted

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.6.0
    • Component/s: java
    • Labels:
      None
    • Hadoop Flags:
      Reviewed

      Description

      This is an idea for an improvement to the SpecificCompiler-generated record classes. There are two main issues to address:

      1. Default values specified in schemas are only used at read time, not when writing/serializing records. For example, a NullPointerException is thrown when attempting to write a record that has an uninitialized array or string type. I'm sure this was done for good reasons, like giving users maximum control and preventing unnecessary garbage collection, but I think it's also somewhat confusing and unintuitive for new users (myself included).
      2. Users have to create their own factory classes/methods for every record type, both to ensure that all non-primitive members are initialized and to facilitate the construction and initialization of record instances (i.e. constructing and setting values in a single statement).

      These issues have been discussed previously here:

      I'd like to propose a solution that is used by at least one other messaging framework. For each generated record class there will be a public static inner class called Builder. The Builder inner class has the same fields as the record class, as well as accessors and mutators for each of these fields. Whenever a mutator method is called, the Builder sets a boolean flag indicating that the field has been set. All mutators return a reference to 'this', so it's possible to chain a series of setter invocations, which makes it really easy to construct records in a single statement. The Builder also has a build() method which constructs a record instance using the values that were set in the Builder. When the build() method is invoked, if there are any fields that have not been set but have default values as defined in the schema, the Builder will set the values of these fields using their defaults.

      One nice thing about implementing the builder pattern in a static inner Builder class rather than in the record itself is that this enhancement will be completely backwards-compatible with existing code. The record class itself would not change, and the public fields would still be there, so existing code would still work. Users would have the option to use the Builder or continue constructing records manually. Eventually the public fields could be phased out, and the record would be made immutable. All changes would have to be done through the Builder.

      Here is an example of what this might look like:

      // Person.newBuilder() returns a new Person.Builder instance
      // All Person.Builder setters return 'this' allowing us to chain set calls together for convenience
      // Person.Builder.build() returns a Person instance after setting any uninitialized values that have defaults
      Person me = Person.newBuilder().setName("James").setCountry("US").setState("MA").build();
      
      // We still have direct access to Person's members, so the records are backwards-compatible
      me.state = "CA";
      
      // Person has accessor methods now so that the public fields can be phased out later
      System.out.println(me.getState());
      
      // No NPE here because the array<Person> field that stores this person's friends has been automatically 
      // initialized by the Builder to a new java.util.ArrayList<Person> due to a @java_class annotation in the IDL
      System.out.println(me.getFriends().size());
      

      What do people think about this approach? Any other ideas?

      1. AVRO-839.patch
        141 kB
        Doug Cutting
      2. AVRO-839.patch
        128 kB
        Doug Cutting
      3. AVRO-839.patch
        92 kB
        James Baldassari
      4. AVRO-839-v2.patch
        102 kB
        James Baldassari
      5. AVRO-839-v3.patch
        100 kB
        James Baldassari
      6. AVRO-839-v4.patch
        117 kB
        James Baldassari
      7. AVRO-839-v4.patch
        115 kB
        James Baldassari
      8. AVRO-839-v5.patch
        146 kB
        James Baldassari

        Issue Links

          Activity

          No work has yet been logged on this issue.

            People

            • Assignee:
              James Baldassari
              Reporter:
              James Baldassari
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development